feat: value yaml example

chart/README.md

@@ -14,28 +14,9 @@ Helm chart to deploy operators for OTEL Collectors for infrastructure telemetry
 
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
-| otel.manager.podAnnotations."atomi.cloud/cluster" | string | `"opal"` |  |
-| otel.manager.podAnnotations."atomi.cloud/designation" | string | `"operator"` |  |
-| otel.manager.podAnnotations."atomi.cloud/landscape" | string | `"pichu"` |  |
-| otel.manager.podAnnotations."atomi.cloud/layer" | string | `"1"` |  |
-| otel.manager.podAnnotations."atomi.cloud/platform" | string | `"systems"` |  |
-| otel.manager.podAnnotations."atomi.cloud/service" | string | `"telemetry-collector"` |  |
-| otel.manager.podLabels."atomi.cloud/cluster" | string | `"opal"` |  |
-| otel.manager.podLabels."atomi.cloud/designation" | string | `"operator"` |  |
-| otel.manager.podLabels."atomi.cloud/landscape" | string | `"pichu"` |  |
-| otel.manager.podLabels."atomi.cloud/layer" | string | `"1"` |  |
-| otel.manager.podLabels."atomi.cloud/platform" | string | `"systems"` |  |
-| otel.manager.podLabels."atomi.cloud/service" | string | `"telemetry-collector"` |  |
-| otel.manager.resources.limits.cpu | string | `"200m"` |  |
-| otel.manager.resources.limits.memory | string | `"256Mi"` |  |
-| otel.manager.resources.requests.cpu | string | `"100m"` |  |
-| otel.manager.resources.requests.memory | string | `"128Mi"` |  |
-| otel.replicaCount | int | `3` |  |
-| serviceTree.cluster | string | `"opal"` |  |
-| serviceTree.landscape | string | `"pichu"` |  |
-| serviceTree.layer | string | `"1"` |  |
-| serviceTree.platform | string | `"systems"` |  |
-| serviceTree.service | string | `"telemetry-collector"` |  |
+| otel | object | `{"manager":{"podAnnotations":{"<<":{"atomi.cloud/layer":"1","atomi.cloud/module":"operator","atomi.cloud/platform":"sulfoxide","atomi.cloud/service":"lithium"}},"podLabels":{"<<":{"atomi.cloud/layer":"1","atomi.cloud/module":"operator","atomi.cloud/platform":"sulfoxide","atomi.cloud/service":"lithium"}},"resources":{"limits":{"cpu":"200m","memory":"256Mi"},"requests":{"cpu":"100m","memory":"128Mi"}}},"replicaCount":3}` | OTEL Collector Operator Configurations. See [OTEL Collector Operator Helm Chart Documentation](https://github.com/open-telemetry/opentelemetry-operator) |
+| serviceTree | object | `{"layer":"1","module":"operator","platform":"sulfoxide","service":"lithium"}` | AtomiCloud Service Tree. See [ServiceTree](https://atomicloud.larksuite.com/wiki/OkfJwTXGFiMJkrk6W3RuwRrZs64?theme=DARK&contentTheme=DARK#MHw5d76uDo2tBLx86cduFQMRsBb) |
+| tags | object | `{"atomi.cloud/layer":"1","atomi.cloud/module":"operator","atomi.cloud/platform":"sulfoxide","atomi.cloud/service":"lithium"}` | Kubernetes labels and annotations, following Service Tree |
 
 ----------------------------------------------
 Autogenerated from chart metadata using [helm-docs v1.11.1](https://github.com/norwoodj/helm-docs/releases/v1.11.1)

chart/values.example.yaml

@@ -0,0 +1,22 @@
+serviceTree:
+  landscape: &landscape suicune
+  cluster: &cluster opal
+
+tags: &tags
+  atomi.cloud/landscape: *landscape
+  atomi.cloud/cluster: *cluster
+
+otel:
+  replicaCount: 3
+  manager:
+    resources:
+      requests:
+        cpu: 100m
+        memory: 128Mi
+      limits:
+        cpu: 200m
+        memory: 256Mi
+    podAnnotations:
+      <<: *tags
+    podLabels:
+      <<: *tags

chart/values.yaml

@@ -1,9 +1,18 @@
+# -- AtomiCloud Service Tree. See [ServiceTree](https://atomicloud.larksuite.com/wiki/OkfJwTXGFiMJkrk6W3RuwRrZs64?theme=DARK&contentTheme=DARK#MHw5d76uDo2tBLx86cduFQMRsBb)
 serviceTree:
-  landscape: pichu
-  cluster: opal
-  platform: systems
-  service: telemetry-collector
-  layer: "1"
+  platform: &platform sulfoxide
+  service: &service lithium
+  module: &module operator
+  layer: &layer "1"
+
+# -- Kubernetes labels and annotations, following Service Tree
+tags: &tags
+  atomi.cloud/platform: *platform
+  atomi.cloud/service: *service
+  atomi.cloud/module: *module
+  atomi.cloud/layer: *layer
+
+# -- OTEL Collector Operator Configurations. See [OTEL Collector Operator Helm Chart Documentation](https://github.com/open-telemetry/opentelemetry-operator)
 otel:
   replicaCount: 3
   manager:
@@ -15,16 +24,6 @@ otel:
         cpu: 200m
         memory: 256Mi
     podAnnotations:
-      atomi.cloud/landscape: pichu
-      atomi.cloud/cluster: opal
-      atomi.cloud/platform: systems
-      atomi.cloud/service: telemetry-collector
-      atomi.cloud/designation: operator
-      atomi.cloud/layer: "1"
+      <<: *tags
     podLabels:
-      atomi.cloud/landscape: pichu
-      atomi.cloud/cluster: opal
-      atomi.cloud/platform: systems
-      atomi.cloud/service: telemetry-collector
-      atomi.cloud/designation: operator
-      atomi.cloud/layer: "1"
+      <<: *tags