From 75aa434869c47121d93dff9ac4f314ae33934f37 Mon Sep 17 00:00:00 2001 From: Julie Stickler Date: Mon, 16 Dec 2024 18:06:49 -0500 Subject: [PATCH 1/2] docs:adding exceptions to Vale rule --- docs/sources/setup/install/helm/reference.md | 7 +++++-- docs/sources/shared/configuration.md | 20 ++++++++++++-------- docs/templates/configuration.template | 20 ++++++++++++-------- production/helm/loki/reference.md.gotmpl | 7 +++++-- 4 files changed, 34 insertions(+), 20 deletions(-) diff --git a/docs/sources/setup/install/helm/reference.md b/docs/sources/setup/install/helm/reference.md index 81619a5de0a46..9478186b96dda 100644 --- a/docs/sources/setup/install/helm/reference.md +++ b/docs/sources/setup/install/helm/reference.md @@ -1,5 +1,5 @@ --- -title: Helm Chart Values +title: Helm chart values menuTitle: Helm chart values description: Reference for Helm Chart values. aliases: @@ -10,7 +10,7 @@ keywords: [] -# Helm Chart Values +# Helm chart values @@ -22,6 +22,7 @@ This is the generated reference for the Loki Helm Chart values. > please refer to the `values.yaml` of the respective Github repository > [grafana/helm-charts](https://github.com/grafana/helm-charts/tree/main/charts/loki-stack). + {{< responsive-table >}} @@ -11782,3 +11783,5 @@ null {{< /responsive-table >}} + + diff --git a/docs/sources/shared/configuration.md b/docs/sources/shared/configuration.md index b64879703c960..c30347fc01db0 100644 --- a/docs/sources/shared/configuration.md +++ b/docs/sources/shared/configuration.md @@ -44,8 +44,8 @@ value is set to the specified default. You can use environment variable references in the configuration file to set values that need to be configurable during deployment. To do this, pass `-config.expand-env=true` and use: -``` -${VAR} +```bash +{VAR} ``` Where VAR is the name of the environment variable. @@ -56,8 +56,8 @@ References to undefined variables are replaced by empty strings unless you speci To specify a default value, use: -``` -${VAR:-default_value} +```bash +{VAR:-default_value} ``` Where default_value is the value to use if the environment variable is undefined. @@ -78,6 +78,8 @@ Pass the `-config.expand-env` flag at the command line to enable this way of set ### Supported contents and default values of `loki.yaml` + + ```yaml # A comma-separated list of components to run. The default value 'all' runs Loki # in single binary mode. The value 'read' is an alias to run only read-path @@ -6448,6 +6450,8 @@ Configuration for `tracing`. [enabled: | default = true] ``` + + ## Runtime Configuration file Loki has a concept of "runtime config" file, which is simply a file that is reloaded while Loki is running. It is used by some Loki components to allow operator to change some aspects of Loki configuration without restarting it. File is specified by using `-runtime-config.file=` flag and reload period (which defaults to 10 seconds) can be changed by `-runtime-config.reload-period=` flag. Previously this mechanism was only used by limits overrides, and flags were called `-limits.per-user-override-config=` and `-limits.per-user-override-period=10s` respectively. These are still used, if `-runtime-config.file=` is not specified. @@ -6492,7 +6496,7 @@ on a cluster or per-tenant basis. - To disable out-of-order writes for all tenants, place in the `limits_config` section: - ``` + ```yaml limits_config: unordered_writes: false ``` @@ -6500,7 +6504,7 @@ place in the `limits_config` section: - To disable out-of-order writes for specific tenants, configure a runtime configuration file: - ``` + ```yaml runtime_config: file: overrides.yaml ``` @@ -6508,7 +6512,7 @@ configure a runtime configuration file: In the `overrides.yaml` file, add `unordered_writes` for each tenant permitted to have out-of-order writes: - ``` + ```yaml overrides: "tenantA": unordered_writes: false @@ -6520,7 +6524,7 @@ is configurable with `max_chunk_age`. Loki calculates the earliest time that out-of-order entries may have and be accepted with -``` +```yaml time_of_most_recent_line - (max_chunk_age/2) ``` diff --git a/docs/templates/configuration.template b/docs/templates/configuration.template index 47945146b210e..3050090ba9e8f 100644 --- a/docs/templates/configuration.template +++ b/docs/templates/configuration.template @@ -44,8 +44,8 @@ value is set to the specified default. You can use environment variable references in the configuration file to set values that need to be configurable during deployment. To do this, pass `-config.expand-env=true` and use: -``` -${VAR} +```bash +{VAR} ``` Where VAR is the name of the environment variable. @@ -56,8 +56,8 @@ References to undefined variables are replaced by empty strings unless you speci To specify a default value, use: -``` -${VAR:-default_value} +```bash +{VAR:-default_value} ``` Where default_value is the value to use if the environment variable is undefined. @@ -78,8 +78,12 @@ Pass the `-config.expand-env` flag at the command line to enable this way of set ### Supported contents and default values of `loki.yaml` + + {{ .ConfigFile }} + + ## Runtime Configuration file Loki has a concept of "runtime config" file, which is simply a file that is reloaded while Loki is running. It is used by some Loki components to allow operator to change some aspects of Loki configuration without restarting it. File is specified by using `-runtime-config.file=` flag and reload period (which defaults to 10 seconds) can be changed by `-runtime-config.reload-period=` flag. Previously this mechanism was only used by limits overrides, and flags were called `-limits.per-user-override-config=` and `-limits.per-user-override-period=10s` respectively. These are still used, if `-runtime-config.file=` is not specified. @@ -124,7 +128,7 @@ on a cluster or per-tenant basis. - To disable out-of-order writes for all tenants, place in the `limits_config` section: - ``` + ```yaml limits_config: unordered_writes: false ``` @@ -132,7 +136,7 @@ place in the `limits_config` section: - To disable out-of-order writes for specific tenants, configure a runtime configuration file: - ``` + ```yaml runtime_config: file: overrides.yaml ``` @@ -140,7 +144,7 @@ configure a runtime configuration file: In the `overrides.yaml` file, add `unordered_writes` for each tenant permitted to have out-of-order writes: - ``` + ```yaml overrides: "tenantA": unordered_writes: false @@ -152,7 +156,7 @@ is configurable with `max_chunk_age`. Loki calculates the earliest time that out-of-order entries may have and be accepted with -``` +```yaml time_of_most_recent_line - (max_chunk_age/2) ``` diff --git a/production/helm/loki/reference.md.gotmpl b/production/helm/loki/reference.md.gotmpl index 0efc492767c2b..e7cc2d6df14cb 100644 --- a/production/helm/loki/reference.md.gotmpl +++ b/production/helm/loki/reference.md.gotmpl @@ -1,5 +1,5 @@ --- -title: Helm Chart Values +title: Helm chart values menuTitle: Helm chart values description: Reference for Helm Chart values. aliases: @@ -10,7 +10,7 @@ keywords: [] -# Helm Chart Values +# Helm chart values @@ -22,6 +22,7 @@ This is the generated reference for the Loki Helm Chart values. > please refer to the `values.yaml` of the respective Github repository > [grafana/helm-charts](https://github.com/grafana/helm-charts/tree/main/charts/loki-stack). + {{ define "chart.valuesTableHtml" }} {{ `{{< responsive-table >}}` }} @@ -47,3 +48,5 @@ This is the generated reference for the Loki Helm Chart values. {{ end }} {{ template "chart.valuesTableHtml" . }} + + From 016dfbf3738032ba0b336ebc619e36cc9d16603b Mon Sep 17 00:00:00 2001 From: Julie Stickler Date: Tue, 17 Dec 2024 11:09:43 -0500 Subject: [PATCH 2/2] review comments --- docs/sources/shared/configuration.md | 4 ++-- docs/templates/configuration.template | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/sources/shared/configuration.md b/docs/sources/shared/configuration.md index c30347fc01db0..2237aacfd988c 100644 --- a/docs/sources/shared/configuration.md +++ b/docs/sources/shared/configuration.md @@ -45,7 +45,7 @@ You can use environment variable references in the configuration file to set val To do this, pass `-config.expand-env=true` and use: ```bash -{VAR} +${VAR} ``` Where VAR is the name of the environment variable. @@ -57,7 +57,7 @@ References to undefined variables are replaced by empty strings unless you speci To specify a default value, use: ```bash -{VAR:-default_value} +${VAR:-default_value} ``` Where default_value is the value to use if the environment variable is undefined. diff --git a/docs/templates/configuration.template b/docs/templates/configuration.template index 3050090ba9e8f..038176d9f47e4 100644 --- a/docs/templates/configuration.template +++ b/docs/templates/configuration.template @@ -45,7 +45,7 @@ You can use environment variable references in the configuration file to set val To do this, pass `-config.expand-env=true` and use: ```bash -{VAR} +${VAR} ``` Where VAR is the name of the environment variable. @@ -57,7 +57,7 @@ References to undefined variables are replaced by empty strings unless you speci To specify a default value, use: ```bash -{VAR:-default_value} +${VAR:-default_value} ``` Where default_value is the value to use if the environment variable is undefined.