Docker deployment utilities for REDMIC infrastructure. You can use it to deploy your own services into your servers.
Docker deployment utilities for REDMIC infrastructure.
You can use it to deploy your own services, supporting **docker-compose** and **Docker Swarm** environments.
## Actions
***deploy**: Perform a deployment of a service on a remote Docker environment. Contains 3 stages:
***deploy**: Perform a service deployment on a remote Docker environment. Contains 3 stages:
**prepare-deploy*: Copy resources to remote environment (*docker-compose* files, service configurations...), prepare environment variables and directories, etc.
**do-deploy*: Launch service on Docker environment. Both standard (using docker-compose) and Swarm modes are supported on remote Docker environment, but Swarm mode is recommended (even for a single-node clusters).
**do-deploy*: Launch service on Docker environment. Both standard (using *docker-compose*) and *Swarm* modes are supported on remote Docker environment, but *Swarm* mode is recommended (even for single-node clusters).
**check-deploy*: Once deployment is done, this stage wait a defined period of time for the service to being up and running (or stopped after run successfully). If service status remains stable after several checks, then it is considered successfully deployed.
**check-deploy*: Once deployment is done, this stage waits a defined time period for the service to being up and running (or stopped after run successfully). If service status remains stable after several checks, then it is considered successfully deployed.
***create-nets**: Prepare remote environment creating Docker networks which are external to service (not created by service deployment itself).
***create-nets**: Prepare remote environment creating Docker networks which are external to service definition (not created by service deployment itself, defined as *external* in compose files).
***relaunch**: Force a previously deployed service to update, relaunching it with the same service configuration. Available only for Swarm mode.
***relaunch**: Force a previously deployed service to update, relaunching it with the same service configuration. Available only for *Swarm* mode.
## Usage
For REDMIC, we use this image automatically from jobs defined inGitLabCI configuration, but you can run it directly:
For REDMIC, we use this image into CI/CD configuration. Deploy jobs are defined into our [GitLabCI configuration](https://gitlab.com/redmic-project/gitlab-ci-templates), but you can run it directly using `docker run`:
As you can see, there is configuration through environment variables and by script (<action>) parameters.
As you can see, configuration is possible through environment variables and by script (<action>) parameters.
Using environment variables, you can configure:
By environment variables, you can configure:
* Behaviour of this image itself.
* When action is *deploy* and using the `$ENV_PREFIX` in your variables, the remote environment (where you are deploying to) for service configuration.
* Remote environment (where you are deploying to) for service configuration and service environment variables. Only when action is *deploy* and using the `ENV_PREFIX` prefix in your variable names.
Using script parameters you can set:
* When action is *deploy*, remote environment for service configuration and service environment variables. These parameters overwrite previous environment values, including those defined using the `ENV_PREFIX` prefix.
* When action is *create-nets*, the name of external networks to create.
By script parameters you can set:
* When action is *deploy*, remote environment variables, in order to configure your service. These parameters overwrite remote environment variables, including those defined using the `$ENV_PREFIX`.
* When action is *create-nets*, the name of the networks that are going to be created.
## Configuration
### Docker deploy
You may define these environment variables (**bold** are mandatory):
***STACK**: Name of Docker stack (Swarm mode) or project (docker-compose mode) used to wrap deployed services.
***SSH_REMOTE**: SSH user and host of remote machine where you are going to deploy.
***DEPLOY_KEY**: Private key paired with a public key accepted by remote machine, used to authenticate.
**SERVICE*: Name of service to relaunch. **Required** for relaunch action.
**SERVICES_TO_DEPLOY*: Names of services to deploy, separated by space. Only for standard mode (docker-compose).
**ENV_PREFIX*: Prefix used to identify variables to be defined in remote environment (without this prefix). Default `DD_`.
**ENV_SPACE_REPLACEMENT*: Unique string used to replace spaces into variable values while handling them. Default `<dd-space>`.
**COMPOSE_FILE*: Name of docker-compose file with deployment definition. Multiple files are supported, separated by colon (`:`). Default `docker-compose.yml`.
**DEPLOY_PATH*: Path in remote host where deployment directory (containing temporary files) will be created. Default `~`.
**DEPLOY_DIR_NAME*: Name of directory containing files needed for deployment. Default `deploy`.
**DEFAULT_DEPLOY_FILES*: Files needed for deployment, if `${DEPLOY_DIR_NAME}` does not exist. Default `docker-compose*.yml .env`.
**FORCE_DOCKER_COMPOSE*: Use always standard mode with docker-compose instead of Docker Swarm, even if it is available on remote Docker environment. Default `0`.
**REGISTRY_URL*: Address of Docker registry where Docker images to deploy are stored. Leave it empty to use Docker Hub registry.
**REGISTRY_USER*: Docker registry username of user with read permissions. **Required** for private registries.
**REGISTRY_PASS*: Docker registry user password of user with read permissions. **Required** for private registries.
**SERVICES_TO_CHECK*: Names of services to check after deployment, separated by space.
**STATUS_CHECK_RETRIES*: Default `10`.
**STATUS_CHECK_INTERVAL*: Default `20`.
**STATUS_CHECK_DELAY*: Default `120`.
**STATUS_CHECK_MIN_HITS*: Default `3`.
**USE_IMAGE_DIGEST*: Update service image using digest data when relaunching. Default `0`.
**GREP_BIN*: Default `grep`.
***DEPLOY_KEY**: Private key used to authenticate, paired with a public key accepted by remote host.
***SSH_REMOTE**: SSH user and hostname (DNS or IP) of remote host where you are going to deploy.
***STACK**: Name of Docker stack (*Swarm* mode) or project (*docker-compose* mode) used to wrap deployed services.
**COMPOSE_FILE*: Name of service definition file. Multiple files are supported, separated by colon (`:`). Default `docker-compose.yml`.
**DEFAULT_DEPLOY_FILES*: Files needed for deployment. Used only if `DEPLOY_DIR_NAME` directory does not exist. Default `docker-compose*.yml .env`.
**DEPLOY_DIR_NAME*: Name of directory containing files needed for deployment. If directory exists, `DEFAULT_DEPLOY_FILES` is ignored and all content is copied to remote host. Default `deploy`.
**DEPLOY_PATH*: Path in remote host where deployment directory (used to hold temporary files) will be created. Default `~`.
**ENV_PREFIX*: Prefix used to identify variables to be defined in remote environment and service, available there without this prefix. Change this if default value collides with the beginning of your variable names. Default `DD_`.
**ENV_SPACE_REPLACEMENT*: Unique string (change this if that is not true for you) used to replace spaces into variable values while handling them. Default `<dd-space>`.
**FORCE_DOCKER_COMPOSE*: Use always standard (*docker-compose*) mode instead of Docker *Swarm*, even if it is available on remote Docker environment. Default `0`.
**GREP_BIN*: Path to *grep* binary in remote host. Default `grep`.
**REGISTRY_PASS*: Docker registry password, corresponding to a user with read permissions. **Required** for private registry or repository.
**REGISTRY_URL*: Docker registry address, where Docker must log in to retrieve images. Useful only when using private registry or repository. Default is empty, to use Docker Hub registry.
**REGISTRY_USER*: Docker registry username, corresponding to a user with read permissions. **Required** for private registry or repository.
**SERVICE*: Name of service to relaunch (`<stack-name>_<service-name>`). Available and **required** only for *relaunch* action.
**SERVICES_TO_CHECK*: Names of services to check after deployment, separated by space. Default is `STACK` variable value, but setting this to a valid service name is recommended (`<stack-name>_<service-name>`).
**SERVICES_TO_DEPLOY*: Names of services to deploy, separated by space. Available only for standard (*docker-compose*) mode. Default is empty, to deploy all defined services.
**STATUS_CHECK_DELAY*: Seconds to wait before check deployment. Default `120`.
**STATUS_CHECK_INTERVAL*: Seconds to wait between check iterations. Default `20`.
**STATUS_CHECK_MIN_HITS*: Minimum number of successful checks to consider deployment as successful. Default `3`.
**STATUS_CHECK_RETRIES*: Maximum number of checks before considering deployment as failed. Default `10`.
**USE_IMAGE_DIGEST*: Update service image using digest data when relaunching. Available only for *relaunch* action. Default `0`.
### Your services
When using *deploy* action, you can configure your own services through variables:
* Define any variable whose name is prefixed by `ENV_PREFIX` prefix:
1. Set variable `docker run ... -e DD_ANY_NAME=value ... deploy`.
2.`ANY_NAME` will be available into service containers with `value` value.
* Pass any variable as deploy script parameter (without `ENV_PREFIX` prefix):
1. Set parameter to deploy script: `docker run ... deploy ANY_NAME=value`.
2.`ANY_NAME` will be available into service containers with `value` value.
