Organization
Represents the root of the Infrastream resource hierarchy.
Serves as the top-level container for all Organizational Units, GitHub Connections, identity providers, and global users. It establishes global configuration baselines for both GCP and GitHub platforms.
| Property | Type | Description |
|---|
| apiVersion | string | |
| kind | string | |
| metadata | map | |
| spec | Spec | User-defined configuration for the organization. |
CodeOwnersEntry
| Property | Type | Description |
|---|
| key | string | |
| value | string | |
Spec
Defines the global, user-defined configuration for the entire organization.
Encapsulates core organizational identity, domain bindings, global hibernation schedules, and the primary identity federation strategy.
| Property | Type | Description |
|---|
| description | string | This description is optional but will drastically improve the understand of the AI assistant about the structural elements of the organization |
| domain | Domain | Defines the internal and external domain names for the organization. |
| defaultRegion | string | The default GCP region for resources created within the organization. This can be overridden at the OrganizationalUnit, Environment, or Project level. * Sets the location for the core 'infrastream-docker-mirror' Artifact Registry. * Determines the region for the organization's private Certificate Authority pool. |
| gcp | Gcp | Defines the Google Cloud-specific settings for the organization. |
| github | GithubConfig | Defines the settings for the primary GitHub organization that owns the central GitOps repository. This repository hosts the hydrated organization manifests and serves as the source of truth for the platform's core infrastructure. For managing connections to other repositories or organizations (e.g., for application source code), use the 'GithubConnection' manifest instead. * The specified GitHub organization is used to construct the name of the organization's manifests repository (e.g., (org)-infrastream-organization-manifests). * This repository is configured in the computed 'codeowners' block. |
| hibernation | HibernationConfig | Defines the default hibernation schedule for all resources within the organization. This can be overridden at lower levels. This schedule is computed and applied to the 'hibernation' block, controlling the active hours for resources across the platform. |
| workforceFederation | WorkforceFederation | WorkforceFederation defines the identity source for the organization. |
Domain
| Property | Type | Description |
|---|
| internal | string | |
| external | string | |
Gcp
| Property | Type | Description |
|---|
| orgId | string | |
| billingAccountId | string | Deprecated. |
WorkforceFederation
GoogleWorkspace
| Property | Type | Description |
|---|
| domain | string | |
| customerId | string | |
| impersonatedEmail | string | |
InfrastreamManaged
| Property | Type | Description |
|---|
| domain | string | |
MicrosoftEntraId
| Property | Type | Description |
|---|
| issuerUri | string | |
GithubConfig
Configuration for the central GitOps repository hosted on GitHub.
This determines where the engine pushes hydrated infrastructure state and application configs, establishing the source of truth for the GitOps workflow.
| Property | Type | Description |
|---|
| organization | string | The name of the GitHub Organization that owns the central GitOps repository (e.g., 'pvotal-tech'). This repository will host the organization's hydrated manifests. |
| repositoryPrefix | string | A global prefix that will be prepended to any repository managed by the platform. |
| administrators | list of string | A list of GitHub usernames to be granted admin access. This field is not currently used. |
HibernationConfig
Consolidates hibernation scheduling logic.
Used by the orchestrator to aggregate windows and exclusions across OU, Environment, and Project inheritance chains into a final deployment state.
| Property | Type | Description |
|---|
| hibernate | bool | When set to 'true', forces the resource into hibernation immediately, overriding any active 'windows' or 'exclusions'. Defaults to 'false'. |
| windows | list of WindowsEntry | A map of recurring time windows during which the resource will be hibernated. The key of the map provides a unique name for each window. |
| exclusions | list of ExclusionsEntry | A map of specific, non-recurring time windows during which hibernation will be suspended, even if a 'window' is active. Use this for planned maintenance or high-traffic periods. The key of the map provides a unique name for each exclusion. |
ExclusionsEntry
WindowsEntry
HibernationExclusion
Defines a specific suspension of the hibernation schedule.
Prevents down-scaling operations during the specified timeframe, ensuring workloads remain active for special events or maintenance.
| Property | Type | Description |
|---|
| start | string | The start date and time for the exclusion window in RFC3339 format. |
RFC3339 |
| end | string | The end date and time for the exclusion window in RFC3339 format.
RFC3339 |
HibernationWindow
Defines a recurring period when an asset should be scaled down.
Scheduled cron strings used by the control plane's orchestration tools to dynamically stop virtual machines or scale Cloud Run instances to zero.
| Property | Type | Description |
|---|
| start | string | A cron expression defining when the hibernation window begins. |
| end | string | A cron expression defining when the hibernation window ends. |