Skip to main content
Publishing proposes an add-on definition your organisation curated to the global Ankra catalogue. Nothing changes until the pull request it opens is reviewed and merged; after that, the add-on appears in the add-on catalogue of every organisation on Ankra.

What publishing does

The add-on catalogue every organisation sees is backed by a public Git repository, ankraio/ankra-global-resources. Each globally available add-on is one kind: Addon manifest in that repository’s addons/ directory - a small YAML file carrying the add-on’s name, display metadata, and the match rules that link Helm charts to it. When you publish an add-on:
  1. Ankra renders your organisation’s definition as a kind: Addon manifest.
  2. It opens a pull request against the catalogue repository on your behalf, on a dedicated branch.
  3. The Ankra team reviews the pull request. Merging it is the approval.
  4. The platform sync ingests the merged manifest, and the add-on becomes available to all organisations.
Your organisation keeps its own copy of the definition. An organisation-scoped add-on always shadows the global one with the same name, so publishing never changes what your own catalogue shows you.

Who can publish

Publishing puts your organisation’s name on a pull request against a public repository, and once merged the entry is visible to every organisation on Ankra. It therefore requires the Manage Helm registries permission (helm.manage), which organisation admins and owners hold. Anyone else can read the preview of what publishing would propose, which says they may not publish, but cannot submit it.

Publishing an add-on

The portal has no screen for publishing an add-on, the CLI has no publish command, and the API has no publish route for an API token. Contact support to propose an add-on your organisation curated.

What cannot be published

The catalogue repository is public, and a pull request is effectively permanent: a credential that reaches it stays in the repository’s history even if the branch is later closed. Ankra screens the rendered manifest before it can be proposed and refuses anything carrying:
  • credentials embedded in a URL, such as https://user:password@host
  • recognisable provider tokens (GitHub, GitLab, AWS, Slack, generic API secret keys) or a PEM private key block
The offending field is named so it can be corrected. This is a check on the ten metadata fields an add-on definition publishes; it is not a substitute for keeping credentials out of your definitions in the first place.

Tracking a publish

A publish request carries the link of its pull request and a state: The platform re-checks open pull requests and moves their state on by itself.

The Addon manifest

The manifest published for your add-on mirrors the definition fields:
spec.name is the add-on’s unique slug across the catalogue. The match rules (match_chart_names, match_keywords, match_home_url_prefixes) determine which Helm charts resolve to the add-on in every organisation’s catalogue.

Removing a published add-on

Removing the manifest from the catalogue repository, again through a pull request, retires the global add-on. Organisations that defined their own add-on of the same name keep it; only the shared, Ankra-curated entry goes away.