public/rancher-docs
1
0
Fork 0
mirror of https://github.com/rancher/rancher-docs.git synced 2026-09-25 04:28:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

completing draft of pipelines

Browse Source
This commit is contained in:
Mark Bishop
2018-09-25 19:11:53 -07:00
parent 14572c1a86
commit 21207f0e8d
3 changed files with 34 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
content/rancher/v2.x/en/tools/pipelines/configurations/_index.md
+15 -4
View File
@@ -2,9 +2,7 @@
title: Configuring Pipelines
weight: 3725
---
<!-- TODO:
-[] Add steps for configuring repo -->
Configuring a pipeline automates the process of triggering and publishing builds. This section describes how to set up a pipeline in a production environment.
- The [Basic Configuration](#basic-configuration) section provides sequential instruction on how to configure a functional pipeline.
@@ -20,6 +18,16 @@ Initial configuration of a pipeline in a production environment involves complet
>**Note:** Before setting up a pipeline for a production environment, we recommend trying the [Pipeline Quick Start Guide]({{< baseurl >}}/rancher/v2.x/en/tools/pipelines/quick-start-guide).
<!-- TOC -->
- [1. Configuring Version Control Providers](#1-configuring-version-control-providers)
- [2. Configuring Pipeline Stages and Steps](#2-configuring-pipeline-stages-and-steps)
- [3. Running the Pipeline](#3-running-the-pipeline)
- [4. Configuring Persistent Data for Pipeline Components](#4-configuring-persistent-data-for-pipeline-components)
- [Advanced Configuration](#advanced-configuration)
<!-- /TOC -->
### 1. Configuring Version Control Providers
@@ -336,8 +344,11 @@ Complete both [A—Configuring Persistent Data for Docker Registry](#a—configu
During the process of configuring a pipeline, you can configure advanced options for triggering the pipeline or configuring environment variables.
- [Configuring Pipeline Trigger Rules](#configuring-pipeline-trigger-rules)
- [Configuring Timeouts](#configuring-timeouts)
- [Configuring Environment Variables](#configuring-environment-variables)
- [Configuring Pipeline Secrets](#configuring-pipeline-secrets)
- [Configuring the Executor Quota](#configuring-the-executor-quota)
### Configuring Pipeline Trigger Rules
content/rancher/v2.x/en/tools/pipelines/quick-start-guide/_index.md
+3 -3
View File
@@ -9,7 +9,7 @@ Rancher ships with several example repositories that you can use to familiarize
- Maven
- php
## 1—Configure Repositories
## 1. Configure Repositories
By default, the example pipeline repositories are disabled. Go enable one (or more) to test out the pipeline feature.
@@ -34,7 +34,7 @@ By default, the example pipeline repositories are disabled. Go enable one (or mo
- `jenkins`
- `minio`
## 2—Run Example Pipelines
## 2. Run Example Pipeline
<<<<<<< HEAD
1. Click Run.
@@ -55,6 +55,6 @@ After configuring an example repository, run the pipeline to see how it works.
## What's Next?
For detailed information about setting up a pipeline configuration in production, see the [Configuring Pipelines]({{< baseurl >}}/rancher/v2.x/en/tools/pipelines/configurations/).
For detailed information about setting up a pipeline in production, see the [Configuring Pipelines]({{< baseurl >}}/rancher/v2.x/en/tools/pipelines/configurations/).
content/rancher/v2.x/en/tools/pipelines/reference/_index.md
+16 -3
View File
@@ -3,12 +3,11 @@ title: Pipeline Variable Reference
weight: 8000
---
## Variable Substitution
For your convenience, the following variables are available in your pipeline configurations, and they will be substituted by metadata of a pipeline execution. You can reference them in the form of `${VAR_NAME}`:
For your convenience, the following variables are available for your pipeline configuration scripts. During pipeline executions, these variables are replaced by metadata. You can reference them in the form of `${VAR_NAME}`.
Variable Name | Description
------------------------|------------------------------------------------------------
<<<<<<< HEAD
CICD_GIT_REPO_NAME | Repository Name (Stripped of Github Organization)
CICD_GIT_URL | URL of the Git repository
CICD_GIT_COMMIT | Git commit ID being executed.
@@ -21,6 +20,20 @@ CICD_EXECUTION_SEQUENCE | Build number of the pipeline
CICD_EXECUTION_ID | Combination of {CICD_PIPELINE_ID}-{CICD_EXECUTION_SEQUENCE}
CICD_REGISTRY | Address for the docker registry of previous publish image step, available in the kubernetes manifest file of a `Deploy YAML` step.
CICD_IMAGE | Name of the built image of previous publish image step, available in the kubernetes manifest file of a `Deploy YAML` step. It does not contain the image tag.
=======
`CICD_GIT_REPO_NAME` | Repository name (Github organization omitted).
`CICD_GIT_URL` | URL of the Git repository.
`CICD_GIT_COMMIT` | Git commit ID being executed.
`CICD_GIT_BRANCH` | Git branch of this event.
`CICD_GIT_REF` | Git reference specification of this event.
`CICD_GIT_TAG` | Git tag name, set on tag event.
`CICD_EVENT` | Event that triggered the build (`push`, `pull_request` or `tag`).
`CICD_PIPELINE_ID` | Rancher ID for the pipeline.
`CICD_EXECUTION_SEQUENCE` | Build number of the pipeline.
`CICD_EXECUTION_ID` | Combination of `{CICD_PIPELINE_ID}-{CICD_EXECUTION_SEQUENCE}`.
`CICD_REGISTRY` | Address for the Docker registry for the previous publish image step, available in the Kubernetes manifest file of a `Deploy YAML` step.
`CICD_IMAGE` | Name of the image built from the previous publish image step, available in the Kubernetes manifest file of a `Deploy YAML` step. It does not contain the image tag.<br/><br/> [Example](https://github.com/rancher/pipeline-example-go/blob/master/deployment.yaml)
>>>>>>> 893010ad... completing draft of pipelines
## Full `.rancher-pipeline.yml` Example