diff --git a/incubator/chartmuseum/Chart.yaml b/incubator/chartmuseum/Chart.yaml index 2c664ec4c0..01c39b2e6b 100644 --- a/incubator/chartmuseum/Chart.yaml +++ b/incubator/chartmuseum/Chart.yaml @@ -1,7 +1,7 @@ apiVersion: v1 description: Helm Chart Repository with support for Amazon S3 and Google Cloud Storage name: chartmuseum -version: 0.4.1 +version: 0.4.2 appVersion: 0.4.1 home: https://github.com/chartmuseum/chartmuseum icon: https://raw.githubusercontent.com/chartmuseum/chartmuseum/master/logo.png diff --git a/incubator/chartmuseum/README.md b/incubator/chartmuseum/README.md index 0ab365a859..46c1eaa046 100644 --- a/incubator/chartmuseum/README.md +++ b/incubator/chartmuseum/README.md @@ -12,7 +12,9 @@ Please also see https://github.com/kubernetes-helm/chartmuseum ## Configuration -By default this chart will not have persistent storage. +By default this chart will not have persistent storage, and the API service +will be *DISABLED*. This protects against unauthorized access to the API +with default configuration values. For a more robust solution supply helm install with a custom values.yaml You are also required to create the StorageClass resource ahead of time: @@ -23,28 +25,60 @@ kubectl create -f /path/to/storage_class.yaml The following tables lists common configurable parameters of the chart and their default values. See values.yaml for all available options. -| Parameter | Description | Default | -|------------------------------|---------------------------------------------|-----------------------------------------------------| -| `image.pullPolicy` | Container pull policy | `IfNotPresent` | -| `image.repository` | Container image to use | `chartmuseum/chartmuseum` | -| `image.tag` | Container image tag to deploy | `v0.4.1` | -| `persistence.accessMode` | Access mode to use for PVC | `ReadWriteOnce` | -| `persistence.enabled` | Whether to use a PVC for persistent storage | `false` | -| `persistence.size` | Amount of space to claim for PVC | `8Gi` | -| `persistence.storageClass` | Storage Class to use for PVC | `-` | -| `replicaCount` | k8s replicas | `1` | -| `resources.limits.cpu` | Container maximum CPU | `100m` | -| `resources.limits.memory` | Container maximum memory | `128Mi` | -| `resources.requests.cpu` | Container requested CPU | `80m` | -| `resources.requests.memory` | Container requested memory | `64Mi` | -| `nodeSelector` | Map of node labels for pod assignment | `{}` | -| `tolerations` | List of node taints to tolerate | `[]` | -| `affinity` | Map of node/pod affinities | `{}` | +| Parameter | Description | Default | +|----------------------------------------|---------------------------------------------|-----------------------------------------------------| +| `image.pullPolicy` | Container pull policy | `IfNotPresent` | +| `image.repository` | Container image to use | `chartmuseum/chartmuseum` | +| `image.tag` | Container image tag to deploy | `v0.4.1` | +| `persistence.accessMode` | Access mode to use for PVC | `ReadWriteOnce` | +| `persistence.enabled` | Whether to use a PVC for persistent storage | `false` | +| `persistence.size` | Amount of space to claim for PVC | `8Gi` | +| `persistence.storageClass` | Storage Class to use for PVC | `-` | +| `replicaCount` | k8s replicas | `1` | +| `resources.limits.cpu` | Container maximum CPU | `100m` | +| `resources.limits.memory` | Container maximum memory | `128Mi` | +| `resources.requests.cpu` | Container requested CPU | `80m` | +| `resources.requests.memory` | Container requested memory | `64Mi` | +| `nodeSelector` | Map of node labels for pod assignment | `{}` | +| `tolerations` | List of node taints to tolerate | `[]` | +| `affinity` | Map of node/pod affinities | `{}` | +| `env.open.STORAGE` | Storage Backend to use | `local` | +| `env.open.ALIBABA_BUCKET` | Bucket to store charts in for Alibaba | `` | +| `env.open.ALIBABA_PREFIX` | Prefix to store charts under for Alibaba | `` | +| `env.open.ALIBABA_ENDPOINT` | Alternative Alibaba endpoint | `` | +| `env.open.ALIBABA_SSE` | Server side encryption algoritm to use | `` | +| `env.open.AMAZON_BUCKET` | Bucket to store charts in for AWS | `` | +| `env.open.AMAZON_ENDPOINT` | Alternative AWS endpoint | `` | +| `env.open.AMAZON_PREFIX` | Prefix to store charts under for AWS | `` | +| `env.open.AMAZON_REGION` | Region to use for bucket access for AWS | `` | +| `env.open.AMAZON_SSE` | Server side encryption algoritm to use | `` | +| `env.open.GOOGLE_BUCKET` | Bucket to store charts in for GCP | `` | +| `env.open.GOOGLE_PREFIX` | Prefix to store charts under for GCP | `` | +| `env.open.STORAGE_MICROSOFT_CONTAINER` | Container to store charts under for MS | `` | +| `env.open.STORAGE_MICROSOFT_PREFIX` | Prefix to store charts under for MS | `` | +| `env.open.CHART_POST_FORM_FIELD_NAME` | Form field to query for chart file content | `` | +| `env.open.PROV_POST_FORM_FIELD_NAME` | Form field to query for chart provenance | `` | +| `env.open.DEBUG` | Show debug messages | `false` | +| `env.open.LOG_JSON` | Output structured logs in JSON | `true` | +| `env.open.DISABLE_METRICS` | Disable Prometheus metrics | `true` | +| `env.open.DISABLE_API` | Disable all routes prefixed with /api | `true` | +| `env.open.ALLOW_OVERWRITE` | Allow chart versions to be re-uploaded | `false` | +| `env.open.CHART_URL` | Absolute url for .tgzs in index.yaml | `` | +| `env.open.AUTH_ANONYMOUS_GET` | Allow anon GET operations when auth is used | `false` | +| `env.open.CONTEXT_PATH` | Set the base context path | `` | +| `env.open.INDEX_LIMIT` | Parallel scan limit for the repo indexer | `` | +| `env.secret.BASIC_AUTH_USER` | Username for basic HTTP authentication | `` | +| `env.secret.BASIC_AUTH_PASS` | Password for basic HTTP authentication | `` | + + secret: + # username for basic http authentication + BASIC_AUTH_USER: + # password for basic http authentication + BASIC_AUTH_PASS: Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. - ## Installation ```shell diff --git a/incubator/chartmuseum/values.yaml b/incubator/chartmuseum/values.yaml index 56c8f00f56..7292d3646c 100644 --- a/incubator/chartmuseum/values.yaml +++ b/incubator/chartmuseum/values.yaml @@ -54,7 +54,7 @@ env: ALLOW_OVERWRITE: false # absolute url for .tgzs in index.yaml CHART_URL: - # allow annonymous GET operations when auth is used + # allow anonymous GET operations when auth is used AUTH_ANONYMOUS_GET: false # sets the base context path CONTEXT_PATH: