Geo: Create API toggle for silent mode
Release notes
We need a way to toggle Silent mode on and off. We will start with exposing a toggle in the API.
Silent mode blocks all outbound traffic such as emails, webhooks, etc.. from a GitLab instance. See &9826 for a more detailed description of Silent mode.
Problem to solve
- We want allow toggling of the Silent mode feature on/off similar to maintenance mode.
- The value should be a true/false setting to enable/disable silent mode.
- It should be possible to use the API to read back the current value of the setting.
Intended users
User experience goal
-
Silent mode toggle should be available as a REST API under application settings. e.g. api/v4/application/settings?silent_mode
-
It should be possible to both set a true/false value as well as read the current value of the setting.
-
In future we may consider adding UI controls as well.
Proposal
- We want to make a toggle for silent mode available on the GitLab REST API.
- It should sit under application settings.
- The API should map to a DB setting that outbound communication modules/services can check against to decide whether to egress the traffic.
- By default this setting should be "off" / "false"
Permissions and Security
Only users with Admin privileges should be able to call this API.
Authentication and authorization should follow existing GitLab mechanisms to restrict access.
Documentation
Availability & Testing
This feature will need the following tests:
- Unit tests
- End-to-end test
Available Tier
- Free
- Premium/Silver
- Ultimate/Gold
Feature Usage Metrics
TBD
What does success look like, and how can we measure that?
Success would be when silent mode is being used by the GitLab Dedicated team to in their routine DR testing with Geo.
We see customers leveraging this feature to support routine DR testing.
Acceptance
What is the type of buyer?
Is this a cross-stage feature?
Yes
What is the competitive advantage or differentiation for this feature?
This will allow customers to routinely test the integrity of their DR Geo site without generating lots of spam traffic towards their users. Customers will gain more confidence in the solution through their own routine testing and validation efforts.
GitLab Dedicated will be able to routinely perform testing of the DR site without generating traffic towards their users.
This will be a unique GitLab capability that our major competitors do not yet have.
Links / references
This page may contain information related to upcoming products, features and functionality. It is important to note that the information presented is for informational purposes only, so please do not rely on the information for purchasing or planning purposes. Just like with all projects, the items mentioned on the page are subject to change or delay, and the development, release, and timing of any products, features, or functionality remain at the sole discretion of GitLab Inc.