Docker Compose customizations

Edit online

This section describes the process of adding custom values to the Docker Compose templates in Faspex 5.0.8 and later.

Starting from Faspex 5.0.8, users can customize the settings in the docker-compose.yml file. This is done with customization files that are used to auto-generate the actual docker-compose.yml file that runs the containers.
Note: These files and their contents will be saved even after rpm upgrades to future versions of Faspex.

To add custom settings to your Docker compose template, create your own specific _customizations.yml files in the /opt/aspera/faspex/conf/docker_compose_templates/custom/<CONTAINER>_customizations.yml> directory. Each file must contain valid yaml syntax and follow this naming convention:

  • core_customizations.yml

  • service_customizations.yml

  • db_customizations.yml

  • ui_customizations.yml

  • router_customizations.yml

  • connect-deployer_customizations.yml

Example of a core_customizations.yml file:

extra_hosts:
  - "hsts-redis01 hsts-cluster01.fyre.ibm.com:9.30.1.10"
  - "hsts-redis11 hsts-cluster01.fyre.ibm.com:9.30.1.20"
  - "hsts-redis21 hsts-cluster01.fyre.ibm.com:9.30.1.30"
ports: [3000:3000]
This example custom file adds an HSTS cluster array and exposes the core container port on the Docker/Podman host to port 3000 mapped to the container port listening on port 3000.
Important: Make sure to run faspexctl setup after this to propagate these changes into Faspex.

Faspex 5.0.6 / 5.0.7 users

Edit online

If you already customized your docker-compose.yml files before upgrading to Faspex 5.0.8, you will need to copy your customizations to /opt/aspera/faspex/conf/docker_compose_templates/custom/CONTAINER_customizations.yml(For example in the case of the core_customizations.yml file). Do this for each section that you modify.

Important: You must do this before running faspexctl setup and after installing or upgrading to Faspex 5.0.8.