docs: Update Kubernetes terminology in setup/install/helm/reference.md #12234

edsoncelio · 2024-03-16T18:41:52Z

What this PR does / why we need it:
Update docs to use the correct Kubernetes terminology.
https://grafana.com/docs/writers-toolkit/write/style-guide/capitalization-punctuation/#kubernetes-objects

Which issue(s) this PR fixes:
Fixes #11944

Special notes for your reviewer:
Command to check using vale:

vale --filter='.Name =="Grafana.Kubernetes"' docs/sources/setup/install/helm/reference.md

Checklist

Reviewed the CONTRIBUTING.md guide (required)
Documentation added
Tests updated
CHANGELOG.md updated
- If the change is worth mentioning in the release notes, add add-to-release-notes label
Changes that require user attention or interaction to upgrade are documented in docs/sources/setup/upgrade/_index.md
For Helm chart changes bump the Helm chart version in production/helm/loki/Chart.yaml and update production/helm/loki/CHANGELOG.md and production/helm/loki/README.md. Example PR
If the change is deprecating or removing a configuration option, update the deprecated-config.yaml and deleted-config.yaml files respectively in the tools/deprecated-config-checker directory. Example PR

jdbaldry

Thank you for this contribution and for reading through our style guide!

It's great to have the style guide propagating through our docs, the consistency will surely make them easier to read :)

I'll let the Loki technical writer double check the changes.

edsoncelio · 2024-03-18T13:11:02Z

Thank you for this contribution and for reading through our style guide!

It's great to have the style guide propagating through our docs, the consistency will surely make them easier to read :)

I'll let the Loki technical writer double check the changes.
Thanks!

I'm in doubt in this PR because looks like this file is generated automatically (or almost that) running a command instead of manually created.

Based on that error:
Please generate Helm Chart reference by running 'make -C docs sources/setup/install/helm/reference.md'

JStickler · 2024-03-19T18:17:30Z

@edsoncelio Did you edit this file directly? Or was this change automatically generated? The Helm reference should be updated in production/helm/loki/reference.md.gotmlp. There's a note to that effect at line 11 of the docs/sources/setup/install/helm/reference.md file, you might have missed it.

Also any Helm changes (even documentation) requires that you bump the Helm chart version in production/helm/loki/Chart.yaml and update production/helm/loki/CHANGELOG.md and production/helm/loki/README.md. Example PR

edsoncelio · 2024-03-19T18:22:11Z

@edsoncelio Did you edit this file directly? Or was this change automatically generated? The Helm reference should be updated in production/helm/loki/reference.md.gotmlp. There's a note to that effect at line 11 of the docs/sources/setup/install/helm/reference.md file, you might have missed it.

Also any Helm changes (even documentation) requires that you bump the Helm chart version in production/helm/loki/Chart.yaml and update production/helm/loki/CHANGELOG.md and production/helm/loki/README.md. Example PR

Hi!
I've edited it directly.
Thanks for clarifying I missed the note.
I'll update the PR during the week :)

JStickler · 2024-03-19T18:32:54Z

Thanks. And don't be surprised if you have to update the Helm version more than once. It depends on how many Helm updates we have on any given day.

…n templates (grafana#12242) Signed-off-by: Michel Hollands <[email protected]>

Signed-off-by: Jan-Otto Kröpke <[email protected]>

…#12196) Co-authored-by: Salva Corts <[email protected]>

Co-authored-by: Michel Hollands <[email protected]>

Co-authored-by: J Stickler <[email protected]> Co-authored-by: Jack Baldry <[email protected]>

Every time when reading a bloom page into memory, a new byte slice with the size of the decoded page was allocated. This PR changes bloom page decoder to use a byte slice from the `BlockPool`. The caller (`LazyBloomIter` of the block querier) is responsible for closing the page whenever a new one is loaded, so the byte slice is put back to its pool. Additionally, this PR changes the max bucket of the `BlockPool` byte slice pool to 64MB so that pages bigger than 16MB are correctly put back to the pool, since [slices exceeding the capacity of the largest bucket are not put back](https://github.com/grafana/loki/blob/main/vendor/github.com/prometheus/prometheus/util/pool/pool.go#L74-L87). --- Signed-off-by: Christian Haudum <[email protected]>

…na#12222)

**What this PR does / why we need it**: This change allows the retrieval of the `TenantConfig` or the `DefaultConfig`. It also defines an interface instead of a tenant config function which makes it a little easier to grok the code. Eventually this will enable us to introduce GEL specific configurations. **Checklist** - [ ] Reviewed the [`CONTRIBUTING.md`](https://github.com/grafana/loki/blob/main/CONTRIBUTING.md) guide (**required**) - [ ] Documentation added - [x] Tests updated - [ ] `CHANGELOG.md` updated - [ ] If the change is worth mentioning in the release notes, add `add-to-release-notes` label - [ ] Changes that require user attention or interaction to upgrade are documented in `docs/sources/setup/upgrade/_index.md` - [ ] For Helm chart changes bump the Helm chart version in `production/helm/loki/Chart.yaml` and update `production/helm/loki/CHANGELOG.md` and `production/helm/loki/README.md`. [Example PR](grafana@d10549e) - [ ] If the change is deprecating or removing a configuration option, update the `deprecated-config.yaml` and `deleted-config.yaml` files respectively in the `tools/deprecated-config-checker` directory. [Example PR](grafana@0d4416a)

… wal (grafana#12219) Co-authored-by: J Stickler <[email protected]>

Signed-off-by: Michel Hollands <[email protected]>

grafana#12265)

The blocks cache is an in-memory cache that represents the single source of truth of what blocks are available on the file system and manages their end-of-life behaviour. There is a follow-up branch to wire up the new cache, based on this branch. Signed-off-by: Christian Haudum <[email protected]>

Co-authored-by: Travis Patterson <[email protected]>

Co-authored-by: loki-gh-app[bot] <160051081+loki-gh-app[bot]@users.noreply.github.com> Co-authored-by: Trevor Whitney <[email protected]>

…rafana#12149) Co-authored-by: Trevor Whitney <[email protected]>

This PR updates the Prometheus dependency in Loki and Promtail. The PR is required so that we can also update Grafana Agent to the latest Prometheus. Unfortunately, Promtail and Loki share the same go.mod file.

…e size for querying (grafana#12297) Signed-off-by: Christian Haudum <[email protected]>

Signed-off-by: Christian Haudum <[email protected]>

A concurrency of 10 per worker seems to be too high for a reasonable 8GiB memory limit on bloom gateways. So this PR makes the concurrency configurable and uses a default of 4. Memory usage of loading block pages into memory therefore being: ``` worker_concurrency x block_query_concurrency x max_block_page_size x 2 ``` With current defaults: ``` 4 x 4 x 32MiB x 2 = 1GiB ``` Signed-off-by: Christian Haudum <[email protected]>

edsoncelio · 2024-03-22T00:31:27Z

I'll close this PR and open a new with the updated branch :)

docs: fix terminology pod to Pod

3c81704

edsoncelio requested a review from a team as a code owner March 16, 2024 18:41

pull-request-size bot added the size/S label Mar 16, 2024

github-actions bot added the type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories label Mar 16, 2024

jdbaldry approved these changes Mar 18, 2024

View reviewed changes

ashwanthgoli and others added 21 commits March 21, 2024 21:24

chore(image-tags): exclude helm release tags (grafana#12240)

e8dca07

fix: Helm fix usage of http_listen_port and grpc_listen_port fields i…

ad02d24

…n templates (grafana#12242) Signed-off-by: Michel Hollands <[email protected]>

fix: helm template error if ingress is enabled (grafana#12241)

fdd7249

Signed-off-by: Jan-Otto Kröpke <[email protected]>

fix(bloom-compactor): Correctly disable the bloom-compactor. (grafana…

bc4b0e3

…#12196) Co-authored-by: Salva Corts <[email protected]>

feat: use http_listen_port for compactorAddress (grafana#12230)

78c36ab

Co-authored-by: Michel Hollands <[email protected]>

docs: Update structured metadata docs (grafana#12187)

20bc313

docs: Update Kubernetes terminology in operations pages (grafana#12235)

b897510

Co-authored-by: J Stickler <[email protected]> Co-authored-by: Jack Baldry <[email protected]>

test: Fix race condition in LogQL test (grafana#12247)

1732648

feat: Helm: Add extraContainers to read pods (grafana#12243)

97244e2

feat(operator): Restructure LokiStack metrics (grafana#12228)

4734e8f

feat(blooms): Dedupe download queue items to reduce queue size (grafa…

986b617

…na#12222)

fix: Remove lost character in ciliumnetworkpolicy.yaml (grafana#12263)

869ff5d

docs: Updated the information in the documentation about working with…

f159ae3

… wal (grafana#12219) Co-authored-by: J Stickler <[email protected]>

ci: track main of loki-release on main branch (grafana#12264)

35ee676

fix: update google.golang.org/protobuf to v1.33.0 (grafana#12269)

0bd2afc

Signed-off-by: Michel Hollands <[email protected]>

fix: pass correctly formatted query tags from the ruler to the querier (

5d01a45

grafana#12265)

chore: make error labels injectable via 'Add' (grafana#12251)

26bf1d9

chore: allow lint to be run in container locally (grafana#12277)

6109a15

ashwanthgoli and others added 17 commits March 21, 2024 21:24

fix(querytags): propagate query tags to ingesters (grafana#12267)

8a9f8cd

Co-authored-by: Travis Patterson <[email protected]>

ci: CVE scanning and bump release pipeline (grafana#12031)

481c238

feat(helm): Upgrade helm Loki version (grafana#12094)

ef835fe

Co-authored-by: loki-gh-app[bot] <160051081+loki-gh-app[bot]@users.noreply.github.com> Co-authored-by: Trevor Whitney <[email protected]>

fix(nix): no systemd package on darwin systems (grafana#12229)

04cf7e5

chore(operator): adds reusable workflow for opening PRs to hub repos (g…

1e7ee4d

…rafana#12149) Co-authored-by: Trevor Whitney <[email protected]>

chore(operator): prepare community release v0.6.0 (grafana#12246)

d298093

chore(operator): fix release operatorhub workflow (grafana#12289)

25dfda8

chore(deps): Update Prometheus in Loki and Promtail (grafana#12245)

f88c4ad

This PR updates the Prometheus dependency in Loki and Promtail. The PR is required so that we can also update Grafana Agent to the latest Prometheus. Unfortunately, Promtail and Loki share the same go.mod file.

refactor: Pass context to usage tracker. (grafana#12272)

9cf35bc

chore(operator): fix typos in release workflow (grafana#12294)

ec985c5

chore(operator): fix typo on ocp community release (grafana#12295)

813e665

fix(blooms): Correctly skip block page in case it exceeds the max pag…

9736772

…e size for querying (grafana#12297) Signed-off-by: Christian Haudum <[email protected]>

feat(blooms): Make bloom block compression configurable (grafana#12293)

7fcc65c

Signed-off-by: Christian Haudum <[email protected]>

feat(bloomstore): Wire up new blocks cache (grafana#12275)

28c7677

Signed-off-by: Christian Haudum <[email protected]>

fix(blooms): leaky ref (grafana#12300)

97bfb9e

fix(blooms): fix typo in pool decl (grafana#12302)

9253500

edsoncelio requested review from periklis and xperimental as code owners March 22, 2024 00:30

edsoncelio marked this pull request as draft March 22, 2024 00:30

github-actions bot added sig/operator area/helm labels Mar 22, 2024

edsoncelio closed this Mar 22, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Update Kubernetes terminology in setup/install/helm/reference.md #12234

docs: Update Kubernetes terminology in setup/install/helm/reference.md #12234

edsoncelio commented Mar 16, 2024 •

edited

Loading

jdbaldry left a comment

edsoncelio commented Mar 18, 2024

JStickler commented Mar 19, 2024 •

edited

Loading

edsoncelio commented Mar 19, 2024

JStickler commented Mar 19, 2024

edsoncelio commented Mar 22, 2024

docs: Update Kubernetes terminology in setup/install/helm/reference.md #12234

docs: Update Kubernetes terminology in setup/install/helm/reference.md #12234

Conversation

edsoncelio commented Mar 16, 2024 • edited Loading

jdbaldry left a comment

Choose a reason for hiding this comment

edsoncelio commented Mar 18, 2024

JStickler commented Mar 19, 2024 • edited Loading

edsoncelio commented Mar 19, 2024

JStickler commented Mar 19, 2024

edsoncelio commented Mar 22, 2024

edsoncelio commented Mar 16, 2024 •

edited

Loading

JStickler commented Mar 19, 2024 •

edited

Loading