debian-mirror-gitlab/doc/ci/examples/deployment/README.md

129 lines
4.1 KiB
Markdown
Raw Normal View History

2019-09-04 21:01:54 +05:30
---
type: tutorial
---
2017-08-17 22:00:37 +05:30
# Using Dpl as deployment tool
2015-09-25 12:07:36 +05:30
2020-03-13 15:44:24 +05:30
[Dpl](https://github.com/travis-ci/dpl) (pronounced like the letters D-P-L) is a deploy tool made for
2017-08-17 22:00:37 +05:30
continuous deployment that's developed and used by Travis CI, but can also be
used with GitLab CI.
2015-09-25 12:07:36 +05:30
2019-09-04 21:01:54 +05:30
Dpl can be used to deploy to any of the [supported providers](https://github.com/travis-ci/dpl#supported-providers).
2017-08-17 22:00:37 +05:30
## Requirements
To use Dpl you need at least Ruby 1.9.3 with ability to install gems.
## Basic usage
Dpl can be installed on any machine with:
2015-09-25 12:07:36 +05:30
2020-03-13 15:44:24 +05:30
```shell
2015-09-25 12:07:36 +05:30
gem install dpl
```
2017-08-17 22:00:37 +05:30
This allows you to test all commands from your local terminal, rather than
having to test it on a CI server.
2015-09-25 12:07:36 +05:30
If you don't have Ruby installed you can do it on Debian-compatible Linux with:
2017-08-17 22:00:37 +05:30
2020-03-13 15:44:24 +05:30
```shell
2015-09-25 12:07:36 +05:30
apt-get update
apt-get install ruby-dev
```
The Dpl provides support for vast number of services, including: Heroku, Cloud Foundry, AWS/S3, and more.
To use it simply define provider and any additional parameters required by the provider.
2019-12-26 22:10:19 +05:30
For example if you want to use it to deploy your application to Heroku, you need to specify `heroku` as provider, specify `api-key` and `app`.
All possible parameters can be found here: <https://github.com/travis-ci/dpl#heroku-api>.
2015-09-25 12:07:36 +05:30
2017-08-17 22:00:37 +05:30
```yaml
2015-09-25 12:07:36 +05:30
staging:
2017-08-17 22:00:37 +05:30
stage: deploy
script:
2015-09-25 12:07:36 +05:30
- gem install dpl
- dpl --provider=heroku --app=my-app-staging --api-key=$HEROKU_STAGING_API_KEY
```
2019-12-21 20:55:43 +05:30
In the above example we use Dpl to deploy `my-app-staging` to Heroku server with API key stored in `HEROKU_STAGING_API_KEY` secure variable.
2015-09-25 12:07:36 +05:30
To use different provider take a look at long list of [Supported Providers](https://github.com/travis-ci/dpl#supported-providers).
2017-08-17 22:00:37 +05:30
## Using Dpl with Docker
2019-09-04 21:01:54 +05:30
In most cases, you will have configured [GitLab Runner](https://docs.gitlab.com/runner/) to use your server's shell commands.
This means that all commands are run in the context of local user (e.g. gitlab_runner or gitlab_ci_multi_runner).
2015-09-25 12:07:36 +05:30
It also means that most probably in your Docker container you don't have the Ruby runtime installed.
You will have to install it:
2017-08-17 22:00:37 +05:30
```yaml
2015-09-25 12:07:36 +05:30
staging:
2017-08-17 22:00:37 +05:30
stage: deploy
script:
2015-09-25 12:07:36 +05:30
- apt-get update -yq
- apt-get install -y ruby-dev
- gem install dpl
- dpl --provider=heroku --app=my-app-staging --api-key=$HEROKU_STAGING_API_KEY
only:
- master
```
2017-08-17 22:00:37 +05:30
The first line `apt-get update -yq` updates the list of available packages,
where second `apt-get install -y ruby-dev` installs the Ruby runtime on system.
2015-09-25 12:07:36 +05:30
The above example is valid for all Debian-compatible systems.
2017-08-17 22:00:37 +05:30
## Usage in staging and production
It's pretty common in the development workflow to have staging (development) and
production environments
Let's consider the following example: we would like to deploy the `master`
branch to `staging` and all tags to the `production` environment.
2015-09-25 12:07:36 +05:30
The final `.gitlab-ci.yml` for that setup would look like this:
2017-08-17 22:00:37 +05:30
```yaml
2015-09-25 12:07:36 +05:30
staging:
2017-08-17 22:00:37 +05:30
stage: deploy
script:
2015-09-25 12:07:36 +05:30
- gem install dpl
- dpl --provider=heroku --app=my-app-staging --api-key=$HEROKU_STAGING_API_KEY
only:
- master
2017-08-17 22:00:37 +05:30
2015-09-25 12:07:36 +05:30
production:
2017-08-17 22:00:37 +05:30
stage: deploy
script:
2015-09-25 12:07:36 +05:30
- gem install dpl
- dpl --provider=heroku --app=my-app-production --api-key=$HEROKU_PRODUCTION_API_KEY
only:
- tags
```
We created two deploy jobs that are executed on different events:
2017-08-17 22:00:37 +05:30
2015-09-25 12:07:36 +05:30
1. `staging` is executed for all commits that were pushed to `master` branch,
2019-02-15 15:39:39 +05:30
1. `production` is executed for all pushed tags.
2015-09-25 12:07:36 +05:30
We also use two secure variables:
2017-08-17 22:00:37 +05:30
2015-09-25 12:07:36 +05:30
1. `HEROKU_STAGING_API_KEY` - Heroku API key used to deploy staging app,
2019-02-15 15:39:39 +05:30
1. `HEROKU_PRODUCTION_API_KEY` - Heroku API key used to deploy production app.
2015-09-25 12:07:36 +05:30
2017-08-17 22:00:37 +05:30
## Storing API keys
Secure Variables can added by going to your project's
2018-11-08 19:23:39 +05:30
**Settings ➔ CI / CD ➔ Variables**. The variables that are defined
2017-08-17 22:00:37 +05:30
in the project settings are sent along with the build script to the Runner.
The secure variables are stored out of the repository. Never store secrets in
your project's `.gitlab-ci.yml`. It is also important that the secret's value
is hidden in the job log.
You access added variable by prefixing it's name with `$` (on non-Windows runners)
or `%` (for Windows Batch runners):
2015-09-25 12:07:36 +05:30
2019-02-15 15:39:39 +05:30
1. `$VARIABLE` - use it for non-Windows runners
1. `%VARIABLE%` - use it for Windows Batch runners
2017-08-17 22:00:37 +05:30
Read more about the [CI variables](../../variables/README.md).