From 2aa95c86322142fb0b9bb2354e8f1d63c3dd09e8 Mon Sep 17 00:00:00 2001 From: Michael Valdron Date: Thu, 10 Nov 2022 10:59:44 -0500 Subject: [PATCH] helm chart docs updated. Signed-off-by: Michael Valdron --- deploy/chart/devfile-registry/README.md | 37 ++++++++++++++----------- 1 file changed, 21 insertions(+), 16 deletions(-) diff --git a/deploy/chart/devfile-registry/README.md b/deploy/chart/devfile-registry/README.md index be86181a..977e965c 100644 --- a/deploy/chart/devfile-registry/README.md +++ b/deploy/chart/devfile-registry/README.md @@ -62,19 +62,24 @@ The following fields can be configured in the Helm chart, either via the `values | Parameter | Description | Default | | ----------------------- | --------------------------------------------- | ---------------------------------------------------------- | -| `global.ingress.domain` | Ingress domain for the devfile registry | **MUST BE SET BY USER** | -| `global.ingress.class` | Ingress class for the devfile registry | `nginx` | -| `global.ingress.secretName` | Name of an existing tls secret if using TLS | ` '' ` | -| `global.isOpenShift ` | Set to true to use OpenShift routes instead of ingress | `false` | -| `global.tlsEnabled` | Set to true to use the devfile registry with TLS | `false` | -| `devfileIndex.image` | Image used for the devfile index image | `quay.io/devfile/devfile-index` | -| `devfileIndex.tag` | Tag for devfile index image | `next` | -| `devfileIndex.imagePullpolicy` | Image pull policy for devfile index image | `Always` | -| `devfileIndex.memoryLimit` | Memory for devfile index container | `256Mi` | -| `ociRegistry.image` | Image used for the oci registry image | `quay.io/devfile/oci-registry` | -| `ociRegistry.tag` | Tag for oci registry image | `next` | -| `ociRegistry.imagePullpolicy` | Image pull policy for oci registry image | `Always` | -| `ociRegistry.memoryLimit` | Memory for oci registry container | `256Mi` | -| `persistence.enabled` | Enable persistent storage for the registry | `true` | -| `persistence.size` | The size of the persistent volume (if-enabled) | `1Gi` | -| `telemetry.key` | The write key for the Segment instance | **MUST BE SET BY USER** | \ No newline at end of file +| `global.ingress.domain` | Ingress domain for the devfile registry | **MUST BE SET BY USER** | +| `global.ingress.class` | Ingress class for the devfile registry | `nginx` | +| `global.ingress.secretName` | Name of an existing tls secret if using TLS | ` '' ` | +| `global.isOpenShift ` | Set to true to use OpenShift routes instead of ingress | `false` | +| `global.tlsEnabled` | Set to true to use the devfile registry with TLS | `false` | +| `global.headless` | Set to true to run in headless mode (does not expect attached registry viewer) | `false` | +| `devfileIndex.image` | Image used for the devfile index image | `quay.io/devfile/devfile-index` | +| `devfileIndex.tag` | Tag for devfile index image | `next` | +| `devfileIndex.imagePullpolicy` | Image pull policy for devfile index image | `Always` | +| `devfileIndex.memoryLimit` | Memory for devfile index container | `256Mi` | +| `registryViewer.image` | Image used for the registry viewer image | `quay.io/devfile/registry-viewer` | +| `registryViewer.tag` | Tag for registry viewer image | `next` | +| `registryViewer.imagePullpolicy` | Image pull policy for registry viewer image | `Always` | +| `registryViewer.memoryLimit` | Memory for registry viewer container | `256Mi` | +| `ociRegistry.image` | Image used for the oci registry image | `quay.io/devfile/oci-registry` | +| `ociRegistry.tag` | Tag for oci registry image | `next` | +| `ociRegistry.imagePullpolicy` | Image pull policy for oci registry image | `Always` | +| `ociRegistry.memoryLimit` | Memory for oci registry container | `256Mi` | +| `persistence.enabled` | Enable persistent storage for the registry | `true` | +| `persistence.size` | The size of the persistent volume (if-enabled) | `1Gi` | +| `telemetry.key` | The write key for the Segment instance | **MUST BE SET BY USER** | \ No newline at end of file