> For the complete documentation index, see [llms.txt](https://docs.openg2p.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.openg2p.org/~/changes/xKUM0sBXFkyR8F24yAMq/deployment/helm-charts.md).
# Helm Charts
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.
## Source code
Charts may be found here:
| Module | Location |
| --------------------------------------------------------------------- | ---------------------------------------------------------------- |
| [Social Registry](/~/changes/xKUM0sBXFkyR8F24yAMq/social-registry.md) | |
| [PBMS](/~/changes/xKUM0sBXFkyR8F24yAMq/pbms.md) | |
| [SPAR](/~/changes/xKUM0sBXFkyR8F24yAMq/spar.md) | |
## Published repository
All charts are published to this public website: . This website is automatically created by Github with contents on [`gh-pages`](https://github.com/OpenG2P/openg2p-helm/tree/gh-pages) branch of openg2p-helm repository. Charts are automatically published via Github action given [here](https://github.com/OpenG2P/openg2p-deployment/blob/main/.github/workflows/push_trigger.yml).
Charts may be published manually with the procedure given below:
1. Create Helm packaged zip files by executing the following command in the folder that contains your charts source code.
```
helm package charts/
```
2. You will see packaged `.tgz` files created in the current directory.
3. 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).
4. Make sure you have direct check-in permissions to the `openg2p-helm` repo.
5. Run
```
./publish.sh
```
## Publish Helm charts as Rancher apps
To have your charts available in Rancher Apps and be able to install from Rancher UI follow guide given [here](https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/helm-charts-in-rancher/create-apps). See [example](https://github.com/OpenG2P/openg2p-social-registry-deployment/tree/develop/charts/openg2p-social-registry) of Helm chart configured for Rancher.
### Automatic publishing
To have your chart published automatically to be available in Rancher, add the following annotation to `Chart.yaml` in your helm chart.
```yaml
annotations:
openg2p.org/add-to-rancher: ""
```
### Manual publishing
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 [Installation using Rancher UI](/~/changes/xKUM0sBXFkyR8F24yAMq/spar/deployment.md#installation-using-rancher-ui) on how to add this repository).
{% hint style="info" %}
If in [annotations](https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/helm-charts-in-rancher/create-apps#chartyaml-annotations) 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.
{% endhint %}
## Helm chart versions
The chart version is mentioned as `version` attribute in the `Chart.yaml` file (see [example](https://github.com/OpenG2P/openg2p-spar-deployment/blob/1.0.0/charts/spar/Chart.yaml)). For version numbers we adhere to [Semantic Versioning 2.0](https://semver.org/spec/v2.0.0.html) with "Simple 1-1 versioning" convention as described [here](https://codefresh.io/docs/docs/ci-cd-guides/helm-best-practices/#simple-1-1-versioning). Here, chart version is kept same as docker version (app version).
Chart State
Chart version
Docker version (app version)
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 from `Chart.yaml` as it is redundant.
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.openg2p.org/~/changes/xKUM0sBXFkyR8F24yAMq/deployment/helm-charts.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.