Helm Charts
Last updated
Was this helpful?
Last updated
Was this helpful?
For deployment on Kubernetes OpenG2P provides Helm charts for all its components. Instructions to install a module/component using Helm are provided in the respective deployment guides.
Charts may be found here:
All charts are published to this public website: . This website is automatically created by Github with contents on branch of openg2p-helm repository. Charts are automatically published via Github action given .
Charts may be published manually with the procedure given below:
Create Helm packaged zip files by executing the following command in the folder that contains your charts source code.
You will see packaged .tgz
files created in the current directory.
Clone repo and switch to gh-pages
branch. Copy the above .tgz
files to root folder of the repo (where you will see several .tgz
files).
Make sure you have direct check-in permissions to the openg2p-helm
repo.
Run
To have your chart published automatically to be available in Rancher, add the following annotation to Chart.yaml
in your helm chart.
Released
Same as docker version (app version)
Same as chart version
Development
0.0.0-develop
develop
Since chart version matches docker version (app version) it is recommended that
appVersion
attribute is removed fromChart.yaml
as it is redundant.
To have your charts available in Rancher Apps and be able to install from Rancher UI follow guide given . See of Helm chart configured for Rancher.
To publish a chart on Rancher Apps in step 3 above, copy the chart zip to /rancher
folder of the repo. Run ./index.sh.
This will generate and index.yaml
file in the folder. This file will be read by Rancher to display in the catalogue (refer on how to add this repository).
If in for the chart fixed name and namespace of the Helm chart is specified, then only one instance of the application will be installed and further attempts to install will only update the application. Example, Monitoring app on Rancher.
The chart version is mentioned as version
attribute in the Chart.yaml
file (see ). For version numbers we adhere to with "Simple 1-1 versioning" convention as described . Here, chart version is kept same as docker version (app version).