diff options
| author |   Dhrumin Desai <dd303q@att.com> | 2021-08-09 16:52:04 -0400 |
|---|---|---|
| committer | Dhrumin Desai <dd303q@att.com> | 2021-08-31 14:54:58 -0400 |
| commit | 1838366d51a172b0240a5e23c5d691b544a7a6be (patch) | |
| tree | 750e3f37c67b3e350a3e40a81088e08a2e696252 /mod2/helm-generator/helmchartgenerator-cli/src/main/resources/Usage.txt | |
| parent | f6129791bd343d7c4a19bc4c5c758d76e24f0926 (diff) | |
Helm-generator - seedcode delivery for helm chart generation tool from component spec
Issue-ID: DCAEGEN2-2694
Change-Id: I3e317e312f90b061c0cdff155b8673967aea414b
Signed-off-by: Dhrumin Desai <dd303q@att.com>
Diffstat (limited to 'mod2/helm-generator/helmchartgenerator-cli/src/main/resources/Usage.txt')
| -rw-r--r-- | mod2/helm-generator/helmchartgenerator-cli/src/main/resources/Usage.txt | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/mod2/helm-generator/helmchartgenerator-cli/src/main/resources/Usage.txt b/mod2/helm-generator/helmchartgenerator-cli/src/main/resources/Usage.txt new file mode 100644 index 0000000..7aaec03 --- /dev/null +++ b/mod2/helm-generator/helmchartgenerator-cli/src/main/resources/Usage.txt @@ -0,0 +1,32 @@ + +Helm Chart Generator: + +- generate a helm chart from the base helm template and parsed component spec file. +- distribute a helm chart to Chartmuseum + +Environment variables: + +| Name | Description | +|------------------------------------|-----------------------------------------------------------------------------------| +| $CHARTMUSEUM_BASEURL | set a Chartmuseum base url for chart distribution. | +| $CHARTMUSEUM_AUTH_BASIC_USERNAME | set a Chartmuseum username for the basic auth. | +| $CHARTMUSEUM_AUTH_BASIC_PASSWORD | set a Chartmuseum password for the basic auth. | + +Requirements: + +- Helm Chart Generator uses 'helm' command installed on the host machine, so 'helm' command must be installed. +- For the distribution, $CHARTMUSEUM_BASEURL, $CHARTMUSEUM_AUTH_BASIC_USERNAME and $CHARTMUSEUM_AUTH_BASIC_PASSWORD + must be set. + +Usage: + helmchartgenerator-<jar-version>.jar <args> (with JAR) + OR + HelmChartGeneratorApplication.java <args> (with the main class) + + - Arguments must be passed in the numeric order mentioned below. +Arguments: + 1. Spec file location (Required) + 2. Chart directory location (helm template location) (Required) + 3. Output directory location (Required) + 4. Component spec schema (Optional) (Note: Default componentSpec schema will be used if not passed.) + 5. --distribute flag (Optional) |