mod2/helm-generator/README.md

   1 ## Instructions for running helm chart generator
   2 version: 1.0.4-SNAPSHOT
   3
   4 1. Must have helm installed.
   5
   6 2. Run `mvn clean package` to build and package the code.
   7
   8 3. Discover helmchartgenerator-cli-<version>.jar under helmchartgenerator-cli/target
   9
  10 4. Override the default values for Chart Museum APIs for chart distribution by setting the following ENV variables:
  11     CHARTMUSEUM_BASEURL -> Base URL along with a port of Chart Museum (e.g "http://chartmuseum:8080")
  12                            (Note: the port is only needed if it's not the standard 80 for http or 443 for https.)
  13     CHARTMUSEUM_AUTH_BASIC_USERNAME -> Username for basic auth
  14     CHARTMUSEUM_AUTH_BASIC_PASSWORD -> Password for basic auth
  15
  16 5. Run the jar with these parameters set in the following order:
  17     1. Spec file location
  18     2. Chart directory location
  19     3. Output directory location
  20     4. Component spec schema (Optional)
  21     5. --distribute flag (Optional)
  22     6. --help (to see usage)
  23
  24     Arguments expected as: `<somePath/spec.json>  <somePath/chartDirectory> <somePath/outputDirectory> <somepath/specSchema.json> --distribute`
  25
  26     Test files currently included in project:
  27         - Spec file: `helm-chart-generator\src\test\input\specs\ves.json`
  28         - Charts Directory: `helm-chart-generator\src\test\input\blueprint`