diff options
| author | Zeger-Jan van de Weg <git@zjvandeweg.nl> | 2020-02-17 22:52:03 +0300 |
|---|---|---|
| committer | John Cai <jcai@gitlab.com> | 2020-02-17 22:52:03 +0300 |
| commit | fe657a35c971e95c20e35dc98746f0d87b665ebd (patch) | |
| tree | 4f0d90dc7d4626008142bf3d31dea4d761f3860d | |
| parent | b34e98ed7d850c586b12153ae504bc0b24e6a7f1 (diff) | |
Document Gitaly's use of feature flags
Change should be merged after: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/24679
| -rw-r--r-- | README.md | 2 | ||||
| -rw-r--r-- | doc/PROCESS.md | 17 |
2 files changed, 18 insertions, 1 deletions
@@ -58,7 +58,7 @@ Gitaly requires Go 1.12.13 or newer and Ruby 2.6. Run `make` to download and compile Ruby dependencies, and to compile the Gitaly Go executable. -Gitaly uses `git`. Versions `2.21.0`, `2.22.0` and `2.24.0` are supported. +Gitaly uses `git`. Versions `2.22.0` and `2.24.0` are supported. ## Configuration diff --git a/doc/PROCESS.md b/doc/PROCESS.md index ebb38d54d..46616e76b 100644 --- a/doc/PROCESS.md +++ b/doc/PROCESS.md @@ -1,5 +1,22 @@ ## Gitaly Team Process +### Feature flags + +Gitaly uses feature flags to safely roll out features in production. Feature +flags are part of the `context.Context` of each RPC. The `featureflag` package +will help you with flow control. + +Feature flags are [enabled through chatops][enable-flags]. For Gitaly, you have +to prepend `gitaly_` to your feature flag when enabling or disabling. For example: +to enable the feature flag "mep_mep", you run: + +`/chatops run feature set gitaly_mep_mep true` + +For customers, who don't use chatops, an [HTTP API is available][ff-api]. + +[enable-flags]: https://docs.gitlab.com/ee/development/feature_flags/controls.html +[ff-api]: https://docs.gitlab.com/ee/api/features.html#features-flags-api + ### Gitaly Releases Gitaly uses [SemVer](https://semver.org) version numbering. |