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

Add new helm command to README.md, fix typos #836

Merged
merged 5 commits into from
Jul 26, 2023
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
2 changes: 1 addition & 1 deletion charts/opentelemetry-operator/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
apiVersion: v2
name: opentelemetry-operator
version: 0.34.0
version: 0.34.1
description: OpenTelemetry Operator Helm chart for Kubernetes
type: application
home: https://opentelemetry.io/
Expand Down
15 changes: 11 additions & 4 deletions charts/opentelemetry-operator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@ certificate that the API server is configured to trust. There are a few differen
In this way, cert-manager will generate a self-signed certificate. _See [cert-manager installation](https://cert-manager.io/docs/installation/kubernetes/) for more details._
- You can provide your own Issuer by configuring the `admissionWebhooks.certManager.issuerRef` value. You will need
to specify the `kind` (Issuer or ClusterIssuer) and the `name`. Note that this method also requires the installation of cert-manager.
- You can use an automatically generated self-signed certificate by setting `admissionWebhooks.certManager.enabled` to `false` and `admissionWebhooks.autoGenerateCert` to `true`. Helm will create a self-signd cert and a secret for you.
- You can use an automatically generated self-signed certificate by setting `admissionWebhooks.certManager.enabled` to `false` and `admissionWebhooks.autoGenerateCert` to `true`. Helm will create a self-signed cert and a secret for you.
- You can use your own generated self-signed certificate by setting both `admissionWebhooks.certManager.enabled` and `admissionWebhooks.autoGenerateCert` to `false`. You should provide the necessary values to `admissionWebhooks.cert_file`, `admissionWebhooks.key_file`, and `admissionWebhooks.ca_file`.
- You can sideload custom webhooks and certificate by disabling `.Values.admissionWebhooks.create` and `admissionWebhooks.certManager.enabled` while setting your custom cert secret name in `admissionWebhooks.secretName`
- You can disable webhooks alltogether by disabling `.Values.admissionWebhooks.create` and setting env var to `ENABLE_WEBHOOKS: "false"`
- You can disable webhooks altogether by disabling `.Values.admissionWebhooks.create` and setting env var to `ENABLE_WEBHOOKS: "false"`

## Add Repository

Expand All @@ -46,6 +46,13 @@ $ helm install --namespace opentelemetry-operator-system \
opentelemetry-operator open-telemetry/opentelemetry-operator
```

If you wish for helm to create an automatically generated self-signed certificate, make sure to set the appropriate values when installing the chart:

```console
$ helm install --set admissionWebhooks.certManager.enabled=false --set admissionWebhooks.certManager.autoGenerateCert=true \
opentelemetry-operator open-telemetry/opentelemetry-operator
```

_See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._

## Uninstall Chart
Expand Down Expand Up @@ -106,7 +113,7 @@ to an early version if anything unexpected happens, pause the Collector, etc. In
instance just as an application.

The following example configuration deploys the Collector as Deployment resource. The receiver is Jaeger receiver and
the exporter is logging exporter.
the exporter is [logging exporter](https://github.com/open-telemetry/opentelemetry-collector/blob/main/exporter/loggingexporter).

```console
$ kubectl apply -f - <<EOF
Expand Down Expand Up @@ -137,7 +144,7 @@ EOF

### DaemonSet Mode

DaemonSet should satisfy your needs if you want the Collector run as an agent in your Kubernetes nodes.
DaemonSet should satisfy your needs if you want the Collector to run as an agent on your Kubernetes nodes.
In this case, every Kubernetes node will have its own Collector copy which would monitor the pods in it.

The following example configuration deploys the Collector as DaemonSet resource. The receiver is Jaeger receiver and
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ metadata:
annotations:
cert-manager.io/inject-ca-from: default/example-opentelemetry-operator-serving-cert
labels:
helm.sh/chart: opentelemetry-operator-0.34.0
helm.sh/chart: opentelemetry-operator-0.34.1
app.kubernetes.io/name: opentelemetry-operator
app.kubernetes.io/version: "0.81.0"
app.kubernetes.io/managed-by: Helm
Expand Down Expand Up @@ -85,7 +85,7 @@ metadata:
annotations:
cert-manager.io/inject-ca-from: default/example-opentelemetry-operator-serving-cert
labels:
helm.sh/chart: opentelemetry-operator-0.34.0
helm.sh/chart: opentelemetry-operator-0.34.1
app.kubernetes.io/name: opentelemetry-operator
app.kubernetes.io/version: "0.81.0"
app.kubernetes.io/managed-by: Helm
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ apiVersion: cert-manager.io/v1
kind: Certificate
metadata:
labels:
helm.sh/chart: opentelemetry-operator-0.34.0
helm.sh/chart: opentelemetry-operator-0.34.1
app.kubernetes.io/name: opentelemetry-operator
app.kubernetes.io/version: "0.81.0"
app.kubernetes.io/managed-by: Helm
Expand All @@ -29,7 +29,7 @@ apiVersion: cert-manager.io/v1
kind: Issuer
metadata:
labels:
helm.sh/chart: opentelemetry-operator-0.34.0
helm.sh/chart: opentelemetry-operator-0.34.1
app.kubernetes.io/name: opentelemetry-operator
app.kubernetes.io/version: "0.81.0"
app.kubernetes.io/managed-by: Helm
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
labels:
helm.sh/chart: opentelemetry-operator-0.34.0
helm.sh/chart: opentelemetry-operator-0.34.1
app.kubernetes.io/name: opentelemetry-operator
app.kubernetes.io/version: "0.81.0"
app.kubernetes.io/managed-by: Helm
Expand Down Expand Up @@ -201,7 +201,7 @@ apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
labels:
helm.sh/chart: opentelemetry-operator-0.34.0
helm.sh/chart: opentelemetry-operator-0.34.1
app.kubernetes.io/name: opentelemetry-operator
app.kubernetes.io/version: "0.81.0"
app.kubernetes.io/managed-by: Helm
Expand All @@ -219,7 +219,7 @@ apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
labels:
helm.sh/chart: opentelemetry-operator-0.34.0
helm.sh/chart: opentelemetry-operator-0.34.1
app.kubernetes.io/name: opentelemetry-operator
app.kubernetes.io/version: "0.81.0"
app.kubernetes.io/managed-by: Helm
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
labels:
helm.sh/chart: opentelemetry-operator-0.34.0
helm.sh/chart: opentelemetry-operator-0.34.1
app.kubernetes.io/name: opentelemetry-operator
app.kubernetes.io/version: "0.81.0"
app.kubernetes.io/managed-by: Helm
Expand All @@ -25,7 +25,7 @@ apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
labels:
helm.sh/chart: opentelemetry-operator-0.34.0
helm.sh/chart: opentelemetry-operator-0.34.1
app.kubernetes.io/name: opentelemetry-operator
app.kubernetes.io/version: "0.81.0"
app.kubernetes.io/managed-by: Helm
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ apiVersion: apps/v1
kind: Deployment
metadata:
labels:
helm.sh/chart: opentelemetry-operator-0.34.0
helm.sh/chart: opentelemetry-operator-0.34.1
app.kubernetes.io/name: opentelemetry-operator
app.kubernetes.io/version: "0.81.0"
app.kubernetes.io/managed-by: Helm
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ apiVersion: rbac.authorization.k8s.io/v1
kind: Role
metadata:
labels:
helm.sh/chart: opentelemetry-operator-0.34.0
helm.sh/chart: opentelemetry-operator-0.34.1
app.kubernetes.io/name: opentelemetry-operator
app.kubernetes.io/version: "0.81.0"
app.kubernetes.io/managed-by: Helm
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ apiVersion: rbac.authorization.k8s.io/v1
kind: RoleBinding
metadata:
labels:
helm.sh/chart: opentelemetry-operator-0.34.0
helm.sh/chart: opentelemetry-operator-0.34.1
app.kubernetes.io/name: opentelemetry-operator
app.kubernetes.io/version: "0.81.0"
app.kubernetes.io/managed-by: Helm
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ apiVersion: v1
kind: Service
metadata:
labels:
helm.sh/chart: opentelemetry-operator-0.34.0
helm.sh/chart: opentelemetry-operator-0.34.1
app.kubernetes.io/name: opentelemetry-operator
app.kubernetes.io/version: "0.81.0"
app.kubernetes.io/managed-by: Helm
Expand All @@ -31,7 +31,7 @@ apiVersion: v1
kind: Service
metadata:
labels:
helm.sh/chart: opentelemetry-operator-0.34.0
helm.sh/chart: opentelemetry-operator-0.34.1
app.kubernetes.io/name: opentelemetry-operator
app.kubernetes.io/version: "0.81.0"
app.kubernetes.io/managed-by: Helm
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ metadata:
name: opentelemetry-operator
namespace: default
labels:
helm.sh/chart: opentelemetry-operator-0.34.0
helm.sh/chart: opentelemetry-operator-0.34.1
app.kubernetes.io/name: opentelemetry-operator
app.kubernetes.io/version: "0.81.0"
app.kubernetes.io/managed-by: Helm
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ metadata:
name: "example-opentelemetry-operator-cert-manager"
namespace: default
labels:
helm.sh/chart: opentelemetry-operator-0.34.0
helm.sh/chart: opentelemetry-operator-0.34.1
app.kubernetes.io/name: opentelemetry-operator
app.kubernetes.io/version: "0.81.0"
app.kubernetes.io/managed-by: Helm
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ metadata:
name: "example-opentelemetry-operator-metrics"
namespace: default
labels:
helm.sh/chart: opentelemetry-operator-0.34.0
helm.sh/chart: opentelemetry-operator-0.34.1
app.kubernetes.io/name: opentelemetry-operator
app.kubernetes.io/version: "0.81.0"
app.kubernetes.io/managed-by: Helm
Expand Down Expand Up @@ -43,7 +43,7 @@ metadata:
name: "example-opentelemetry-operator-webhook"
namespace: default
labels:
helm.sh/chart: opentelemetry-operator-0.34.0
helm.sh/chart: opentelemetry-operator-0.34.1
app.kubernetes.io/name: opentelemetry-operator
app.kubernetes.io/version: "0.81.0"
app.kubernetes.io/managed-by: Helm
Expand Down