From b5e593dcb010c5e411917083f69d3273e4d860b0 Mon Sep 17 00:00:00 2001 From: Adam Pickering Date: Fri, 27 Sep 2024 15:27:33 -0600 Subject: [PATCH] Update deprecation and removal policy and add documentation for upstream.yaml `Deprecated` field (#1062) --- README.md | 25 ++++++++++++++++--------- 1 file changed, 16 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 275df1aae5..1fd9123728 100644 --- a/README.md +++ b/README.md @@ -47,15 +47,6 @@ for inclusion in Rancher Partner charts. The Helm chart must: Testing these requirements will ensure that Rancher users can deploy your software correctly and easily. -### Removal - -Charts will be removed from this repo if technical requirements are not met, if -a serious security problem arises, or if the vendor's SUSE "Ready" partnership -is no longer active. In these cases, the pull request that removes the chart -will indicate an alternative source (e.g. the corresponding upstream project or -[Rancher Prime Application Collection](https://apps.rancher.io)) if one is -available. - ## Workflow #### 1. Fork the [Rancher Partner Charts](https://github.com/rancher/partner-charts/) repository, clone your fork, checkout the **main-source** branch and pull the latest changes. @@ -197,6 +188,7 @@ Options for `upstream.yaml` | ArtifactHubRepo | ArtifactHubPackage | Defines the repo to access on Artifact Hub | AutoInstall | | Allows setting a required additional chart to deploy prior to current chart, such as a dedicated CRDs chart | ChartMetadata | | Allows setting/overriding the value of any valid [Chart.yaml variable](https://helm.sh/docs/topics/charts/#the-chartyaml-file) +| Deprecated | | Whether the package is deprecated. Deprecated packages will not integrate any new chart versions from upstream | DisplayName | | Sets the name the chart will be listed under in the Rancher UI | Experimental | | Adds the 'experimental' annotation which adds a flag on the UI entry | Fetch | HelmChart, HelmRepo | Selects set of charts to pull from upstream.
- **latest** will pull only the latest chart version *default*
- **newer** will pull all newer versions than currently stored
- **all** will pull all versions @@ -336,3 +328,18 @@ git commit -m "Migrating chart" git push origin ``` #### 11. Open a pull request to the `main-source` branch for review + +## Deprecation and Removal Policy + +Charts may be removed from this repository for a number of reasons: + +- Technical requirements are not met +- A serious security problem is discovered +- The vendor's SUSE "Ready" partnership is no longer active + +In these cases, the chart will first be deprecated. While a chart is deprecated, +no new versions of the chart will be added to this repository. The chart will +be left in the deprecated state for a minimum of 3 months, and then it will be +removed. The pull requests that deprecate and remove the chart will indicate an +alternative source (e.g. the corresponding upstream project or [Rancher Prime +Application Collection](https://apps.rancher.io)) if one is available.