diff options
author | Mark Pundsack <markpundsack@users.noreply.github.com> | 2016-06-20 15:07:38 -0700 |
---|---|---|
committer | Mark Pundsack <markpundsack@users.noreply.github.com> | 2016-06-20 15:07:38 -0700 |
commit | 41af86bc86a3bab9c83729ff76776fc137b350ef (patch) | |
tree | 28350ccd065bcd275b04d54d0836173d3f8a9855 /doc/ci | |
parent | edfe2e2db98e1a5541d5d683ac3a686d24a9c429 (diff) | |
download | gitlab-ce-41af86bc86a3bab9c83729ff76776fc137b350ef.tar.gz |
Move Pipelines and Builds definitions to their own page
Diffstat (limited to 'doc/ci')
-rw-r--r-- | doc/ci/README.md | 4 | ||||
-rw-r--r-- | doc/ci/definitions/README.md | 52 | ||||
-rw-r--r-- | doc/ci/environments.md | 2 |
3 files changed, 3 insertions, 55 deletions
diff --git a/doc/ci/README.md b/doc/ci/README.md index 7abce85c8d8..f8d02af31ab 100644 --- a/doc/ci/README.md +++ b/doc/ci/README.md @@ -1,11 +1,11 @@ ## GitLab CI Documentation -### CI/CD User documentation +### CI User documentation - [Get started with GitLab CI](quick_start/README.md) -- [CI/CD Definitions](definitions/README.md) - [CI examples for various languages](examples/README.md) - [Learn how to enable or disable GitLab CI](enable_or_disable_ci.md) +- [Pipelines](pipelines.md) - [Environments and deployments](environments.md) - [Learn how `.gitlab-ci.yml` works](yaml/README.md) - [Configure a Runner, the application that runs your builds](runners/README.md) diff --git a/doc/ci/definitions/README.md b/doc/ci/definitions/README.md deleted file mode 100644 index 4ec5eee5757..00000000000 --- a/doc/ci/definitions/README.md +++ /dev/null @@ -1,52 +0,0 @@ -## CI/CD Definitions - -### Pipelines - -A pipeline is a group of [builds] that get executed in [stages] (batches). All of -the builds in a stage are executed in parallel (if there are enough concurrent -[runners]), and if they all succeed, the pipeline moves on to the next stage. If -one of the builds fails, the next stage is not (usually) executed. - -### Builds - -Builds are runs of [jobs]. Not to be confused with a `build` stage. - -### Jobs - -Jobs are the basic work unit of CI/CD. Jobs are used to create [builds], which are -then picked up by [Runners] and executed within the environment of the Runner. -Each job is run independently from each other. - -### Runners - -A runner is an isolated (virtual) machine that picks up builds through the -coordinator API of GitLab CI. A runner can be specific to a certain project or -serve any project in GitLab CI. A runner that serves all projects is called a -shared runner. - -### Stages - -Stages allow [jobs] to be grouped into parallel and sequential [builds]. Builds -of the same stage are executed in parallel and builds of the next stage are run -after the jobs from the previous stage complete successfully. Stages allow for -flexible multi-stage [pipelines]. By default [pipelines] have `build`, `test` -and `deploy` stages, but these can be defined in `.gitlab-ci.yml`. If a job -doesn't specify a stage, the job is assigned to the test stage. - -### Environments - -Environments are places where code gets deployed, such as staging or production. -CI/CD [Pipelines] usually have one or more deploy stages with [jobs] that do -[deployments] to an environment. - -### Deployments - -Deployments are created when [jobs] deploy versions of code to [environments]. - -[pipelines]: #pipelines -[builds]: #builds -[runners]: #runners -[jobs]: #jobs -[stages]: #stages -[environments]: #environments -[deployments]: #deployments diff --git a/doc/ci/environments.md b/doc/ci/environments.md index 040379bb381..d85b8a34ced 100644 --- a/doc/ci/environments.md +++ b/doc/ci/environments.md @@ -52,7 +52,7 @@ Clicking on an environment will show the history of deployments. Only deploys that happen after your `.gitlab-ci.yml` is properly configured will show up in the environments and deployments lists. -[Pipelines]: quick_start/README.md +[Pipelines]: pipelines.md [jobs]: yaml/README.md#jobs [environments]: #environments [deployments]: #deployments |