Skip to content

Commit 908f61e

Browse files
authored
Shorten name of the chart (#18)
Having "o11y-collector-for-kubernetes" as part a name for all k8s resources installed with the chart is redundant and make it hard to read. Simplify the name of the chart to just "o11y-collector"
1 parent e30e1b5 commit 908f61e

25 files changed

+6
-6
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Observability Collector for Kubernetes
22

3-
`o11y-collector-for-kubernetes` is a [Helm](https://github.com/kubernetes/helm) chart that
3+
`o11y-collector` is a [Helm](https://github.com/kubernetes/helm) chart that
44
creates a kubernetes daemonset along with other kubernetes objects in a
55
kubernetes cluster to collect the cluster's logs, traces and metrics send them to
66
[Signalfx](https://www.signalfx.com/).
@@ -62,13 +62,13 @@ In order to install helm chart you need to clone the repo first and use it local
6262
```bash
6363
$ git clone [email protected]:signalfx/o11y-collector-for-kubernetes.git
6464
$ cd ./o11y-collector-for-kubernetes
65-
$ helm install my-o11y-collector --set="splunkRealm=us0,splunkAccessToken=xxxxxx,clusterName=my-cluster" ./helm-charts/o11y-collector-for-kubernetes
65+
$ helm install my-o11y-collector --set="splunkRealm=us0,splunkAccessToken=xxxxxx,clusterName=my-cluster" ./helm-charts/o11y-collector
6666
```
6767

6868
Instead of setting helm values as arguments a yaml file can be provided:
6969

7070
```bash
71-
$ helm install my-o11y-collector --values my_values.yaml ./helm-charts/o11y-collector-for-kubernetes
71+
$ helm install my-o11y-collector --values my_values.yaml ./helm-charts/o11y-collector
7272
```
7373

7474
### How to uninstall
@@ -84,7 +84,7 @@ deletes the release.
8484

8585
## Configuration
8686

87-
The [values.yaml](https://github.com/signalfx/o11y-collector-for-kubernetes/blob/master/helm-charts/o11y-collector-for-kubernetes/values.yaml)
87+
The [values.yaml](https://github.com/signalfx/o11y-collector-for-kubernetes/blob/master/helm-charts/o11y-collector/values.yaml)
8888
lists all supported configurable parameters for this chart, along with detailed explanation.
8989
Read through it to understand how to configure this chart.
9090

@@ -116,7 +116,7 @@ It's possible to disable any kind of telemetry with the following parameters:
116116
For exapmle, to install o11y collector only for logs:
117117

118118
```bash
119-
$ helm install my-o11y-collector --set="splunkRealm=us0,splunkAccessToken=xxxxxx,clusterName=my-cluster,metricsEnabled=false,tracesEnabled=false" ./helm-charts/o11y-collector-for-kubernetes
119+
$ helm install my-o11y-collector --set="splunkRealm=us0,splunkAccessToken=xxxxxx,clusterName=my-cluster,metricsEnabled=false,tracesEnabled=false" ./helm-charts/o11y-collector
120120
```
121121

122122
## License ##

helm-charts/o11y-collector-for-kubernetes/Chart.yaml renamed to helm-charts/o11y-collector/Chart.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
apiVersion: v2
2-
name: o11y-collector-for-kubernetes
2+
name: o11y-collector
33
version: 0.1.0
44
description: Splunk Observability Collector for Kubernetes Helm Chart
55
type: application

0 commit comments

Comments
 (0)