diff options
| author | GitLab Bot <gitlab-bot@gitlab.com> | 2021-10-20 03:12:54 +0000 |
|---|---|---|
| committer | GitLab Bot <gitlab-bot@gitlab.com> | 2021-10-20 03:12:54 +0000 |
| commit | d1a991fd3a540d22045ecba119f65640faff6d29 (patch) | |
| tree | f58e0c12e9f285d79fbe8dc57a890202688e2e63 /doc/operations | |
| parent | a0ef617f9ae96b0ed3fe0054bbbb65d2b80e2b10 (diff) | |
| download | gitlab-ce-d1a991fd3a540d22045ecba119f65640faff6d29.tar.gz | |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/operations')
| -rw-r--r-- | doc/operations/feature_flags.md | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/doc/operations/feature_flags.md b/doc/operations/feature_flags.md index 2af4ee47292..dd74bfd6a3c 100644 --- a/doc/operations/feature_flags.md +++ b/doc/operations/feature_flags.md @@ -403,6 +403,29 @@ else end ``` +### Unleash Proxy example + +As of [Unleash Proxy](https://docs.getunleash.io/sdks/unleash-proxy) version +0.2, the proxy is compatible with feature flags. To run a Docker container to +connect to your project's feature flags, run the following command: + +```shell +docker run \ + -e UNLEASH_PROXY_SECRET=<secret> \ + -e UNLEASH_PROXY_URL=<project feature flags URL> \ + -e UNLEASH_PROXY_INSTANCE_ID=<project feature flags instance ID> \ + -e UNLEASH_PROXY_APP_NAME=<project environment> \ + -e UNLEASH_PROXY_API_TOKEN=<token> +``` + +| Variable | Value | +| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | +| `UNLEASH_PROXY_SECRET` | Shared secret used to configure an [Unleash Proxy client](https://docs.getunleash.io/sdks/unleash-proxy#how-to-connect-to-the-proxy). | +| `UNLEASH_PROXY_URL` | Your project's API URL. For more details, read [Get access credentials](#get-access-credentials). | +| `UNLEASH_PROXY_INSTANCE_ID` | Your project's Instance ID. For more details, read [Get access credentials](#get-access-credentials). | +| `UNLEASH_PROXY_APP_NAME` | The name of the environment the application runs in. For more details, read [Get access credentials](#get-access-credentials). | +| `UNLEASH_PROXY_API_TOKEN` | Required to start the Unleash Proxy, but not used to connect to GitLab. Can be set to any value. | + ## Feature Flag Related Issues **(PREMIUM)** > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/36617) in GitLab 13.2. |