Environment Configuration Block
Document environment settings including URLs, configuration variables, resources, and dependencies. Supports secret masking for sensitive values.
The Environment Configuration block documents the settings and resources for different deployment environments. It captures configuration variables (with secret masking), infrastructure resources, dependencies, and access details.
When to Use
Block Properties
| Property | Required | Description |
|---|---|---|
| Name | Yes | Environment name |
| Type | No | Development, Testing, Staging, Production, etc. |
| Description | No | Purpose and characteristics of the environment |
| URL | No | Primary access URL |
| Variables | No | Configuration key-value pairs with optional secret flag |
| Resources | No | Infrastructure and resource specifications |
| Dependencies | No | External services and systems required |
| Owner | No | Team or person responsible |
| Last Updated | No | Date of last configuration change |
Variable Properties
| Property | Required | Description |
|---|---|---|
| Key | Yes | Configuration variable name |
| Value | Yes | Configuration value |
| Secret | No | Whether to mask the value in display |
| Description | No | Purpose of this configuration variable |
Environment Types
Example: Production Environment
A production environment configuration with infrastructure details.
Example: Staging Environment
A staging environment matching production configuration at reduced scale.
Example: Development Environment
A local development environment configuration.