Skip to content

Commit

Permalink
[demo] remove observability config section (open-telemetry#705)
Browse files Browse the repository at this point in the history 
This is a breaking change for anyone that disabled one of the four sub-charts before. UPGRADING.md is updated accordingly.

---------

Signed-off-by: Pierre Tessier <pierre@pierretessier.com>
  • Loading branch information
@puckpuck
puckpuck authored Mar 26, 2023
1 parent 98ceee0 commit 185ac3a
Show file tree
Hide file tree
Showing 22 changed files with 226 additions and 280 deletions.
4 changes: 2 additions & 2 deletions charts/opentelemetry-demo/Chart.lock
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ dependencies:
- name: grafana
repository: https://grafana.github.io/helm-charts
version: 6.51.2
digest: sha256:70149fdf53acfc2b727edc8017e5908aa14854231c02a4f8ea1a9b4d2445511b
generated: "2023-03-01T21:49:19.776835-05:00"
digest: sha256:f57abba37767e7496e246d1cd6515033c3af053cb879c7055c6465dc77c2d6fc
generated: "2023-03-24T19:41:18.7604-04:00"
12 changes: 6 additions & 6 deletions charts/opentelemetry-demo/Chart.yaml
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
apiVersion: v2
type: application
name: opentelemetry-demo
version: 0.19.15
description: OpenTelemetry Demo Helm chart for Kubernetes
version: 0.20.0
description: opentelemetry demo helm chart
home: https://opentelemetry.io/
sources:
- https://github.com/open-telemetry/opentelemetry-demo
Expand All @@ -16,16 +16,16 @@ dependencies:
- name: opentelemetry-collector
version: 0.49.1
repository: https://open-telemetry.github.io/opentelemetry-helm-charts
condition: observability.otelcol.enabled
condition: opentelemetry-collector.enabled
- name: jaeger
version: 0.67.6
repository: https://jaegertracing.github.io/helm-charts
condition: observability.jaeger.enabled
condition: jaeger.enabled
- name: prometheus
version: 19.7.2
repository: https://prometheus-community.github.io/helm-charts
condition: observability.prometheus.enabled
condition: prometheus.enabled
- name: grafana
version: 6.51.2
repository: https://grafana.github.io/helm-charts
condition: observability.grafana.enabled
condition: grafana.enabled
17 changes: 6 additions & 11 deletions charts/opentelemetry-demo/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,8 @@ the demo
| `default.schedulingRules.tolerations` | Tolerations for pod assignment | `[]` |
| `default.securityContext` | Demo components container security context | `{}` |
| `serviceAccount.annotations` | Annotations for the serviceAccount | `{}` |
| `serviceAccount.create` | Wether to create a serviceAccount or use an existing one | `true` |
| `serviceAccount.name` | The name of the ServiceAccount to use for demo components | `""` |
| `serviceAccount.create` | Wether to create a serviceAccount or use an existing one | `true` |
| `serviceAccount.name` | The name of the ServiceAccount to use for demo components | `""` |

### Component parameters

Expand Down Expand Up @@ -103,15 +103,6 @@ component.
| `initContainers[].image` | Image to use for the init container | `nil` |
| `initContainers[].command` | Command to run for the init container | `nil` |

### Observability parameters

| Parameter | Description | Default |
|------------------------------------|-----------------------------------------------|---------|
| `observability.otelcol.enabled` | Enables the OpenTelemetry Collector sub-chart | `true` |
| `observability.jaeger.enabled` | Enables the Jaeger sub-chart | `true` |
| `observability.prometheus.enabled` | Enables the Prometheus sub-chart | `true` |
| `observability.grafana.enabled` | Enables the Grafana sub-chart | `true` |

### Sub-charts

The OpenTelemetry Demo Helm chart depends on 4 sub-charts:
Expand All @@ -131,6 +122,7 @@ parameters by default. The overriden parameters are specified below.
| Parameter | Description | Default |
|------------------|----------------------------------------------------|----------------------------------------------------------|
| `enabled` | Install the OpenTelemetry collector | `true` |
| `nameOverride` | Name that will be used by the sub-chart release | `otelcol` |
| `mode` | The Deployment or Daemonset mode | `deployment` |
| `resources` | CPU/Memory resource requests/limits | 100Mi memory limit |
Expand All @@ -146,6 +138,7 @@ parameters by default. The overriden parameters are specified below.
| Parameter | Description | Default |
|--------------------------------|----------------------------------------------------|-----------------------------------------------------------------------|
| `enabled` | Install the Jaeger sub-chart | `true` |
| `provisionDataStore.cassandra` | Provision a cassandra data store | `false` (required for AllInOne mode) |
| `allInOne.enabled` | Enable All in One In-Memory Configuration | `true` |
| `allInOne.args` | Command arguments to pass to All in One deployment | `["--memory.max-traces", "10000", "--query.base-path", "/jaeger/ui"]` |
Expand All @@ -162,6 +155,7 @@ parameters by default. The overriden parameters are specified below.
| Parameter | Description | Default |
|--------------------------------------|------------------------------------------------|-----------------------------------------------------------|
| `enabled` | Install the Prometheus sub-chart | `true` |
| `alertmanager.enabled` | Install the alertmanager | `false` |
| `configmapReload.prometheus.enabled` | Install the configmap-reload container | `false` |
| `kube-state-metrics.enabled` | Install the kube-state-metrics sub-chart | `false` |
Expand All @@ -182,6 +176,7 @@ parameters by default. The overriden parameters are specified below.
| Parameter | Description | Default |
|-----------------------|----------------------------------------------------|----------------------------------------------------------------------|
| `enabled` | Install the Grafana sub-chart | `true` |
| `grafana.ini` | Grafana's primary configuration | Enables anonymous login, and proxy through the frontendProxy service |
| `adminPassword` | Password used by `admin` user | `admin` |
| `rbac.pspEnabled` | Enable PodSecurityPolicy resources | `false` |
Expand Down
6 changes: 6 additions & 0 deletions charts/opentelemetry-demo/UPGRADING.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Upgrade guidelines

## To 0.20

The `observability.<sub chart>.enabled` parameters have been moved to an
`enabled` parameter within the sub chart itself. If you had changes to these
parameters, you will need to update your changes to work with the new structure.

## To 0.18

The `serviceType` and `servicePort` parameters have been moved under a `service`
Expand Down
Loading

0 comments on commit 185ac3a

Please sign in to comment.