Skip to main content

Environment

Environment​

A deployment lifecycle boundary, for example Development, Staging, or Production.

It provisions a GCP folder under the parent OrganizationalUnit. Its direct children, Secret and Project manifests, inherit its permissions, hibernation schedules, and domain segments.

PropertyTypeDescription
apiVersionstringAPI schema version. Must be lowops.manifests.v1.
kindstringResource kind. Must be Environment.
metadatamapThe engine reads the reserved keys name, organizational-unit, and organization to resolve the identity and the parent OrganizationalUnit.
specEnvironmentDefinitionDesired environment configuration. Child Projects inherit its permissions, hibernation schedule, and domain segment. See EnvironmentDefinition.

EnvironmentDefinition​

Definition of an Environment, for example staging or prod.

It maps to a GCP folder under the parent OU folder and sets defaults for the projects in it.

PropertyTypeDescription
displayNamestringDisplay name of the GCP folder. Same rules as OrganizationalUnitDefinition.display_name.
descriptionstringFree-text description.
hibernationHibernationConfigDefault hibernation schedule for the environment. It overrides the schedule of the parent OrganizationalUnit. Child Project manifests inherit it.
permissionsAccessPermissionsDefault permissions for the environment. Child Project manifests inherit them. The engine combines them with the permissions of the parent OrganizationalUnit.
networkEnvironmentNetworkNOT YET IMPLEMENTED. The engine ignores this field. See EnvironmentNetwork.

HibernationConfig​

Hibernation schedule configuration.

The engine combines windows and exclusions from the OU, Environment and Project into the final state.

PropertyTypeDescription
hibernateboolIf true, the resource hibernates immediately and overrides all windows and exclusions. Defaults to false.
windowslist of WindowsEntryTime windows that repeat, in which the resource hibernates. The map key is a unique name.
exclusionslist of ExclusionsEntryOne-time windows that suspend hibernation, even if a window is active. Use them for planned maintenance or high-traffic periods. The map key is a unique name.

EnvironmentNetwork​

VPC flow log settings for an Environment.

NOT YET IMPLEMENTED. The engine ignores this message.

PropertyTypeDescription
logsNetworkLogsNOT YET IMPLEMENTED. The engine ignores this field. See NetworkLogs.

AccessPermissions​

Administrator, contributor, and viewer privileges for an asset.

The engine aggregates the users and groups into IAM policies.

PropertyTypeDescription
administratorsDetailedAccessPermissionsUsers and groups with administrative privileges, usually full control.
contributorsDetailedAccessPermissionsUsers and groups with contributor privileges, usually read and write access.
viewersDetailedAccessPermissionsUsers and groups with viewer privileges, usually read-only access.

DetailedAccessPermissions​

User and group access definitions.

The engine resolves the listed manifests to Google Workspace identity emails for IAM bindings.

PropertyTypeDescription
memberslist of stringNames of OrganizationUser manifests.
groupslist of stringNames of OrganizationUserGroup manifests.

WindowsEntry​

PropertyTypeDescription
keystring
valueHibernationWindow

NetworkLogs​

VPC Flow Logs export settings.

NOT YET IMPLEMENTED. The engine ignores this message. Intended use: set the aggregation interval and sampling rate of flow logs.

PropertyTypeDescription
intervalstringAggregation interval. One of the INTERVAL_* values, from INTERVAL_5_SEC to INTERVAL_15_MIN.
samplingdoubleFraction of connections to capture, from 0.0 (no logs) to 1.0 (all logs).

ExclusionsEntry​

PropertyTypeDescription
keystring
valueHibernationExclusion

HibernationExclusion​

Suspension of the hibernation schedule.

Workloads stay active in the given time frame.

PropertyTypeDescription
startstringWindow start, in RFC3339 format. RFC3339
endstringWindow end, in RFC3339 format. RFC3339

HibernationWindow​

Period when an asset scales down.

Cron strings tell the control plane when to stop virtual machines or scale Cloud Run instances to zero.

PropertyTypeDescription
startstringCron expression for the start of the window.
endstringCron expression for the end of the window.