From c7498dda0538b7942fc9eea2183a6dfa486870cd Mon Sep 17 00:00:00 2001 From: dd di cesare Date: Wed, 20 Nov 2024 15:30:25 +0100 Subject: [PATCH 1/2] [helm] Adding chart docs Signed-off-by: dd di cesare --- charts/limitador-operator/README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 charts/limitador-operator/README.md diff --git a/charts/limitador-operator/README.md b/charts/limitador-operator/README.md new file mode 100644 index 0000000..b97abe1 --- /dev/null +++ b/charts/limitador-operator/README.md @@ -0,0 +1,21 @@ +# Limitador Operator + +This is the Helm Chart to install the official Limitador Kubernetes Operator + +## Installation + +```sh +helm repo add kuadrant https://kuadrant.io/helm-charts/ --force-update +helm install \ + limitador-operator kuadrant/limitador-operator \ + --create-namespace \ + --namespace limitador-system +``` + +### Parameters + +**Coming soon!** At the moment, there's no configuration parameters exposed. + +## Usage + +Read the documentation and user guides in the [Getting Started guide](https://github.com/Kuadrant/limitador/?tab=readme-ov-file#getting-started). From db6078c568f963ab101f057a82261860f0e446e8 Mon Sep 17 00:00:00 2001 From: dd di cesare Date: Wed, 20 Nov 2024 15:30:48 +0100 Subject: [PATCH 2/2] [helm] Adding appVersion to show in the helm cli Signed-off-by: dd di cesare --- charts/limitador-operator/Chart.yaml | 1 + make/helm.mk | 1 + 2 files changed, 2 insertions(+) diff --git a/charts/limitador-operator/Chart.yaml b/charts/limitador-operator/Chart.yaml index 80d08dd..ff7c895 100644 --- a/charts/limitador-operator/Chart.yaml +++ b/charts/limitador-operator/Chart.yaml @@ -16,6 +16,7 @@ kubeVersion: ">=1.19.0-0" type: application # The version will be properly set when the chart is released matching the operator version version: "0.0.0" +appVersion: "0.0.0" maintainers: - email: asnaps@redhat.com name: Alex Snaps diff --git a/make/helm.mk b/make/helm.mk index 6461960..6569556 100644 --- a/make/helm.mk +++ b/make/helm.mk @@ -9,6 +9,7 @@ helm-build: $(KUSTOMIZE) $(OPERATOR_SDK) $(YQ) manifests ## Build the helm chart # Build the helm chart templates from kustomize manifests $(KUSTOMIZE) build config/helm > charts/limitador-operator/templates/manifests.yaml V="$(VERSION)" $(YQ) eval '.version = strenv(V)' -i charts/limitador-operator/Chart.yaml + V="$(VERSION)" $(YQ) eval '.appVersion = strenv(V)' -i charts/limitador-operator/Chart.yaml .PHONY: helm-install helm-install: $(HELM) ## Install the helm chart