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

Jump to bottom

Article about migrating from Consul to memberlist. Added documentation for /memberlist endpoint. #2166

Merged
merged 11 commits into from Jun 24, 2022
Merged

Article about migrating from Consul to memberlist. Added documentation for /memberlist endpoint. #2166

merged 11 commits into from Jun 24, 2022

Conversation

pstibrany
Copy link
Member

@pstibrany pstibrany commented Jun 21, 2022 •
edited

What this PR does

This PR adds step-by-step instructions for migrating from Consul to memberlist. Follow up to #2160 (comment).

Update: this PR now also adds documentation for /memberlist endpoint, since it was missing before.

Checklist

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

@pstibrany
Article about migrating from Consul to memberlist.
2c033fc 
Signed-off-by: Peter Štibraný <pstibrany@gmail.com>
@pstibrany pstibrany mentioned this pull request Jun 21, 2022
Merged
2 tasks
@pstibrany pstibrany added the type/docs Improvements or additions to documentation label Jun 21, 2022
@pstibrany
CHANGELOG.md
f7d455a 
Signed-off-by: Peter Štibraný <pstibrany@gmail.com>
@pstibrany
Lint
03a2d77 
Signed-off-by: Peter Štibraný <pstibrany@gmail.com>
pracucci
pracucci reviewed Jun 22, 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.

Fantastic job! I left few comments, but overall LGTM.

docs/sources/operators-guide/deploying-grafana-mimir/jsonnet/memberlist.md Outdated Show resolved Hide resolved
docs/sources/operators-guide/deploying-grafana-mimir/jsonnet/memberlist.md Outdated Show resolved Hide resolved
docs/sources/operators-guide/deploying-grafana-mimir/jsonnet/memberlist.md Outdated
weight: 30
---

# Migrating from Consul to Memberlist as KV store for hash rings without downtime
Copy link
Collaborator

Choose a reason for hiding this comment

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

As per docs squad guidelines (as I understood it), this is the expected to match the title in the metadata above.

@jdbaldry Is my understanding of the guidelines correct? If so, we could enforce it in the doc-validator.

Copy link
Member

Choose a reason for hiding this comment

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

I also understand this to be the case. I think we absolutely could add it to the doc-validator. The only wrinkle in doing this quickly is that we currently do not parse the front matter as it is not supported by the current markdown parser https://github.com/grafana/technical-documentation/blob/c34c993f9516f2aadb0ad816b74b25a045f59d73/tools/doc-validator/main.go#L192-L193

Copy link
Collaborator

@pracucci pracucci Jun 22, 2022 •
edited

Choose a reason for hiding this comment

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

The frontmatter is just YAML, right? I think all you need to do is to extract its content with a regex and then use the golang YAML parser.

Copy link
Member Author

Choose a reason for hiding this comment

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

For now I've modified title: and this heading to match.

Copy link
Member

Choose a reason for hiding this comment

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

Ah, sorry I did this earlier but forgot to submit the PR for it: https://github.com/grafana/technical-documentation/pull/356/files
I've done it in technical-documentation for now so that I can use it in other repositories. I have a WIP branch for Mimir that uses this version of the doc-validator packaged in a Docker image. Just need IT to create the grafana Docker Hub repository and I'll submit the PR that let's us use the tool with the new functionality :)

docs/sources/operators-guide/deploying-grafana-mimir/jsonnet/memberlist.md Outdated Show resolved Hide resolved
docs/sources/operators-guide/deploying-grafana-mimir/jsonnet/memberlist.md Outdated Show resolved Hide resolved
docs/sources/operators-guide/deploying-grafana-mimir/jsonnet/memberlist.md Outdated Show resolved Hide resolved
docs/sources/operators-guide/deploying-grafana-mimir/jsonnet/memberlist.md Outdated Show resolved Hide resolved
docs/sources/operators-guide/deploying-grafana-mimir/jsonnet/memberlist.md Outdated Show resolved Hide resolved
docs/sources/operators-guide/deploying-grafana-mimir/jsonnet/memberlist.md Outdated Show resolved Hide resolved
docs/sources/operators-guide/deploying-grafana-mimir/jsonnet/memberlist.md Outdated Show resolved Hide resolved
@pstibrany pstibrany changed the title Article about migrating from Consul to memberlist. Article about migrating from Consul to memberlist. Added documentation for /memberlist endpoint. Jun 22, 2022
@pstibrany
Explain queries.
b6296b6 
Signed-off-by: Peter Štibraný <pstibrany@gmail.com>
@pstibrany
Copy link
Member Author

Thank you @pracucci for your detailed feedback, I've used all your suggestions.

@pstibrany
make doc
1518ce3
@pstibrany
Fix links.
a69f843 
Signed-off-by: Peter Štibraný <pstibrany@gmail.com>
pracucci
pracucci approved these changes Jun 22, 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.

Good job! Left few final nits.

operations/mimir/memberlist.libsonnet Outdated Show resolved Hide resolved
docs/sources/operators-guide/reference-http-api/index.md Outdated Show resolved Hide resolved
docs/sources/operators-guide/reference-http-api/index.md Outdated Show resolved Hide resolved
...urces/operators-guide/deploying-grafana-mimir/jsonnet/migrating-from-consul-to-memberlist.md Outdated Show resolved Hide resolved
...urces/operators-guide/deploying-grafana-mimir/jsonnet/migrating-from-consul-to-memberlist.md Outdated Show resolved Hide resolved
...urces/operators-guide/deploying-grafana-mimir/jsonnet/migrating-from-consul-to-memberlist.md Outdated Show resolved Hide resolved
@pstibrany
Apply review feedback.
98ced2e 
Signed-off-by: Peter Štibraný <pstibrany@gmail.com>
@pstibrany
Copy link
Member Author

Good job! Left few final nits.

Thanks, I have applied all your suggestions.

@pstibrany pstibrany enabled auto-merge (squash) June 24, 2022 13:10
@pstibrany pstibrany merged commit e181fa2 into main Jun 24, 2022
@pstibrany pstibrany deleted the memberlist-migration-docs branch June 24, 2022 13:52
rlex added a commit to rlex/mimir that referenced this pull request Jun 28, 2022
@rlex
Merge branch 'main' into helm_prometheusrule
208d9c8 
* main: (63 commits)
  Add new section on website for links to blog posts, podcasts and talks. (grafana#2216)
  Rename codified errors to errors catalog (grafana#2256)
  Helm: add a step to contributing doc (grafana#2257)
  Signal that 2.2 release is now in progress. (grafana#2254)
  Removed migration of alertmanager local state files from old hierarchy (Cortex 1.8 and earlier) (grafana#2253)
  operations/mimir: Change multi_zone_ingester_max_unavailable to 25 (grafana#2251)
  Helm: weekly release (grafana#2252)
  Jsonnet: Configure ingester max global metadata per user and per metric (grafana#2250)
  Helm: metamonitor naming (grafana#2236)
  Mimir documentation about out-of-order (grafana#2183)
  Vendor latest mimir-prometheus/main (grafana#2243)
  Set CODEOWNERS to primary technical writer (grafana#2242)
  Use BasicLifecycler for distributors and auto-forget (grafana#2154)
  Docs: Basic documentation for deploying the ruler using jsonnet. (grafana#2127)
  Fix post merge reviews on 2187 (grafana#2230)
  Add tests for user metadata in the ingester (grafana#2184)
  Change the error message template for per-tenant limits (grafana#2234)
  helm: meta-monitoring (grafana#2068)
  Article about migrating from Consul to memberlist. Added documentation for /memberlist endpoint. (grafana#2166)
  Update runbooks to mention possibility to investigate memberlist KV store in various alerts (grafana#2158)
  ...
masonmei pushed a commit to udmire/mimir that referenced this pull request Jul 11, 2022
@pstibrany
Article about migrating from Consul to memberlist. Added documentatio…
d9cea84 
…n for /memberlist endpoint. (grafana#2166)

* Article about migrating from Consul to memberlist.

Signed-off-by: Peter Štibraný <pstibrany@gmail.com>

* CHANGELOG.md

Signed-off-by: Peter Štibraný <pstibrany@gmail.com>

* Lint

Signed-off-by: Peter Štibraný <pstibrany@gmail.com>

* Apply review feedback, add documentation for /memberlist admin page.

Signed-off-by: Peter Štibraný <pstibrany@gmail.com>

* Mention that /memberlist admin page is now documented in API docs.

Signed-off-by: Peter Štibraný <pstibrany@gmail.com>

* Explain queries.

Signed-off-by: Peter Štibraný <pstibrany@gmail.com>

* make doc

* Fix links.

Signed-off-by: Peter Štibraný <pstibrany@gmail.com>

* Apply review feedback.

Signed-off-by: Peter Štibraný <pstibrany@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@replay replay replay left review comments

@jdbaldry jdbaldry jdbaldry left review comments

@pracucci pracucci pracucci approved these changes

@osg-grafana osg-grafana Awaiting requested review from osg-grafana

Assignees
No one assigned
Labels
type/docs Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@pstibrany @replay @pracucci @jdbaldry