Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jriguera committed Mar 13, 2024
1 parent 36a03b9 commit cc814e5
Showing 1 changed file with 24 additions and 8 deletions.
32 changes: 24 additions & 8 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,34 @@
# Helm repository for Mimir Rules Kubernetes controller

K8S controller to manage Mimir Alerting and Recording rules with dynamic tenants, based on namespace name or annotations.
GitHub repository with code: https://github.com/springernature/o11y-rules-telemetry-operator

## Adding Helm repository
[!WARNING]
> Installing this Helm Chart will install a new CRD `MimirRules` in the cluster. Take this into account for CRD updates or when deleting the controller, those operations will require manual steps with `kubectl delete/apply`.
## Installing

[Helm](https://helm.sh) must be installed to use the charts.
Please refer to Helm's [documentation](https://helm.sh/docs/) to get started.

Once Helm is set up properly, add the repo as follows:
Once Helm is set up properly, you have two ways to install the chart.

## 1. Using GitHub registry with Helm

To show the chart information and see the templates:

```console
helm show all oci://ghcr.io/springernature/charts/mimirrules-controller --version 1.0.3
helm template mimirrules-controller oci://ghcr.io/springernature/charts/mimirrules-controller --version 1.0.3
```

```console
helm upgrade --install mimirrules-controller oci://ghcr.io/springernature/charts/mimirrules-controller --version 1.0.3
```

## 2. Adding Helm repository

First, add this Helm repository:

```console
helm repo add o11y-rules-telemetry-operator https://springernature.github.io/o11y-rules-telemetry-operator
Expand All @@ -16,17 +37,12 @@ helm repo update

You can then run `helm search repo o11y-rules-telemetry-operator` to see the charts.

## Using helm chart

To install the app chart in the Kubernetes cluster.

```console
helm upgrade --install mimirrules o11y-rules-telemetry-operator/mimirrules
helm upgrade --install mimirrules-controller o11y-rules-telemetry-operator/mimirrules-controller
```

This will install CRD `MimirRules`. Take this into account for CRD updates or when deleting the controller, those operations will require manual steps with `kubectl delete/apply`.


### Values

| Key | Type | Default | Description |
Expand Down

0 comments on commit cc814e5

Please sign in to comment.