From 13c253963f86eba7760d7e6d2dc83848207276ed Mon Sep 17 00:00:00 2001 From: Michael Gagliardo Date: Thu, 7 Apr 2022 16:56:56 -0400 Subject: [PATCH] feat: Update sections --- ndustrial/common/README.md | 4 +++- ndustrial/cronjob/README.md | 32 +++++++++++++++++------------ ndustrial/cronjob/_var_list.yml | 8 ++++---- ndustrial/cronjob/values.yaml | 2 ++ ndustrial/deployment/README.md | 14 +++++++++---- ndustrial/deployment/_var_list.yml | 8 ++++---- ndustrial/deployment/values.yaml | 2 ++ ndustrial/statefulset/README.md | 14 +++++++++---- ndustrial/statefulset/_var_list.yml | 8 ++++---- ndustrial/statefulset/values.yaml | 2 ++ 10 files changed, 60 insertions(+), 34 deletions(-) diff --git a/ndustrial/common/README.md b/ndustrial/common/README.md index b855f59..8bed563 100644 --- a/ndustrial/common/README.md +++ b/ndustrial/common/README.md @@ -57,6 +57,7 @@ This chart provides a common template helpers which can be used to develop new c | `contxt.serviceId` | The ID of the Contxt Service that this object belongs to (if applicable) | `nil` | | `contxt.serviceType` | The type of the Contxt Service that this object belongs to (if applicable) | `nil` | + ### Datadog integration parameters | Name | Description | Value | @@ -67,7 +68,7 @@ This chart provides a common template helpers which can be used to develop new c | `datadog.apm.version` | Set an application’s version in traces and logs e.g. 1.2.3, 6c44da20, 2020.02.13. Generally set along with DD_SERVICE. | `""` | | `datadog.apm.profiling_enabled` | Enable Datadog profiling when using ddtrace-run. (Default: false) | `false` | | `datadog.apm.logs_injection` | Enables Logs Injection https://ddtrace.readthedocs.io/en/stable/advanced_usage.html#logs-injection (Default: true) | `true` | -| `datadog.apm.trace_sample_rate` | A float, f, 0.0 <= f <= 1.0. f\*100% of traces will be sampled. (Default: 1.0) | `1` | +| `datadog.apm.trace_sample_rate` | A float, f, 0.0 <= f <= 1.0. f*100% of traces will be sampled. (Default: 1.0) | `1` | | `datadog.apm.trace_agent_host` | The Datadog Agent hostname for sending traces -- has the same functionality as the above agent_host but is used by different language's implementations of the Datadog trace library (Default: status.hostIP) | `""` | | `datadog.openmetrics.enabled` | Enable OpenMetrics scraping | `false` | | `datadog.openmetrics.schema` | The schema to use for OpenMetrics. (Default: http) | `http` | @@ -77,6 +78,7 @@ This chart provides a common template helpers which can be used to develop new c | `datadog.openmetrics.metrics` | List of metrics to collect | `[]` | | `datadog.openmetrics.type_overrides` | Override the collected metrics types | `{}` | + The following table lists the helpers available in the library which are scoped in different sections. ### Affinities diff --git a/ndustrial/cronjob/README.md b/ndustrial/cronjob/README.md index 9c98ca1..32b9aeb 100644 --- a/ndustrial/cronjob/README.md +++ b/ndustrial/cronjob/README.md @@ -105,18 +105,24 @@ ### Pod Affinity parameters -| Name | Description | Value | -| ---------------------------- | ----------------------------------------------------------------------------------------- | ------ | -| `podAffinityPreset` | Pod affinity preset. Ignored if `affinity` is set. Allowed values: `soft` or `hard` | `""` | -| `podAntiAffinityPreset` | Pod anti-affinity preset. Ignored if `affinity` is set. Allowed values: `soft` or `hard` | `soft` | -| `nodeAffinityPreset.type` | Node affinity preset type. Ignored if `affinity` is set. Allowed values: `soft` or `hard` | `""` | -| `nodeAffinityPreset.key` | Node label key to match. Ignored if `affinity` is set | `""` | -| `nodeAffinityPreset.values` | Node label values to match. Ignored if `affinity` is set | `[]` | -| `affinity` | Affinity for Cert Manager CronJob | `{}` | -| `nodeSelector` | Node labels for pod assignment | `{}` | -| `externalSecrets` | Secrets resolved from an external source | `[]` | -| `externalSecrets.0.path` | Path of the external secret | `""` | -| `externalSecrets.0.secret` | Optionally specify the name of the generated secret. Default value derived from path | `""` | -| `externalSecrets.0.provider` | Optionally specify the name of the secret store provider. Defaults to "vault-backend" | `""` | +| Name | Description | Value | +| --------------------------- | ----------------------------------------------------------------------------------------- | ------ | +| `podAffinityPreset` | Pod affinity preset. Ignored if `affinity` is set. Allowed values: `soft` or `hard` | `""` | +| `podAntiAffinityPreset` | Pod anti-affinity preset. Ignored if `affinity` is set. Allowed values: `soft` or `hard` | `soft` | +| `nodeAffinityPreset.type` | Node affinity preset type. Ignored if `affinity` is set. Allowed values: `soft` or `hard` | `""` | +| `nodeAffinityPreset.key` | Node label key to match. Ignored if `affinity` is set | `""` | +| `nodeAffinityPreset.values` | Node label values to match. Ignored if `affinity` is set | `[]` | +| `affinity` | Affinity for Cert Manager CronJob | `{}` | +| `nodeSelector` | Node labels for pod assignment | `{}` | + + +### External secrets + +| Name | Description | Value | +| ---------------------------- | ------------------------------------------------------------------------------------- | ----- | +| `externalSecrets` | Secrets resolved from an external source | `[]` | +| `externalSecrets.0.path` | Path of the external secret | `""` | +| `externalSecrets.0.secret` | Optionally specify the name of the generated secret. Default value derived from path | `""` | +| `externalSecrets.0.provider` | Optionally specify the name of the secret store provider. Defaults to "vault-backend" | `""` | diff --git a/ndustrial/cronjob/_var_list.yml b/ndustrial/cronjob/_var_list.yml index 581d10b..55e6716 100644 --- a/ndustrial/cronjob/_var_list.yml +++ b/ndustrial/cronjob/_var_list.yml @@ -296,18 +296,18 @@ default: {} type: - variable: externalSecrets - group: Pod Affinity + group: External secrets default: &2 [] type: - variable: externalSecrets.0.path - group: Pod Affinity + group: External secrets default: *2 type: - variable: externalSecrets.0.secret - group: Pod Affinity + group: External secrets default: *2 type: - variable: externalSecrets.0.provider - group: Pod Affinity + group: External secrets default: *2 type: diff --git a/ndustrial/cronjob/values.yaml b/ndustrial/cronjob/values.yaml index cc0fe73..4af96c2 100644 --- a/ndustrial/cronjob/values.yaml +++ b/ndustrial/cronjob/values.yaml @@ -310,6 +310,8 @@ affinity: {} ## nodeSelector: {} +## @section External secrets + ## @param externalSecrets [array] Secrets resolved from an external source ## @param externalSecrets.0.path [string] Path of the external secret ## @param externalSecrets.0.secret [string] Optionally specify the name of the generated secret. Default value derived from path diff --git a/ndustrial/deployment/README.md b/ndustrial/deployment/README.md index 89da8db..57021b0 100644 --- a/ndustrial/deployment/README.md +++ b/ndustrial/deployment/README.md @@ -212,9 +212,15 @@ | `datadog.openmetrics.endpoint` | The endpoint to scrape metrics from | `/metrics` | | `datadog.openmetrics.metrics` | List of metrics to collect | `[]` | | `datadog.openmetrics.type_overrides` | Override the collected metrics types | `{}` | -| `externalSecrets` | Secrets resolved from an external source | `[]` | -| `externalSecrets.0.path` | Path of the external secret | `""` | -| `externalSecrets.0.secret` | Optionally specify the name of the generated secret. Default value derived from path | `""` | -| `externalSecrets.0.provider` | Optionally specify the name of the secret store provider. Defaults to "vault-backend" | `""` | + + +### External secrets + +| Name | Description | Value | +| ---------------------------- | ------------------------------------------------------------------------------------- | ----- | +| `externalSecrets` | Secrets resolved from an external source | `[]` | +| `externalSecrets.0.path` | Path of the external secret | `""` | +| `externalSecrets.0.secret` | Optionally specify the name of the generated secret. Default value derived from path | `""` | +| `externalSecrets.0.provider` | Optionally specify the name of the secret store provider. Defaults to "vault-backend" | `""` | diff --git a/ndustrial/deployment/_var_list.yml b/ndustrial/deployment/_var_list.yml index 3af2111..ab53ec6 100644 --- a/ndustrial/deployment/_var_list.yml +++ b/ndustrial/deployment/_var_list.yml @@ -572,18 +572,18 @@ default: {} type: - variable: externalSecrets - group: Datadog integration + group: External secrets default: &2 [] type: - variable: externalSecrets.0.path - group: Datadog integration + group: External secrets default: *2 type: - variable: externalSecrets.0.secret - group: Datadog integration + group: External secrets default: *2 type: - variable: externalSecrets.0.provider - group: Datadog integration + group: External secrets default: *2 type: diff --git a/ndustrial/deployment/values.yaml b/ndustrial/deployment/values.yaml index eef19d1..da57d2e 100644 --- a/ndustrial/deployment/values.yaml +++ b/ndustrial/deployment/values.yaml @@ -588,6 +588,8 @@ datadog: ## @param datadog.openmetrics.type_overrides [object] Override the collected metrics types type_overrides: {} +## @section External secrets + ## @param externalSecrets [array] Secrets resolved from an external source ## @param externalSecrets.0.path [string] Path of the external secret ## @param externalSecrets.0.secret [string] Optionally specify the name of the generated secret. Default value derived from path diff --git a/ndustrial/statefulset/README.md b/ndustrial/statefulset/README.md index 47ff289..fbcdf36 100644 --- a/ndustrial/statefulset/README.md +++ b/ndustrial/statefulset/README.md @@ -208,9 +208,15 @@ | `datadog.openmetrics.endpoint` | The endpoint to scrape metrics from | `/metrics` | | `datadog.openmetrics.metrics` | List of metrics to collect | `[]` | | `datadog.openmetrics.type_overrides` | Override the collected metrics types | `{}` | -| `externalSecrets` | Secrets resolved from an external source | `[]` | -| `externalSecrets.0.path` | Path of the external secret | `""` | -| `externalSecrets.0.secret` | Optionally specify the name of the generated secret. Default value derived from path | `""` | -| `externalSecrets.0.provider` | Optionally specify the name of the secret store provider. Defaults to "vault-backend" | `""` | + + +### External secrets + +| Name | Description | Value | +| ---------------------------- | ------------------------------------------------------------------------------------- | ----- | +| `externalSecrets` | Secrets resolved from an external source | `[]` | +| `externalSecrets.0.path` | Path of the external secret | `""` | +| `externalSecrets.0.secret` | Optionally specify the name of the generated secret. Default value derived from path | `""` | +| `externalSecrets.0.provider` | Optionally specify the name of the secret store provider. Defaults to "vault-backend" | `""` | diff --git a/ndustrial/statefulset/_var_list.yml b/ndustrial/statefulset/_var_list.yml index d774e66..90ae34a 100644 --- a/ndustrial/statefulset/_var_list.yml +++ b/ndustrial/statefulset/_var_list.yml @@ -576,18 +576,18 @@ default: {} type: - variable: externalSecrets - group: Datadog integration + group: External secrets default: &2 [] type: - variable: externalSecrets.0.path - group: Datadog integration + group: External secrets default: *2 type: - variable: externalSecrets.0.secret - group: Datadog integration + group: External secrets default: *2 type: - variable: externalSecrets.0.provider - group: Datadog integration + group: External secrets default: *2 type: diff --git a/ndustrial/statefulset/values.yaml b/ndustrial/statefulset/values.yaml index 3444ce5..e24b7b4 100644 --- a/ndustrial/statefulset/values.yaml +++ b/ndustrial/statefulset/values.yaml @@ -573,6 +573,8 @@ datadog: ## @param datadog.openmetrics.type_overrides [object] Override the collected metrics types type_overrides: {} +## @section External secrets + ## @param externalSecrets [array] Secrets resolved from an external source ## @param externalSecrets.0.path [string] Path of the external secret ## @param externalSecrets.0.secret [string] Optionally specify the name of the generated secret. Default value derived from path