Skip to content

Commit e14e58e

Browse files
vmelikyanvmelikyan
authored
Merge pull request #21 from GoodRxOSS/envLens-feature-flag
docs update
2 parents f11061e + 4ab6c38 commit e14e58e

File tree

4 files changed

+44
-26
lines changed

4 files changed

+44
-26
lines changed

‎src/pages/docs/schema/docker.mdx‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -167,14 +167,14 @@ services:
167167

168168
### Optional Fields
169169

170-
| Field | Type | Description |
171-
| ------------ | ------- | ----------------------------------------------------------- |
172-
| `command` | string | Override container entrypoint |
173-
| `arguments` | string | Arguments passed to the command. Use `%%SPLIT%%` for spaces |
174-
| `env` | object | Environment variables |
175-
| `ports` | array | Exposed container ports |
176-
| `deployment` | object | Deployment configuration (see below) |
177-
| `envLens` | boolean | Enable environment lens ingress banner |
170+
| Field | Type | Description |
171+
| ------------ | ------- | ---------------------------------------------------------------------------------------- |
172+
| `command` | string | Override container entrypoint |
173+
| `arguments` | string | Arguments passed to the command. Use `%%SPLIT%%` for spaces |
174+
| `env` | object | Environment variables |
175+
| `ports` | array | Exposed container ports |
176+
| `deployment` | object | Deployment configuration (see below) |
177+
| `envLens` | boolean | Enable environment lens ingress banner. Overrides the global `features.envLens` default. |
178178

179179
## Deployment Options
180180

‎src/pages/docs/schema/github.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -282,10 +282,10 @@ Persistent volume mounts for stateful data:
282282

283283
### Optional Fields
284284

285-
| Field | Type | Description |
286-
| ------------ | ------- | -------------------------------------- |
287-
| `deployment` | object | Deployment configuration (see above) |
288-
| `envLens` | boolean | Enable environment lens ingress banner |
285+
| Field | Type | Description |
286+
| ------------ | ------- | ---------------------------------------------------------------------------------------- |
287+
| `deployment` | object | Deployment configuration (see above) |
288+
| `envLens` | boolean | Enable environment lens ingress banner. Overrides the global `features.envLens` default. |
289289

290290
## Template Variables
291291

‎src/pages/docs/schema/helm.mdx‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -245,20 +245,20 @@ Configuration for an init container that runs before the main application. Uses
245245

246246
## Fields Reference
247247

248-
| Field | Type | Required | Description |
249-
| ------------------ | ------- | ---------- | -------------------------------------- |
250-
| `chart.name` | string | **Yes** | Chart name or path |
251-
| `chart.repoUrl` | string | For public | Helm repository URL |
252-
| `chart.version` | string | No | Chart version |
253-
| `chart.values` | array | No | Inline Helm values |
254-
| `chart.valueFiles` | array | No | Value file paths |
255-
| `repository` | string | For builds | GitHub repository |
256-
| `branchName` | string | For builds | Branch to build from |
257-
| `docker` | object | No | Docker build config |
258-
| `args` | string | No | Additional Helm arguments |
259-
| `version` | string | No | Helm CLI version |
260-
| `deploymentMethod` | string | No | `"native"` or `"ci"` |
261-
| `envLens` | boolean | No | Enable environment lens ingress banner |
248+
| Field | Type | Required | Description |
249+
| ------------------ | ------- | ---------- | ---------------------------------------------------------------------------------------- |
250+
| `chart.name` | string | **Yes** | Chart name or path |
251+
| `chart.repoUrl` | string | For public | Helm repository URL |
252+
| `chart.version` | string | No | Chart version |
253+
| `chart.values` | array | No | Inline Helm values |
254+
| `chart.valueFiles` | array | No | Value file paths |
255+
| `repository` | string | For builds | GitHub repository |
256+
| `branchName` | string | For builds | Branch to build from |
257+
| `docker` | object | No | Docker build config |
258+
| `args` | string | No | Additional Helm arguments |
259+
| `version` | string | No | Helm CLI version |
260+
| `deploymentMethod` | string | No | `"native"` or `"ci"` |
261+
| `envLens` | boolean | No | Enable environment lens ingress banner. Overrides the global `features.envLens` default. |
262262

263263
## Templated Variables
264264

‎src/pages/docs/setup/configure-lifecycle.mdx‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,24 @@ Replace the `defaultIPWhiteList` under `global_config.serviceDefaults` with your
6060

6161
---
6262

63+
## Enable Environment Lens Globally
64+
65+
The environment lens banner can be enabled globally for all services via the `features` row in `global_config`. Individual services can still override this by setting `envLens` explicitly in their `lifecycle.yaml`.
66+
67+
```sql
68+
-- Enable envLens globally for all services
69+
INSERT INTO public.global_config ("key", config, "createdAt", "updatedAt")
70+
VALUES ('features', '{"envLens": true}'::json, NOW(), NOW())
71+
ON CONFLICT ("key")
72+
DO UPDATE SET
73+
config = (public.global_config.config::jsonb || '{"envLens": true}'::jsonb)::json,
74+
"updatedAt" = NOW();
75+
```
76+
77+
After running this, [refresh the config cache](#refresh-config-cache) to apply the change.
78+
79+
---
80+
6381
## Refresh config cache
6482

6583
```sh

0 commit comments

Comments
 (0)