Commit fc5f7209 authored by Russell Dickenson's avatar Russell Dickenson

Merge branch 'eread/move-ff-note' into 'master'

Move feature flag note

See merge request gitlab-org/gitlab!58721
parents 4a8a1ff1 0817ed2e
...@@ -66,6 +66,10 @@ Gitaly comes pre-configured with Omnibus GitLab, which is a configuration ...@@ -66,6 +66,10 @@ Gitaly comes pre-configured with Omnibus GitLab, which is a configuration
GitLab installations for more than 2000 users should use Gitaly Cluster. GitLab installations for more than 2000 users should use Gitaly Cluster.
NOTE:
If not set in GitLab, feature flags are read as false from the console and Gitaly uses their
default value. The default value depends on the GitLab version.
## Gitaly Cluster ## Gitaly Cluster
Gitaly, the service that provides storage for Git repositories, can Gitaly, the service that provides storage for Git repositories, can
......
...@@ -24,6 +24,10 @@ See the [design ...@@ -24,6 +24,10 @@ See the [design
document](https://gitlab.com/gitlab-org/gitaly/-/blob/master/doc/design_ha.md) document](https://gitlab.com/gitlab-org/gitaly/-/blob/master/doc/design_ha.md)
for implementation details. for implementation details.
NOTE:
If not set in GitLab, feature flags are read as false from the console and Praefect uses their
default value. The default value depends on the GitLab version.
## Setup Instructions ## Setup Instructions
If you [installed](https://about.gitlab.com/install/) GitLab using the Omnibus If you [installed](https://about.gitlab.com/install/) GitLab using the Omnibus
...@@ -978,9 +982,6 @@ Feature.enable(:gitaly_reference_transactions) ...@@ -978,9 +982,6 @@ Feature.enable(:gitaly_reference_transactions)
Feature.disable(:gitaly_reference_transactions_primary_wins) Feature.disable(:gitaly_reference_transactions_primary_wins)
``` ```
NOTE:
If not set in GitLab, flags are read as false from the console and Praefect uses their default value, which depends on the GitLab version.
To monitor strong consistency, you can use the following Prometheus metrics: To monitor strong consistency, you can use the following Prometheus metrics:
- `gitaly_praefect_transactions_total`: Number of transactions created and - `gitaly_praefect_transactions_total`: Number of transactions created and
......
...@@ -303,16 +303,19 @@ Here are the steps to gate a new feature in Gitaly behind a feature flag. ...@@ -303,16 +303,19 @@ Here are the steps to gate a new feature in Gitaly behind a feature flag.
### GitLab Rails ### GitLab Rails
1. Test in a Rails console by setting the feature flag: Test in a Rails console by setting the feature flag:
NOTE: ```ruby
Pay attention to the name of the flag and the one used in the Rails console. Feature.enable('gitaly_go_find_all_tags')
There is a difference between them (dashes replaced by underscores and name ```
prefix is changed). Make sure to prefix all flags with `gitaly_`.
```ruby Pay attention to the name of the flag and the one used in the Rails console. There is a difference
Feature.enable('gitaly_go_find_all_tags') between them (dashes replaced by underscores and name prefix is changed). Make sure to prefix all
``` flags with `gitaly_`.
NOTE:
If not set in GitLab, feature flags are read as false from the console and Gitaly uses their
default value. The default value depends on the GitLab version.
### Testing with GDK ### Testing with GDK
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment