Update documentation to match Gitaly's new configuration structure
What does this MR do?
Omnibus previously had a custom configuration structure for Gitaly that didn't match the actual structure of Gitaly. This made a number of things more difficult than they had to be. Omnibus was recently updated to place Gitaly's configuration under gitaly['configuration'] hash which gets directly marshaled as TOML for the final Gitaly configuration. While there is still backwards compatibility handling in place, we should update the documentation to use the new structure in preparation for deprecating the old configuration keys. This commit updates Gitaly's documentation to refer to the new keys.
Related issues
gitaly#4467 (closed)
gitaly#4754 (closed)
omnibus-gitlab!6621 (merged)
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding or changing the main heading of the page (H1), ensure that the product tier badge is added. -
If you are a GitLab team member, request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
If you are a GitLab team member and only adding documentation, do not add any of the following labels:
~"frontend"
~"backend"
~"type::bug"
~"database"
These labels cause the MR to be added to code verification QA issues.
Reviewer's checklist
Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.
If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.
-
If the content requires it, ensure the information is reviewed by a subject matter expert. - Technical writer review items:
-
Ensure docs metadata is present and up-to-date. -
Ensure the appropriate labels are added to this MR. -
Ensure a release milestone is set. - If relevant to this MR, ensure content topic type principles are in use, including:
-
The headings should be something you'd do a Google search for. Instead of Default behavior
, say something likeDefault behavior when you close an issue
. -
The headings (other than the page title) should be active. Instead of Configuring GDK
, say something likeConfigure GDK
. -
Any task steps should be written as a numbered list. - If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
-
-
-
Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.
Merge request reports
Activity
changed milestone to %15.9
assigned to @samihiltunen
1 Warning This merge request is quite big (1036 lines changed), please consider splitting it into multiple merge requests. 1 Message This merge request adds or changes documentation files. A review from the Technical Writing team before you merge is recommended. Reviews can happen after you merge. Documentation review
The following files require a review from a technical writer:
-
doc/administration/gitaly/configure_gitaly.md
(Link to current live version) -
doc/administration/gitaly/praefect.md
(Link to current live version) -
doc/administration/gitaly/troubleshooting.md
(Link to current live version) -
doc/administration/monitoring/prometheus/index.md
(Link to current live version) -
doc/administration/reference_architectures/10k_users.md
(Link to current live version) -
doc/administration/reference_architectures/25k_users.md
(Link to current live version) -
doc/administration/reference_architectures/2k_users.md
(Link to current live version) -
doc/administration/reference_architectures/3k_users.md
(Link to current live version) -
doc/administration/reference_architectures/50k_users.md
(Link to current live version) -
doc/administration/reference_architectures/5k_users.md
(Link to current live version) -
doc/administration/sidekiq/index.md
(Link to current live version) -
doc/administration/server_hooks.md
(Link to current live version) -
doc/topics/git/troubleshooting_git.md
(Link to current live version) -
doc/update/index.md
(Link to current live version)
The review does not need to block merging this merge request. See the:
-
Metadata for the
*.md
files that you've changed. The first few lines of each*.md
file identify the stage and group most closely associated with your docs change. - The Technical Writer assigned for that stage and group.
- Documentation workflows for information on when to assign a merge request for review.
If needed, you can retry the
danger-review
job that generated this comment.Generated by
Danger-
added 1 commit
- 89929397 - Update documentation to match Praefect's new configuration structure
added 1 commit
- 2b87a75c - Update documentation to match Gitaly's new configuration structure
added 1675 commits
-
2b87a75c...c7855673 - 1670 commits from branch
master
- 1e599667 - Update documentation to match Praefect's new configuration structure
- 1850c73a - Add migration instructions for Praefect's new configuration
- 0680be0d - Document invalid metadata deletions being default enabled
- 630ec666 - Update documentation to match Gitaly's new configuration structure
- 6cc793f0 - Add migration instructions for Gitaly's new configuration
Toggle commit list-
2b87a75c...c7855673 - 1670 commits from branch
- Resolved by Evan Read
@eread this also depends on !110379 (merged) and !110661 (merged) to avoid conflicts. This documents a similar set of configuration changes for Gitaly as we are doing for Praefect.
Only the last two commits are introduced in this MR. Could you review this ahead of time to parallelize some of the work? Thanks!
@toon could you please review these documentation changes for the Gitaly team?
@grantyoung this does a similar set of changes for Gitaly's configuration as we did for Praefect in !110379 (merged). This also touches the reference architecture documentation, so maybe you'd like to take a look as well.
requested review from @eread, @toon, and @grantyoung
added 1 commit
- ef3cda87 - Add migration instructions for Gitaly's new configuration
mentioned in merge request omnibus-gitlab!6670 (merged)
- Resolved by Sami Hiltunen
- Resolved by Sami Hiltunen
- Resolved by Sami Hiltunen
- Resolved by Sami Hiltunen
- Resolved by Sami Hiltunen
- Resolved by Sami Hiltunen
removed review request for @eread
added Technical Writing devopssystems docsfeature labels and removed docsimprovement label
added 4 commits
Toggle commit list- Resolved by Toon Claes
Thanks @eread, I applied the changes and also update the migration notes to match your comments in the Praefect MR. Please have another look.
added 5 commits
- f53f5017 - Update documentation to match Praefect's new configuration structure
- 4e2b9002 - Add migration instructions for Praefect's new configuration
- bc85b67d - Document invalid metadata deletions being default enabled
- b140ac6c - Update documentation to match Gitaly's new configuration structure
- 89842037 - Add migration instructions for Gitaly's new configuration
Toggle commit listrequested review from @eread
mentioned in merge request !110661 (merged)
removed review request for @eread
mentioned in merge request omnibus-gitlab!6658 (merged)
added 1885 commits
-
fe39a4bd...15b151dc - 1883 commits from branch
master
- 6d81c8b4 - Update documentation to match Gitaly's new configuration structure
- 0e9b15ae - Add migration instructions for Gitaly's new configuration
-
fe39a4bd...15b151dc - 1883 commits from branch
- Resolved by Evan Read
Rebased this now that !110379 (merged) was merged.
requested review from @eread
removed review request for @eread
changed milestone to %15.10
added missed:15.9 label
mentioned in merge request omnibus-gitlab!6621 (merged)
added 991 commits
-
0e9b15ae...98bb24cb - 989 commits from branch
master
- 41793059 - Update documentation to match Gitaly's new configuration structure
- 2aed864f - Add migration instructions for Gitaly's new configuration
-
0e9b15ae...98bb24cb - 989 commits from branch
removed review request for @toon
mentioned in merge request !113286 (merged)
mentioned in merge request !113847 (merged)
added 2528 commits
-
2aed864f...0c0ef58b - 2526 commits from branch
master
- 7b691b72 - Update documentation to match Gitaly's new configuration structure
- 2ed5497d - Add migration instructions for Gitaly's new configuration
-
2aed864f...0c0ef58b - 2526 commits from branch
added 553 commits
-
2ed5497d...d3fe24b9 - 551 commits from branch
master
- 9744919d - Update documentation to match Gitaly's new configuration structure
- af6fb0ad - Add migration instructions for Gitaly's new configuration
-
2ed5497d...d3fe24b9 - 551 commits from branch
added 1 commit
- c48cfccc - Add migration instructions for Gitaly's new configuration
requested review from @eread
enabled an automatic merge when the pipeline for 26c08556 succeeds
mentioned in commit 4f5ead81
added workflowstaging-canary label
added workflowcanary label and removed workflowstaging-canary label
added workflowstaging label and removed workflowcanary label
added workflowproduction label and removed workflowstaging label
mentioned in issue gitaly#4754 (closed)
added releasedcandidate label
added releasedpublished label and removed releasedcandidate label
mentioned in issue gitlab-environment-toolkit#651 (closed)
mentioned in issue gitlab-environment-toolkit#720 (closed)