debian-mirror-gitlab/doc/user/feature_flags.md

59 lines
2.7 KiB
Markdown
Raw Normal View History

2020-11-24 15:15:51 +05:30
---
stage: none
group: Development
info: "See the Technical Writers assigned to Development Guidelines: https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments-to-development-guidelines"
description: "Understand what 'GitLab features deployed behind flags' means."
2021-06-08 01:23:25 +05:30
layout: 'feature_flags'
2020-11-24 15:15:51 +05:30
---
# GitLab functionality may be limited by feature flags
> Feature flag documentation warnings were [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/227806) in GitLab 13.4.
GitLab releases some features in a disabled state using [feature flags](../development/feature_flags/index.md),
allowing them to be tested by specific groups of users and strategically
rolled out until they become enabled for everyone.
As a GitLab user, this means that some features included in a GitLab release
may be unavailable to you.
In this case, you'll see a warning like this in the feature documentation:
2021-04-29 21:17:54 +05:30
This in-development feature might not be available for your use. There can be
[risks when enabling features still in development](#risks-when-enabling-features-still-in-development).
Refer to this feature's version history for more details.
2020-11-24 15:15:51 +05:30
In the version history note, you'll find information on the state of the
feature flag, including whether the feature is on ("enabled by default") or
off ("disabled by default") for self-managed GitLab instances and for users of
GitLab.com. To see the full notes:
1. Click the three-dots icon (ellipsis) to expand version history notes:
2021-03-11 19:13:27 +05:30
![Version history note with FF information](img/version_history_notes_collapsed_v13_2.png)
2020-11-24 15:15:51 +05:30
1. Read the version history information:
2021-03-11 19:13:27 +05:30
![Version history note with FF information](img/feature_flags_history_note_info_v13_2.png)
2020-11-24 15:15:51 +05:30
If you're a user of a GitLab self-managed instance and you want to try to use a
disabled feature, you can ask a [GitLab administrator to enable it](../administration/feature_flags.md),
although changing a feature's default state isn't recommended.
If you're a GitLab.com user and the feature is disabled, be aware that GitLab may
be working on the feature for potential release in the future.
2021-04-29 21:17:54 +05:30
## Risks when enabling features still in development
Features that are disabled by default may change or be removed without notice in a future version of GitLab.
Data corruption, stability degradation, or performance degradation might occur if
you enable a feature that's disabled by default. Problems caused by using a default
disabled feature aren't covered by GitLab support, unless you were directed by GitLab
to enable the feature.
## Risks when disabling released features
In most cases, the feature flag code is removed in a future version of GitLab.
If and when that occurs, from that point onward you can't keep the feature in a disabled state.