> For the complete documentation index, see [llms.txt](https://rc.sunbird.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://rc.sunbird.org/use/getting-started/installation/helm-setup.md).

# Helm Setup

{% hint style="warning" %}
**Helm charts don't live in `sunbird-rc-core` anymore.** They live in the separate [`Sunbird-RC/devops`](https://github.com/Sunbird-RC/devops) repo, under `deploy-as-code/helm/v1`. This is the single most common trip-up when following this page — an older doc revision pointed at `sunbird-rc-core/infra/...`, which no longer exists.
{% endhint %}

**Prerequisites**: Kubernetes cluster (min. 3 nodes), Helm, kubectl, [ingress-nginx](https://kubernetes.github.io/ingress-nginx/deploy/), a Postgres DB (for both Keycloak and the registry), and optionally ElasticSearch, Kafka, Redis, Minio. See the [High-Level Architecture](/registry/technical-overview/high-level-architecture.md) page for what each optional service is for.

{% stepper %}
{% step %}

### Clone the repo and pre-check the cluster

```bash
git clone https://github.com/Sunbird-RC/devops.git
cd devops/deploy-as-code/helm/v1
```

```bash
kubectl cluster-info
kubectl get nodes
kubectl get ns
helm version
```

Create a namespace:

```bash
kubectl create ns demo-registry
```

{% endstep %}

{% step %}

### Create secrets

Base64-encode all passwords/secrets and set them in `values.yaml`:

| Secret                           | Required | Purpose                                                     |
| -------------------------------- | -------- | ----------------------------------------------------------- |
| `DB_PASSWORD`                    | Yes      | Postgres database password                                  |
| `KEYCLOAK_ADMIN_PASSWORD`        | Yes      | Keycloak admin console password                             |
| `KEYCLOAK_DEFAULT_USER_PASSWORD` | Yes      | Default password for new users created by the registry      |
| `MINIO_SECRET_KEY`               | No       | Minio secret key                                            |
| `ELASTIC_SEARCH_PASSWORD`        | No       | ElasticSearch connection password                           |
| `KEYCLOAK_ADMIN_CLIENT_SECRET`   | No       | Client secret of the Keycloak admin client for the registry |
| {% endstep %}                    |          |                                                             |

{% step %}
{% hint style="info" %}
The passwords listed in the `values.yaml` should be updated.
{% endhint %}
{% endstep %}

{% step %}

### Configure values, schemas and signing keys

Modify the configuration values — database address, ElasticSearch address, etc. — in `values.yaml`.

Place schema files at [`devops/deploy-as-code/helm/v1/helm_charts/charts/registry/schemas`](https://github.com/Sunbird-RC/devops/tree/main/deploy-as-code/helm/v1/helm_charts/charts/registry/schemas).

Configure signing keys (a sample key ships by default — replace it before going live):

* Public + private signing keys: [`.../certificate-signer/keys`](https://github.com/Sunbird-RC/devops/tree/main/deploy-as-code/helm/v1/helm_charts/charts/certificate-signer/keys)
* Public key only (for verifiers): [`.../public-key-service/keys`](https://github.com/Sunbird-RC/devops/tree/main/deploy-as-code/helm/v1/helm_charts/charts/public-key-service/keys)
  {% endstep %}

{% step %}

### Deploy

```bash
helm upgrade --install --namespace=demo-registry demo-registry helm_charts --create-namespace
kubectl get pods -n demo-registry
```

{% endstep %}

{% step %}

### Import the Keycloak realm and set the secret

Via the admin console (`<host>/auth/`): Master → Add realm → import `imports/realm-export.json`.

Then Clients → `admin-api` → Credentials → Regenerate Secret → copy it, base64-encode it, and set `KEYCLOAK_ADMIN_CLIENT_SECRET` via `kubectl edit secret rc-secret -n demo-registry`. Then:

```bash
kubectl rollout restart deploy/demo-registry -n demo-registry
kubectl get pods -n demo-registry
```

{% endstep %}

{% step %}

### Check the registry APIs

Open `<host>/registry/api/docs/swagger.json` in a browser.
{% endstep %}
{% endstepper %}


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://rc.sunbird.org/use/getting-started/installation/helm-setup.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.