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: Move rule storages configs to their own sections #4493

Merged
merged 2 commits into from
Oct 25, 2021

Conversation

DylanGuedes
Copy link
Contributor

@DylanGuedes DylanGuedes commented Oct 18, 2021

What this PR does / why we need it:
In this PR we:

  • Create new docs sections azure_storage_config, gcs_storage_config, s3_storage_config, and swift_storage_config, with the docs configs from the existing ruler_config/storage section
  • Reference the new sections in the existing ruler_config section

Why:

  • In a future PR, I'll reuse these new sections to document a new config. Without these storages in separate configs, I would have to duplicate the configs, which might be problematic because every new change to storage-related configs would require updating multiple places
  • I'm doing this in a separate PR to avoid avoiding making PR 4485 gigantic

Which issue(s) this PR fixes:
N/A

Special notes for your reviewer:
The new sections will be used on this PR

Checklist

  • Documentation added
  • Tests updated

- Create new docs sections `azure_storage_config`, `gcs_storage_config`,
  `s3_storage_config`, and `swift_storage_config` with the docs configs from
`ruler_config["storage"]`
- Reference the new sections in the existing `ruler_config` section
- Add missing periods at `ruler_config` configs
Copy link
Member

@owen-d owen-d left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

Copy link
Contributor

@KMiller-Grafana KMiller-Grafana left a comment

Choose a reason for hiding this comment

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

LGTM.

@DylanGuedes
Copy link
Contributor Author

Thank you both for the reviews!

I don't have permission to merge it though :( could you?

- This way we can reuse these configs in different places (different from `-ruler.config`)
@dannykopping dannykopping merged commit f4cfd28 into grafana:main Oct 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants