From f5c36a0123d193cfa25d70afc84adc228cb97c62 Mon Sep 17 00:00:00 2001 From: Cheng Dan Date: Mon, 20 Aug 2018 16:47:43 +0800 Subject: [PATCH 1/2] helm chart doc improve Signed-off-by: Cheng Dan --- contrib/helm/harbor/README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/contrib/helm/harbor/README.md b/contrib/helm/harbor/README.md index ebe0d5769..331b330b0 100644 --- a/contrib/helm/harbor/README.md +++ b/contrib/helm/harbor/README.md @@ -189,4 +189,23 @@ The following tables lists the configurable parameters of the Harbor chart and t | `notary.affinity` | Node/Pod affinities | `{}` | ## Persistence -TBD + +You need to create `StorageClass` before able to persist data in persistent volume. + +And set the following values in `values.yaml` + +```yaml +persistence: + enabled: true + +``` + +Four PVCs will be created automatically, +- adminserver-config +- chartmuseum-data +- database-data +- registry-data + +All the created PVCs need to be removed manually after helm delete the Chart. + +When running a cluster without persistence, this Chart will use `emptyDir` as the temporary volumes. Data will not survive during termination of a pod. From b42776c7554594be61125615aeeba6c5795059b8 Mon Sep 17 00:00:00 2001 From: Cheng Dan Date: Mon, 20 Aug 2018 20:19:08 +0800 Subject: [PATCH 2/2] updated according to Herny's review. Signed-off-by: Cheng Dan --- contrib/helm/harbor/README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/contrib/helm/harbor/README.md b/contrib/helm/harbor/README.md index 331b330b0..0aa894b78 100644 --- a/contrib/helm/harbor/README.md +++ b/contrib/helm/harbor/README.md @@ -190,9 +190,9 @@ The following tables lists the configurable parameters of the Harbor chart and t ## Persistence -You need to create `StorageClass` before able to persist data in persistent volume. +You need to create `StorageClass` before you can persist data in persistent volume. -And set the following values in `values.yaml` +To create a `StorageClass`, set the following value in `values.yaml`: ```yaml persistence: @@ -200,12 +200,12 @@ persistence: ``` -Four PVCs will be created automatically, +Four PVCs will be created automatically: - adminserver-config - chartmuseum-data - database-data - registry-data -All the created PVCs need to be removed manually after helm delete the Chart. +All the created PVCs need to be removed manually after Helm deletes the Chart. -When running a cluster without persistence, this Chart will use `emptyDir` as the temporary volumes. Data will not survive during termination of a pod. +When running a cluster without persistence, this Chart uses `emptyDir` as the temporary volumes. Data does not survive the termination of a pod.