mirror of
https://github.com/rancher/rancher-docs.git
synced 2026-05-04 20:23:24 +00:00
Billy Tat
78 lines
3.3 KiB
Markdown
78 lines
3.3 KiB
Markdown
---
|
|
title: Example Repositories
|
|
weight: 500
|
|
aliases:
|
|
- /rancher/v2.0-v2.4/en/tools/pipelines/quick-start-guide/
|
|
- /rancher/v2.0-v2.4/en/k8s-in-rancher/pipelines/example-repos
|
|
---
|
|
|
|
Rancher ships with several example repositories that you can use to familiarize yourself with pipelines. We recommend configuring and testing the example repository that most resembles your environment before using pipelines with your own repositories in a production environment. Use this example repository as a sandbox for repo configuration, build demonstration, etc. Rancher includes example repositories for:
|
|
|
|
- Go
|
|
- Maven
|
|
- php
|
|
|
|
> **Note:** The example repositories are only available if you have not [configured a version control provider](../../how-to-guides/advanced-user-guides/manage-projects/ci-cd-pipelines.md).
|
|
|
|
To start using these example repositories,
|
|
|
|
1. [Enable the example repositories](#1-enable-the-example-repositories)
|
|
2. [View the example pipeline](#2-view-the-example-pipeline)
|
|
3. [Run the example pipeline](#3-run-the-example-pipeline)
|
|
|
|
### 1. Enable the Example Repositories
|
|
|
|
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 **Global** view, navigate to the project that you want to test out pipelines.
|
|
|
|
1. Click **Resources > Pipelines.** In versions before v2.3.0, click **Workloads > Pipelines.**
|
|
|
|
1. Click **Configure Repositories**.
|
|
|
|
**Step Result:** A list of example repositories displays.
|
|
|
|
>**Note:** Example repositories only display if you haven't fetched your own repos.
|
|
|
|
1. Click **Enable** for one of the example repos (e.g., `https://github.com/rancher/pipeline-example-go.git`). Then click **Done**.
|
|
|
|
**Results:**
|
|
|
|
- The example repository is enabled to work with a pipeline is available in the **Pipeline** tab.
|
|
|
|
- The following workloads are deployed to a new namespace:
|
|
|
|
- `docker-registry`
|
|
- `jenkins`
|
|
- `minio`
|
|
|
|
### 2. View the Example Pipeline
|
|
|
|
After enabling an example repository, review the pipeline to see how it is set up.
|
|
|
|
1. From the **Global** view, navigate to the project that you want to test out pipelines.
|
|
|
|
1. Click **Resources > Pipelines.** In versions before v2.3.0, click **Workloads > Pipelines.**
|
|
|
|
1. Find the example repository, select the vertical **⋮**. There are two ways to view the pipeline:
|
|
* **Rancher UI**: Click on **Edit Config** to view the stages and steps of the pipeline.
|
|
* **YAML**: Click on View/Edit YAML to view the `./rancher-pipeline.yml` file.
|
|
|
|
### 3. Run the Example Pipeline
|
|
|
|
After enabling an example repository, run the pipeline to see how it works.
|
|
|
|
1. From the **Global** view, navigate to the project that you want to test out pipelines.
|
|
|
|
1. Click **Resources > Pipelines.** In versions before v2.3.0, click **Workloads > Pipelines.**
|
|
|
|
1. Find the example repository, select the vertical **⋮ > Run**.
|
|
|
|
>**Note:** When you run a pipeline the first time, it takes a few minutes to pull relevant images and provision necessary pipeline components.
|
|
|
|
**Result:** The pipeline runs. You can see the results in the logs.
|
|
|
|
### What's Next?
|
|
|
|
For detailed information about setting up your own pipeline for your repository, [configure a version control provider](../../how-to-guides/advanced-user-guides/manage-projects/ci-cd-pipelines.md), enable a repository and finally configure your pipeline.
|