From 4015ebdfe003a7d0429370f82f148215e22a2956 Mon Sep 17 00:00:00 2001 From: Sheng Liang Date: Sat, 29 Sep 2018 15:31:11 -0700 Subject: [PATCH] Fix pipeline docs --- content/rancher/v2.x/en/tools/pipelines/_index.md | 10 +++++----- .../v2.x/en/tools/pipelines/configurations/_index.md | 6 +++--- .../v2.x/en/tools/pipelines/docs-for-v2.0.x/_index.md | 6 +++++- .../en/tools/pipelines/quick-start-guide/_index.md | 4 ++-- 4 files changed, 15 insertions(+), 11 deletions(-) diff --git a/content/rancher/v2.x/en/tools/pipelines/_index.md b/content/rancher/v2.x/en/tools/pipelines/_index.md index c0997848f76..9714d93d2aa 100644 --- a/content/rancher/v2.x/en/tools/pipelines/_index.md +++ b/content/rancher/v2.x/en/tools/pipelines/_index.md @@ -38,7 +38,7 @@ Pipelines are represented as pipeline files that are checked into source code re - Using the Rancher UI. - Updating the configuration in the repository, using tools like Git CLI to trigger a build with the latest CI definition. ->**Note:** Rancher Pipeline not a replacement for enterprise-grade Jenkins or any other CI tool your team uses. +>**Note:** Rancher Pipeline provides a simple CI/CD experience, but it does not offer the full power and flexibility of and is not a replacement of enterprise-grade Jenkins or other CI tools your team uses. ## Supported Version Control Platforms @@ -46,9 +46,9 @@ Rancher pipelines currently supports GitHub and GitLab (available as of Rancher >**Note:** Additions to pipelines are scoped for future releases of Rancher, such as: > ->- Additional version control systems +>- Additional version control systems such as BitBucket >- Deployment via Helm charts ->- Rancher catalog deployments +>- Deployment via Rancher catalog ## How Pipelines Work @@ -65,7 +65,7 @@ When you configure a pipeline in one of your projects, a namespace specifically - **Docker Registry:** - 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. + 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. The internal Docker Registry is only accessible from cluster nodes and cannot be directly accessed by users. Images are not persisted across multiple pipeline runs. If you need to access your images outside of a single pipeline run, please push to an external registry. @@ -73,7 +73,7 @@ When you configure a pipeline in one of your projects, a namespace specifically Minio storage is used to store the logs for pipeline executions. - >**Note:** The managed Jenkins instance works statelessly, so don't worry about its data persistency. The Docker Registry and Minio instances use ephemeral volumes by default, but we recommend that you configure persistent volumes for them, as described in [data persistency for pipeline components](/rancher/v2.x/en/tools/pipelines/configurations/#data-persistency-for-pipeline-components). + >**Note:** The managed Jenkins instance works statelessly, so don't worry about its data persistency. The Docker Registry and Minio instances use ephemeral volumes by default, which is fine for most use cases. If you want to make sure pipeline logs can survive node failures, you can configure persistent volumes for them, as described in [data persistency for pipeline components](/rancher/v2.x/en/tools/pipelines/configurations/#data-persistency-for-pipeline-components). ## Pipeline Triggers diff --git a/content/rancher/v2.x/en/tools/pipelines/configurations/_index.md b/content/rancher/v2.x/en/tools/pipelines/configurations/_index.md index dbb109d122d..616c40e7e95 100644 --- a/content/rancher/v2.x/en/tools/pipelines/configurations/_index.md +++ b/content/rancher/v2.x/en/tools/pipelines/configurations/_index.md @@ -235,7 +235,7 @@ This process takes several minutes. When it completes, you can view each pipelin ### 4. Configuring Persistent Data for Pipeline Components -The internal [Docker registry]({{< baseurl >}}/rancher/v2.x/en/tools/pipelines/#reg) and the [Minio]({{< baseurl >}}/rancher/v2.x/en/tools/pipelines/#minio) wokrloads use ephemeral volumes by default. This default storage works out-of-the-box and makes testing easy, but it does not help in cases of disaster recovery. We recommend that you to configure these two deployments to persist their data. +The internal [Docker registry]({{< baseurl >}}/rancher/v2.x/en/tools/pipelines/#reg) and the [Minio]({{< baseurl >}}/rancher/v2.x/en/tools/pipelines/#minio) wokrloads use ephemeral volumes by default. This default storage works out-of-the-box and makes testing easy, but you lose the build images and build logs if the node running the Docker Registry or Minio fails. In most cases this is fine. If you want build images and logs to survive node failures, you can configure the Docker Registry and Minio to use persistent volumes. Complete both [A—Configuring Persistent Data for Docker Registry](#a—configuring-persistent-data-for-docker-registry) _and_ [B—Configuring Persistent Data for Minio](#b—configuring-persistent-data-for-minio). @@ -474,7 +474,7 @@ branch: ### Configuring Timeouts -Each pipeline execution has a default timeout of 60 second. If the pipeline execution cannot complete within its timeout period, the pipeline is aborted. If a pipeline has more executions than can be completed in 60 minutes, +Each pipeline execution has a default timeout of 60 minutes. If the pipeline execution cannot complete within its timeout period, the pipeline is aborted. If a pipeline has more executions than can be completed in 60 minutes, {{% tabs %}} {{% tab "By UI" %}} @@ -543,7 +543,7 @@ stages: ### Configuring Pipeline Secrets -If you need to use security-sensitive information in your pipeline scripts (like a password), you can pass them in using [secrets]({{< baseurl >}}/rancher/v2.x/en/k8s-in-rancher/secrets/). +If you need to use security-sensitive information in your pipeline scripts (like a password), you can pass them in using Kubernetes [secrets]({{< baseurl >}}/rancher/v2.x/en/k8s-in-rancher/secrets/). >**Prerequisite:** Create a secret for your project for use in pipelines. diff --git a/content/rancher/v2.x/en/tools/pipelines/docs-for-v2.0.x/_index.md b/content/rancher/v2.x/en/tools/pipelines/docs-for-v2.0.x/_index.md index 90640959d8e..5c14bd17f61 100644 --- a/content/rancher/v2.x/en/tools/pipelines/docs-for-v2.0.x/_index.md +++ b/content/rancher/v2.x/en/tools/pipelines/docs-for-v2.0.x/_index.md @@ -3,6 +3,10 @@ title: v2.0.x Pipeline Documentation weight: 9000 --- +>**Note:** This section describes the pipeline feature as implemented in Rancher v2.0.x. If you are using Rancher v2.1 or later, where pipelines have been significantly improved, please refer to the new documentation for [v2.1 or later](/rancher/v2.x/en/tools/pipelines). + + + Pipelines help you automate the software delivery process. You can integrate Rancher with GitHub to create a pipeline. You can set up your pipeline to run a series of stages and steps to test your code and deploy it. @@ -118,4 +122,4 @@ CICD_PIPELINE_ID | Rancher ID for the pipeline CICD_GIT_URL | URL of the Git repository CICD_EXECUTION_SEQUENCE | Build number of the pipeline CICD_EXECUTION_ID | Combination of {CICD_PIPELINE_ID}-{CICD_EXECUTION_SEQUENCE} -CICD_GIT_COMMIT | Git commit ID being executed. \ No newline at end of file +CICD_GIT_COMMIT | Git commit ID being executed. diff --git a/content/rancher/v2.x/en/tools/pipelines/quick-start-guide/_index.md b/content/rancher/v2.x/en/tools/pipelines/quick-start-guide/_index.md index f14c8de0ca9..c23356ac307 100644 --- a/content/rancher/v2.x/en/tools/pipelines/quick-start-guide/_index.md +++ b/content/rancher/v2.x/en/tools/pipelines/quick-start-guide/_index.md @@ -11,7 +11,7 @@ Rancher ships with several example repositories that you can use to familiarize ## 1. Configure Repositories -By default, the example pipeline repositories are disabled. Enable one (or more) to test out the pipeline feature and see how to leverage it. +By default, the example pipeline repositories are disabled. Enable one (or more) to test out the pipeline feature and see how it works. 1. From the context menu, open the project for which you want to run a pipeline. @@ -43,7 +43,7 @@ After configuring an example repository, run the pipeline to see how it works. >**Note:** When you run a pipeline the first time, it takes a few minutes to pull relevant images and provision necessary pipeline components. To understand what the example pipeline is doing, select `Ellipsis (...) > Edit Config` for your repo. Alternatively, view the `.rancher-pipeline.yml` file in the example repositories. -**Result:** The pipeline runs. +**Result:** The pipeline runs. You can see the results in the logs. ## What's Next?