The installation is designed to require as minimal information as possible. Therefor the min information we need is the directory where the installer should install uvuyo. This is passed to the installer via the
--uvuyo.home=/opt/2yetis/uvuyo parameter. Of course, you would need to change the value of the directory in case you chose to use a custom location.
Nevertheless, when running the installation in more complex environments using docker you might need to add additional information to the installer. This is done using the
--config parameter. This parameter controls the content of the docker-compose file. With this parameter you can specify a file which contains additional information on which docker containers should be created by docker-compose on the machine.
--config parameter you can either specify a predefined configuration or a file with which you can specify installation details. The predefined configurations are “test” and “development”. If you do not specify any parameter, the installer will default to “development”.
When you choose “development” for the –config parameter (or if you do not specify this parameter at all), a docker compose file will be created for you which will create three containers on your machine. One container hosting the uvuyo node micro service, another container hosting the kafka server and a third container with the zookeeper instance needed by kafka.
Choose the development configuration if you want to have a simple uvuyo installation to test the product. The development configuration does not provide any high availability features.
When you choose “test” for the
--config parameter, a docker compose file will be created for you which will create nine containers on your machine – three for all the components involved. (You will have three uvuyo instances, three kafka instances and three zookeeper instances all configured as clusters).
The “test” configuration allows you to test failover scenarios. It will also allow you to configure uvuyo behind a load balancer to test these types of setups. Be aware that setting up the installation as a “test” configuration does install the services as clusters, nevertheless the system will not be high available since all services run on the same machine. If the machine goes down the uvuyo application will no longer be available.