README.md

Corda 5 Development Pre-requisites Helm chart

The contents of this repository can be used to install the Kafka and PostgreSQL pre-requisites for Corda 5 development. The auto-generated charts/corda-dev-prereqs/README.md contains details of the configurable values.

Installation from source

Assuming helm with a version greater than 3.7 is installed, the chart may be used a follows.

Install helm chart

To install the helm chart with the default values run the following command:

helm upgrade -i "<RELEASE NAME>" charts/corda-dev-prereqs --namespace "<RELEASE NAMESPACE>" --create-namespace --wait

On completion, the chart outputs the overrides that should then be used with your Corda Helm install.

Optionally execute test hook

After the release has been installed, it may be tested via the following command:

helm test "<RELEASE NAME>" -n "<RELEASE NAMESPACE>"

Maintaining

As new value fields are added to the default charts/corda-dev-prereqs/values.yaml, doc strings should be included.

For objects prefer this style:

# Doc string on an object, which won't show in README.md
foo: {}

Whereas for primitive types prefer this style:

# -- Doc string for a primitive, which will show in the README.md
foo: "bar"

Then using helm-docs

Generate the README.md via:

$ helm-docs
INFO[2022-02-22T18:13:16Z] Found Chart directories [charts/corda-dev-prereqs]
INFO[2022-02-22T18:13:16Z] Generating README Documentation for chart charts/corda-dev-prereqs