Skip to content

[docs] Add initial documentation for read-write mode #3951

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
Merged
merged 11 commits into from
Jan 26, 2023
Merged

[docs] Add initial documentation for read-write mode #3951

merged 11 commits into from
Jan 26, 2023

Conversation

jhesketh
Copy link
Contributor

@jhesketh jhesketh commented Jan 13, 2023 •
edited
Loading

Fixes #3362

Checklist

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

@jhesketh jhesketh requested review from a team as code owners January 13, 2023 04:29
@jhesketh jhesketh force-pushed the read-write-deployment/docs branch from 469deca to 67be648 Compare January 13, 2023 04:39
@osg-grafana osg-grafana added the type/docs Improvements or additions to documentation label Jan 13, 2023
@pracucci pracucci self-requested a review January 16, 2023 08:34
pracucci
pracucci reviewed Jan 16, 2023
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.

  • Add a CHANGELOG entry under the "Documentation" section, please.

jhesketh and others added 3 commits January 17, 2023 15:49
@jhesketh @pracucci @osg-grafana
Apply suggestions from code review
37e12c4 
Co-authored-by: Marco Pracucci <[email protected]>
Co-authored-by: Ursula Kallio <[email protected]>
@jhesketh
Iterate from review feedback.
d2ceb9c 
Document in detail the migration procedure.
@jhesketh
Update CHANGELOG
251b40b
pracucci
pracucci approved these changes Jan 19, 2023
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.

Great job! The migration guide is very well written 👏 I left few last comments. @osg-grafana can you review too, please?

osg-grafana
osg-grafana reviewed Jan 19, 2023
View reviewed changes
...mir/operators-guide/deploy-grafana-mimir/jsonnet/migrate-from-microservices-to-read-write.md
At a high level the basic process of steps to complete is:

1. Deploy read-write components along side microservices (they join the same ring).
1. Switch over end points in your ingress.
Copy link
Contributor

Choose a reason for hiding this comment

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

I need to revisit the structure of this doc because the high-level steps can have Step 1: etc. but there are many steps. I will come back to this tomorrow.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The high level steps are meant to portray the general process. There are a number of specific items to complete in order to do what the process is describing. I'm open to suggestions.

Copy link
Contributor

Choose a reason for hiding this comment

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

I will look at the structure in a subsequent PR. Best to iterate as you suggested in a DM. :)

osg-grafana
osg-grafana suggested changes Jan 19, 2023
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.

Need to come back to this to revisit the structure of Steps versus 1., 1., 1..

@56quarters
Copy link
Contributor

The CHANGELOG has just been cut to prepare for the next Mimir release. Please rebase main and eventually move the CHANGELOG entry added / updated in this PR to the top of the CHANGELOG document. Thanks!

@jhesketh
Copy link
Contributor Author

Thank you both for all the feedback! I will incorporate these changes later this week as I have other priorities for the first few days.

@osg-grafana osg-grafana added this to the 2.7 milestone Jan 25, 2023
@osg-grafana osg-grafana mentioned this pull request Jan 26, 2023
Closed
osg-grafana
osg-grafana approved these changes Jan 26, 2023
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.

Unblocking with feedback; will refactor docs/sources/mimir/operators-guide/deploy-grafana-mimir/jsonnet/migrate-from-microservices-to-read-write.md in a subsequent PR.

@pracucci pracucci merged commit 69c4ecb into main Jan 26, 2023
@pracucci pracucci deleted the read-write-deployment/docs branch January 26, 2023 16:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pracucci pracucci pracucci approved these changes

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

Assignees
No one assigned
Labels
release/notified-changelog-cut type/docs Improvements or additions to documentation
Projects
None yet
Milestone
2.7
Development

Successfully merging this pull request may close these issues.

Docs: read-write deployment
4 participants
@jhesketh @56quarters @pracucci @osg-grafana