Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: adding exceptions to Vale rule (backport release-3.2.x) #15447

Merged
merged 1 commit into from
Dec 17, 2024
+30 −16
Merged

docs: adding exceptions to Vale rule (backport release-3.2.x) #15447

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions docs/sources/setup/install/helm/reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Helm Chart Values
title: Helm chart values
menuTitle: Helm chart values
description: Reference for Helm Chart values.
aliases:
Expand All @@ -10,7 +10,7 @@ keywords: []

<!-- Autogenerated. Modify ../production/helm/loki/reference.md.gotmpl -->

# Helm Chart Values
# Helm chart values
<!-- vale Grafana.Quotes = NO -->
<!-- The reference title is required. Use a noun-based title. -->
<!-- vale Grafana.Quotes = YES -->
Expand All @@ -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).

<!-- vale Grafana.Spelling = NO -->
<!-- Override default values table from helm-docs. See https://github.com/norwoodj/helm-docs/tree/master#advanced-table-rendering -->

{{< responsive-table >}}
Expand Down Expand Up @@ -10977,3 +10978,5 @@ null
</table>
{{< /responsive-table >}}

<!-- vale Grafana.Spelling = YES -->

16 changes: 10 additions & 6 deletions docs/sources/shared/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ 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:

```
```bash
${VAR}
```

Expand All @@ -56,7 +56,7 @@ References to undefined variables are replaced by empty strings unless you speci

To specify a default value, use:

```
```bash
${VAR:-default_value}
```

Expand All @@ -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`

<!-- vale Grafana.Spelling = NO -->

```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
Expand Down Expand Up @@ -6678,6 +6680,8 @@ Configuration for `tracing`.
[enabled: <boolean> | default = true]
```

<!-- vale Grafana.Spelling = YES -->

## 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=<filename>` flag and reload period (which defaults to 10 seconds) can be changed by `-runtime-config.reload-period=<duration>` flag. Previously this mechanism was only used by limits overrides, and flags were called `-limits.per-user-override-config=<filename>` and `-limits.per-user-override-period=10s` respectively. These are still used, if `-runtime-config.file=<filename>` is not specified.
Expand Down Expand Up @@ -6722,23 +6726,23 @@ 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
```

- To disable out-of-order writes for specific tenants,
configure a runtime configuration file:

```
```yaml
runtime_config:
file: overrides.yaml
```

In the `overrides.yaml` file, add `unordered_writes` for each tenant
permitted to have out-of-order writes:

```
```yaml
overrides:
"tenantA":
unordered_writes: false
Expand All @@ -6750,7 +6754,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)
```

Expand Down
16 changes: 10 additions & 6 deletions docs/templates/configuration.template
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ 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:

```
```bash
${VAR}
```

Expand All @@ -56,7 +56,7 @@ References to undefined variables are replaced by empty strings unless you speci

To specify a default value, use:

```
```bash
${VAR:-default_value}
```

Expand All @@ -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`

<!-- vale Grafana.Spelling = NO -->

{{ .ConfigFile }}

<!-- vale Grafana.Spelling = YES -->

## 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=<filename>` flag and reload period (which defaults to 10 seconds) can be changed by `-runtime-config.reload-period=<duration>` flag. Previously this mechanism was only used by limits overrides, and flags were called `-limits.per-user-override-config=<filename>` and `-limits.per-user-override-period=10s` respectively. These are still used, if `-runtime-config.file=<filename>` is not specified.
Expand Down Expand Up @@ -124,23 +128,23 @@ 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
```

- To disable out-of-order writes for specific tenants,
configure a runtime configuration file:

```
```yaml
runtime_config:
file: overrides.yaml
```

In the `overrides.yaml` file, add `unordered_writes` for each tenant
permitted to have out-of-order writes:

```
```yaml
overrides:
"tenantA":
unordered_writes: false
Expand All @@ -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)
```

Expand Down
7 changes: 5 additions & 2 deletions production/helm/loki/reference.md.gotmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Helm Chart Values
title: Helm chart values
menuTitle: Helm chart values
description: Reference for Helm Chart values.
aliases:
Expand All @@ -10,7 +10,7 @@ keywords: []

<!-- Autogenerated. Modify ../production/helm/loki/reference.md.gotmpl -->

# Helm Chart Values
# Helm chart values
<!-- vale Grafana.Quotes = NO -->
<!-- The reference title is required. Use a noun-based title. -->
<!-- vale Grafana.Quotes = YES -->
Expand All @@ -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).

<!-- vale Grafana.Spelling = NO -->
<!-- Override default values table from helm-docs. See https://github.com/norwoodj/helm-docs/tree/master#advanced-table-rendering -->
{{ define "chart.valuesTableHtml" }}
{{ `{{< responsive-table >}}` }}
Expand All @@ -47,3 +48,5 @@ This is the generated reference for the Loki Helm Chart values.
{{ end }}

{{ template "chart.valuesTableHtml" . }}
<!-- vale Grafana.Spelling = YES -->

Loading