cc-docker

WARNING: This does not yet work!

This is a setup for docker compose to deploy a complete ClusterCockpit Application Stack including all external components.

At the end it will create containers for:

• mysql
• influxdb
• php-fpm (including the Symfony application)
• phpmyadmin
• nginx

Everything is configured in .env.

There exist multiple persistent (shared) volumes:

• symfony mapping to /var/www/symfony for the ClusterCockpit source tree
• sql mapping to /var/lib/mysql
• influxdb/data mapping to /var/lib/influxdb2
• influxdb/config mapping to /etc//influxdb2
• logs/nginx mapping to /var/log/nginx
• logs/symfony mapping to /var/www/symfony/var/log

The containers are build and started using the command:

docker compose up

Desired modes for the future are:

• Demo Includes everything to try out ClusterCockpit including initial Database Fixtures. No SSL and no reverse Proxy.
• Develop Only includes all external components of ClusterCockpit. A functional PHP environment and the ClusterCockpit source must be maintained on host machine.
• Production Includes everything to run ClusterCockpit in a Production environment including SSL and traefic reverse proxy and container orchestration.

TODOS (There are probably a lot more!):

• Some of the Volume directories need to be created first.
• ClusterCockpit is at the moment still using the influxDB V1 API, the InfluxDB container is already V2
• For a complete demo database setup, InfluxDB data fixtures are missing (MySQL demo database is available)

Known Issues

• docker-compose installed on Ubuntu (18.04, 20.04) via apt-get can not correctly parse docker-compose.yml due to version differences. Install latest version of docker-compose from https://docs.docker.com/compose/install/ instead.
• You need to ensure that no other web server is running on port 80 (e.g. Apache2). If port 80 is already in use, edit NGINX_PORT environment variable in .env.
• Existing VPN connections sometimes cause problems with docker. If docker-compose does not start up correctly, try disabling any active VPN connection. Refer to https://stackoverflow.com/questions/45692255/how-make-openvpn-work-with-docker for further information.

Using for DEMO purpose

Info

• Demo starts in production environment.
• Uses prepared fixture data for databases (Changes will not be preserved).
• ClusterCockpit will be initialized from scratch on every start (Changes will not be preserved).

Setup

The fixture data needs to be prepared before the first start of the containers:

• $ cd data
• $ ./init.sh

After that from the root of the repository you can start up the containers with:

• docker-compose up
• Wait... and wait a little longer

By default, you can access ClusterCockpit in your browser at http://localhost . If NGINX_PORT environment variable was changed, use http://localhost:$PORT .

Credentials for admin user are:

• User: admin
• Password: AdminDev

You can shutdown the containers by pressing CTRL-C.

To reuse an existing Symfony tree at ./data/symfony you may change the environment variable APP_CLUSTERCOCKPIT_INIT in .env from true to false.

Using for DEVELOP purpose

Info

• APP_ENVIRONMENT variable in .env used to switch php-fpm container to development environment.
• APP_CLUSTERCOCKPIT_INIT variable in .env used to prevent container from initializing a new ClusterCockpit instance on every start.
• In this case, an existing Symfony tree at ./data/symfony is required.
• Due to additional dependencies of the development environment, the instance has to be prepared with composer and yarn devel-options.
• By default, this also uses prepared fixture data for databases (Changes will not be preserved). In order to use an existing database, changes in .env and docker-compose.yml are required (see below).

Setup

If not using an existing database, the fixture data needs to be prepared before the first start of the containers:

• $ cd data
• $ ./init.sh

If an existing database is to be used, do the following:

• Change variables under MySQL and/or INFLUXDB in .env to match the credentials of your database(s).
• Uncomment the mapping of default volume paths in docker-compose.yml for cc-db and/or cc-influxdb under volumes.
• Comment or delete the line - ${DATADIR}/sql:/docker-entrypoint-initdb.d for cc-db.

In .env, change the following variables under APP

• APP_CLUSTERCOCKPIT_INIT to false
• APP_ENVIRONMENT to dev

After that from the root of the repository you can start up the containers with:

• docker-compose up
• Wait... and wait a little longer

By default, you can access ClusterCockpit in your browser at http://localhost . If NGINX_PORT environment variable was changed, use http://localhost:$PORT .

If default database fixture were used, the credentials for admin user are:

• User: admin
• Password: AdminDev

You can shutdown the containers by pressing CTRL-C.