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

Doc: Add a migration guide from Helm 2.1 to 3.0 #2291

Merged
merged 23 commits into from
Jul 8, 2022
Merged

Doc: Add a migration guide from Helm 2.1 to 3.0 #2291

merged 23 commits into from
Jul 8, 2022

Conversation

Logiraptor
Copy link
Contributor

What this PR does

Which issue(s) this PR fixes or relates to

Fixes #2218

Checklist

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

@Logiraptor Logiraptor added the type/docs Improvements or additions to documentation label Jun 30, 2022
@osg-grafana osg-grafana self-requested a review June 30, 2022 17:06
@osg-grafana
Copy link
Contributor

osg-grafana commented Jun 30, 2022 •
edited
Loading

Is a user upgrading, migrating, either, or both? I can wait until this is a bit more baked, but am thinking of where it belongs.

krajorama
krajorama reviewed Jul 1, 2022
View reviewed changes
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.

Awesome work @Logiraptor! I've added a few suggestions

docs/sources/release-notes/upgrading-helm-from-2.1-to-3.0.md Outdated Show resolved Hide resolved
docs/sources/release-notes/upgrading-helm-from-2.1-to-3.0.md Outdated Show resolved Hide resolved
docs/sources/release-notes/upgrading-helm-from-2.1-to-3.0.md Outdated Show resolved Hide resolved
docs/sources/release-notes/upgrading-helm-from-2.1-to-3.0.md Outdated Show resolved Hide resolved
docs/sources/release-notes/upgrading-helm-from-2.1-to-3.0.md Outdated Show resolved Hide resolved
docs/sources/release-notes/upgrading-helm-from-2.1-to-3.0.md Outdated Show resolved Hide resolved
@krajorama krajorama added the helm label Jul 1, 2022
@Logiraptor @krajorama
Apply suggestions from code review
73c2b50 
Co-authored-by: George Krajcsovits <krajorama@users.noreply.github.com>
@Logiraptor
Copy link
Contributor Author

@osg-grafana I had the same question when I was trying to figure out where to put this.

It doesn't feel like it belongs with the "Migrating to Mimir" type docs, since it's just Mimir to newer Mimir.
But at the same time it's a bit of a process, which makes me "feel" like I'm migrating my config to a different format.
In the end after thinking about it, I think it's most accurate to say "upgrading"

@osg-grafana osg-grafana marked this pull request as ready for review July 6, 2022 15:45
@osg-grafana osg-grafana changed the title WIP Migration Guide Doc: Add a migration guide from Helm 2.1 to 3.0 Jul 6, 2022
@osg-grafana
Copy link
Contributor

@Logiraptor I will get to this tomorrow.

@dimitarvdimitrov
Wrap up upgrade guide
d8c7f27 
Signed-off-by: Dimitar Dimitrov <dimitar.dimitrov@grafana.com>
@dimitarvdimitrov
Fix title for CI to pass
4a4e2da 
Signed-off-by: Dimitar Dimitrov <dimitar.dimitrov@grafana.com>
@dimitarvdimitrov
Copy link
Contributor

I pushed a commit which addresses the TOODs and corrects some small nitpicks like punctuation. I tried adding some external references and making the instructions more explicit. @osg-grafana can you take a look? @Logiraptor and @krajorama too if you guys have time

@dimitarvdimitrov
Copy link
Contributor

also removed some parts of the example values file to make it shorter and hopefully easier to read. I tried making it clear that some parts are removed. With the shorter version users may not realize that the new structuredConfig will save them lots of copying. Open to feedback.

@osg-grafana
Copy link
Contributor

osg-grafana commented Jul 7, 2022 •
edited
Loading

I pushed a commit which addresses the TOODs and corrects some small nitpicks like punctuation. I tried adding some external references and making the instructions more explicit. @osg-grafana can you take a look? @Logiraptor and @krajorama too if you guys have time

Yes, after lunch. :) This documentation needs to be refactored to the correct location within the docs as a whole instead of under release notes. Will offer a suggestion after food.

osg-grafana
osg-grafana suggested changes Jul 7, 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.

I am in the process of opening up a PR against this one.

Logiraptor and others added 6 commits July 8, 2022 10:56
@Logiraptor @dimitarvdimitrov
WIP Migration Guide
4296c8e
@Logiraptor @krajorama @dimitarvdimitrov
Apply suggestions from code review
08b6f84 
Co-authored-by: George Krajcsovits <krajorama@users.noreply.github.com>
@dimitarvdimitrov
Wrap up upgrade guide
894b624 
Signed-off-by: Dimitar Dimitrov <dimitar.dimitrov@grafana.com>
@dimitarvdimitrov
Fix title for CI to pass
ce49391 
Signed-off-by: Dimitar Dimitrov <dimitar.dimitrov@grafana.com>
@osg-grafana @dimitarvdimitrov
make doc at root dir.
3af829b
@dimitarvdimitrov
Move upgrade guide
a52d837 
Signed-off-by: Dimitar Dimitrov <dimitar.dimitrov@grafana.com>
@dimitarvdimitrov dimitarvdimitrov force-pushed the logiraptor/version-3-migration-guide branch from 08b1c09 to a52d837 Compare July 8, 2022 08:58
osg-grafana
osg-grafana approved these 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.

Unblocking and we still need to make a couple minors changes.

@osg-grafana osg-grafana enabled auto-merge (squash) July 8, 2022 16:29
@osg-grafana osg-grafana merged commit 61b589d into main Jul 8, 2022
@osg-grafana osg-grafana deleted the logiraptor/version-3-migration-guide branch July 8, 2022 16:35
masonmei pushed a commit to udmire/mimir that referenced this pull request Jul 11, 2022
@Logiraptor @krajorama
@dimitarvdimitrov @osg-grafana
Doc: Add a migration guide from Helm 2.1 to 3.0 (grafana#2291)
1e2c192 
Co-authored-by: George Krajcsovits <krajorama@users.noreply.github.com>
Signed-off-by: Dimitar Dimitrov <dimitar.dimitrov@grafana.com>
Co-authored-by: Dimitar Dimitrov <dimitar.dimitrov@grafana.com>
Co-authored-by: Ursula Kallio <ursula.kallio@grafana.com>
grafanabot pushed a commit that referenced this pull request Jul 11, 2022
@Logiraptor @grafanabot
Doc: Add a migration guide from Helm 2.1 to 3.0 (#2291)
5150a10 
Co-authored-by: George Krajcsovits <krajorama@users.noreply.github.com>
Signed-off-by: Dimitar Dimitrov <dimitar.dimitrov@grafana.com>
Co-authored-by: Dimitar Dimitrov <dimitar.dimitrov@grafana.com>
Co-authored-by: Ursula Kallio <ursula.kallio@grafana.com>
(cherry picked from commit 61b589d)
@grafanabot grafanabot mentioned this pull request Jul 11, 2022
Merged
dimitarvdimitrov pushed a commit that referenced this pull request Jul 11, 2022
@grafanabot
Doc: Add a migration guide from Helm 2.1 to 3.0 (#2291) (#2363)
5bcfd7a 
Co-authored-by: George Krajcsovits <krajorama@users.noreply.github.com>
Signed-off-by: Dimitar Dimitrov <dimitar.dimitrov@grafana.com>
Co-authored-by: Dimitar Dimitrov <dimitar.dimitrov@grafana.com>
Co-authored-by: Ursula Kallio <ursula.kallio@grafana.com>
Co-authored-by: Patrick Oyarzun <patrick.oyarzun@grafana.com>

(cherry picked from commit 61b589d)
@dimitarvdimitrov dimitarvdimitrov mentioned this pull request Jul 11, 2022
Merged
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@krajorama krajorama krajorama left review comments

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

Assignees

@dimitarvdimitrov dimitarvdimitrov

Labels
backport release-2.2 helm type/docs Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Docs: Write Helm migration documentation for 2.1 to 3.0
4 participants
@Logiraptor @osg-grafana @dimitarvdimitrov @krajorama