Skip to content

Update Praefect virtual_storages format in ref architectures

Catalin Irimie requested to merge cat-virtualstorages-refarch-format into master

What does this MR do?

This is different than the format in the Praefect docs (step 6) which should be used, this MR updates the format from the old, deprecated one, to the new one including 'nodes'.

Related issues

Background in internal Slack thread but essentially, I've asked which format should be used, and @samihiltunen replied:

The format in the ref architectures docs is deprecated and should print out a warning when it’s used. There’s fallback code to handle the old format still. The old format didn’t really match the structure of Praefect’s config and made it awkward to add virtual storage scoped configuration keys as the nodes and other keys would be mixed

Author's checklist (required)

Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

For more information about labels, see Technical Writing workflows - Labels.

For suggestions that you are confident don't need to be reviewed, change them locally and push a commit directly to save others from unneeded reviews. For example:

  • Clear typos, like this is a typpo.
  • Minor issues, like single quotes instead of double quotes, Oxford commas, and periods.

For more information, see our documentation on Merging a merge request.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.

Merge request reports