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

Jump to bottom

Common storage backend docs #2347

Merged
merged 10 commits into from
Aug 8, 2022
Merged

Common storage backend docs #2347

merged 10 commits into from
Aug 8, 2022

Conversation

colega
Copy link
Contributor

@colega colega commented Jul 8, 2022 •
edited
Loading

What this PR does

Adds documentation to the feature added in #2330

Which issue(s) this PR fixes or relates to

Fixes #2319

Checklist

  • Tests updated
  • Documentation added
  • CHANGELOG.md updated - the order of entries should be [CHANGE], [FEATURE], [ENHANCEMENT], [BUGFIX]

@colega colega added the type/docs Improvements or additions to documentation label Jul 8, 2022
@colega colega mentioned this pull request Jul 8, 2022
Merged
3 tasks
@colega colega requested review from osg-grafana and pracucci July 8, 2022 11:26
@osg-grafana
Copy link
Contributor

@colega, is this going in to 2.2 or 2.3?

@colega
Copy link
Contributor Author

colega commented Jul 8, 2022

This is going to be 2.3

@osg-grafana osg-grafana added this to the 2.3 milestone Jul 8, 2022
osg-grafana
osg-grafana suggested changes Jul 8, 2022
View reviewed changes
Copy link
Contributor

@osg-grafana osg-grafana left a comment

Choose a reason for hiding this comment

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

Blocking until I can pick this up again after 2.2 goes out.

docs/sources/operators-guide/configuring/about-configurations.md Outdated Show resolved Hide resolved
docs/sources/operators-guide/configuring/about-configurations.md Outdated Show resolved Hide resolved
docs/sources/operators-guide/configuring/about-configurations.md Outdated Show resolved Hide resolved
docs/sources/operators-guide/configuring/configuring-object-storage-backend.md Outdated Show resolved Hide resolved
docs/sources/operators-guide/configuring/configuring-object-storage-backend.md Outdated Show resolved Hide resolved
docs/sources/operators-guide/configuring/configuring-object-storage-backend.md Outdated Show resolved Hide resolved
docs/sources/operators-guide/configuring/about-configurations.md Outdated Show resolved Hide resolved
@colega colega force-pushed the common-storage-backend-config branch from f185a6b to df7d532 Compare July 8, 2022 14:12
pracucci
pracucci approved these changes Jul 8, 2022
View reviewed changes
Copy link
Collaborator

@pracucci pracucci left a comment

Choose a reason for hiding this comment

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

Solid work! I left few minor comments. Technical accuracy is 👍 . I let Ursula follow up for the form :)

docs/sources/operators-guide/configuring/configure-object-storage-backend.md Outdated Show resolved Hide resolved
docs/sources/operators-guide/configuring/configure-object-storage-backend.md Outdated Show resolved Hide resolved
docs/sources/operators-guide/configuring/configure-object-storage-backend.md Outdated Show resolved Hide resolved
docs/sources/operators-guide/configuring/configure-object-storage-backend.md Outdated Show resolved Hide resolved
@colega colega force-pushed the common-storage-backend-config branch from df7d532 to d652246 Compare July 8, 2022 14:50
Base automatically changed from common-storage-backend-config to main July 8, 2022 15:03
@osg-grafana
Copy link
Contributor

@colega, can we move this forward now?

colega added 2 commits July 29, 2022 08:56
@colega
Common storage backend docs
44029b2 
Signed-off-by: Oleg Zaytsev <mail@olegzaytsev.com>
@colega
make docs
0381408 
Signed-off-by: Oleg Zaytsev <mail@olegzaytsev.com>
@colega colega force-pushed the common-storage-backend-config-docs branch from 589dc24 to 426146d Compare July 29, 2022 06:58
osg-grafana and others added 5 commits July 29, 2022 09:16
@osg-grafana @colega
Rename configuring-object-storage-backend.md to configure-object-stor…
64b943c 
…age-backend.md
@colega @osg-grafana @pracucci
Apply suggestions from code review
8426185 
Co-authored-by: Ursula Kallio <ursula.kallio@grafana.com>
Co-authored-by: Marco Pracucci <marco@pracucci.com>
@colega
s/Configuring/Configure/
1b23d00 
Signed-off-by: Oleg Zaytsev <mail@olegzaytsev.com>
@colega
Add link for "Ruler and alertmanager support a local backend"
9b4bb49 
Signed-off-by: Oleg Zaytsev <mail@olegzaytsev.com>
@colega
Add link to precedence logic of YAML and CLI
1e07d73 
Signed-off-by: Oleg Zaytsev <mail@olegzaytsev.com>
@colega colega force-pushed the common-storage-backend-config-docs branch 2 times, most recently from a804ac5 to 515f623 Compare July 29, 2022 07:18
@colega
s/configuring/configure/ in paths
4923632 
Signed-off-by: Oleg Zaytsev <mail@olegzaytsev.com>
@colega colega force-pushed the common-storage-backend-config-docs branch from 515f623 to 4923632 Compare July 29, 2022 07:18
@colega
Copy link
Contributor Author

colega commented Jul 29, 2022

@osg-grafana I applied all the feedback now. Sorry for the delay, PTAL.

osg-grafana
osg-grafana reviewed Jul 29, 2022
View reviewed changes
docs/sources/operators-guide/configure/about-configurations.md

For a reference of this configuration, see [object storage configuration reference ]({{< relref "configure-object-storage-backend.md" >}}).

The precedence of the common configuration is as follows, where each configuration overrides the previous one:
Copy link
Contributor

Choose a reason for hiding this comment

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

Very clear, nice job! :)

osg-grafana
osg-grafana approved these changes Jul 29, 2022
View reviewed changes
Copy link
Contributor

@osg-grafana osg-grafana left a comment

Choose a reason for hiding this comment

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

Thanks, @colega! Unblocking with feedback.

@colega @osg-grafana
Apply suggestions from code review
10ae66e 
Co-authored-by: Ursula Kallio <ursula.kallio@grafana.com>
@colega
Copy link
Contributor Author

colega commented Jul 29, 2022

Thank you for all the feedback, @osg-grafana !!

@colega
make doc
716f5a1 
Signed-off-by: Oleg Zaytsev <mail@olegzaytsev.com>
@colega colega merged commit 80597ff into main Aug 8, 2022
@colega colega deleted the common-storage-backend-config-docs branch August 8, 2022 11:29
@colega colega mentioned this pull request Aug 23, 2022
Closed
@pracucci pracucci mentioned this pull request Sep 16, 2022
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@osg-grafana osg-grafana osg-grafana approved these changes

@pracucci pracucci pracucci approved these changes

Assignees

@colega colega

Labels
type/docs Improvements or additions to documentation
Projects
None yet
Milestone
2.3
Development

Successfully merging this pull request may close these issues.

Allow configuring block storage everywhere from a common place
3 participants
@colega @osg-grafana @pracucci