ChartMuseum Documentation

ChartMuseum is an open-source Helm Chart Repository server written in Go. It functions as a valid Helm Chart Repository and provides an API for uploading and managing charts. It supports various cloud storage backends including:

• Google Cloud Storage
• Amazon S3
• Microsoft Azure Blob Storage
• Alibaba Cloud OSS Storage
• Openstack Object Storage
• Oracle Cloud Infrastructure Object Storage
• Baidu Cloud BOS Storage
• Tencent Cloud Object Storage
• DigitalOcean Spaces
• Minio
• etcd

To use charts stored in ChartMuseum with the Helm CLI, follow these steps:

1. Add the repository to your local Helm configuration:

   helm repo add chartmuseum http://localhost:8080

2. Search for available charts:

   helm search repo chartmuseum/

3. Install a chart:

   helm install chartmuseum/mychart --generate-name

Use the local storage backend and specify a root directory. Ensure ChartMuseum has read-write access to this path.

chartmuseum --debug --port=8080 \
  --storage="local" \
  --storage-local-rootdir="./chartstorage"

You can install ChartMuseum using an official installer script or by downloading binaries manually from the GitHub releases page. Use chartmuseum --version to verify your installation.

curl https://raw.githubusercontent.com/helm/chartmuseum/main/scripts/get-chartmuseum | bash

Set the AZURE_STORAGE_ACCOUNT and AZURE_STORAGE_ACCESS_KEY environment variables, then use the microsoft storage backend.

chartmuseum --debug --port=8080 \
  --storage="microsoft" \
  --storage-microsoft-container="mycontainer" \
  --storage-microsoft-prefix=""

The ChartMuseum loadtesting subproject uses pipenv for dependency management. To set up the environment, install pipenv via pip, navigate to the loadtesting directory, and run pipenv install to install the required dependencies, including the locust library.

pip install pipenv
cd loadtesting
pipenv install

ChartMuseum can be configured using three methods:

1. CLI Flags: Use flags like --port or --storage.
2. Environment Variables: All CLI options can be set as environment variables. Convert the flag to uppercase and replace hyphens (-) with underscores (_). For example, --storage-amazon-bucket becomes STORAGE_AMAZON_BUCKET.
3. Configuration File: Use the --config <path> flag to load a YAML file.

Example config.yaml structure:

debug: true
port: 8080
storage.backend: local
storage.local.rootdir: <storage_path>
bearerauth: 1
authrealm: <authorization server url>
authservice: <authorization server service name>
authcertpath: <path to authorization server public pem file>
authactionssearchpath: <optional: JMESPath to find allowed actions in a jwt token>
depth: 2

Use the oracle storage backend and provide the bucket and compartment ID.

chartmuseum --debug --port=8080 \
  --storage="oracle" \
  --storage-oracle-bucket="my-ocs-bucket" \
  --storage-oracle-prefix="" \
  --storage-oracle-compartmentid="ocid1.compartment.oc1..1234"

To enable HTTPS, provide the certificate and key:

• --tls-cert=<crt>
• --tls-key=<key>

To enable Client Certificate Authentication, also provide the CA certificate:

• --tls-ca-cert=<cacert>

Once the environment is set up and a ChartMuseum instance is running (e.g., at http://localhost:8080), you can start the Locust loadtesting tool using pipenv run locust.

After starting the process, open your browser and navigate to http://localhost:8089 to access the Locust web console and initiate a new loadtest.

# run locust on a running chartmuseum instance
pipenv run locust --host http://localhost:8080

You can upload charts to ChartMuseum using curl or the helm-push plugin.

Using curl (Binary Data)

To upload a packaged chart:

curl --data-binary "@mychart-0.1.0.tgz" http://localhost:8080/api/charts

To upload a provenance file separately:

curl --data-binary "@mychart-0.1.0.tgz.prov" http://localhost:8080/api/prov

Using curl (Multipart Form Data)

You can upload both the chart and the provenance file in a single request:

curl -F "chart=@mychart-0.1.0.tgz" -F "prov=@mychart-0.1.0.tgz.prov" http://localhost:8080/api/charts

Using helm-push plugin

If you have the helm-push plugin installed, use:

helm cm-push mychart/ chartmuseum

# Package the chart first
cd mychart/
helm package .

# Upload the chart
curl --data-binary "@mychart-0.1.0.tgz" http://localhost:8080/api/charts