diff --git a/.github/workflows/helm-lint.yml b/.github/workflows/helm-lint.yml index c1ccbf7ba2..b20590a9c9 100644 --- a/.github/workflows/helm-lint.yml +++ b/.github/workflows/helm-lint.yml @@ -14,4 +14,6 @@ jobs: - name: Install Helm uses: azure/setup-helm@v4 - name: Lint Charts - run: helm lint helm/* + run: | + shopt -s extglob + helm lint helm/!(*.md) diff --git a/helm/README.md b/helm/README.md new file mode 100644 index 0000000000..9562d11384 --- /dev/null +++ b/helm/README.md @@ -0,0 +1,48 @@ +# Odigos Helm Chart + +[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![Release](https://github.com/odigos-io/odigos/actions/workflows/release.yml/badge.svg?branch=main)](https://github.com/odigos-io/odigos/actions/workflows/release.yml) + +This repository contains the helm chart for Odigos - the observability control plane. + +``` +helm repo add odigos https://odigos-io.github.io/odigos --force-update +``` + +## Migration + +If you have been previously using chart repository at [odigos-charts](https://github.com/odigos-io/odigos-charts) you will get an error "Error: repository name (odigos) already exists, please specify a different name". +To update to new repository location run: + +```sh +helm repo add odigos https://odigos-io.github.io/odigos/ --force-update +``` + +## Usage + +Add helm repository: + +```sh +helm repo add odigos https://odigos-io.github.io/odigos +``` + +### Install Odigos + +```sh +helm repo update +helm upgrade --install odigos odigos/odigos --namespace odigos-system --create-namespace +kubectl label namespace odigos-system odigos.io/system-object="true" +``` + +- **Openshift Clusters** - Make sure to set `openshift.enabled=true` in the values file or pass it as a flag while installing the chart. +- **GKE Clusters** - Make sure to set `gke.enabled=true` in the values file or pass it as a flag while installing the chart. + +### Uninstall Odigos + +```sh +helm delete odigos -n odigos-system +kubectl delete ns odigos-system +``` + +## License + +[Apache 2.0 License](https://github.com/prometheus-community/helm-charts/blob/main/LICENSE).