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.

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: Don't allow running new and old querier worker grpc clients #12916

Merged
merged 4 commits into from
May 8, 2024

Conversation

DylanGuedes
Copy link
Contributor

What this PR does / why we need it:
Make new and old ways of configuring querier workers grpc clients mutually exclusive. Otherwise we'll never migrate to the new configs.

Which issue(s) this PR fixes:
Fixes #

Special notes for your reviewer:

Checklist

  • Reviewed the CONTRIBUTING.md guide (required)
  • Documentation added
  • Tests updated
  • Title matches the required conventional commits format, see here
    • Note that Promtail is considered to be feature complete, and future development for logs collection will be in Grafana Alloy. As such, feat PRs are unlikely to be accepted unless a case can be made for the feature actually being a bug fix to existing behavior.
  • 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

@pull-request-size pull-request-size bot added size/M and removed size/S labels May 8, 2024
@github-actions github-actions bot added the type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories label May 8, 2024
@DylanGuedes DylanGuedes changed the title Make it impossible to run both new and old configs. docs: Don't allow running new and old querier worker grpc clients May 8, 2024
@DylanGuedes DylanGuedes marked this pull request as ready for review May 8, 2024 12:15
@DylanGuedes DylanGuedes requested a review from a team as a code owner May 8, 2024 12:15
@@ -2237,19 +2237,19 @@ The `frontend_worker` configures the worker - running within the Loki querier -
[id: <string> | default = ""]

# Configures the querier gRPC client used to communicate with the
# query-frontend. Shouldn't be used in conjunction with 'grpc_client_config'.
# query-frontend. Can't be used in conjunction with 'grpc_client_config'.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(nit) I prefer full sentences:

Suggested change
# query-frontend. Can't be used in conjunction with 'grpc_client_config'.
# query-frontend. This can't be used in conjunction with 'grpc_client_config'.

Copy link
Contributor

@JStickler JStickler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[docs team] LGTM

@DylanGuedes DylanGuedes merged commit 18a558c into main May 8, 2024
59 checks passed
@DylanGuedes DylanGuedes deleted the make-grpc-configs-mutually-exclusive branch May 8, 2024 22:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size/M type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants