Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Helm docs #171

Merged
merged 2 commits into from
Nov 20, 2024
Merged

Helm docs #171

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c7498dd
[helm] Adding chart docs
didierofrivia Nov 20, 2024
db6078c
[helm] Adding appVersion to show in the helm cli
didierofrivia Nov 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions charts/limitador-operator/Chart.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: [email protected]
name: Alex Snaps
Expand Down
21 changes: 21 additions & 0 deletions charts/limitador-operator/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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).
1 change: 1 addition & 0 deletions make/helm.mk
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading