Skip to content

Commit

Permalink
feat: Update sections
Browse files Browse the repository at this point in the history
  • Loading branch information
@mgagliardo91
mgagliardo91 committed Apr 7, 2022
1 parent 3b6b8ed commit 13c2539
Show file tree
Hide file tree
Showing 10 changed files with 60 additions and 34 deletions.
4 changes: 3 additions & 1 deletion ndustrial/common/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand All @@ -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` |
Expand All @@ -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
Expand Down
32 changes: 19 additions & 13 deletions ndustrial/cronjob/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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" | `""` |


8 changes: 4 additions & 4 deletions ndustrial/cronjob/_var_list.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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:
2 changes: 2 additions & 0 deletions ndustrial/cronjob/values.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
14 changes: 10 additions & 4 deletions ndustrial/deployment/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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" | `""` |


8 changes: 4 additions & 4 deletions ndustrial/deployment/_var_list.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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:
2 changes: 2 additions & 0 deletions ndustrial/deployment/values.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
14 changes: 10 additions & 4 deletions ndustrial/statefulset/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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" | `""` |


8 changes: 4 additions & 4 deletions ndustrial/statefulset/_var_list.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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:
2 changes: 2 additions & 0 deletions ndustrial/statefulset/values.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 13c2539

Please sign in to comment.