Skip to main content
Connect a Helm registry and Ankra reads its charts, so anyone in your organisation can add them to a Stack. This page adds an HTTP chart repository or an OCI registry, signs in to a private one, keeps its chart list current and removes it again. Which of the two kinds to use, and how it relates to Ankra’s own catalogue, is explained in Chart sources.

Before you start

  • A role that may manage Helm registries. Without it, Helm registries says “Your role can see the registries, not add, sync or delete them. Someone who may manage Helm registries can.”
  • For a private registry, a login that can read its charts: a username and a password or token. The provider notes below say what each registry expects.
  • An address Ankra and your clusters can reach. Ankra reads the registry’s chart list from its own platform, and each cluster pulls the chart from the registry when it deploys (the agent on the native engine, Argo CD on an Argo CD cluster), signing in with the registry’s credential when it has one.
  • For the CLI steps, the ankra CLI, signed in to your organisation.

Pick the registry kind

The two kinds are added in two places: Typical addresses:

Add an HTTP chart repository

1

Open Helm registries

Open Build & delivery → Helm registries (/next/organisation/helm-registries).The page lists the connected registries with their Charts, State and Last read, and below them Registry credentials.
2

Store the login (private registries only)

Under Registry credentials, select Add credential. Enter a Name (such as harbor-robot), the Username and the Password or token, then select Add credential.The credential appears in the list. Ankra keeps it encrypted and never shows the password again.
3

Add the registry

Select Add registry and fill in:
  • Name - how Stacks refer to this registry. Letters, numbers and dashes, at most 63 characters.
  • Address - the repository, starting with https://. Put the login in a credential, not in the address.
  • Charts to leave out (optional) - chart names Ankra should not read, separated by commas or spaces.
  • Credential - None, a public registry, or the credential you stored.
Select Add registry. Ankra reads the registry right away: its State reads Reading charts, then Up to date with a chart count.

Connect an OCI registry

An oci:// address typed into Add registry is refused with “Connect an OCI registry in Build & delivery > Registries, where Ankra checks its login and lists its projects. Its charts then show here.” That page is Build & delivery → Registries.
1

Start the connection

Open Build & delivery → Registries (/next/organisation/registries) and, under Connected registries, select Connect a registry.The dialog opens on Kind of registry, the first of four steps.
2

Choose the kind

Choose Other OCI registry for GitHub, Docker Hub, ECR, Azure or any other OCI registry, and select Next. Harbor and Google Artifact Registry also let Ankra make robot accounts; they are covered in Harbor as your application registry.
3

Give the address and the login

Enter the registry’s host in Address (for example ghcr.io) and, optionally, a Name in Ankra. Under Admin credential, choose A new one (enter the login, which is sent to Ankra once and never shown again), One already stored, or None for a registry anyone may pull from. Select Next (it reads Find projects when Ankra can sign in and list what the registry holds).
4

Name the projects

Type the projects to connect, separated by commas, and add them. Each project becomes one registry entry at oci://<host>/<project>, named after Name in Ankra. With no project, Ankra connects the host as one entry.
5

Review and connect

Review lists what Ankra will make; nothing is saved until you connect. Select the button that names the count, such as Connect 1 project.The dialog reports what happened, step by step. The new entries appear under Build & delivery → Helm registries, where Ankra reads them like any other registry.
A project name is one path segment (lowercase letters, digits, ., _ and -), so the portal connects oci://ghcr.io/your-org but not oci://ghcr.io/your-org/charts. For an address with a deeper path, use the CLI.

What each provider expects as a login

These are the registries’ own rules; check the provider’s documentation for the current ones.
Username: your GitHub username. Password: a personal access token with the read:packages scope.
Username: _json_key. Password: the JSON key of a service account with the Artifact Registry Reader role.
Username: AWS. Password: the token from aws ecr get-login-password.
ECR tokens expire after 12 hours. Change the credential’s login before it expires, or the registry’s reads fail.
Username: your Docker Hub username. Password: an access token from your Docker Hub settings.
To change a stored login, open the credential’s options (⋮) under Registry credentials and select Change login…. The old login is not shown, so enter the username and password again; registries that sign in with it use the new login from their next read. From the CLI: ankra helm credentials update my-cred --username robot.

Keep the chart list current

Ankra reads each registry on a schedule to find new and updated charts, every 2 minutes unless you change it. Between reads, a chart you just pushed is not listed until someone syncs the registry.
Open the registry from Build & delivery → Helm registries (select its name, or Open in its options).
  • How Ankra reads it shows Last read, Next read and Reads by itself. Sync now reads the registry at once.
  • More (⋮) → Change how often it is read… sets Seconds between reads: 0 turns automatic reads off, otherwise 60 to 86400 seconds (a day). Select Save.
  • Sync history lists each read of the registry’s index (Registry index) and of single charts (One chart), newest first, with its status (Succeeded, Failed, Running, Timed out, Waiting) and what each step printed.

Use the charts in a Stack

Once a registry is read, its charts appear in the stack editor: Add → Helm add-on opens Find a chart, which searches every connected registry. Pick the chart, pin a version, set its values and select Add to draft, then review and deploy the draft. The full flow is in Create and change a stack; browsing charts before you install them is in Charts and the add-on catalogue.

Example: Envoy Gateway and the Gateway API

Envoy Gateway ships its chart as an OCI artifact on Docker Hub, so it installs through an organisation registry:
  1. Connect oci://registry-1.docker.io/envoyproxy as an OCI registry (host registry-1.docker.io, project envoyproxy). It is public, so choose None as the credential.
  2. Add the gateway-helm chart to a Stack as a Helm add-on and pin its version.
  3. Add your GatewayClass, Gateway and HTTPRoute resources as manifests in the same Stack, with the Envoy Gateway add-on as their parent, so they are applied after the chart has installed its CRDs.
  4. Review and deploy the draft.
The same steps apply to any Gateway API implementation that publishes a Helm chart. A cluster Ankra builds can also serve the Gateway API from its networking stack’s Traefik, with no chart of your own: see Gateway API.

Remove a registry

Deleting a registry cannot be undone. Its charts leave the chart list, and Stacks that install a chart from it fail their next deploy until it is connected again.
In Build & delivery → Helm registries, open the registry’s options (⋮), select Delete… and confirm with Delete registry. An OCI registry has Remove or manage in Registries instead: it is removed under Build & delivery → Registries, which first checks the robots that log in through it. The registries Ankra provides to every organisation cannot be deleted.

Ankra’s global registries

Besides the registries you connect, every organisation sees a set of preloaded registries Ankra provides. They power the public catalogue and live in the public ankraio/ankra-global-resources repository:
  • helm_registries/ - the preloaded chart repositories.
  • addons/ - the add-on definitions. See Publishing add-ons.
To propose a registry for every Ankra organisation, fork the repository, add your registry definition to helm_registries/ and open a pull request that describes the charts and what they are for. Once it is merged, the charts are available to every organisation.

Use the API

Scripts can manage registries over the API with an API token:
A private registry adds "credential_name" next to url, naming a registry credential created beforehand.

Verify

Open Build & delivery → Helm registries: the registry’s State reads Up to date with a chart count. Then open a Stack, select Add → Helm add-on and search for one of its charts in Find a chart. From the CLI, ankra helm registries get my-charts lists the charts Ankra read.

What can go wrong