-
Notifications
You must be signed in to change notification settings - Fork 109
/
listing-feature-flags.html.md.erb
118 lines (75 loc) · 5.46 KB
/
listing-feature-flags.html.md.erb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
---
title: Using feature flags with Cloud Foundry
owner: CLI
---
<%# Reset page title based on platform type %>
<% if vars.platform_code != 'CF' %>
<% set_title("Using feature flags with", vars.app_runtime_abbr) %>
<% end %>
With <%= vars.app_runtime_abbr %>, you can set feature flags by using the cf CLI to activate or deactivate the features available to users.
## <a id='flag-commands'></a> View and edit feature flags
To perform the following procedures, you must be logged in to your deployment as an admin using the Cloud Foundry Command Line Interface (cf CLI).
To view and edit feature flags:
1. Use the `cf feature-flags` command to list the feature flags:
<pre class="terminal">
$ cf feature-flags
Features State
user_org_creation disabled
private_domain_creation enabled
app_bits_upload enabled
app_scaling enabled
route_creation enabled
service_instance_creation enabled
diego_cnb disabled
diego_docker disabled
set_roles_by_username enabled
unset_roles_by_username enabled
task_creation enabled
env_var_visibility enabled
space_scoped_private_broker_creation enabled
space_developer_env_var_visibility enabled
service_instance_sharing disabled
hide_marketplace_from_unauthenticated_users disabled
resource_matching enabled
</pre>
<br>
For descriptions of the features enabled by each feature flag, see [Feature Flags](#flags).
1. To view the status of a feature flag, run:
```
cf feature-flag FEATURE-FLAG-NAME
```
Where `FEATURE-FLAG-NAME` is the name of the feature flag you want to view.
1. To enable a feature flag, run:
```
cf enable-feature-flag FEATURE-FLAG-NAME
```
Where `FEATURE-FLAG-NAME` is the name of the feature flag you want to activate.
1. To deactivate a feature flag, run:
```
cf disable-feature-flag FEATURE-FLAG-NAME
```
Where `FEATURE-FLAG-NAME` is the name of the feature flag you want to deactivate.
## <a id='flags'></a> Feature flags
Only admins can set feature flags. All flags are activated by default except `user_org_creation` and `diego_docker`. When deactivated, these features are only available to admins.
The following list provides descriptions of the features enabled or deactivate by each flag, and the minimum Cloud Controller API (CC API) version necessary to use the feature. <%= vars.api_version %>:
* `user_org_creation`: Any user can create an org. <%= vars.user_org_creation %> Minimum CC API version: 2.12.
* `private_domain_creation`: An Org Manager can create private domains for that org. Minimum CC API version: 2.12.
* `app_bits_upload`: Space Developers can upload app bits. Minimum CC API version: 2.12.
* `app_scaling`: Space Developers can perform scaling operations such as changing memory, disk, or instances. Minimum CC API version: 2.12.
* `route_creation`: Space Developers can create routes in a space. Minimum CC API version: 2.12.
* `route_sharing`: Space Developers can share routes between two spaces (including across orgs) in which they have the Space Developer role. When deactivated, Space Developers cannot share routes between two spaces. Minimum CC API version: 3.117.
* `service_instance_creation`: Space Developers can create service instances in a space. Minimum CC API version: 2.12.
* `diego_cnb`: Space Developers can build apps with Cloud Native Buildpacks. Minimum CC API version 3.168.
* `diego_docker`: Space Developers can push Docker apps. Minimum CC API version 2.33.
* `set_roles_by_username`: Org Managers and Space Managers can add roles by username. Minimum CC API version: 2.37.
* `unset_roles_by_username`: Org Managers and Space Managers can remove roles by username. Minimum CC API version: 2.37.
* `task_creation`: Space Developers can create tasks on their app. Minimum CC API version: 2.47.
* `env_var_visibility`: Admins can view environment variables. Minimum CC API version: 2.58.
* `space_scoped_private_broker_creation`: Space Developers can create space-scoped private service brokers. Minimum CC API version: 2.58.
* `space_developer_env_var_visibility`: Space Developers can view their v2 environment variables. Space Developers and Space Supporters can view their v3 environment variables. Minimum CC API version: 2.58.
* `service_instance_sharing`: Space Developers can share service instances between two spaces (across orgs) in which they have the Space Developer role.
* `hide_marketplace_from_unauthenticated_users`: Do not allow unauthenticated users to see the service offerings available in the marketplace.
* `resource_matching`: Allow the package upload endpoint to cache uploaded packages for resource matching. When deactivated, the resource match endpoint always returns an empty array of matches. Minimum CC API version: 3.77.
For more information about feature flag commands, see [Feature Flags](http://v3-apidocs.cloudfoundry.org/version/3.76.0/index.html#feature-flags) in the Cloud Foundry API documentation.
## <a id="disabling-custom-buildpacks"></a> Deactivate custom buildpacks
<%= vars.disable_custom_buildpacks %>