Skip to main content

Organization

Organization​

Represents the root of the Infrastream resource hierarchy.

It contains all OrganizationalUnits, GitHub connections, identity providers and global users. It sets the global baselines for GCP and GitHub.

PropertyTypeDescription
apiVersionstringAPI schema version. Must be lowops.manifests.v1.
kindstringResource kind. Must be Organization.
metadatamapThe engine reads the reserved key name to resolve the identity of this manifest. An Organization is the hierarchy root, so it has no parent.
specSpecDesired configuration. See Spec.

CodeOwnersEntry​

PropertyTypeDescription
keystring
valuestring

HibernationScheduleCronsEntry​

PropertyTypeDescription
keystring
valuestring

Spec​

User-authored organization configuration.

It sets the description, domains, default region, GitHub organization, hibernation schedule and workforce federation.

PropertyTypeDescription
descriptionstringOptional free text. The engine copies it to the core organization-manifests repository description. AI assistants use it as context.
domainDomainInternal and external base domains. Required. See Domain.
defaultRegionstringDefault GCP region for organization resources. Required. An OrganizationalUnit, Environment or Project can override it. It also sets the location of the core infrastream-docker-mirror Artifact Registry and the region of the private Certificate Authority pool.
githubGithubConfigPrimary GitHub organization. Required. It owns the central GitOps repository with the hydrated organization manifests. Its name sets the repository name (<org>-infrastream-organization-manifests) and the code owners. For application source code, use GithubConnection.
permissionsAccessPermissionsAdministrators and contributors that own the organization. They cascade to every descendant as code owners. They also set the global * default in the CODEOWNERS of the core organization-manifests repository, so they review any file with no more specific owner. Optional. If unset, the engine emits no default code owner.
hibernationHibernationConfigDefault active-hours schedule for all resources in the organization. A lower level can override it.
workforceFederationWorkforceFederationIdentity source for the users of the organization. Required. See WorkforceFederation.

Domain​

Internal and external DNS domains for the organization.

The engine derives environment and project hostnames from these base domains. Each must be a lowercase FQDN: two or more dot-separated labels of 1-63 characters from [a-z0-9-], with no hyphen at the start or end.

PropertyTypeDescription
internalstringBase domain for private, in-cluster service names. Must be a lowercase FQDN (see Domain). Recommended: define a *.internal hostname.
externalstringBase domain for public hostnames. Child OrganizationalUnits, Environments and Projects prefix their name onto it. Must be a lowercase FQDN (see Domain).
registryAliaseslist of stringAdditional domains that also serve the managed proxy registries. The managed proxy registries (types BUF and DART) have the address <registry>.pkg.<external>. Each alias adds <registry>.pkg.<alias>. A registry then gets a new address without a change to external. Such a change would move the portal host and every unit, environment and project zone.

WorkforceFederation​

Workforce identity-federation strategy.

It selects the source of the human users of the organization. Set exactly one backend in the federation oneof.

PropertyTypeDescription
googleWorkspaceGoogleWorkspaceGoogle Workspace backend. See GoogleWorkspace.
microsoftEntraIdMicrosoftEntraIdMicrosoft Entra ID backend. See MicrosoftEntraId.
infrastreamManagedInfrastreamManagedInfrastream-managed backend. See InfrastreamManaged.

GoogleWorkspace​

Google Workspace federation backend.

Federates workforce identities from a Google Workspace directory through domain-wide delegation.

PropertyTypeDescription
domainstringPrimary domain of the Google Workspace directory. Required.
customerIdstringCustomer ID of the Google Workspace account. It scopes the directory API calls. Required.
impersonatedEmailstringAdmin email that the engine impersonates through domain-wide delegation to read and provision directory identities. Required.

InfrastreamManaged​

Infrastream-managed workforce backend.

Users bring their own Google accounts, declared in OrganizationUser spec.primaryEmail. Infrastream allowlists each address and binds it as an IAM principal. This backend has no configuration.

MicrosoftEntraId​

Microsoft Entra ID federation backend.

Federates workforce identities from a Microsoft Entra ID (formerly Azure AD) tenant.

PropertyTypeDescription
issuerUristringOIDC issuer URI of the Entra ID tenant. It sets the federation trust. Required.

GithubConfig​

Configuration for the central GitOps repository on GitHub.

The engine pushes hydrated infrastructure state and application configs to it.

PropertyTypeDescription
organizationstringName of the GitHub organization that owns the central GitOps repository. Required.
administratorslist of stringNOT YET IMPLEMENTED. The engine ignores this field. Intended use: GitHub usernames with admin access on the managed repositories.

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.

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

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.