mimirtool: retain old default of blocks_storage.backend #1626

dimitarvdimitrov · 2022-04-04T18:51:55Z

What this PR does

When passing --update-defaults to mimirtool config convert and the
value of blocks_storage.backend is using the old default of "s3", the
value in the resulting config is updated to "filesystem." It is better
if the value is not updated.

Which issue(s) this PR fixes or relates to

Fixes #1622

Checklist

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

When passing `--update-defaults` to mimirtool config convert and the value of blocks_storage.backend is using the old default of "s3", the value in the resulting config is updated to "filesystem." It is better if the value is not updated. Signed-off-by: Dimitar Dimitrov <dimitar.dimitrov@grafana.com>

pstibrany

What about other storages? (Alertmanager, ruler) I would expect the update path to be the same for all of them (if alertmanager / ruler were used in the first place).

pstibrany · 2022-04-05T06:46:59Z

I think this now deserves a CHANGELOG entry too.

When passing `--update-defaults` to mimirtool config convert and the value of *_storage.backend is using the old default of "s3", the value in the resulting config is updated to "filesystem." It is better if the value is not updated. Signed-off-by: Dimitar Dimitrov <dimitar.dimitrov@grafana.com>

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

dimitarvdimitrov · 2022-04-05T09:05:05Z

nice call @pstibrany. I've added (ruler|alertmanager)_storage.backend to the list of retained old defaults in 740878d and added a changelog entry in fbbc355

I also added some docs to mention the special behaviour for these defaults in a075db0. Also added type/docs label to get some advice from Docs squad on that paragraph.

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

pstibrany

Looks good to me. There is no good / easy way checking if alertmanager and ruler were used before (in Cortex) :(

docs/sources/operators-guide/tools/mimirtool.md

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

pracucci

I'm not much familiar with the config conversion tool, but to my understanding the changes make sense.

dimitarvdimitrov · 2022-04-14T14:16:37Z

thank you for reviewing. For visibility - I'm waiting for the docs squad to get to this PR so they can review the added docs to mimirtool.

There is other work related to this that I'd like to do - some filesystem paths (like /data/compactor changed default values, and we can employ a similar approach as in this PR to provide a smoother migration.

I want these to be included in the 2.1 release, so if I don't get a docs review in the next week. We can extract the docs in a separate PR and move on with the code changes

osg-grafana

Unblocking with feedback, which I would like in part to be technically vetted for accuracy.

docs/sources/operators-guide/tools/mimirtool.md

osg-grafana · 2022-04-20T13:47:37Z

docs/sources/operators-guide/tools/mimirtool.md

@@ -655,6 +655,22 @@ It supports converting both CLI flags and [YAML configuration files]({{< relref
 | `-v`, `--verbose`    | If you set this flag, the CLI flags and YAML paths from the old configuration that do not exist in the new configuration are printed to `stderr`. This flag also prints default values that have changed between the old and the new configuration. |
 | `--gem`              | If you set this flag, the tool will convert from Grafana Metrics Enterprise (GEM) v1.7.x to v2.0.0.                                                                                                                                                 |

+##### A note on default values
+
+This command is designed to aid a migration from Cortex to Grafana Mimir. There are changes to the default values of


Suggested change

This command is designed to aid a migration from Cortex to Grafana Mimir. There are changes to the default values of

The `mimirtool` command helps you migrate from Cortex to Grafana Mimir. There are changes to the default values of

I assume we are talking about the mimirtool here.

I am talking about the mimirtool config convert command. Which is part of the mimirtool tool. I pushed a change in cecbdd2 to follow your advice

docs/sources/operators-guide/tools/mimirtool.md

osg-grafana · 2022-04-20T13:50:16Z

docs/sources/operators-guide/tools/mimirtool.md

+This command will output the Cortex default value even when the configuration parameter is not explicitly set in the input
+configuration. If the Cortex default value is explicitly set in the input configuration, and you have provided
+the `--update-defaults` flag, the command will not update the value to the Mimir default.


Suggested change

This command will output the Cortex default value even when the configuration parameter is not explicitly set in the input

configuration. If the Cortex default value is explicitly set in the input configuration, and you have provided

the `--update-defaults` flag, the command will not update the value to the Mimir default.

The `mimirtool` command outputs the Cortex default value even when the configuration parameter is not explicitly set in the input

configuration. If in the input configuration you explicitly set the Cortex default value, and you have provide

the `--update-defaults` flag, the `mimirtool` command will not update the value to the Mimir default.

Please vet for technical accuracy.

changed in cecbdd2, can you take another look?

osg-grafana

See previous comment. :)

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

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

dimitarvdimitrov added bug Something isn't working component/mimirtool labels Apr 4, 2022

dimitarvdimitrov mentioned this pull request Apr 4, 2022

mimirtool: Failed to pick the correct backend when running convert #1622

Closed

pstibrany reviewed Apr 5, 2022

View reviewed changes

dimitarvdimitrov added 3 commits April 5, 2022 11:58

Add docs to explain fields that retain old default

a075db0

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

Update CHANGELOG.md

fbbc355

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

dimitarvdimitrov added the type/docs Improvements or additions to documentation label Apr 5, 2022

Fix typos

64cd7a8

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

dimitarvdimitrov added 2 commits April 5, 2022 12:09

Dashes it is

57e1f96

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

Dashes and spaces then

273c99f

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

dimitarvdimitrov requested a review from pstibrany April 5, 2022 13:15

pstibrany approved these changes Apr 6, 2022

View reviewed changes

docs/sources/operators-guide/tools/mimirtool.md Outdated Show resolved Hide resolved

Update wording for GEM retained default

fbb3ead

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

pracucci approved these changes Apr 14, 2022

View reviewed changes

pracucci requested a review from osg-grafana April 14, 2022 14:26

osg-grafana reviewed Apr 20, 2022

View reviewed changes

osg-grafana approved these changes Apr 20, 2022

View reviewed changes

dimitarvdimitrov and others added 2 commits April 21, 2022 14:31

Address PR feedback

cecbdd2

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

Apply suggestions from code review

0ce405d

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

pracucci merged commit 6f5563f into main Apr 22, 2022

pracucci deleted the dimitar/mimirtool-fix-blocks-storage-backend branch April 22, 2022 09:25

dimitarvdimitrov mentioned this pull request Apr 26, 2022

mimirtool config: Add more retained old defaults #1762

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

mimirtool: retain old default of blocks_storage.backend #1626

mimirtool: retain old default of blocks_storage.backend #1626

dimitarvdimitrov commented Apr 4, 2022

pstibrany left a comment

pstibrany commented Apr 5, 2022

dimitarvdimitrov commented Apr 5, 2022

pstibrany left a comment

pracucci left a comment

dimitarvdimitrov commented Apr 14, 2022 •

edited

Loading

osg-grafana left a comment

osg-grafana Apr 20, 2022

dimitarvdimitrov Apr 21, 2022

osg-grafana Apr 20, 2022

dimitarvdimitrov Apr 21, 2022

osg-grafana left a comment

	This command is designed to aid a migration from Cortex to Grafana Mimir. There are changes to the default values of
	The `mimirtool` command helps you migrate from Cortex to Grafana Mimir. There are changes to the default values of

mimirtool: retain old default of blocks_storage.backend #1626

mimirtool: retain old default of blocks_storage.backend #1626

Conversation

dimitarvdimitrov commented Apr 4, 2022

What this PR does

Which issue(s) this PR fixes or relates to

Checklist

pstibrany left a comment

Choose a reason for hiding this comment

pstibrany commented Apr 5, 2022

dimitarvdimitrov commented Apr 5, 2022

pstibrany left a comment

Choose a reason for hiding this comment

pracucci left a comment

Choose a reason for hiding this comment

dimitarvdimitrov commented Apr 14, 2022 • edited Loading

osg-grafana left a comment

Choose a reason for hiding this comment

osg-grafana Apr 20, 2022

Choose a reason for hiding this comment

dimitarvdimitrov Apr 21, 2022

Choose a reason for hiding this comment

osg-grafana Apr 20, 2022

Choose a reason for hiding this comment

dimitarvdimitrov Apr 21, 2022

Choose a reason for hiding this comment

osg-grafana left a comment

Choose a reason for hiding this comment

dimitarvdimitrov commented Apr 14, 2022 •

edited

Loading