gitlab-org--gitlab-foss/doc/development/licensed_feature_availability.md

38 lines
1.4 KiB
Markdown
Raw Normal View History

# Licensed feature availability **(STARTER)**
2019-05-05 09:57:21 -04:00
As of GitLab 9.4, we've been supporting a simplified version of licensed
feature availability checks via `ee/app/models/license.rb`, both for
2019-05-05 09:57:21 -04:00
on-premise or GitLab.com plans and features.
## Restricting features scoped by namespaces or projects
GitLab.com plans are persisted on user groups and namespaces, therefore, if you're adding a
feature such as [Related issues](../user/project/issues/related_issues.md) or
[Service desk](../user/project/service_desk.md),
2019-05-05 09:57:21 -04:00
it should be restricted on namespace scope.
1. Add the feature symbol on `EES_FEATURES`, `EEP_FEATURES` or `EEU_FEATURES` constants in
`ee/app/models/license.rb`. Note on `ee/app/models/ee/namespace.rb` that _Bronze_ GitLab.com
2019-05-05 09:57:21 -04:00
features maps to on-premise _EES_, _Silver_ to _EEP_ and _Gold_ to _EEU_.
1. Check using:
2019-05-05 09:57:21 -04:00
```ruby
project.feature_available?(:feature_symbol)
```
## Restricting global features (instance)
However, for features such as [Geo](../administration/geo/replication/index.md) and
[Load balancing](../administration/database_load_balancing.md), which cannot be restricted
to only a subset of projects or namespaces, the check will be made directly in
2019-05-05 09:57:21 -04:00
the instance license.
1. Add the feature symbol on `EES_FEATURES`, `EEP_FEATURES` or `EEU_FEATURES` constants in
2019-05-05 09:57:21 -04:00
`ee/app/models/license.rb`.
1. Add the same feature symbol to `GLOBAL_FEATURES`
1. Check using:
2019-05-05 09:57:21 -04:00
```ruby
License.feature_available?(:feature_symbol)
```