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

Prepare Mimir 2.0.0 final #1553

Merged
merged 23 commits into from
Mar 28, 2022
Merged

Prepare Mimir 2.0.0 final #1553

merged 23 commits into from
Mar 28, 2022

Conversation

pracucci
Copy link
Collaborator

@pracucci pracucci commented Mar 28, 2022

What this PR does

This PR prepares Mimir for the 2.0.0 final release. It includes:

  • Cherry pick docs, jsonnet and bug fixing changes since rc.4 (see detailed list below)
  • Update CHANGELOG and VERSION
  • Update release instructions
  • Fix image tag in jsonnet (it's 2.0.0 and not mimir-2.0.0)
  • I had to rebuild the config descriptor (checked in a unit test) to match the release-2.0 branch (doesn't include the new config introduced in Implement remote write forwarding in Distributor #1052

Cherry-picked:

Excluded:

Draft PR because I want to have control over the merge (will merge commit it).

Which issue(s) this PR fixes or relates to

Fixes #

Checklist

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

pracucci and others added 22 commits March 28, 2022 09:56
* Moved bucket-index doc to Hugo bundles

Signed-off-by: Marco Pracucci <marco@pracucci.com>

* Moved hash rings doc to Hugo bundles and fixed image

Signed-off-by: Marco Pracucci <marco@pracucci.com>

* Moved query sharding doc to Hugo bundles

Signed-off-by: Marco Pracucci <marco@pracucci.com>
* Add GEM config extensions to descriptors

Signed-off-by: Dimitar Dimitrov <dimitar.dimitrov@grafana.com>

* Add other hidden GEM config options

Signed-off-by: Dimitar Dimitrov <dimitar.dimitrov@grafana.com>
* Add JSON config descriptors

Signed-off-by: Dimitar Dimitrov <dimitar.dimitrov@grafana.com>

* Update help.txt

Signed-off-by: Dimitar Dimitrov <dimitar.dimitrov@grafana.com>

* A change to make the descriptor go out of sync

Signed-off-by: Dimitar Dimitrov <dimitar.dimitrov@grafana.com>

* Update help.txt

Signed-off-by: Dimitar Dimitrov <dimitar.dimitrov@grafana.com>

* Revert "A change to make the descriptor go out of sync"

This reverts commit c1f3e2e.
* Moved shuffle sharding doc to Hugo bundles

Signed-off-by: Marco Pracucci <marco@pracucci.com>

* Moved mirroring doc to Hugo bundles

Signed-off-by: Marco Pracucci <marco@pracucci.com>

* Moved config reference doc to Hugo bundles

Signed-off-by: Marco Pracucci <marco@pracucci.com>
…config option. (#1526)

* Import memberlist.libsonnet by default, control use of memberlist by config option.

Signed-off-by: Peter Štibraný <pstibrany@gmail.com>
* Moved ruler doc to Hugo bundles

Signed-off-by: Marco Pracucci <marco@pracucci.com>

* Moved architecture doc to Hugo bundles

Signed-off-by: Marco Pracucci <marco@pracucci.com>

* Moved deployment modes doc to Hugo bundles

Signed-off-by: Marco Pracucci <marco@pracucci.com>

* Moved production tips doc to Hugo bundles

Signed-off-by: Marco Pracucci <marco@pracucci.com>

* Moved Mimir logo image

Signed-off-by: Marco Pracucci <marco@pracucci.com>

* Simplified paths

Signed-off-by: Marco Pracucci <marco@pracucci.com>
* Add start of migration from Cortex docs

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Complete configuration conversion documentation, start Jsonnet docs

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Start documenting migration from Cortex Jsonnet

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Linting

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Use active voice

Co-authored-by: Chris Moyer <chris.moyer@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Be more specific

Co-authored-by: Chris Moyer <chris.moyer@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Refer to documentation for how to upload rules and import dashboards

Co-authored-by: Bryan Boreham <bryan@weave.works>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Fix typos, use Grafana Mimir, prefer "available" to "present"

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Clarify that it is the users decision

Co-authored-by: Chris Moyer <chris.moyer@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Remove link to Cortex Jsonnet as there is no need for a user to follow it

Co-authored-by: Chris Moyer <chris.moyer@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Use imperative verbs for steps

Co-authored-by: Chris Moyer <chris.moyer@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Emphasize the Jsonnet deployment steps preamble

Co-authored-by: Chris Moyer <chris.moyer@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Label substeps with letters

Co-authored-by: Chris Moyer <chris.moyer@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Fix typo

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Distinguish between the monitoring mixin and its constituent elements

Co-authored-by: Marco Pracucci <marco@pracucci.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Correct explanation of `--include-defaults`

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Fix typo

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Convert from flags to JSON

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Encourage reading of the release notes for breaking changes

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Simplify stem sentence

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Linting

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Start drafting Helm chart conversion

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Apply suggestions from code review

* Apply code review suggestions

Co-authored-by: Chris Moyer <chris.moyer@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Add helm upgrade instruction

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Remove Helm upgrade instructions deferred to a future PR

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Revise mimirtool information to refer to the tools own documentation

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Remove bash scripts and propose verifying operation with dashboards

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Document bash scripts for extracting flags from Jsonnet

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Refer to mimirtool documentation for extracting Jsonnet flags

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Remove duplicate install instructions

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Incorporate Docs squad review

Co-authored-by: Karen Miller <karen.miller@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Remove prerequisite to read the release notes as they do not document breaking changes

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Add notable changes to consider

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Link to Jsonnet specific instructions in the opening paragraph

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Clarify that --update-defaults affects explicitly set values that match the cortex defaults

Co-authored-by: Nick Pillitteri <nick.pillitteri@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Add description

Co-authored-by: Fiona Artiaga <89225282+GrafanaWriter@users.noreply.github.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Apply documentation review feedback

Co-authored-by: Fiona Artiaga <89225282+GrafanaWriter@users.noreply.github.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Only specify a single alternative for ruler endpoint migration

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Fix typos and missing words

Co-authored-by: replay <mauro.stettler@gmail.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Use "Current" to describe current API endpoints

Co-authored-by: replay <mauro.stettler@gmail.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Note that upgrade is possible from either Cortex 1.10 or 1.11

Co-authored-by: Marco Pracucci <marco@pracucci.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Link to the full CHANGELOG for a complete list of changes

Co-authored-by: Marco Pracucci <marco@pracucci.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Fix linting

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Bryan Boreham <bryan@weave.works>
Co-authored-by: Marco Pracucci <marco@pracucci.com>
Co-authored-by: Karen Miller <karen.miller@grafana.com>
Co-authored-by: Nick Pillitteri <nick.pillitteri@grafana.com>
Co-authored-by: Fiona Artiaga <89225282+GrafanaWriter@users.noreply.github.com>
Co-authored-by: replay <mauro.stettler@gmail.com>
* Added tool to validate documentation links and images

Signed-off-by: Marco Pracucci <marco@pracucci.com>

* Run validation in CI

Signed-off-by: Marco Pracucci <marco@pracucci.com>

* Fixed white noise check to exclude any vendor dir

Signed-off-by: Marco Pracucci <marco@pracucci.com>

* filepath.Clean() is not necessary if path has been built with filepath.Join()

Signed-off-by: Marco Pracucci <marco@pracucci.com>

* Update tools/doc-validator/main.go

Co-authored-by: Mauro Stettler <mauro.stettler@gmail.com>

* Fixed license header

Signed-off-by: Marco Pracucci <marco@pracucci.com>

Co-authored-by: Mauro Stettler <mauro.stettler@gmail.com>
Signed-off-by: Dimitar Dimitrov <dimitar.dimitrov@grafana.com>
Signed-off-by: Dimitar Dimitrov <dimitar.dimitrov@grafana.com>
* Docs: adds getting started video

* corrected typo

* adds intro that describes the difference between the text and video

* added break to add space

* fixes link
* Add internal documentation about our usage of Hugo page bundles

Signed-off-by: Marco Pracucci <marco@pracucci.com>

* Update docs/internal/contributing/how-to-write-documentation.md

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

* Update docs/internal/contributing/how-to-write-documentation.md

Co-authored-by: Nick Pillitteri <56quarters@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Ursula Kallio <ursula.kallio@grafana.com>

* Fixed link and mentioned command to validate doc

Signed-off-by: Marco Pracucci <marco@pracucci.com>

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Nick Pillitteri <56quarters@users.noreply.github.com>
Co-authored-by: Ursula Kallio <ursula.kallio@grafana.com>
…unction (#1542)

Signed-off-by: Marco Pracucci <marco@pracucci.com>
* Move tutorials to docs/sources/

Signed-off-by: Marco Pracucci <marco@pracucci.com>

* Add description and keywords

Co-authored-by: Fiona Artiaga <89225282+GrafanaWriter@users.noreply.github.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Fiona Artiaga <89225282+GrafanaWriter@users.noreply.github.com>
* adds blog post links and introduction video to release notes; update getting started video

* make doc
…1541)

* Correct substition for determining version from release tags

Release tags do not use the prefix `v`, they use the prefix `mimir-`.

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Make base branch configurable

Was useful to facilitate testing a release based on a branch that has
not yet been merged into the main branch of the website repository.

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* adds vimeo code

* adds migration video

* moves video to jsonnet section
Signed-off-by: Marco Pracucci <marco@pracucci.com>
Signed-off-by: Marco Pracucci <marco@pracucci.com>
…'s nothing to update

Signed-off-by: Marco Pracucci <marco@pracucci.com>
@pracucci pracucci mentioned this pull request Mar 28, 2022
68 tasks
Signed-off-by: Marco Pracucci <marco@pracucci.com>
@jdbaldry
Copy link
Member

This PR prepares Mimir for the 2.0.0 final release. It includes:

I have validated that this is reflected in the diff.

On the Jsonnet image tag, was that a result of human error in a search and replace process or is there something that is updating that tag for us?
I am guessing the former but wanted to check.

@jdbaldry
Copy link
Member

Also, regarding the process, and not this PR specifically. What are the reasons for choosing not to cherry-pick certain commits?

@pracucci
Copy link
Collaborator Author

pracucci commented Mar 28, 2022

On the Jsonnet image tag, was that a result of human error in a search and replace process or is there something that is updating that tag for us?

At the beginning we were tagging images with mimir- prefix but it looked weird to see something like grafana/query-tee:mimir-2.0.0 so we decided to just tag them without the mimir- prefix (eg. grafana/query-tee:2.0.0). When we did the change to the tagging script, we forgot to change jsonnet too, which I'm fixing in this PR.

Also, regarding the process, and not this PR specifically. What are the reasons for choosing not to cherry-pick certain commits?

Our policy is not cherry-pick any code change which is not a bug fix. We're expected to cherry-pick only bug fixed or changes to non-code, like docs and jsonnet. We also agreed to allow to cherry-pick any config conversion tool change for the 2.0.0 release.

Copy link
Member

@jdbaldry jdbaldry left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for explaining the process and the changes made.

@pracucci pracucci marked this pull request as ready for review March 28, 2022 09:26
@pracucci pracucci merged commit 9fd2da5 into release-2.0 Mar 28, 2022
@pracucci pracucci deleted the prepare-2.0.0-final branch March 28, 2022 09:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants