From 3059edc641fafaf2c1342496bc27a16dd856c956 Mon Sep 17 00:00:00 2001 From: hjkatz Date: Tue, 12 Nov 2024 19:26:07 +0000 Subject: [PATCH] Update README.md and values.schema.json with readme-generator-for-helm --- helm/ngrok-operator/README.md | 15 ++++++++------- helm/ngrok-operator/values.schema.json | 5 +++++ 2 files changed, 13 insertions(+), 7 deletions(-) diff --git a/helm/ngrok-operator/README.md b/helm/ngrok-operator/README.md index 2e8e4718..328a28db 100644 --- a/helm/ngrok-operator/README.md +++ b/helm/ngrok-operator/README.md @@ -35,13 +35,14 @@ To uninstall the chart: ### Common parameters -| Name | Description | Value | -| ------------------- | ------------------------------------------------------------------ | ----------------------------------------- | -| `nameOverride` | String to partially override generated resource names | `""` | -| `fullnameOverride` | String to fully override generated resource names | `""` | -| `description` | ngrok-operator description that will appear in the ngrok dashboard | `The official ngrok Kubernetes Operator.` | -| `commonLabels` | Labels to add to all deployed objects | `{}` | -| `commonAnnotations` | Annotations to add to all deployed objects | `{}` | +| Name | Description | Value | +| ------------------- | ------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------- | +| `nameOverride` | String to partially override generated resource names | `""` | +| `fullnameOverride` | String to fully override generated resource names | `""` | +| `description` | ngrok-operator description that will appear in the ngrok dashboard | `The official ngrok Kubernetes Operator.` | +| `commonLabels` | Labels to add to all deployed objects | `{}` | +| `commonAnnotations` | Annotations to add to all deployed objects | `{}` | +| `oneClickDemoMode` | If true, then the operator will startup without required fields or API registration, become Ready, but not actually be running | `false` | ### Image configuration diff --git a/helm/ngrok-operator/values.schema.json b/helm/ngrok-operator/values.schema.json index 1c1bf961..5f8b34c1 100644 --- a/helm/ngrok-operator/values.schema.json +++ b/helm/ngrok-operator/values.schema.json @@ -27,6 +27,11 @@ "description": "Annotations to add to all deployed objects", "default": {} }, + "oneClickDemoMode": { + "type": "boolean", + "description": "If true, then the operator will startup without required fields or API registration, become Ready, but not actually be running", + "default": false + }, "image": { "type": "object", "properties": {