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: Run Grafana Mimir in production using the Helm chart #3072

Merged
merged 7 commits into from Oct 24, 2022

Conversation

dimitarvdimitrov
Copy link
Contributor

What this PR does

Adds a guide that's meant to help users move from a small dev Mimir installation to a "production-ready" setup. A lot of the guide is pointing to other articles.

The PR also changes a handful of other articles and the chart README to fix outdated information or add more details.

This PR contains a link to the HA deduplication with consul article and to the zone awareness migration guide, which are still unpublished. So the CI here should fail at least because of that.

Which issue(s) this PR fixes or relates to

Fixes #2181

Checklist

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

@dimitarvdimitrov dimitarvdimitrov added type/docs Improvements or additions to documentation helm labels Sep 28, 2022
@dimitarvdimitrov
Copy link
Contributor Author

we just worked through the editing process of the article with @osg-grafana, I think it's turning into a great resource for our opensource users

@pracucci
Copy link
Collaborator

pracucci commented Oct 7, 2022

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!

@osg-grafana
Copy link
Contributor

Please change running- to run- so that you are using imperatives for tasks.

@osg-grafana
Copy link
Contributor

Please change running- to run- so that you are using imperatives for tasks.

And configuring-with-helm.md to configure-with-helm.md.

@dimitarvdimitrov
Copy link
Contributor Author

And configuring-with-helm.md to configure-with-helm.md.

There is no configuring-with-helm.md. Did you mean configuration-with-helm.md?

@dimitarvdimitrov
Copy link
Contributor Author

@osg-grafana I opened a new PR with the unrelated changes #3178

@dimitarvdimitrov dimitarvdimitrov force-pushed the dimitar/helm-prepare-for-production-guide branch 2 times, most recently from 964e4c1 to d0aae71 Compare October 12, 2022 09:58
@krajorama krajorama self-requested a review October 13, 2022 12:09
Copy link
Contributor

@krajorama krajorama left a comment

Choose a reason for hiding this comment

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

Good stuff! There's a part in the README.md that talks about storage, should probably refer to the new documentation.

@dimitarvdimitrov
Copy link
Contributor Author

thanks for the review, can you take another look when you have time?

Copy link
Contributor

@krajorama krajorama left a comment

Choose a reason for hiding this comment

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

I think we should merge it and we should do a global review of all the helm docs together once we merged this, multizone, security, sizing plan update and more before 4.0.

@dimitarvdimitrov dimitarvdimitrov force-pushed the dimitar/helm-prepare-for-production-guide branch from d2cab6e to 1d24729 Compare October 20, 2022 10:18
Copy link
Contributor

@krajorama krajorama left a comment

Choose a reason for hiding this comment

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

With the comment to revert renaming the title of the document, it's too long.

@dimitarvdimitrov dimitarvdimitrov force-pushed the dimitar/helm-prepare-for-production-guide branch from dfc1129 to 8e36f23 Compare October 21, 2022 15:55
dimitarvdimitrov and others added 5 commits October 24, 2022 16:43
Signed-off-by: Dimitar Dimitrov <dimitar.dimitrov@grafana.com>
Signed-off-by: Dimitar Dimitrov <dimitar.dimitrov@grafana.com>
Signed-off-by: Dimitar Dimitrov <dimitar.dimitrov@grafana.com>
Co-authored-by: George Krajcsovits <krajorama@users.noreply.github.com>
Signed-off-by: Dimitar Dimitrov <dimitar.dimitrov@grafana.com>
@dimitarvdimitrov dimitarvdimitrov enabled auto-merge (squash) October 24, 2022 14:47
@dimitarvdimitrov dimitarvdimitrov force-pushed the dimitar/helm-prepare-for-production-guide branch from be8179b to e00f797 Compare October 24, 2022 14:47
Signed-off-by: Dimitar Dimitrov <dimitar.dimitrov@grafana.com>
@dimitarvdimitrov dimitarvdimitrov changed the title Docs: Add "Run in production using the Helm chart" Docs: Run Grafana Mimir in production using the Helm chart Oct 24, 2022
@dimitarvdimitrov dimitarvdimitrov enabled auto-merge (squash) October 24, 2022 14:48
Signed-off-by: Dimitar Dimitrov <dimitar.dimitrov@grafana.com>
@dimitarvdimitrov dimitarvdimitrov merged commit 7b55b0d into main Oct 24, 2022
@dimitarvdimitrov dimitarvdimitrov deleted the dimitar/helm-prepare-for-production-guide branch October 24, 2022 16:58
@grafanabot
Copy link
Contributor

The backport to release-2.4 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new branch
git switch --create backport-3072-to-release-2.4 origin/release-2.4
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x 7b55b0d60bfcccdcc8c3f777891c9902e141327f
# Push it to GitHub
git push --set-upstream origin backport-3072-to-release-2.4
git switch main
# Remove the local backport branch
git branch -D backport-3072-to-release-2.4

Then, create a pull request where the base branch is release-2.4 and the compare/head branch is backport-3072-to-release-2.4.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: Create "Prepare for production" Helm chart
5 participants