public/rancher-docs
1
0
Fork 0
mirror of https://github.com/rancher/rancher-docs.git synced 2026-05-15 17:43:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

updates and formatting

Browse Source
This commit is contained in:
Bill Maxwell
2018-09-27 21:33:28 -07:00
parent 6aa95a2c36
commit 45e028cbc6
3 changed files with 8 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files
content/rancher/v2.x/en/tools/pipelines/_index.md
+6 -6
View File
@@ -42,13 +42,13 @@ Pipelines are represented as pipeline files that are checked into source code re
## Supported Version Control Platforms
Rancher pipelines currently supports GitHub and GitLab (available as of Rancher v2.0.1).
Rancher pipelines currently supports GitHub and GitLab (available as of Rancher v2.1.0).
>**Note:** Additions to pipelines are scoped for future releases of Rancher, such as:
>
>- Additional version control systems
>- Deployment of Kubernetes YAML
>- Catalog deployment
>- Deployment via Helm charts
>- Rancher catalog deployments
## How Pipelines Work
@@ -57,15 +57,15 @@ When you configure a pipeline in one of your projects, a namespace specifically
- **Jenkins:**
The pipeline's build engine. Because project users likely won't interact with Jenkins, it's managed and locked.
The pipeline's build engine. Because project users do not directly interact with Jenkins, it's managed and locked.
>**Note:** There is no option to reuse existing Jenkins deployments as the pipeline engine.
>**Note:** There is no option to use existing Jenkins deployments as the pipeline engine.
<a id="reg"></a>
- **Docker Registry:**
Out-of-the-box, the default target for your builds is an internal Docker Registry. However, you can make configurations to push to a remote registry instead. Docker Registry is only accessible from cluster nodes and cannot be directly accessed by users.
Out-of-the-box, the default target for your build-publish step is an internal Docker Registry. However, you can make configurations to push to a remote registry instead. This Docker Registry is only accessible from cluster nodes and cannot be directly accessed by users. Images are not persisted longer then the pipelines current run. If you need to access your images outside of a single pipeline run, please push to an external registry.
<a id="minio"></a>
content/rancher/v2.x/en/tools/pipelines/quick-start-guide/_index.md
+2 -12
View File
@@ -11,11 +11,11 @@ Rancher ships with several example repositories that you can use to familiarize
## 1. Configure Repositories
By default, the example pipeline repositories are disabled. Go enable one (or more) to test out the pipeline feature.
By default, the example pipeline repositories are disabled. Enable one (or more) to test out the pipeline feature and see how to leverage it.
1. From the context menu, open the project for which you want to run a pipeline.
1. From the main menu, select **Workloads**. The select the **Pipelines** tab.
1. From the main menu, select **Workloads**. Then select the **Pipelines** tab.
1. Click **Configure Repositories**.
@@ -36,14 +36,6 @@ By default, the example pipeline repositories are disabled. Go enable one (or mo
## 2. Run Example Pipeline
<<<<<<< HEAD
1. Click Run.
>**Note:** When you are running a pipeline the first time, it will take a few minutes to pull relevant images and provision necessary pipeline components.
To understand what the example pipeline is doing, you can check the `.rancher-pipeline.yml` file in the example repositories, or click `Edit Config` action of the enabled repository to see it via UI wizard.
<<<<<<< HEAD
=======
=======
After configuring an example repository, run the pipeline to see how it works.
1. From the **Pipelines** tab, select **Ellipsis (...) > Run**.
@@ -56,5 +48,3 @@ After configuring an example repository, run the pipeline to see how it works.
## What's Next?
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
-15
View File
@@ -7,20 +7,6 @@ For your convenience, the following variables are available for your pipeline co
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.
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, can be "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 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.
@@ -33,7 +19,6 @@ CICD_IMAGE | Name of the built image of previous publish image step
`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