mod2/helm-generator/helmchartgenerator-cli/src/main/resources/Usage.txt

   1
   2 Helm Chart Generator:
   3
   4 - generate a helm chart from the base helm template and parsed component spec file.
   5 - distribute a helm chart to Chartmuseum
   6
   7 Environment variables:
   8
   9 | Name                               | Description                                                                       |
  10 |------------------------------------|-----------------------------------------------------------------------------------|
  11 | $CHARTMUSEUM_BASEURL               | set a Chartmuseum base url for chart distribution.                                |
  12 | $CHARTMUSEUM_AUTH_BASIC_USERNAME   | set a Chartmuseum username for the basic auth.                                    |
  13 | $CHARTMUSEUM_AUTH_BASIC_PASSWORD   | set a Chartmuseum password for the basic auth.                                    |
  14
  15 Requirements:
  16
  17 - Helm Chart Generator uses 'helm' command installed on the host machine, so 'helm' command must be installed.
  18 - For the distribution, $CHARTMUSEUM_BASEURL, $CHARTMUSEUM_AUTH_BASIC_USERNAME and $CHARTMUSEUM_AUTH_BASIC_PASSWORD
  19   must be set.
  20
  21 Usage:
  22   helmchartgenerator-<jar-version>.jar <args>         (with JAR)
  23                     OR
  24   HelmChartGeneratorApplication.java <args>           (with the main class)
  25
  26   - Arguments must be passed in the numeric order mentioned below.
  27 Arguments:
  28   1. Spec file location (Required)
  29   2. Chart directory location (helm template location) (Required)
  30   3. Output directory location (Required)
  31   4. Component spec schema (Optional) (Note: Default componentSpec schema will be used if not passed.)
  32   5. --distribute flag (Optional)