andata
/
rancher-partner-charts
mirror of https://git.rancher.io/partner-charts
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README.md

pull/595/head
Samuel Attwood 2022-12-02 03:16:19 -05:00 committed by GitHub
parent 1833a49b1d
commit 9c2de092e1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -2,7 +2,7 @@
This repository is reserved for partner charts in the Rancher's v2.5+ catalog. As part of this catalog, This repository is reserved for partner charts in the Rancher's v2.5+ catalog. As part of this catalog,
all charts will benefit of a cloud native packaging system that directly references an upstream chart all charts will benefit of a cloud native packaging system that directly references an upstream chart
from a Helm repository and automates applying Rancher specific modifications and adding overlay from a Helm or git repository and automates applying Rancher specific modifications and adding overlay
files on top of it. files on top of it.
## Requirements ## Requirements
@ -26,7 +26,7 @@ files on top of it.
* Managing CRDs and best practices: https://helm.sh/docs/chart_best_practices/custom_resource_definitions/ * Managing CRDs and best practices: https://helm.sh/docs/chart_best_practices/custom_resource_definitions/
* Semver Rules: https://semver.org/ * Semver Rules: https://semver.org/
* Chart must be in a hosted [Helm repository](https://helm.sh/docs/topics/chart_repository/) that we can reference. * Chart must be in a hosted [Helm](https://helm.sh/docs/topics/chart_repository/) or Git repository that we can reference.
* Chart must have the following Rancher specific add-ons (More details on this below). * Chart must have the following Rancher specific add-ons (More details on this below).
* kubeVersion set in the chart's metadata * kubeVersion set in the chart's metadata
@ -35,18 +35,18 @@ files on top of it.
## Workflow ## Workflow
### 1. Fork the [Rancher Partner Charts](https://github.com/rancher/partner-charts/) repository #### 1. Fork the [Rancher Partner Charts](https://github.com/rancher/partner-charts/) repository
### 2. Clone your fork and ensure the main-source branch is checked out #### 2. Clone your fork and ensure the main-source branch is checked out
```bash ```bash
git clone -b main-source git@github.com:<your_github>/partner-charts.git git clone -b main-source git@github.com:<your_github>/partner-charts.git
``` ```
### 3. Create subdirectories in **packages** in the form of `<vendor>/<chart>` #### 3. Create subdirectories in **packages** in the form of `<vendor>/<chart>`
```bash ```bash
cd partner-charts cd partner-charts
mkdir -p packages/suse/kubewarden-controller mkdir -p packages/suse/kubewarden-controller
``` ```
### 4. Create your [upstream.yaml](#configuration-file) #### 4. Create your [upstream.yaml](#configuration-file)
Some [examples](#examples) are provided below Some [examples](#examples) are provided below
```bash ```bash
cat <<EOF > packages/suse/kubewarden-controller/upstream.yaml cat <<EOF > packages/suse/kubewarden-controller/upstream.yaml
@ -59,19 +59,19 @@ ChartMetadata:
icon: https://www.kubewarden.io/images/icon-kubewarden.svg icon: https://www.kubewarden.io/images/icon-kubewarden.svg
EOF EOF
``` ```
### 5. [Create 'overlay' files](#overlay) #### 5. [Create 'overlay' files](#overlay)
Create any add-on files such as an app-readme.md and questions.yaml in an 'overlay' subdirectory (Optional) Create any add-on files such as an app-readme.md and questions.yaml in an 'overlay' subdirectory (Optional)
```bash ```bash
mkdir packages/suse/kubewarden-controller/overlay mkdir packages/suse/kubewarden-controller/overlay
echo "Example app-readme.md" > packages/suse/kubewarden-controller/overlay/app-readme.md echo "Example app-readme.md" > packages/suse/kubewarden-controller/overlay/app-readme.md
``` ```
### 6. Commit your packages directory #### 6. Commit your packages directory
```bash ```bash
git add packages/suse/kubewarden-controller git add packages/suse/kubewarden-controller
git commit -m "Submitting suse/kubewarden-controller" git commit -m "Submitting suse/kubewarden-controller"
``` ```
### 7. [Test your configuration](#testing-your-configuration) #### 7. [Test your configuration](#testing-your-configuration)
### 8. Push your commit and open a pull request #### 8. Push your commit and open a pull request
```bash ```bash
git push origin main-source git push origin main-source
@ -81,22 +81,22 @@ git push origin main-source
## Testing your configuration ## Testing your configuration
If you would like to test your configuration using the CI tool, simply run the provided script in `scripts/pull-ci-scripts` to download the binary. The 'auto' function is what will be run to download and store your chart. If you would like to test your configuration using the CI tool, simply run the provided script in `scripts/pull-ci-scripts` to download the binary. The 'auto' function is what will be run to download and store your chart.
### 1. Download the binary #### 1. Download the binary
```bash ```bash
scripts/pull-ci-scripts scripts/pull-ci-scripts
``` ```
### 2. Set the **PACKAGE** environment variable to your chart #### 2. Set the **PACKAGE** environment variable to your chart
You can confirm the package entry with `bin/partner-charts-ci list` which will list all detected charts with a configuration file. You can confirm the package entry with `bin/partner-charts-ci list` which will list all detected charts with a configuration file.
```bash ```bash
export PACKAGE=<vendor>/<chart> export PACKAGE=<vendor>/<chart>
``` ```
### 3. Run the 'auto' or 'stage' function #### 3. Run the 'auto' or 'stage' function
The 'auto' subcommand will run the complete CI process. The 'auto' subcommand will run the complete CI process.
The 'stage' subcommand will do the same process but will not create a git commit when it completes. The 'stage' subcommand will do the same process but will not create a git commit when it completes.
```bash ```bash
bin/partner-charts-ci auto bin/partner-charts-ci auto
``` ```
### 4. Validate your changes #### 4. Validate your changes
```bash ```bash
bin/partner-charts-ci validate bin/partner-charts-ci validate
``` ```