Managing configurations

Configs

The /configs directory contains all of your configs. The name of the directory for each config is used to identify it when you run the deploy command. You can have as many different configs in the configs directory, however you can only have one deployed and running in the environment at any time.
If there is only one config in the configs directory, it is used by default. Otherwise you must specify the name of the config with the -c <config-name> option when you run the deploy command.

  • When you run the deploy command and specify the name of a config that is already deployed, the running deployment is updated with any changes you have made to the configuration or the referenced connectors, extensions and plugins.
  • When you run the deploy command and specify the name of a config that is not deployed, the containers in the current environment are stopped and a new environment is deployed with the specified config.

The deploy script

The deploy command is used to deploy configs, assets and manage your environment.

The following usage and help is provided for the deploy command:

Usage:
  deploy [-c <config_name>] [-t {clean}] [-v] [-y]
  deploy [-c <config_name>] [-e <runtime_environment>] [-v] [-y]
  deploy [-c <config_name>] [-t {generate-db-scripts}] [-v] [-y]
  deploy [-c <config_name>] [-t {backup|restore} [-b <backup_name>]] [-v] [-y]
  deploy [-c <config_name>] [-r <release_number>] [-v] [-y]
  deploy -h

Options:
  -c <config_name>                       Name of the config to use. If there is only one config, it is used by default.
  -t {clean}                             Clean the deployment. Will permanently remove all containers and data.
  -t {backup}                            Backup the database.
  -t {restore}                           Restore the database.
  -t {generate-db-scripts}               Generate the scripts to create the database.
  -b <backup_name>                       Name of the backup to create or restore. If not specified, the default backup is used.
  -r <release_number>                    Creates a 'release' change-set, with the specified release number.
  -e <runtime_environment>               Name of the runtime environment to use.
  -v                                     Verbose output.
  -y                                     Answer 'yes' to all prompts.
  -h                                     Display the help.