Skip to content

Commit ebd5b34

Browse files
authored
Update installation instructions (#19)
1 parent 908f61e commit ebd5b34

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,15 +56,22 @@ To install o11y-collector in k8s cluster at least three parameters must be provi
5656
- `splunkAccessToken`: Your SignalFx org access token.
5757
- `clusterName`: arbitrary value that will identify your kubernetes cluster in SignalFx environment.
5858

59-
The project is in active development state. There are no packages released yet.
60-
In order to install helm chart you need to clone the repo first and use it locally.
59+
The repository is not publicly available yet.
60+
In order to install the helm chart you need to clone the repo first and use it locally.
6161

6262
```bash
6363
$ git clone [email protected]:signalfx/o11y-collector-for-kubernetes.git
6464
$ cd ./o11y-collector-for-kubernetes
6565
$ helm install my-o11y-collector --set="splunkRealm=us0,splunkAccessToken=xxxxxx,clusterName=my-cluster" ./helm-charts/o11y-collector
6666
```
6767

68+
Once the repository is public, it will be possible to use helm repository to install the chart.
69+
70+
```bash
71+
$ helm repo add o11y-collector-for-kubernetes https://signalfx.github.io/o11y-collector-for-kubernetes
72+
$ helm install my-o11y-collector --set="splunkRealm=us0,splunkAccessToken=xxxxxx,clusterName=my-cluster" o11y-collector-for-kubernetes/o11y-collector
73+
```
74+
6875
Instead of setting helm values as arguments a yaml file can be provided:
6976

7077
```bash
@@ -113,7 +120,7 @@ It's possible to disable any kind of telemetry with the following parameters:
113120
- `tracesEnabled`: `false`
114121
- `logsEnabled`: `false`
115122

116-
For exapmle, to install o11y collector only for logs:
123+
For example, to install o11y collector only for logs:
117124

118125
```bash
119126
$ helm install my-o11y-collector --set="splunkRealm=us0,splunkAccessToken=xxxxxx,clusterName=my-cluster,metricsEnabled=false,tracesEnabled=false" ./helm-charts/o11y-collector

0 commit comments

Comments
 (0)