Managing Chart Metadata

1. Setting Chart Annotations

Example: Artifact Hub annotations

annotations:
  category: Database
  licenses: Apache-2.0
  artifacthub.io/license: Apache-2.0
  artifacthub.io/prerelease: "false"
  artifacthub.io/containsSecurityUpdates: "true"
  artifacthub.io/links: |
    - name: source
      url: https://github.com/acme/api
    - name: support
      url: https://github.com/acme/api/issues

2. Adding Custom Metadata

AnnotationPurpose
artifacthub.io/changesPer-release changelog
artifacthub.io/imagesList of bundled container images
artifacthub.io/operator"true" for operator charts
artifacthub.io/signKeyPublic key fingerprint for verification
artifacthub.io/recommendationsRelated charts

3. Documenting Chart Purpose

SectionAudience
README introQuick-start install command
Configuration tableAll values + defaults + descriptions
Architecture diagramHow components interact
ExamplesCommon deployment patterns

4. Listing Chart Dependencies

Example: View resolved deps

helm dependency list ./chart
helm show chart ./chart | yq '.dependencies'

5. Setting Minimum Kubernetes Version

FieldExample
kubeVersion">=1.27.0-0"
EnforcementHelm refuses install on incompatible cluster

6. Adding Chart Maturity

Annotation valueMeaning
"experimental"Early development, API may change
"alpha"Limited testing
"beta"Stabilizing
"stable"Production-ready

7. Linking to Source Code

Example: sources list

sources:
  - https://github.com/acme/api
  - https://github.com/acme/charts
home: https://docs.acme.io/api

8. Providing Support Contacts

maintainers:
  - name: Platform Team
    email: platform@acme.io
annotations:
  artifacthub.io/links: |
    - { name: support, url: https://acme.io/support }
    - { name: slack,   url: https://acme.slack.com/channels/charts }

9. Setting Chart License

FieldFormat
annotations.licensesSPDX identifier (e.g. Apache-2.0, MIT)
LICENSE fileFull license text in chart root

10. Adding Chart Category

CategoryExamples
databasepostgresql, mysql, redis
monitoring-loggingprometheus, grafana, loki
networkingingress-nginx, cert-manager, cilium
securityvault, falco, kyverno
integration-and-deliveryargo-cd, jenkins, tekton