Mention deleting gitlab-cluster.json
What does this MR do?
Slack conversation (internal):
Customer asking about these kindss of messages (seeing it for the secondary too) after a bit of a messy recovery (afaik everything is up an running now).
The 'geo_primary_role' is defined in /etc/gitlab/gitlab-cluster.json as 'true' and overrides the setting in the /etc/gitlab/gitlab.rb
I'm not finding any specific documentation / issues or other slack messages on this. Can it be ignored? Any specific actions/steps that need to be taken?
The customer in this case tried to promote a secondary, realized the secondary wasn't up to date and is looking to get it added back as a secondary, and is seeing those warnings during a reconfigure.
I feel like just initiating the replication process would update/replace and make these warnings go away. But maybe they need to explicitly update or delete the
gitlab-cluster.json
I suspect you are correct, that you may need to delete
gitlab-cluster.json
when adding a former primary site readding a former secondary site as a secondary. If so, we probably need to mention this to https://docs.gitlab.com/ee/administration/geo/disaster_recovery/bring_primary_back.htmlIIUC, the main purpose of
gitlab-cluster.json
is to allow thegitlab-ctl geo promote
command to overridegitlab.rb
settings sincegitlab.rb
is user-configured and should not be modified by GitLab code, butgitlab.rb
may contain secondary-specific settings which don't make sense after promotion.If
gitlab-cluster.json
only contains overrides like "actually this is a primary" or "disable these secondary-specific services", then I think it can be safely deleted when demoting.
Yes, you can delete the
gitLab-cluster.json
file.Every Sidekiq, PostgreSQL, Gitaly, and Rails nodes has this file.
Related issues
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.