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

docs: replace make install/deploy with official image and kustomize #31

Merged
merged 1 commit into from
Feb 13, 2024
+36 −19
Merged

docs: replace make install/deploy with official image and kustomize #31

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
55 changes: 36 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Telemetry-controller can be configured using Custom Resources to set up an opini
- kubectl version v1.11.3+.
- Access to a Kubernetes v1.11.3+ cluster.

### To Deploy on the cluster
### Deployment steps for users

**Install cert-manager, and opentelemtry-operator:**
```sh
Expand All @@ -19,6 +19,23 @@ helm upgrade --install --repo https://charts.jetstack.io cert-manager cert-manag
kubectl apply -f https://github.com/open-telemetry/opentelemetry-operator/releases/latest/download/opentelemetry-operator.yaml --wait
```

**Deploy telemetry-controller:**
```sh
kubectl apply -k 'github.com/kube-logging/telemetry-controller/config/default'
```
**Remove the controller and CRDs from the cluster:**
```sh
kubectl delete -k 'github.com/kube-logging/telemetry-controller/config/default'
```

### Deployment steps for contributors
**Install cert-manager, and opentelemtry-operator:**
```sh
helm upgrade --install --repo https://charts.jetstack.io cert-manager cert-manager --namespace cert-manager --create-namespace --version v1.13.3 --set installCRDs=true --wait

kubectl apply -f https://github.com/open-telemetry/opentelemetry-operator/releases/latest/download/opentelemetry-operator.yaml --wait
```

**Install the CRDs into the cluster:**

```sh
Expand All @@ -40,6 +57,24 @@ make deploy IMG=telemetry-controller:tag
> **NOTE**: If you encounter RBAC errors, you may need to grant yourself cluster-admin
privileges or be logged in as admin.

**Delete the instances (CRs) from the cluster:**

```sh
kubectl delete -f docs/examples/simple-demo/
```

**Remove the controller from the cluster:**

```sh
make undeploy
```

**Delete the APIs(CRDs) from the cluster:**

```sh
make uninstall
```
### Example setup
**Create instances of your solution**
You can deploy the example configuration provided as part of the docs. This will deploy a demo pipeline with one tenant, two subscriptions, and an OpenObserve instance.
Deploying Openobserve is an optional, but recommended step, logs can be forwarded to any OTLP endpoint. Openobserve provides a UI to visualize the ingested logstream.
Expand Down Expand Up @@ -72,24 +107,6 @@ helm install --wait --create-namespace --namespace example-tenant-ns --generate-
**Open the Openobserve UI and inspect the generated log messages**
![Openobserve logs](docs/assets/openobserve-logs.png)

### To Uninstall
**Delete the instances (CRs) from the cluster:**

```sh
kubectl delete -f docs/examples/simple-demo/
```

**UnDeploy the controller from the cluster:**

```sh
make undeploy
```

**Delete the APIs(CRDs) from the cluster:**

```sh
make uninstall
```

## Contributing

Expand Down
Loading