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.

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

chore: migrate docs from odigos-charts #1476

Merged
merged 2 commits into from
Aug 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 3 additions & 1 deletion .github/workflows/helm-lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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)
48 changes: 48 additions & 0 deletions helm/README.md
Original file line number Diff line number Diff line change
@@ -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).
Loading