Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/helm/chartmuseum

helm chart repository server
https://github.com/helm/chartmuseum

chartmuseum charts helm kubernetes

Last synced: 11 days ago
JSON representation

helm chart repository server

Awesome Lists containing this project

README 

        
# ChartMuseum



[![GitHub Actions status](https://github.com/helm/chartmuseum/workflows/build/badge.svg)](https://github.com/helm/chartmuseum/actions?query=workflow%3Abuild)

[![Go Report Card](https://goreportcard.com/badge/github.com/helm/chartmuseum)](https://goreportcard.com/report/github.com/helm/chartmuseum)

[![GoDoc](https://godoc.org/github.com/helm/chartmuseum?status.svg)](https://godoc.org/github.com/helm/chartmuseum)







*ChartMuseum* is an open-source **[Helm Chart Repository](https://helm.sh/docs/topics/chart_repository/)** server written in Go (Golang), with support for cloud storage backends, including [Google Cloud Storage](https://cloud.google.com/storage/), [Amazon S3](https://aws.amazon.com/s3/), [Microsoft Azure Blob Storage](https://azure.microsoft.com/en-us/services/storage/blobs/), [Alibaba Cloud OSS Storage](https://www.alibabacloud.com/product/oss), [Openstack Object Storage](https://developer.openstack.org/api-ref/object-store/), [Oracle Cloud Infrastructure Object Storage](https://cloud.oracle.com/storage), [Baidu Cloud BOS Storage](https://cloud.baidu.com/product/bos.html), [Tencent Cloud Object Storage](https://intl.cloud.tencent.com/product/cos), [DigitalOcean Spaces](https://www.digitalocean.com/products/spaces/), [Minio](https://min.io/), and [etcd](https://etcd.io/).



Works as a valid Helm Chart Repository, and also provides an API for uploading charts.








Powered by some great Go technology:

- [helm/helm](https://github.com/helm/helm) - for working with charts

- [gin-gonic/gin](https://github.com/gin-gonic/gin) - for HTTP routing

- [urfave/cli](https://github.com/urfave/cli) - for command line option parsing

- [spf13/viper](https://github.com/spf13/viper) - for configuration

- [uber-go/zap](https://github.com/uber-go/zap) - for logging

- [chartmuseum/auth](https://github.com/chartmuseum/auth) - for auth

- [chartmuseum/storage](https://github.com/chartmuseum/storage) - for multi-cloud storage



## API



### Helm Chart Repository

- `GET /index.yaml` - retrieved when you run `helm repo add chartmuseum http://localhost:8080/`

- `GET /charts/mychart-0.1.0.tgz` - retrieved when you run `helm install chartmuseum/mychart`

- `GET /charts/mychart-0.1.0.tgz.prov` - retrieved when you run `helm install` with the `--verify` flag



### Chart Manipulation

- `POST /api/charts` - upload a new chart version

- `POST /api/prov` - upload a new provenance file

- `DELETE /api/charts//` - delete a chart version (and corresponding provenance file)

- `GET /api/charts` - list all charts

- `GET /api/charts/` - list all versions of a chart

- `GET /api/charts//` - describe a chart version

- `GET /api/charts///templates` - get chart template

- `GET /api/charts///values` - get chart values

- `HEAD /api/charts/` - check if chart exists (any versions)

- `HEAD /api/charts//` - check if chart version exists



### Server Info

- `GET /` - HTML welcome page

- `GET /info` - returns current ChartMuseum version

- `GET /health` - returns 200 OK



## Uploading a Chart Package

*Follow **"How to Run"** section below to get ChartMuseum up and running at http://localhost:8080*



First create `mychart-0.1.0.tgz` using the [Helm CLI](https://docs.helm.sh/using_helm/#installing-helm):

```

cd mychart/

helm package .

```



Upload `mychart-0.1.0.tgz`:

```bash

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

```



If you've signed your package and generated a [provenance file](https://github.com/helm/helm-www/blob/master/content/en/docs/topics/provenance.md), upload it with:

```bash

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

```



Both files can also be uploaded at once (or one at a time) on the `/api/charts` route using the `multipart/form-data` format:



```bash

curl -F "[email protected]" -F "[email protected]" http://localhost:8080/api/charts

```



You can also use the [helm-push plugin](https://github.com/chartmuseum/helm-push):

```

helm cm-push mychart/ chartmuseum

```



## Installing Charts into Kubernetes

Add the URL to your *ChartMuseum* installation to the local repository list:

```bash

helm repo add chartmuseum http://localhost:8080

```



Search for charts:

```bash

helm search repo chartmuseum/

```



Install chart:

```bash

helm install chartmuseum/mychart --generate-name

```



## How to Run

### CLI

#### Installation



You can use the installer script:

```

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

```



or download manually from the [releases page](https://github.com/helm/chartmuseum/releases),

which also contains all package checksums and signatures.



Determine your version with `chartmuseum --version`.



#### Configuration

Show all CLI options with `chartmuseum --help`. Common configurations can be seen below.



All command-line options can be specified as environment variables, which are defined by the command-line option, capitalized, with all `-`'s replaced with `_`'s.



For example, the env var `STORAGE_AMAZON_BUCKET` can be used in place of `--storage-amazon-bucket`.



##### Using a configuration file

Use `chartmuseum --config config.yaml` to read configuration from a file.



When using file-based configuration, the corresponding option name can be looked up in [`pkg/config/vars.go`]( https://github.com/helm/chartmuseum/blob/main/pkg/config/vars.go). It would be the key of `configVars` entry corresponding to the command line option / environment variable. For example, `--storage` corresponds to `storage.backend` in the configuration file.



Here's a complete example of a `config.yaml`:



```yaml

debug: true

port: 8080

storage.backend: local

storage.local.rootdir: 

bearerauth: 1

authrealm: 

authservice: 

authcertpath: 

authactionssearchpath: 

depth: 2

```



#### Using with Amazon S3 or Compatible services like Minio or DigitalOcean.

Make sure your environment is properly setup to access `my-s3-bucket`



For Amazon S3, `endpoint` is automatically inferred.

```bash

chartmuseum --debug --port=8080 \

  --storage="amazon" \

  --storage-amazon-bucket="my-s3-bucket" \

  --storage-amazon-prefix="" \

  --storage-amazon-region="us-east-1"

```



For S3 compatible services like Minio, set the credentials using environment variables and pass the `endpoint`.



```bash

export AWS_ACCESS_KEY_ID=""

export AWS_SECRET_ACCESS_KEY=""

chartmuseum --debug --port=8080 \

  --storage="amazon" \

  --storage-amazon-bucket="my-s3-bucket" \

  --storage-amazon-prefix="" \

  --storage-amazon-region="us-east-1" \

  --storage-amazon-endpoint="my-s3-compatible-service-endpoint"

```



You need at least the following permissions inside your IAM Policy

```yaml

{

  "Version": "2012-10-17",

  "Statement": [

    {

      "Sid": "AllowListObjects",

      "Effect": "Allow",

      "Action": [

        "s3:ListBucket"

      ],

      "Resource": "arn:aws:s3:::my-s3-bucket"

    },

    {

      "Sid": "AllowObjectsCRUD",

      "Effect": "Allow",

      "Action": [

        "s3:DeleteObject",

        "s3:GetObject",

        "s3:PutObject"

      ],

      "Resource": "arn:aws:s3:::my-s3-bucket/*"

    }

  ]

}

```



In order to work with AWS service accounts you may need to set `AWS_SDK_LOAD_CONFIG=1` in your environment.

For more context, please see [here](https://github.com/helm/chartmuseum/issues/280#issuecomment-592292527).



If you are using S3-Compatible storage, provider of S3 storage has [disabled path-style and force virtual hosted-style](https://aws.amazon.com/cn/blogs/aws/amazon-s3-path-deprecation-plan-the-rest-of-the-story/), you can use specify `storage-amazon-force-path-style` options as following example:

```

export AWS_ACCESS_KEY_ID=""

export AWS_SECRET_ACCESS_KEY=""

chartmuseum --debug --port=8080 \

  --storage="amazon" \

  --storage-amazon-bucket="my-s3-bucket" \

  --storage-amazon-prefix="" \

  --storage-amazon-region="us-east-1" \

  --storage-amazon-endpoint="my-s3-compatible-service-endpoint"

  --storage-amazon-force-path-style=false

```



For DigitalOcean, set the credentials using environment variable and pass the `endpoint`.

Note below, that the region `us-east-1` needs to be set, since that is how the DigitalOcean cli implementation functions. The actual region of your spaces location is defined by the endpoint. Below we are using Frankfurt as an example.

```bash

export AWS_ACCESS_KEY_ID="spaces_access_key"

export AWS_SECRET_ACCESS_KEY="spaces_secret_key"

  chartmuseum --debug --port=8080 \

  --storage="amazon" \

  --storage-amazon-bucket="my_spaces_name" \

  --storage-amazon-prefix="my_spaces_name_subfolder" \

  --storage-amazon-region="us-east-1" \

  --storage-amazon-endpoint="https://fra1.digitaloceanspaces.com"

```

The access_key and secret_key can be generated from the DigitalOcean console, under the section API/Spaces_access_keys.



Note: on certain S3-based storage backends, the `LastModified` field on objects

is truncated to the nearest second. For more info, please see issue [#152](https://github.com/helm/chartmuseum/issues/152).



In order to mitigate this, you may use use the `--storage-timestamp-tolerance` option.

For example, to round to the nearest second, you could use `--storage-timestamp-tolerance=1s`.

For acceptable values to use for this field, please see [here](https://golang.org/pkg/time/#ParseDuration).



#### Using with Google Cloud Storage

Make sure your environment is properly setup to access `my-gcs-bucket`.



One way to do so is to set the `GOOGLE_APPLICATION_CREDENTIALS` var in your environment, pointing to the JSON file containing your service account key:

```

export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/[FILE_NAME].json"

```



More info on Google Cloud authentication can be found [here](https://cloud.google.com/docs/authentication/getting-started).



```bash

chartmuseum --debug --port=8080 \

  --storage="google" \

  --storage-google-bucket="my-gcs-bucket" \

  --storage-google-prefix=""

```



#### Using with Microsoft Azure Blob Storage



Make sure your environment is properly setup to access `mycontainer`.



To do so, you must set the following env vars:

- `AZURE_STORAGE_ACCOUNT`

- `AZURE_STORAGE_ACCESS_KEY`



```bash

chartmuseum --debug --port=8080 \

  --storage="microsoft" \

  --storage-microsoft-container="mycontainer" \

  --storage-microsoft-prefix=""

```



#### Using with Alibaba Cloud OSS Storage



Make sure your environment is properly setup to access `my-oss-bucket`.



To do so, you must set the following env vars:

- `ALIBABA_CLOUD_ACCESS_KEY_ID`

- `ALIBABA_CLOUD_ACCESS_KEY_SECRET`



```bash

chartmuseum --debug --port=8080 \

  --storage="alibaba" \

  --storage-alibaba-bucket="my-oss-bucket" \

  --storage-alibaba-prefix="" \

  --storage-alibaba-endpoint="oss-cn-beijing.aliyuncs.com"

```



#### Using with Openstack Object Storage



Make sure your environment is properly setup to access `mycontainer`.



To do so, you must set the following env vars (depending on your openstack version):

- `OS_AUTH_URL`

- either `OS_PROJECT_NAME` or `OS_TENANT_NAME` or `OS_PROJECT_ID` or `OS_TENANT_ID`

- either `OS_DOMAIN_NAME` or `OS_DOMAIN_ID`

- either `OS_USERNAME` or `OS_USERID`

- `OS_PASSWORD`



```bash

chartmuseum --debug --port=8080 \

  --storage="openstack" \

  --storage-openstack-container="mycontainer" \

  --storage-openstack-prefix="" \

  --storage-openstack-region="myregion"

```



For Swift V1 Auth you must set the following env vars:

- `ST_AUTH`

- `ST_USER`

- `ST_KEY`



```bash

chartmuseum --debug --port=8080 \

  --storage="openstack" \

  --storage-openstack-auth="v1" \

  --storage-openstack-container="mycontainer" \

  --storage-openstack-prefix=""

```



#### Using with Oracle Cloud Infrastructure Object Storage



Make sure your environment is properly setup to access `my-ocs-bucket`.



More info on Oracle Cloud Infrastructure authentication can be found [here](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm).



```bash

chartmuseum --debug --port=8080 \

  --storage="oracle" \

  --storage-oracle-bucket="my-ocs-bucket" \

  --storage-oracle-prefix="" \

  --storage-oracle-compartmentid="ocid1.compartment.oc1..1234"

```



#### Using with Baidu Cloud BOS Storage



Make sure your environment is properly setup to access `my-bos-bucket`.



To do so, you must set the following env vars:

- `BAIDU_CLOUD_ACCESS_KEY_ID`

- `BAIDU_CLOUD_ACCESS_KEY_SECRET`



```bash

chartmuseum --debug --port=8080 \

  --storage="baidu" \

  --storage-baidu-bucket="my-bos-bucket" \

  --storage-baidu-prefix="" \

  --storage-baidu-endpoint="bj.bcebos.com"

```



#### Using with Tencent Cloud COS Storage



Make sure your environment is properly setup to access `my-cos-bucket`.



To do so, you must set the following env vars:

- `TENCENT_CLOUD_COS_SECRET_ID`

- `TENCENT_CLOUD_COS_SECRET_KEY`



```bash

chartmuseum --debug --port=8080 \

  --storage="tencent" \

  --storage-tencent-bucket="my-cos-bucket" \

  --storage-tencent-prefix="" \

  --storage-tencent-endpoint="cos.ap-beijing.myqcloud.com"

```



#### Using with etcd



To use etcd as backend you need the CA certificate and the signed key pair.

See [here](https://coreos.com/etcd/docs/latest/op-guide/security.html)



```bash

chartmuseum --debug --port=8080 \

  --storage="etcd" \

  --storage-etcd-cafile="/path/to/ca.crt" \

  --storage-etcd-certfile="/path/to/server.crt" \

  --storage-etcd-keyfile="/path/to/server.key" \

  --storage-etcd-prefix="" \

  --storage-etcd-endpoint="http://localhost:2379"

```



#### Using with local filesystem storage

Make sure you have read-write access to `./chartstorage` (will create if doesn't exist on first upload)

```bash

chartmuseum --debug --port=8080 \

  --storage="local" \

  --storage-local-rootdir="./chartstorage"

```



#### Basic Auth

If both of the following options are provided, basic http authentication will protect all routes:

- `--basic-auth-user=` - username for basic http authentication

- `--basic-auth-pass=` - password for basic http authentication



You may want basic auth to only be applied to operations that can change Charts, i.e. PUT, POST and DELETE.  So to avoid basic auth on GET operations use



- `--auth-anonymous-get` - allow anonymous GET operations



#### Bearer/Token Auth



If all of the following options are provided, bearer auth will protect all routes:

- `--bearer-auth` - enables bearer auth

- `--auth-realm=` - authorization server url

- `--auth-service=` - authorization server service name

- `--auth-cert-path=` - path to authorization server public pem file

- `--auth-actions-search-path=` - (optional) JMESPath to find allowed actions in a jwt token



Using options above, *ChartMuseum* is configured with a public key, and will accept RS256 JWT tokens signed by the associated private key, passed in the `Authorization` header. You can use the [chartmuseum/auth](https://github.com/chartmuseum/auth) Go library to generate valid JWT tokens.



##### JWT Token without a custom JMESPath to find actions



In order to gain access to a specific resource, the JWT token must contain an `access` section in the claims. This section indicates which resources the user is able to access. Here is an example token payload:



```json

{

  "exp": 1543995770,

  "iat": 1543995470,

  "access": [

    {

      "type": "artifact-repository",

      "name": "org1/repo1",

      "actions": [

        "pull"

      ]

    }

  ]

}

```



The `type` is always "artifact-repository", the `name` is the namespace/tenant (just use the string "repo" if using single-tenant server), and `actions` is an array of actions the user can perform ("pull" and/or "push).



If your JWT token structure is different, you can configure a [JMESPath string](https://jmespath.org/). So you can define the way to find the allowed actions yourself.

For the `type` and the the `name` you can use following placeholder

* name: `$NAMESPACE`

* type: `$ACCESS_ENTRY_TYPE`



E.g.: If you want to represent the default configuration, the JMESPath looks like: `access[?name=='$NAMESPACE' && type=='$ACCESS_ENTRY_TYPE'].actions[]`.



For more information about how this works, please see [chartmuseum/auth-server-example](https://github.com/chartmuseum/auth-server-example).



#### HTTPS

If both of the following options are provided, the server will listen and serve HTTPS:

- `--tls-cert=` - path to tls certificate chain file

- `--tls-key=` - path to tls key file



##### HTTPS with Client Certificate Authentication

If the above HTTPS values are provided in addition to below, the server will listen and serve HTTPS and authenticate client requests against the CA certificate:

-  `--tls-ca-cert=` - path to tls certificate file



#### Just generating index.yaml

You can specify the `--gen-index` option if you only wish to use _ChartMuseum_ to generate your index.yaml file. Note that this will only work with `--depth=0`.



The contents of index.yaml will be printed to stdout and the program will exit. This is useful if you are satisfied with your current Helm CI/CD process and/or don't want to monitor another webservice.



#### Other CLI options

- `--log-json` - output structured logs as json

- `--log-health` - log incoming /health requests

- `--log-latency-integer` - log latency as an integer (nanoseconds) instead of a string

- `--disable-api` - disable all routes prefixed with /api

- `--disable-delete` - explicitly disable the delete chart route

- `--disable-statefiles` - disable use of index-cache.yaml

- `--allow-overwrite` - allow chart versions to be re-uploaded without ?force querystring

- `--disable-force-overwrite` - do not allow chart versions to be re-uploaded, even with ?force querystring

- `--chart-url=` - absolute url for .tgzs in index.yaml

- `--storage-amazon-endpoint=` - alternative s3 endpoint

- `--storage-amazon-sse=` - s3 server side encryption algorithm

- `--storage-openstack-cacert=` - path to a custom ca certificates bundle for openstack

- `--chart-post-form-field-name=` - form field which will be queried for the chart file content

- `--prov-post-form-field-name=` - form field which will be queried for the provenance file content

- `--index-limit=` - limit the number of parallel indexers

- `--context-path=` - base context path (new root for application routes)

- `--depth=` - levels of nested repos for multitenancy

- `--cors-alloworigin=` - value to set in the Access-Control-Allow-Origin HTTP header

- `--read-timeout=` - socket read timeout for http server

- `--write-timeout=` - socker write timeout for http server



### Docker Image

Available via [GitHub Container Registry (GHCR)](https://github.com/orgs/helm/packages/container/package/chartmuseum).



Example usage (local storage):

```bash

docker run --rm -it \

  -p 8080:8080 \

  -e DEBUG=1 \

  -e STORAGE=local \

  -e STORAGE_LOCAL_ROOTDIR=/charts \

  -v $(pwd)/charts:/charts \

  ghcr.io/helm/chartmuseum:v0.16.2

```



Example usage (S3):

```bash

docker run --rm -it \

  -p 8080:8080 \

  -e DEBUG=1 \

  -e STORAGE="amazon" \

  -e STORAGE_AMAZON_BUCKET="my-s3-bucket" \

  -e STORAGE_AMAZON_PREFIX="" \

  -e STORAGE_AMAZON_REGION="us-east-1" \

  -v ~/.aws:/home/chartmuseum/.aws:ro \

  ghcr.io/helm/chartmuseum:v0.16.2

```



### Helm Chart

There is a [Helm chart for *ChartMuseum*](https://github.com/chartmuseum/charts/tree/main/src/chartmuseum) itself.



You can also view it on [Artifact Hub](https://artifacthub.io/packages/helm/chartmuseum/chartmuseum).



To install:

```bash

helm repo add chartmuseum https://chartmuseum.github.io/charts

helm install chartmuseum/chartmuseum

```



If interested in making changes, please submit a PR to [chartmuseum/charts](https://github.com/chartmuseum/charts). Before doing any work, please check for any [currently open pull requests](https://github.com/chartmuseum/charts/pulls?q=is%3Apr+is%3Aopen). Thanks!



## Multitenancy

Multitenancy is supported with the `--depth` flag.



To begin, start with a directory structure such as

```

charts

├── org1

│   ├── repoa

│   │   └── nginx-ingress-0.9.3.tgz

├── org2

│   ├── repob

│   │   └── chartmuseum-0.4.0.tgz

```



This represents a storage layout appropriate for `--depth=2`. The organization level can be eliminated by using `--depth=1`. The default depth is 0 (singletenant server).



Start the server with `--depth=2`, pointing to the `charts/` directory:

```

chartmuseum --debug --depth=2 --storage="local" --storage-local-rootdir=./charts

```



This example will provide two separate Helm Chart Repositories at the following locations:

- `http://localhost:8080/org1/repoa`

- `http://localhost:8080/org2/repob`



This should work with all supported storage backends.



To use the chart manipulation routes, simply place the name of the repo directly after "/api" in the route:



```bash

curl -F "[email protected]" http://localhost:8080/api/org1/repoa/charts

```



You may also experiment with the `--depth-dynamic` flag, which should allow for dynamic depth levels (i.e. all of `/api/charts`, `/api/myrepo/charts`, `/api/org1/repoa/charts`).



## Pagination



For large chart repositories, you may wish to paginate the results from the `GET /api/charts` route.



To do so, add the `offset` and `limit` query params to the request. For example, to retrieve a list of 5 charts total, skipping the first 5 charts, you could use the following:



```

GET /api/charts?offset=5&limit=5

```



## Cache



By default, the contents of `index.yaml` (per-tenant) will be stored in memory. This means that memory usage will continue to grow indefinitely as more charts are added to storage.



You may wish to offload this to an external cache store, especially for large, multitenant installations.



### Cache Interval



When dealing with thousands of charts, you may experience latency with the default settings. This is because upon each request, the storage backend is scanned for changes compared to the cache.



If you are ok with `index.yaml` being out-of-date for a fixed period of time, you can improve performance by using the `--cache-interval=` option.

When this setting is enabled, the charts available for each tenant are refreshed on a timer.



For example, to only check storage every 5 minutes, you can use `--cache-interval=5m`.



For valid values to use for this setting, please see [here](https://godoc.org/time#ParseDuration).



### Using Redis



Example of using Redis as an external cache store:

```bash

chartmuseum --debug --port=8080 \

  --storage="local" \

  --storage-local-rootdir="./chartstorage" \

  --cache="redis" \

  --cache-redis-addr="localhost:6379" \

  --cache-redis-password="" \

  --cache-redis-db=0

```



## Prometheus Metrics



ChartMuseum exposes its [Prometheus metrics](https://prometheus.io/docs/concepts/metric_types/) at the `/metrics` route on the main port. This can be enabled with the `--enable-metrics` command-line flag or the `ENABLE_METRICS` environment variable.



> Note that the Kubernetes chart currently disables metrics by default (`ENABLE_METRICS=false` is set in the chart). The `--disable-metrics` command-line flag has be deprecated and will only be available in `v0.14.0` and prior.



Below are the current application metrics exposed. Note that there is a per tenant (repo) label. The repo label corresponds to the depth parameter, so a depth=2 as the example above would

have repo labels named `org1/repoa` and `org2/repob`.



| Metric                                   | Type  | Labels     | Description                              |

| ---------------------------------------- | ----- | ---------- | ---------------------------------------- |

| chartmuseum_charts_served_total          | Gauge | {repo="*"} | Total number of charts                   |

| chartmuseum_chart_versions_served_total | Gauge | {repo="*"} | Total number of chart versions available |



*: see above for repo label



There are other general global metrics harvested (per process, hence for all tenants). You can get the complete list by using the `/metrics` route.



| Metric                                     | Type    | Labels                                                | Description                               |

| ------------------------------------------ | ------- | ----------------------------------------------------- | ----------------------------------------- |

| chartmuseum_request_duration_seconds       | Summary | {quantile="0.5"}, {quantile="0.9"}, {quantile="0.99"} | The HTTP request latencies in seconds     |

| chartmuseum_request_duration_seconds_sum   |         |                                                       |                                           |

| chartmuseum_request_duration_seconds_count |         |                                                       |                                           |

| chartmuseum_request_size_bytes             | Summary | {quantile="0.5"}, {quantile="0.9"}, {quantile="0.99"} | The HTTP request sizes in bytes           |

| chartmuseum_request_size_bytes_sum         |         |                                                       |                                           |

| chartmuseum_request_size_bytes_count       |         |                                                       |                                           |

| chartmuseum_response_size_bytes            | Summary | {quantile="0.5"}, {quantile="0.9"}, {quantile="0.99"} | The HTTP response sizes in bytes          |

| chartmuseum_response_size_bytes_sum        |         |                                                       |                                           |

| chartmuseum_response_size_bytes_count      |         |                                                       |                                           |

| go_goroutines                              | Gauge   |                                                       | Number of goroutines that currently exist |



## Notes on index.yaml

The repository index (index.yaml) is dynamically generated based on packages found in storage. If you store your own version of index.yaml, it will be completely ignored.



`GET /index.yaml` occurs when you run `helm repo add chartmuseum http://localhost:8080` or `helm repo update`.



If you manually add/remove a .tgz package from storage, it will be immediately reflected in `GET /index.yaml`.



You are no longer required to maintain your own version of index.yaml using `helm repo index --merge`.



The `--gen-index` CLI option (described above) can be used to generate and print index.yaml to stdout.



Upon index regeneration, *ChartMuseum* will, however, save a statefile in storage called `index-cache.yaml` used for cache optimization. This file is only meant for internal use, but may be able to be used for migration to simple storage.



## Mirroring the official Kubernetes repositories

Please see `scripts/mirror-k8s-repos.sh` for an example of how to download all .tgz packages from the official Kubernetes repositories (both stable and incubator).



You can then use *ChartMuseum* to serve up an internal mirror:

```

scripts/mirror-k8s-repos.sh

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

 ```



## Custom Welcome Page



With the flag `--web-template-path=`, you can specify the path to your custom welcome page.



The structure of the folder should be like this:



```bash

web/

  index.html

  xyz.html

  static/

      main.css

      main.js

```



> ChartMuseum is using gin-gonic to serve the static files, this means that you can use go-template to render the files.



If you don't specify a custom welcome page, ChartMuseum will serve the default one.



#### Artifact Hub



By setting the flag `--artifact-hub-repo-id `, ChartMuseum will serve a `artifacthub-repo.yml` file with the

specified repo ID in the `repositoryID` field of the yaml file.



```yaml

repositoryID: The ID of the Artifact Hub repository where the packages will be published to (optional, but it enables verified publisher)

```



##### Multitenancy



For multitenancy setups, you can provide a key value pair to the flag in the format: `--artifact-hub-repo-id =`



```bash

chartmuseum --storage local --storage-local-rootdir /tmp/ --depth 1 --artifact-hub-repo-id org1= --artifact-hub-repo-id org2=

```



The `artifacthub-repo.yml` file will then be served at `/org1/artifacthub-repo.yml` and `/org2/artifacthub-repo.yml`



## Original Logo



**_"Preserve your precious artifacts... in the cloud!"_**



![](./logo.png)



## Subprojects



The following subprojects are maintained by *ChartMuseum*:



- [chartmuseum/helm-push](https://github.com/chartmuseum/helm-push) - Helm plugin to push chart package to ChartMuseum

- [chartmuseum/storage](https://github.com/chartmuseum/storage) - Go library providing common interface for working across multiple cloud storage backends

- [chartmuseum/auth](https://github.com/chartmuseum/auth) - Go library for generating ChartMuseum JWT Tokens, authorizing HTTP requests, etc.

- [chartmuseum/auth-server-example](https://github.com/chartmuseum/auth-server-example) - Example server providing JWT tokens for ChartMuseum auth

- [chartmuseum/testbed](https://github.com/chartmuseum/testbed) - Docker testbed for continuous integration

- [chartmuseum/www](https://github.com/chartmuseum/www) - chartmuseum.com static site source code

- [chartmuseum/ui](https://github.com/chartmuseum/ui) - ChartMuseum frontend UI



## Community

You can reach the *ChartMuseum* community and developers in the [Kubernetes Slack](https://slack.k8s.io) **#chartmuseum** channel.