Skip to content

Document updated Praefect virtual storage configuration format

Sami Hiltunen requested to merge smh-update-praefect-config into master

What does this MR do?

Praefect's virtual storage configuration format in omnibus left no room for other virtual storage related configuration values as the nodes were configured directly in the root of the virtual storage's configuration object. The format was changed to address this by moving the node configuration under the 'nodes' key. This commit updates the documentation to use the updated format.

The change was made in a backwards compatible manner. If nodes are configured in the root of the object, Omnibus corrects this by moving unknown keys under the 'nodes' key.

Related issues

omnibus-gitlab!4988 (merged)
omnibus-gitlab#5981 (closed)

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

Loading