diff --git a/external-scaler-azure-cosmos-db/.helmignore b/external-scaler-azure-cosmos-db/.helmignore index 691fa13d..0f42e889 100644 --- a/external-scaler-azure-cosmos-db/.helmignore +++ b/external-scaler-azure-cosmos-db/.helmignore @@ -20,4 +20,5 @@ .project .idea/ *.tmproj -.vscode/ \ No newline at end of file +.vscode/ +*.gotmpl diff --git a/external-scaler-azure-cosmos-db/README.md b/external-scaler-azure-cosmos-db/README.md index f4eb5677..cd510aa8 100644 --- a/external-scaler-azure-cosmos-db/README.md +++ b/external-scaler-azure-cosmos-db/README.md @@ -29,14 +29,15 @@ Chart for installing KEDA external scaler for Azure Cosmos DB. ## Values -| Key | Type | Default | Description | -|---|---|---|---| -| additionalLabels | object | `{}` | Additional labels that should be applied to all resources | -| image.pullPolicy | string | `"Always"` | The image pull policy for Azure Cosmos DB external scaler | -| image.repository | string | `"ghcr.io/kedacore/external-scaler-azure-cosmos-db"` | The Docker image repository to use for Azure Cosmos DB external scaler | -| image.tag | string | `"0.1.0"` | The Docker image tag to use for Azure Cosmos DB external scaler | -| port | int | `4050` | The incoming port for 'Azure Cosmos DB external scaler' service | -| resources.limits.cpu | string | `"100m"` | Maximum limit on CPU for 'Azure Cosmos DB external scaler' pod | -| resources.limits.memory | string | `"512Mi"` | Maximum limit on memory for 'Azure Cosmos DB external scaler' pod | -| resources.requests.cpu | string | `"10m"` | Initial CPU request by 'Azure Cosmos DB external scaler' pod | -| resources.requests.memory | string | `"128Mi"` | Initial memory request by 'Azure Cosmos DB external scaler' pod | +| Parameter | Type | Default | Description | +|-----------|------|---------|-------------| +| `additionalLabels` | object | `{}` | Additional labels that should be applied to all resources | +| `image.pullPolicy` | string | `"Always"` | The image pull policy for Azure Cosmos DB external scaler | +| `image.repository` | string | `"ghcr.io/kedacore/external-scaler-azure-cosmos-db"` | The Docker image repository to use for Azure Cosmos DB external scaler | +| `image.tag` | string | `"0.1.0"` | The Docker image tag to use for Azure Cosmos DB external scaler | +| `port` | int | `4050` | The incoming port for 'Azure Cosmos DB external scaler' service | +| `resources.limits` | object | `{"cpu":"100m","memory":"512Mi"}` | The CPU/memory resource limit for the 'Azure Cosmos DB external scaler' pod | +| `resources.requests` | object | `{"cpu":"10m","memory":"128Mi"}` | The CPU/memory resource request for the 'Azure Cosmos DB external scaler' pod | + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs) diff --git a/external-scaler-azure-cosmos-db/README.md.gotmpl b/external-scaler-azure-cosmos-db/README.md.gotmpl new file mode 100644 index 00000000..ab1db31b --- /dev/null +++ b/external-scaler-azure-cosmos-db/README.md.gotmpl @@ -0,0 +1,39 @@ +# KEDA External Scaler for Azure Cosmos DB + +Chart for installing KEDA external scaler for Azure Cosmos DB. + +- [Documentation](https://github.com/kedacore/external-scaler-azure-cosmos-db#readme) +- [Release Notes](https://github.com/kedacore/external-scaler-azure-cosmos-db/releases/tag/v0.1.0) +- [Example Usage](https://github.com/kedacore/external-scaler-azure-cosmos-db/tree/main/src/Scaler.Demo) + +## Installation + +1. Add and update Helm chart repo. + + ```shell + helm repo add kedacore https://kedacore.github.io/charts + helm repo update + ``` + +1. Install KEDA Helm chart (*or follow one of the other installation methods on [KEDA documentation](https://keda.sh/docs/deploy)*). + + ```shell + helm install keda kedacore/keda --namespace keda --create-namespace + ``` + +1. Install Azure Cosmos DB external scaler Helm chart. + + ```shell + helm install external-scaler-azure-cosmos-db kedacore/external-scaler-azure-cosmos-db --namespace keda --create-namespace + ``` + +## Values + +| Parameter | Type | Default | Description | +|-----------|------|---------|-------------| +{{- range .Values }} +| `{{ .Key }}` | {{ .Type }} | {{ if .Default }}{{ .Default }}{{ else }}{{ .AutoDefault }}{{ end }} | {{ if .Description }}{{ .Description }}{{ else }}{{ .AutoDescription }}{{ end }} | +{{- end }} + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs) diff --git a/external-scaler-azure-cosmos-db/values.yaml b/external-scaler-azure-cosmos-db/values.yaml index 4efd4fd8..77c7c1f8 100644 --- a/external-scaler-azure-cosmos-db/values.yaml +++ b/external-scaler-azure-cosmos-db/values.yaml @@ -1,21 +1,26 @@ -# Additional labels that should be applied to all resources. +# -- Additional labels that should be applied to all resources additionalLabels: {} # name: # Docker image configuration. image: + # -- The Docker image repository to use for Azure Cosmos DB external scaler repository: ghcr.io/kedacore/external-scaler-azure-cosmos-db + # -- The Docker image tag to use for Azure Cosmos DB external scaler tag: 0.1.0 + # -- The image pull policy for Azure Cosmos DB external scaler pullPolicy: Always -# Service incoming port. +# -- The incoming port for 'Azure Cosmos DB external scaler' service port: 4050 # Container resource requests and limits. resources: + # -- The CPU/memory resource request for the 'Azure Cosmos DB external scaler' pod requests: cpu: 10m memory: 128Mi + # -- The CPU/memory resource limit for the 'Azure Cosmos DB external scaler' pod limits: cpu: 100m memory: 512Mi