# 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](/1.3/social-registry.md) | <https://github.com/OpenG2P/openg2p-social-registry-deployment/> |
| [PBMS](/1.3/pbms.md)                       | <https://github.com/OpenG2P/openg2p-pbms-deployment>             |
| [SPAR](/1.3/spar.md)                       | <https://github.com/OpenG2P/openg2p-spar-deployment/>            |

## Published repository

All charts are published to this public website: <https://openg2p.github.io/openg2p-helm>. 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/<chart name>
```

2. You will see packaged `.tgz` files created in the current directory.
3. Clone <https://github.com/OpenG2P/openg2p-helm> 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](/1.3/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 Helm chart version is mentioned under the `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"](https://codefresh.io/docs/docs/ci-cd-guides/helm-best-practices/#simple-1-1-versioning). Here, the chart version is kept the same as the Docker version (also referred as `appVersion` in Chart.yml.).

<table><thead><tr><th width="166">Chart State</th><th width="245">Chart version</th><th>Docker version (appVersion)</th></tr></thead><tbody><tr><td><strong>Release/Prerelease</strong></td><td>Matches Docker version</td><td>Matches Chart version</td></tr><tr><td><strong>Development</strong></td><td><code>0.0.0-develop</code></td><td><code>develop</code></td></tr></tbody></table>

> Since chart version matches `appVersion` it is recommended that the `appVersion` attribute is removed from `Chart.yaml` as it is redundant.

## Helm chart size limitation

{% hint style="warning" %}
**Helm chart size limitation**

Due to 1 MB limit of Kubernetes ETCD secrets, we have split a large chart into parts. This split is purely to address this limitation. See some discussions here on this topic:

<https://github.com/helm/helm/issues/11493>

<https://azure.github.io/azure-service-operator/design/adr-2023-02-helm-chart-size-limitations/>
{% endhint %}


---

# Agent Instructions: 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:

```
GET https://docs.openg2p.org/1.3/deployment/helm-charts.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.