mirror of
https://github.com/helm/charts.git
synced 2026-08-23 22:37:45 +00:00
[incubator/chartmuseum] update documentation (#3296)
* [incubator/chartmuseum] update documentation * review comments
This commit is contained in:
committed by
k8s-ci-robot
parent
e9dd950ebb
commit
070c65cfd6
@@ -1,7 +1,7 @@
|
||||
apiVersion: v1
|
||||
description: Helm Chart Repository with support for Amazon S3 and Google Cloud Storage
|
||||
name: chartmuseum
|
||||
version: 0.3.0
|
||||
version: 0.3.1
|
||||
appVersion: 0.2.7
|
||||
home: https://github.com/chartmuseum/chartmuseum
|
||||
icon: https://raw.githubusercontent.com/chartmuseum/chartmuseum/master/logo.png
|
||||
|
||||
@@ -1,5 +1,83 @@
|
||||
# ChartMuseum Helm Chart
|
||||
|
||||
Work in progress...
|
||||
Deploy your own private ChartMuseum.
|
||||
|
||||
Please see https://github.com/chartmuseum/chartmuseum
|
||||
Please also see https://github.com/kubernetes-helm/chartmuseum
|
||||
|
||||
## Prerequisites
|
||||
|
||||
* Kubernetes with extensions/v1beta1 available
|
||||
* [If enabled] A persistent storage resource and RW access to it
|
||||
* [If enabled] Kubernetes StorageClass for dynamic provisioning
|
||||
|
||||
## Configuration
|
||||
|
||||
By default this chart will not have persistent storage.
|
||||
|
||||
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:
|
||||
```
|
||||
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 | `0.2.7` |
|
||||
| `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` |
|
||||
|
||||
Specify each parameter using the `--set key=value[,key=value]` argument to
|
||||
`helm install`.
|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
```shell
|
||||
helm install --name my-chartmuseum -f custom.yaml incubator/chartmuseum
|
||||
```
|
||||
|
||||
## Uninstall
|
||||
|
||||
By default, a deliberate uninstall will result in the persistent volume
|
||||
claim being deleted.
|
||||
|
||||
```shell
|
||||
helm delete my-chartmuseum
|
||||
```
|
||||
|
||||
To delete the deployment and its history:
|
||||
```shell
|
||||
helm delete --purge my-chartmuseum
|
||||
```
|
||||
|
||||
## Example storage
|
||||
|
||||
Example storage-class.yaml provided here for use with a Ceph cluster.
|
||||
|
||||
```
|
||||
kind: StorageClass
|
||||
apiVersion: storage.k8s.io/v1
|
||||
metadata:
|
||||
name: storage-volume
|
||||
provisioner: kubernetes.io/rbd
|
||||
parameters:
|
||||
monitors: "10.11.12.13:4567,10.11.12.14:4567"
|
||||
adminId: admin
|
||||
adminSecretName: thesecret
|
||||
adminSecretNamespace: default
|
||||
pool: chartstore
|
||||
userId: user
|
||||
userSecretName: thesecret
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user