mirror of
https://github.com/GSA/notifications-admin.git
synced 2026-05-05 08:31:00 -04:00
Added feature flagging document
This commit is contained in:
50
docs/feature-flagging.md
Normal file
50
docs/feature-flagging.md
Normal file
@@ -0,0 +1,50 @@
|
||||
# Feature Flagging
|
||||
|
||||
## Using Environment Variables
|
||||
|
||||
This guide explains how to update cloud foundry envirionment variables to enable or disable feature flagging.
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- Cloud Foundry CLI (`cf`) must be installed.
|
||||
- Access to Cloud Foundry with the necessary credentials.
|
||||
|
||||
## Steps to Update
|
||||
|
||||
### 1. Log in to Cloud Foundry
|
||||
|
||||
```bash
|
||||
cf login -a api.fr.cloud.gov --sso
|
||||
```
|
||||
|
||||
### 2. Target Correct Space
|
||||
|
||||
This should be handled after authenticating but if not, you can target the spaces specifically
|
||||
|
||||
```
|
||||
cf target -o gsa-tts-benefits-studio -s notify-sandbox
|
||||
```
|
||||
|
||||
### 3. Set Environment Variable
|
||||
|
||||
```
|
||||
cf set-env <APP_NAME> <ENV_VAR_NAME> <VALUE>
|
||||
```
|
||||
|
||||
#### Example:
|
||||
|
||||
```
|
||||
cf set-env notify-admin-sandbox FEATURE_GUIDANCE_ENABLED true
|
||||
```
|
||||
|
||||
### 4. Restage the Application
|
||||
|
||||
```
|
||||
cf restage <APP_NAME>
|
||||
```
|
||||
|
||||
#### Example:
|
||||
|
||||
```
|
||||
cf restage notify-admin-sandbox
|
||||
```
|
||||
Reference in New Issue
Block a user