2016-06-17 00:37:49 +00:00
|
|
|
# Introduction to environments and deployments
|
|
|
|
|
|
|
|
>**Note:**
|
|
|
|
Introduced in GitLab 8.9.
|
|
|
|
|
2016-11-16 16:13:08 +00:00
|
|
|
During the development of software, there can be many stages until it's ready
|
2016-11-04 10:20:44 +00:00
|
|
|
for public consumption. You sure want to first test your code and then deploy it
|
|
|
|
in a testing or staging environment before you release it to the public. That
|
|
|
|
way you can prevent bugs not only in your software, but in the deployment
|
|
|
|
process as well.
|
|
|
|
|
2016-11-16 16:13:08 +00:00
|
|
|
GitLab CI is capable of not only testing or building your projects, but also
|
|
|
|
deploying them in your infrastructure, with the added benefit of giving you a
|
|
|
|
way to track your deployments. In other words, you can always know what is
|
|
|
|
currently being deployed or has been deployed on your servers.
|
2016-11-04 10:20:44 +00:00
|
|
|
|
|
|
|
## Overview
|
|
|
|
|
2016-11-16 16:13:08 +00:00
|
|
|
With environments, you can control the Continuous Deployment of your software
|
|
|
|
all within GitLab. All you need to do is define them in your project's
|
2016-11-07 19:57:18 +00:00
|
|
|
[`.gitlab-ci.yml`][yaml] as we will explore below. GitLab provides a full
|
|
|
|
history of your deployments per every environment.
|
|
|
|
|
|
|
|
Environments are like tags for your CI jobs, describing where code gets deployed.
|
2016-11-04 10:20:44 +00:00
|
|
|
Deployments are created when [jobs] deploy versions of code to environments,
|
|
|
|
so every environment can have one or more deployments. GitLab keeps track of
|
|
|
|
your deployments, so you always know what is currently being deployed on your
|
|
|
|
servers.
|
|
|
|
|
2016-11-16 16:13:08 +00:00
|
|
|
To better understand how environments and deployments work, let's consider an
|
|
|
|
example. We assume that you have already created a project in GitLab and set up
|
|
|
|
a Runner. The example will cover the following:
|
2016-10-19 09:54:38 +00:00
|
|
|
|
2016-11-16 16:13:08 +00:00
|
|
|
- We are developing an application
|
|
|
|
- We want to run tests and build our app on all branches
|
|
|
|
- Our default branch is `master`
|
|
|
|
- We deploy the app only when a pipeline on `master` branch is run
|
2016-10-19 09:54:38 +00:00
|
|
|
|
2016-11-16 16:13:08 +00:00
|
|
|
Let's see how it all ties together.
|
2016-10-19 09:54:38 +00:00
|
|
|
|
2016-11-16 16:13:08 +00:00
|
|
|
## Defining environments
|
2016-10-19 09:54:38 +00:00
|
|
|
|
2016-11-16 16:13:08 +00:00
|
|
|
Let's consider the following `.gitlab-ci.yml` example:
|
2016-10-19 09:54:38 +00:00
|
|
|
|
2016-11-16 16:13:08 +00:00
|
|
|
```yaml
|
|
|
|
stages:
|
|
|
|
- test
|
|
|
|
- build
|
|
|
|
- deploy
|
2016-10-19 09:54:38 +00:00
|
|
|
|
2016-11-16 16:13:08 +00:00
|
|
|
test:
|
|
|
|
stage: test
|
|
|
|
script: echo "Running tests"
|
2016-10-19 09:54:38 +00:00
|
|
|
|
2016-11-16 16:13:08 +00:00
|
|
|
build:
|
|
|
|
stage: build
|
|
|
|
script: echo "Building the app"
|
2016-10-19 09:54:38 +00:00
|
|
|
|
2016-11-16 16:13:08 +00:00
|
|
|
deploy_staging:
|
|
|
|
stage: deploy
|
|
|
|
script:
|
2016-11-16 23:04:28 +00:00
|
|
|
- echo "Deploy to staging server"
|
2016-11-16 16:13:08 +00:00
|
|
|
environment:
|
2016-11-16 23:04:28 +00:00
|
|
|
name: staging
|
|
|
|
url: https://staging.example.com
|
2016-11-16 16:13:08 +00:00
|
|
|
only:
|
|
|
|
- master
|
|
|
|
```
|
2016-06-17 00:37:49 +00:00
|
|
|
|
2016-11-16 16:13:08 +00:00
|
|
|
We have defined 3 [stages](yaml/README.md#stages):
|
2016-09-30 13:45:27 +00:00
|
|
|
|
2016-11-16 16:13:08 +00:00
|
|
|
- test
|
|
|
|
- build
|
|
|
|
- deploy
|
2016-09-30 13:45:27 +00:00
|
|
|
|
2016-11-16 16:13:08 +00:00
|
|
|
The jobs assigned to these stages will run in this order. If a job fails, then
|
|
|
|
the builds that are assigned to the next stage won't run, rendering the pipeline
|
|
|
|
as failed. In our case, the `test` job will run first, then the `build` and
|
|
|
|
lastly the `deploy_staging`. With this, we ensure that first the tests pass,
|
|
|
|
then our app is able to be built successfully, and lastly we deploy to the
|
|
|
|
staging server.
|
2016-09-30 13:45:27 +00:00
|
|
|
|
2016-11-16 23:04:28 +00:00
|
|
|
The `environment` keyword is just a hint for GitLab that this job actually
|
|
|
|
deploys to this environment's `name`. It can also have a `url` which, as we
|
|
|
|
will later see, is exposed in various places within GitLab. Each time a job that
|
|
|
|
has an environment specified and succeeds, a deployment is recorded, remembering
|
|
|
|
the Git SHA and environment name.
|
|
|
|
|
|
|
|
To sum up, with the above `.gitlab-ci.yml` we have achieved that:
|
2016-09-30 13:45:27 +00:00
|
|
|
|
2016-11-16 16:13:08 +00:00
|
|
|
- All branches will run the `test` and `build` jobs.
|
2016-11-16 23:04:28 +00:00
|
|
|
- The `deploy_staging` job will run [only](yaml/README.md#only) on the `master`
|
|
|
|
branch which means all merge requests that are created from branches don't
|
|
|
|
get to deploy to the staging server
|
2016-11-16 16:13:08 +00:00
|
|
|
- When a merge request is merged, all jobs will run and the `deploy_staging`
|
|
|
|
in particular will deploy our code to a staging server while the deployment
|
|
|
|
will be recorded in an environment named `staging`.
|
2016-06-17 00:37:49 +00:00
|
|
|
|
2016-11-16 23:04:28 +00:00
|
|
|
Let's now see how that information is exposed within GitLab.
|
|
|
|
|
|
|
|
## Viewing the current status of an environment
|
|
|
|
|
|
|
|
The environment list under your project's **Pipelines ➔ Environments**, is
|
|
|
|
where you can find information of the last deployment status of an environment.
|
|
|
|
|
|
|
|
Here's how the Environments page looks so far.
|
2016-11-16 16:13:08 +00:00
|
|
|
|
|
|
|
![Staging environment view](img/environments_available_staging.png)
|
|
|
|
|
2016-11-16 23:04:28 +00:00
|
|
|
There's a bunch of information there, specifically you can see:
|
|
|
|
|
|
|
|
- The environment's name with a link to its deployments
|
|
|
|
- The last deployment ID number and who performed it
|
|
|
|
- The build ID of the last deployment with its respective job name
|
|
|
|
- The commit information of the last deployment such as who committed, to what
|
|
|
|
branch and the Git SHA of the commit
|
|
|
|
- The exact time the last deployment was performed
|
|
|
|
- A button that takes you to the URL that you have defined under the
|
|
|
|
`environment` keyword in `.gitlab-ci.yml`
|
|
|
|
- A button that re-deploys the latest deployment, meaning it runs the job
|
|
|
|
defined by the environment name for that specific commit
|
2016-11-16 16:13:08 +00:00
|
|
|
|
|
|
|
>**Notes:**
|
|
|
|
- While you can create environments manually in the web interface, we recommend
|
|
|
|
that you define your environments in `.gitlab-ci.yml` first. They will
|
|
|
|
be automatically created for you after the first deploy.
|
|
|
|
- The environments page can only be viewed by Reporters and above. For more
|
|
|
|
information on the permissions, see the [permissions documentation][permissions].
|
2016-11-16 23:04:28 +00:00
|
|
|
- Only deploys that happen after your `.gitlab-ci.yml` is properly configured
|
|
|
|
will show up in the "Environment" and "Last deployment" lists.
|
2016-11-16 16:13:08 +00:00
|
|
|
|
2016-11-16 23:04:28 +00:00
|
|
|
The information shown in the Environments page is limited to the latest
|
|
|
|
deployments, but as you may have guessed an environment can have multiple
|
|
|
|
deployments.
|
2016-11-16 16:13:08 +00:00
|
|
|
|
2016-11-16 23:04:28 +00:00
|
|
|
## Viewing the deployment history of an environment
|
2016-06-17 00:37:49 +00:00
|
|
|
|
2016-10-19 09:54:38 +00:00
|
|
|
GitLab keeps track of your deployments, so you always know what is currently
|
2016-11-16 23:04:28 +00:00
|
|
|
being deployed on your servers. That way you can have the full history of your
|
|
|
|
deployments per every environment right in your browser. Clicking on an
|
|
|
|
environment will show the history of its deployments. Assuming you have deployed
|
|
|
|
multiple times already, here's how a specific environment's page looks like.
|
|
|
|
|
|
|
|
![Deployments](img/deployments_view.png)
|
2016-10-19 09:54:38 +00:00
|
|
|
|
2016-11-16 23:04:28 +00:00
|
|
|
We can see the same information as when in the Environments page, but this time
|
|
|
|
all deployments are shown. As you may have noticed, apart from the **Re-deploy**
|
|
|
|
button there are now **Rollback** buttons for each deployment. Let's see how
|
|
|
|
that works.
|
|
|
|
|
|
|
|
## Rolling back changes
|
|
|
|
|
|
|
|
You can't control everything, so sometimes things go wrong. When that unfortunate
|
|
|
|
time comes GitLab has you covered. Simply by clicking the **Rollback** button
|
|
|
|
that can be found in the deployments page
|
|
|
|
(**Pipelines ➔ Environments ➔ `environment name`**) you can relaunch the
|
|
|
|
job with the commit associated with it.
|
2016-10-19 09:54:38 +00:00
|
|
|
|
|
|
|
>**Note:**
|
2016-11-16 23:04:28 +00:00
|
|
|
Bare in mind that your mileage will vary and it's entirely up to how you define
|
|
|
|
the deployment process in the job's `script` whether the rollback succeeds or not.
|
|
|
|
GitLab CI is just following orders.
|
|
|
|
|
|
|
|
Thankfully that was the staging server that we had to rollback, and since we
|
|
|
|
learn from our mistakes, we decided to not make the same again when we deploy
|
|
|
|
to the production server. Enter manual actions for deployments.
|
2016-10-19 09:54:38 +00:00
|
|
|
|
|
|
|
## Manually deploying to environments
|
|
|
|
|
2016-11-16 23:04:28 +00:00
|
|
|
Turning a job from running automatically to a manual action is as simple as
|
|
|
|
adding `when: manual` to it. To expand on our previous example, let's add
|
|
|
|
another job that this time deploys our app to a production server and is
|
|
|
|
tracked by a `production` environment. The `.gitlab-ci.yml` looks like this
|
|
|
|
so far:
|
2016-11-16 16:13:08 +00:00
|
|
|
|
2016-11-16 23:04:28 +00:00
|
|
|
```yaml
|
|
|
|
stages:
|
|
|
|
- test
|
|
|
|
- build
|
|
|
|
- deploy
|
|
|
|
|
|
|
|
test:
|
|
|
|
stage: test
|
|
|
|
script: echo "Running tests"
|
|
|
|
|
|
|
|
build:
|
|
|
|
stage: build
|
|
|
|
script: echo "Building the app"
|
|
|
|
|
|
|
|
deploy_staging:
|
|
|
|
stage: deploy
|
|
|
|
script:
|
|
|
|
- echo "Deploy to staging server"
|
|
|
|
environment:
|
|
|
|
name: staging
|
|
|
|
url: https://staging.example.com
|
|
|
|
only:
|
|
|
|
- master
|
|
|
|
|
|
|
|
deploy_prod:
|
|
|
|
stage: deploy
|
|
|
|
script:
|
|
|
|
- echo "Deploy to production server"
|
|
|
|
environment:
|
|
|
|
name: production
|
|
|
|
url: https://example.com
|
|
|
|
when: manual
|
|
|
|
only:
|
|
|
|
- master
|
|
|
|
```
|
|
|
|
|
|
|
|
The `when: manual` action exposes a play button in GitLab's UI and the
|
|
|
|
`deploy_prod` job will only be triggered if and when we click that play button.
|
|
|
|
You can find it in the pipeline, build, environment, and deployment views.
|
|
|
|
|
|
|
|
| Pipelines | Single pipeline | Environments | Deployments | Builds |
|
|
|
|
| --------- | ----------------| ------------ | ----------- | -------|
|
|
|
|
| ![Pipelines manual action](img/environments_manual_action_pipelines.png) | ![Pipelines manual action](img/environments_manual_action_single_pipeline.png) | ![Environments manual action](img/environments_manual_action_environments.png) | ![Deployments manual action](img/environments_manual_action_deployments.png) | ![Builds manual action](img/environments_manual_action_builds.png) |
|
|
|
|
|
|
|
|
Clicking on the play button in either of these places will trigger the
|
|
|
|
`deploy_prod` job, and the deployment will be recorded under a new
|
|
|
|
environment named `production`.
|
|
|
|
|
2016-11-17 09:36:58 +00:00
|
|
|
>**Note:**
|
|
|
|
Remember that if your environment's name is `production` (all lowercase), then
|
|
|
|
it will get recorded in [Cycle Analytics](../user/project/cycle_analytics.md).
|
|
|
|
Double the benefit!
|
|
|
|
|
2016-11-16 23:04:28 +00:00
|
|
|
While this is fine for deploying to some stable environments like staging or
|
|
|
|
production, what happens for branches? So far we haven't defined anything
|
|
|
|
regarding deployments for branches other than `master`. Dynamic environments
|
|
|
|
will help us achieve that.
|
2016-10-19 09:54:38 +00:00
|
|
|
|
|
|
|
## Dynamic environments
|
|
|
|
|
|
|
|
As the name suggests, it is possible to create environments on the fly by just
|
2016-11-17 09:36:58 +00:00
|
|
|
declaring their names dynamically in `.gitlab-ci.yml`. Dynamic environments is
|
2016-11-19 14:36:43 +00:00
|
|
|
the basis of [Review apps](review_apps/index.md).
|
2016-10-19 09:54:38 +00:00
|
|
|
|
|
|
|
GitLab Runner exposes various [environment variables][variables] when a job runs,
|
2016-11-17 09:36:58 +00:00
|
|
|
and as such, you can use them as environment names. Let's add another job in
|
|
|
|
our example which will deploy to all branches except `master`:
|
2016-06-17 00:37:49 +00:00
|
|
|
|
2016-11-17 09:36:58 +00:00
|
|
|
```yaml
|
|
|
|
deploy_review:
|
|
|
|
stage: deploy
|
|
|
|
script:
|
|
|
|
- echo "Deploy a review app"
|
|
|
|
environment:
|
|
|
|
name: review/$CI_BUILD_REF_NAME
|
2016-12-13 19:21:30 +00:00
|
|
|
url: https://$CI_BUILD_REF_SLUG.example.com
|
2016-11-17 09:36:58 +00:00
|
|
|
only:
|
|
|
|
- branches
|
|
|
|
except:
|
|
|
|
- master
|
2016-06-17 00:37:49 +00:00
|
|
|
```
|
2016-11-17 09:36:58 +00:00
|
|
|
|
|
|
|
Let's break it down in pieces. The job's name is `deploy_review` and it runs
|
|
|
|
on the `deploy` stage. The `script` at this point is fictional, you'd have to
|
|
|
|
use your own based on your deployment. Then, we set the `environment` with the
|
|
|
|
`environment:name` being `review/$CI_BUILD_REF_NAME`. Now that's an interesting
|
2016-12-13 19:21:30 +00:00
|
|
|
one. Since the [environment name][env-name] can contain slashes (`/`), we can
|
|
|
|
use this pattern to distinguish between dynamic environments and the regular
|
2016-11-17 09:36:58 +00:00
|
|
|
ones.
|
|
|
|
|
|
|
|
So, the first part is `review`, followed by a `/` and then `$CI_BUILD_REF_NAME`
|
2016-12-13 19:21:30 +00:00
|
|
|
which takes the value of the branch name. Since `$CI_BUILD_REF_NAME` itself may
|
|
|
|
also contain `/`, or other characters that would be invalid in a domain name or
|
|
|
|
URL, we use `$CI_BUILD_REF_SLUG` in the `environment:url` so that the environment
|
2016-11-17 09:36:58 +00:00
|
|
|
can get a specific and distinct URL for each branch. Again, the way you set up
|
|
|
|
the webserver to serve these requests is based on your setup.
|
|
|
|
|
|
|
|
Last but not least, we tell the job to run [`only`][only] on branches
|
|
|
|
[`except`][only] master.
|
|
|
|
|
|
|
|
>**Note:**
|
2016-11-17 10:58:57 +00:00
|
|
|
You are not bound to use the same prefix or only slashes in the dynamic
|
|
|
|
environments' names (`/`), but as we will see later, this will enable the
|
|
|
|
[grouping similar environments](#grouping-similar-environments) feature.
|
2016-11-17 09:36:58 +00:00
|
|
|
|
|
|
|
The whole `.gitlab-ci.yml` looks like this so far:
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
stages:
|
|
|
|
- test
|
|
|
|
- build
|
|
|
|
- deploy
|
|
|
|
|
|
|
|
test:
|
|
|
|
stage: test
|
|
|
|
script: echo "Running tests"
|
|
|
|
|
|
|
|
build:
|
|
|
|
stage: build
|
|
|
|
script: echo "Building the app"
|
|
|
|
|
|
|
|
deploy_review:
|
2016-06-17 00:37:49 +00:00
|
|
|
stage: deploy
|
2016-10-19 09:54:38 +00:00
|
|
|
script:
|
2016-11-17 09:36:58 +00:00
|
|
|
- echo "Deploy a review app"
|
2016-10-19 09:54:38 +00:00
|
|
|
environment:
|
|
|
|
name: review/$CI_BUILD_REF_NAME
|
2016-12-13 19:21:30 +00:00
|
|
|
url: https://$CI_BUILD_REF_SLUG.example.com
|
2016-11-17 09:36:58 +00:00
|
|
|
only:
|
|
|
|
- branches
|
|
|
|
except:
|
|
|
|
- master
|
|
|
|
|
|
|
|
deploy_staging:
|
|
|
|
stage: deploy
|
|
|
|
script:
|
|
|
|
- echo "Deploy to staging server"
|
|
|
|
environment:
|
|
|
|
name: staging
|
|
|
|
url: https://staging.example.com
|
|
|
|
only:
|
|
|
|
- master
|
|
|
|
|
|
|
|
deploy_prod:
|
|
|
|
stage: deploy
|
|
|
|
script:
|
|
|
|
- echo "Deploy to production server"
|
|
|
|
environment:
|
|
|
|
name: production
|
|
|
|
url: https://example.com
|
|
|
|
when: manual
|
|
|
|
only:
|
|
|
|
- master
|
2016-06-17 00:37:49 +00:00
|
|
|
```
|
|
|
|
|
2016-11-17 09:36:58 +00:00
|
|
|
A more realistic example would include copying files to a location where a
|
|
|
|
webserver (NGINX) could then read and serve. The example below will copy the
|
2016-12-13 19:21:30 +00:00
|
|
|
`public` directory to `/srv/nginx/$CI_BUILD_REF_SLUG/public`:
|
2016-11-17 09:36:58 +00:00
|
|
|
|
|
|
|
```yaml
|
|
|
|
review_app:
|
|
|
|
stage: deploy
|
|
|
|
script:
|
2016-12-13 19:21:30 +00:00
|
|
|
- rsync -av --delete public /srv/nginx/$CI_BUILD_REF_SLUG
|
2016-11-17 09:36:58 +00:00
|
|
|
environment:
|
|
|
|
name: review/$CI_BUILD_REF_NAME
|
2016-12-13 19:21:30 +00:00
|
|
|
url: https://$CI_BUILD_REF_SLUG.example.com
|
2016-11-17 09:36:58 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
It is assumed that the user has already setup NGINX and GitLab Runner in the
|
|
|
|
server this job will run on.
|
|
|
|
|
2016-11-18 07:36:40 +00:00
|
|
|
>**Note:**
|
|
|
|
Be sure to check out the [limitations](#limitations) section for some edge
|
2016-12-13 19:21:30 +00:00
|
|
|
cases regarding naming of your branches and Review Apps.
|
2016-11-18 07:36:40 +00:00
|
|
|
|
2016-11-17 09:36:58 +00:00
|
|
|
---
|
|
|
|
|
|
|
|
The development workflow would now be:
|
|
|
|
|
|
|
|
- Developer creates a branch locally
|
|
|
|
- Developer makes changes, commits and pushes the branch to GitLab
|
|
|
|
- Developer creates a merge request
|
|
|
|
|
|
|
|
Behind the scenes:
|
|
|
|
|
|
|
|
- GitLab Runner picks up the changes and starts running the jobs
|
|
|
|
- The jobs run sequentially as defined in `stages`
|
|
|
|
- First, the tests pass
|
|
|
|
- Then, the build begins and successfully also passes
|
|
|
|
- Lastly, the app is deployed to an environment with a name specific to the
|
|
|
|
branch
|
|
|
|
|
|
|
|
So now, every branch gets its own environment and is deployed to its own place
|
|
|
|
with the added benefit of having a [history of deployments](#viewing-the-deployment-history-of-an-environment)
|
|
|
|
and also being able to [rollback changes](#rolling-back-changes) if needed.
|
|
|
|
Let's briefly see where URL that's defined in the environments is exposed.
|
|
|
|
|
|
|
|
## Making use of the environment URL
|
|
|
|
|
|
|
|
The environment URL is exposed in a few places within GitLab.
|
|
|
|
|
|
|
|
| In a merge request widget as a link | In the Environments view as a button | In the Deployments view as a button |
|
|
|
|
| -------------------- | ------------ | ----------- |
|
|
|
|
| ![Environment URL in merge request](img/environments_mr_review_app.png) | ![Environment URL in environments](img/environments_link_url.png) | ![Environment URL in deployments](img/environments_link_url_deployments.png) |
|
|
|
|
|
|
|
|
If a merge request is eventually merged to the default branch (in our case
|
|
|
|
`master`) and that branch also deploys to an environment (in our case `staging`
|
|
|
|
and/or `production`) you can see this information in the merge request itself.
|
|
|
|
|
|
|
|
![Environment URLs in merge request](img/environments_link_url_mr.png)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
We now have a full development cycle, where our app is tested, built, deployed
|
|
|
|
as a Review app, deployed to a staging server once the merge request is merged,
|
|
|
|
and finally manually deployed to the production server. What we just described
|
|
|
|
is a single workflow, but imagine tens of developers working on a project
|
|
|
|
at the same time. They each push to their branches, and dynamic environments are
|
|
|
|
created all the time. In that case, we probably need to do some clean up. Read
|
2016-11-17 10:58:57 +00:00
|
|
|
next how environments can be stopped.
|
2016-11-17 09:36:58 +00:00
|
|
|
|
2016-11-17 10:58:57 +00:00
|
|
|
## Stopping an environment
|
2016-06-17 00:37:49 +00:00
|
|
|
|
2016-11-17 10:58:57 +00:00
|
|
|
By stopping an environment, you are effectively terminating its recording of the
|
|
|
|
deployments that happen in it.
|
|
|
|
|
2016-11-17 11:15:06 +00:00
|
|
|
A branch is associated with an environment when the CI pipeline that is created
|
|
|
|
for this branch, was recently deployed to this environment. You can think of
|
|
|
|
the CI pipeline as the glue between the branch and the environment:
|
|
|
|
`branch ➔ CI pipeline ➔ environment`.
|
2016-11-17 10:58:57 +00:00
|
|
|
|
2016-11-17 11:15:06 +00:00
|
|
|
There is a special case where environments can be manually stopped. That can
|
2016-11-17 10:58:57 +00:00
|
|
|
happen if you provide another job for that matter. The syntax is a little
|
|
|
|
tricky since a job calls another job to do the job.
|
|
|
|
|
|
|
|
Consider the following example where the `deploy_review` calls the `stop_review`
|
|
|
|
to clean up and stop the environment:
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
deploy_review:
|
2016-10-19 09:54:38 +00:00
|
|
|
stage: deploy
|
|
|
|
script:
|
2016-11-17 10:58:57 +00:00
|
|
|
- echo "Deploy a review app"
|
2016-10-19 09:54:38 +00:00
|
|
|
environment:
|
|
|
|
name: review/$CI_BUILD_REF_NAME
|
2016-12-13 19:21:30 +00:00
|
|
|
url: https://$CI_BUILD_REF_SLUG.example.com
|
2016-10-19 09:54:38 +00:00
|
|
|
on_stop: stop_review
|
2016-11-17 10:58:57 +00:00
|
|
|
only:
|
|
|
|
- branches
|
|
|
|
except:
|
|
|
|
- master
|
2016-10-19 09:54:38 +00:00
|
|
|
|
|
|
|
stop_review:
|
2016-11-17 13:10:55 +00:00
|
|
|
variables:
|
|
|
|
GIT_STRATEGY: none
|
2016-11-17 10:58:57 +00:00
|
|
|
script:
|
|
|
|
- echo "Remove review app"
|
2016-10-19 09:54:38 +00:00
|
|
|
when: manual
|
|
|
|
environment:
|
|
|
|
name: review/$CI_BUILD_REF_NAME
|
|
|
|
action: stop
|
|
|
|
```
|
2016-06-17 00:37:49 +00:00
|
|
|
|
2016-11-17 13:10:55 +00:00
|
|
|
Setting the [`GIT_STRATEGY`][git-strategy] to `none` is necessary on the
|
|
|
|
`stop_review` job so that the [GitLab Runner] won't try to checkout the code
|
|
|
|
after the branch is deleted.
|
|
|
|
|
2016-11-17 11:15:06 +00:00
|
|
|
>**Note:**
|
|
|
|
Starting with GitLab 8.14, dynamic environments will be stopped automatically
|
|
|
|
when their associated branch is deleted.
|
|
|
|
|
|
|
|
When you have an environment that has a stop action defined (typically when
|
|
|
|
the environment describes a review app), GitLab will automatically trigger a
|
|
|
|
stop action when the associated branch is deleted.
|
|
|
|
|
2016-11-17 10:58:57 +00:00
|
|
|
You can read more in the [`.gitlab-ci.yml` reference][onstop].
|
|
|
|
|
2016-11-17 09:36:58 +00:00
|
|
|
## Grouping similar environments
|
|
|
|
|
2016-11-17 10:58:57 +00:00
|
|
|
> [Introduced][ce-7015] in GitLab 8.14.
|
|
|
|
|
|
|
|
As we've seen in the [dynamic environments](#dynamic-environments), you can
|
2016-11-17 13:10:55 +00:00
|
|
|
prepend their name with a word, then followed by a `/` and finally the branch
|
|
|
|
name which is automatically defined by the `CI_BUILD_REF_NAME` variable.
|
2016-11-17 10:58:57 +00:00
|
|
|
|
|
|
|
In short, environments that are named like `type/foo` are presented under a
|
|
|
|
group named `type`.
|
|
|
|
|
|
|
|
In our minimal example, we name the environments `review/$CI_BUILD_REF_NAME`
|
|
|
|
where `$CI_BUILD_REF_NAME` is the branch name:
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
deploy_review:
|
|
|
|
stage: deploy
|
|
|
|
script:
|
|
|
|
- echo "Deploy a review app"
|
|
|
|
environment:
|
|
|
|
name: review/$CI_BUILD_REF_NAME
|
|
|
|
```
|
|
|
|
|
|
|
|
In that case, if you visit the Environments page, and provided the branches
|
|
|
|
exist, you should see something like:
|
|
|
|
|
|
|
|
![Environment groups](img/environments_dynamic_groups.png)
|
2016-11-17 09:36:58 +00:00
|
|
|
|
2016-11-16 16:13:08 +00:00
|
|
|
## Checkout deployments locally
|
2016-10-19 09:54:38 +00:00
|
|
|
|
2016-12-13 19:21:30 +00:00
|
|
|
Since 8.13, a reference in the git repository is saved for each deployment, so
|
|
|
|
knowing the state of your current environments is only a `git fetch` away.
|
2016-10-19 09:54:38 +00:00
|
|
|
|
|
|
|
In your git config, append the `[remote "<your-remote>"]` block with an extra
|
|
|
|
fetch line:
|
|
|
|
|
|
|
|
```
|
|
|
|
fetch = +refs/environments/*:refs/remotes/origin/environments/*
|
|
|
|
```
|
|
|
|
|
2016-11-17 11:57:08 +00:00
|
|
|
## Limitations
|
|
|
|
|
2016-12-13 19:21:30 +00:00
|
|
|
1. `$CI_BUILD_REF_SLUG` is not *guaranteed* to be unique, so there is a small
|
|
|
|
chance of collisions between similarly-named branches (`fix-foo` would
|
|
|
|
conflict with `fix/foo`, for instance). Following a well-defined workflow
|
|
|
|
such as [GitLab Flow][gitlab-flow] can keep this from being a problem.
|
2016-11-18 07:31:49 +00:00
|
|
|
1. You are limited to use only the [CI predefined variables][variables] in the
|
|
|
|
`environment: name`. If you try to re-use variables defined inside `script`
|
|
|
|
as part of the environment name, it will not work.
|
2016-11-17 11:57:08 +00:00
|
|
|
|
2016-11-16 16:13:08 +00:00
|
|
|
## Further reading
|
|
|
|
|
|
|
|
Below are some links you may find interesting:
|
|
|
|
|
|
|
|
- [The `.gitlab-ci.yml` definition of environments](yaml/README.md#environment)
|
|
|
|
- [A blog post on Deployments & Environments](https://about.gitlab.com/2016/08/26/ci-deployment-and-environments/)
|
2016-11-17 11:50:40 +00:00
|
|
|
- [Review Apps - Use dynamic environments to deploy your code for every branch](review_apps/index.md)
|
2016-11-16 16:13:08 +00:00
|
|
|
|
2016-06-20 22:07:38 +00:00
|
|
|
[Pipelines]: pipelines.md
|
2016-06-17 00:37:49 +00:00
|
|
|
[jobs]: yaml/README.md#jobs
|
2016-10-19 09:54:38 +00:00
|
|
|
[yaml]: yaml/README.md
|
2016-06-17 00:37:49 +00:00
|
|
|
[environments]: #environments
|
|
|
|
[deployments]: #deployments
|
2016-10-19 09:54:38 +00:00
|
|
|
[permissions]: ../user/permissions.md
|
|
|
|
[variables]: variables/README.md
|
2016-11-17 09:36:58 +00:00
|
|
|
[env-name]: yaml/README.md#environment-name
|
|
|
|
[only]: yaml/README.md#only-and-except
|
2016-11-17 10:58:57 +00:00
|
|
|
[onstop]: yaml/README.md#environment-on_stop
|
|
|
|
[ce-7015]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/7015
|
2016-12-13 19:21:30 +00:00
|
|
|
[gitlab-flow]: ../workflow/gitlab_flow.md
|
2016-11-17 13:10:55 +00:00
|
|
|
[gitlab runner]: https://docs.gitlab.com/runner/
|
|
|
|
[git-strategy]: yaml/README.md#git-strategy
|