components_configuration.rst 4.23 KB
Newer Older
Vojtech Sodoma's avatar
Vojtech Sodoma committed
1 2 3 4 5 6
.. _components_configuration:

************************
Components Configuration
************************

7 8 9
.. important:: When reading this section, keep in mind the :ref:`xivocc_architecture_and_flows` diagram.


Vojtech Sodoma's avatar
Vojtech Sodoma committed
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
Overview
========

This section describes files installed by `xivocc-installer`. Some of these files may be modified for these reasons:

* Components customization
* Multi-server installation

XiVO CC system configuration is stored in the ``/etc/docker/compose`` directory. All files ale configured by the `xivocc-installer`
and don't need to be edited. The directory contains these files:

* ``docker-xivocc.yml``, called `compose file`, defines XiVO CC components and their configuration. It uses variables
  defined in the ``.env`` file.
* ``.env`` file assigns values to variables used in the `compose file`. But this file is being generated by `xivocc-dcomp`
  script and **should not be edited directly**.
* ``factory.env`` file stores XiVO CC version number and distribution and **should not be edited**.
Vojtech Sodoma's avatar
Vojtech Sodoma committed
26
* ``custom.env`` file may be used for component customization and multi-server installation.
Vojtech Sodoma's avatar
Vojtech Sodoma committed
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74

Compose File
============

``docker-xivocc.yml``

Sections
--------

* The main headers in the compose file (without indent) are container names.
* ``image`` - links to container image url on https://hub.docker.com/r/ page.
* ``ports`` - exposes container internal ports to host in format HOST:CONTAINER.
* ``volumes_from`` - mounts all of the volumes from another container
* ``environment`` - adds environment variables into container system
* ``extra_hosts`` - adds host address to /etc/hosts
* ``links`` - adds another container's host address to /etc/hosts

See detailed documentation on `docker web <https://docs.docker.com/compose/compose-file/compose-file-v1/>`_.

Variables
=========

Compose file contains more kinds of variables:

* Variable in the ``environment`` section without assignment is replaced by the same variable from ``.env`` file.
  If it's not defined or assigned in the ``.env`` file, it doesn't appear in the container system.
* Variable in the ``environment`` section with assigned value overrides value defined in the ``.env`` file.
* Variable defined in the ``links`` section can be assigned to variable in the ``environment`` section.
* Variable inside ``${ }`` block is replaced by value defined in ``.env`` file and can be used anywhere.

Variables in the factory.env file
---------------------------------

This file should not be edited. XiVO CC version matches version of xivocc-installer and the other distributions are only
for testing purposes.

* ``XIVOCC_TAG`` - XiVO CC version number
* ``XIVOCC_DIST`` - XiVO CC distribution

Variables in the custom.env file
--------------------------------

All variables listed below can be edited or added to this file. But variables which are assigned inside compose file
must be first unassigned from there.

List of variables shared across containers
------------------------------------------

Vojtech Sodoma's avatar
Vojtech Sodoma committed
75
Main components addresses and ports:
Vojtech Sodoma's avatar
Vojtech Sodoma committed
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90

* ``XIVO_HOST``
* ``XUC_HOST``
* ``XUC_PORT``

Customizable addresses and ports for multi-server installation:

* ``CONFIG_MGT_HOST``
* ``CONFIG_MGT_PORT``
* ``RECORDING_SERVER_HOST``
* ``RECORDING_SERVER_PORT``

Other:

* ``JAVA_OPTS`` - allocates Java memory and sets other Java options. If you want to use different values for containers,
Vojtech Sodoma's avatar
Vojtech Sodoma committed
91
  they must be assigned inside compose file. Or you can define new variable for this purpose - e.g.: ``JAVA_OPTS=JAVA_OPTS_XUC``
Vojtech Sodoma's avatar
Vojtech Sodoma committed
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144
  and set the value in the custom.env file.

.. _list_of_containers:

List of docker containers and their variables
---------------------------------------------

* pgxivocc

  - ``POSTGRES_PASSWORD``

* postgresvols
* xivo_replic

  - ``ELASTICTTL``
  - ``DISABLEELASTIC``

* xivo_stats
* pack_reporting

  - ``WEEKS_TO_KEEP``

* elasticsearch
* kibana_volumes
* fingerboard
* nginx
* spagobi
* recording_rsync
* config_mgt
* recording_server

  - ``RECORDING_WEEKS_TO_KEEP``

* xuc

  - ``XIVO_AMI_SECRET``
  - ``XIVO_AMI_PORT``
  - ``XIVO_CTI_VERSION``
  - ``API_eventUrl``
  - ``XIVO_DIRD_PROFILE``
  - ``SECURED_KRB5_PRINCIPAL``

* xucmgt

  - ``SHOW_RECORDING_CONTROLS``
  - ``SHOW_CALLBACKS``
  - ``SHOW_QUEUE_CONTROLS``
  - ``THIRD_PARTY_URL``
  - ``ENFORCE_MANAGER_SECURITY``
  - ``USE_SSO``

* timezone
* xivocclogs