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

Update docs for change to `crdOptions` and `upstreamOptions` behavior (#3672)

pull/3694/head
Adam Pickering 2024-03-21 17:01:49 -06:00 committed by GitHub
parent a1430dc880
commit a99aabbd5a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/experimental.md
View File

@ -41,4 +41,4 @@ If you would like to perform local validation only (e.g. checking if `make chart
If you would like to perform remote validation only (e.g. checking if all differences between your current repository and an upstream repository are tracked in the `release.yaml`), you can run `./bin/charts-build-scripts validate --upstream`.
Note: These options have **not** been exposed as environment variables since an average consumer of the scripts should rarely, if at all, have any reason for using these options.
Note: These options have **not** been exposed as environment variables since an average consumer of the scripts should rarely, if at all, have any reason for using these options.

6
docs/packages.md
View File

@ -22,12 +22,10 @@ additionalCharts:
# These contain other charts that you would like to package alongside this chart
- workingDir: # same as above
upstreamOptions:
# Mutually exclusive with crdOptions
url: # same as above
subdirectory: # optional, same as above
commit: # optional, same as above
crdOptions:
# Mutually exclusive with upstreamOptions
templateDirectory: # A directory within packages/<package>/template that will contain a template for your CRD chart
crdDirectory: # Where to place your CRDs within a CRD chart (e.g. crds for default charts)
addCRDValidationToMainChart: # Whether to add additional validation to your main chart to check that the CRD chart is installed.
@ -45,7 +43,9 @@ Charts or AdditionalCharts can provide UpstreamOptions with the following possib
#### Additional Charts CRD Options
AdditionalCharts can provide CRDOptions instead of UpstreamOptions. These CRDOptions allow the scripts to automatically construct a CRD chart from your main Chart's contents based on the template provided.
AdditionalCharts can provide CRDOptions instead of or in addition to
UpstreamOptions. These CRDOptions allow the scripts to automatically construct a
CRD chart from your main Chart's contents based on the template provided.
A CRD Chart is a Helm Chart whose sole purpose is to install CRDs onto a cluster before the main Chart is installed.