Skip to main content

Common

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.

AgentAccessControlConfig​

All external access rules of an AI agent.

Mirrors ApplicationAccessControlConfig, but agent rules can differ.

PropertyTypeDescription
additionalRoleslist of stringExtra IAM roles for the agent service account, beyond the base roles (monitoring, logging, tracing, and aiplatform.user).
pubsubApplicationAccessControlPubsubConfigPublish and subscribe grants for specific Pub/Sub topics.
bucketslist of ApplicationAccessControlBucketConfigCloud Storage buckets that the agent can read or write.
databaseApplicationAccessControlDatabaseConfigPostgreSQL database access: instance and schema.
secretslist of SecretsEntryMap from Secret manifest name to how the agent gets the secret, typically as an environment variable.

SecretsEntry​

PropertyTypeDescription
keystring
valueSecretSourceConfig

AgentConfig​

Ops Agent settings for a VM.

Selects the logs and metrics that go to Cloud Monitoring.

PropertyTypeDescription
logFileslist of stringGlob patterns of log files that the Ops Agent ships to Cloud Logging.
metricslist of MetricConfigCustom metric collectors to add to the Ops Agent.

ApplicationAccessControlBucketConfig​

Cloud Storage access for a workload.

Grants roles/storage.objectViewer or roles/storage.objectUser on a bucket.

PropertyTypeDescription
namestringName of the Bucket manifest. It must exist in every environment of the parent ReleaseTrack. Required.
sourcestringName of a GithubRepository manifest whose contents seed the bucket through a gcloud storage rsync job in CI/CD. Optional.
permissionstringREAD_ONLY grants roles/storage.objectViewer. WRITE grants roles/storage.objectUser.
mountPathstringAbsolute path in the container where Cloud Storage FUSE mounts the bucket. If omitted, the engine grants access but does not mount the bucket.
subPathstringBucket prefix that limits access, for example to mount one folder. If omitted, access covers the whole bucket.
promoteboolIf true, the engine promotes the bucket content through the ReleaseTrack with the application.
envVarstringEnvironment variable that receives the bucket name, instead of a filesystem mount. Mutually exclusive with mount_path.

ApplicationAccessControlConfig​

All external access rules of an application.

Each block adds IAM bindings, SQL grants, or secret access.

PropertyTypeDescription
additionalRoleslist of stringExtra IAM roles for the application service account, beyond the roles from the other blocks.
pubsubApplicationAccessControlPubsubConfigPublish and subscribe grants for specific Pub/Sub topics.
bucketslist of ApplicationAccessControlBucketConfigCloud Storage buckets that the application can read or write.
databaseApplicationAccessControlDatabaseConfigPostgreSQL database access: instance, schema, privileges, and credential source.
secretslist of SecretsEntryMap from Secret manifest name to how the application gets the secret.
redislist of ApplicationAccessControlRedisConfigRedis instances that the application can use.
jobslist of ApplicationAccessControlJobConfigCloud Run Jobs of other applications that this application can trigger with the RunJob API.

SecretsEntry​

PropertyTypeDescription
keystring
valueSecretSourceConfig

ApplicationAccessControlDatabaseConfig​

PostgreSQL access for a workload.

Runs CREATE USER and GRANT on the target SQL instance.

PropertyTypeDescription
namestringName of the Database manifest (an AlloyDB/PostgreSQL instance) that the application needs.
schemastringDatabase (schema) in the instance that the application connects to.
privilegeslist of stringSQL privileges for the application database role on the schema: USAGE, CREATE, or ALL. Each one becomes a GRANT statement.
readOnlyboolIf true, the application has read-only access, typically to a read replica.
extensionslist of stringPostgreSQL extensions to enable. Each entry runs CREATE EXTENSION IF NOT EXISTS. The engine merges the lists of all applications that share a schema.
secretSourceSecretSourceConfigSource of the database credentials: the Secret manifest and how the application gets it (environment variable or file mount). Required.

ApplicationAccessControlJobConfig​

Permission to trigger a Cloud Run Job of another application.

Grants roles/run.developer on the job and injects the job resource name as an environment variable.

PropertyTypeDescription
applicationstringName of the Application manifest that owns the target job. Required.
jobstringName of the job. It matches an ApplicationJobReference.name of that application. Required.
envVarstringEnvironment variable for the full Cloud Run resource name of the job. If empty, the caller must derive the job name.

ApplicationAccessControlPubsubConfig​

Pub/Sub permissions for a workload.

The engine grants the roles to the service account of the workload.

PropertyTypeDescription
publishTolist of stringNames of PubSub manifests that the workload can publish to. Each entry grants roles/pubsub.publisher on the topic.
subscribeTolist of stringEach entry, a PubSub manifest name, grants roles/pubsub.subscriber on the TOPIC. On a topic, this role only gives pubsub.topics.attachSubscription. The workload can attach a subscription, but it cannot pull from or acknowledge on any subscription, even a managed one in spec.subscriptions. To create a subscription, the workload also needs pubsub.subscriptions.create on the project, which this field does not grant. To consume from a managed subscription, use pull_from. The behavior stays unchanged for old manifests.
pullFromlist of ApplicationAccessControlPubsubPullConfigEach entry grants roles/pubsub.subscriber on one subscription from spec.subscriptions of a PubSub manifest, and nothing on the topic or the project. The topic and subscription must exist in the project of the workload, or validation fails. See ApplicationAccessControlPubsubPullConfig.

ApplicationAccessControlPubsubPullConfig​

Pub/Sub subscription that a workload consumes.

Grants roles/pubsub.subscriber on a subscription or its dead-letter subscription.

PropertyTypeDescription
topicstringName of the PubSub manifest (topic) that declares the subscription. Required.
subscriptionstringName of the subscription in spec.subscriptions of that manifest. Required.
deadLetterboolIf true, the grant targets the dead-letter subscription <topic>-<subscription>-dlq-sub. The subscription must declare deadLetter. To republish messages, the worker also needs the topic in publish_to.

ApplicationAccessControlRedisConfig​

Redis cache access for a workload.

Injects the connection URL as an environment variable. All instances use TLS (SERVER_AUTHENTICATION).

PropertyTypeDescription
namestringName of the Redis manifest. The application deploys after the DNS record of the instance resolves. Required.
envVarstringEnvironment variable that receives the connection URL redis[s]://memory-<redis-name>.<internal-domain>:<port>. Meshed strategies (SIDECAR, PROXYLESS) use redis:// on port 6380. Direct access (DISABLED) uses rediss:// on port 6379. Required.
caCertPathstringAbsolute path in the container of the server CA certificate (PEM). The application must load it into its TLS trust pool. Required.

ApplicationDefinition​

Application specification.

Spec body of the Application manifest. ExternalApplication uses ExternalApplicationDefinition, because its image comes from outside the workspace.

PropertyTypeDescription
descriptionstringFree text that describes what the application does. Used as documentation and as context for AI assistants.
targetstringRuntime the application deploys to: KUBERNETES, CLOUD_RUN, COMPUTE or CDN. CDN is a static site: the engine provisions a public Bucket behind the load balancer and Cloud CDN, through a StaticAssetRoute. For CDN, build_definition must be a REACT build whose publish stage uploads the production bundle to a STATIC ArtifactRegistry. The engine ignores cluster, and mesh_strategy must be DISABLED.
meshStrategystringSIDECAR deploys a proxy sidecar and creates mesh HTTP/gRPC routes against a SIDECAR_PROXY backend. PROXYLESS uses in-process gRPC service discovery. DISABLED keeps the application out of the mesh. Must be DISABLED when target is CDN.
projectstringName of the Project manifest that receives the resources of the application. Required. It must be present in every environment of the parent ReleaseTrack.
accessControlApplicationAccessControlConfigAccess that the service account of the application gets to platform resources such as Buckets, Databases, Pub/Sub topics and Secrets.
bundleOnlyboolIf true, the engine does not promote the application through pre-release tracks. It records each successful build version as a deployment that release-track bundles can include.
jobslist of ApplicationJobReferenceJobs that run BEFORE deploy, AFTER deploy, SCHEDULED by cron or ON_DEMAND. Each reference needs a JobConfig manifest in every environment.
buildDefinitionstringName of the BuildDefinition manifest that builds the artifact of the application. Required. For compute targets, the registry and image name come from its containerize block. For target: CDN, it must be a REACT build whose publish stage uploads a static bundle to a STATIC registry.
clusterstringmetadata.name of the Kubernetes manifest to deploy to, in project. Required when target is KUBERNETES. Ignored for CLOUD_RUN and COMPUTE. It must exist in every environment of the parent ReleaseTrack.

ApplicationJobReference​

Job that is part of the lifecycle of an Application.

A JobConfig manifest gives the environment-specific container, schedule, and resources.

PropertyTypeDescription
namestringUnique name of the job in the application, for example migrate. It links to the JobConfig manifest. Required.
typestringBEFORE runs before the service deploy and blocks until complete (for example DB migrations). AFTER runs after the deploy and blocks until complete. SCHEDULED runs on a Cloud Scheduler cron expression. ON_DEMAND has no schedule: a user triggers it manually or with the API.

ApprovalPolicy​

Recursive rule for who must approve a deployment stage.

A node is a leaf with one stakeholder, or an any-of, all-of, or quorum composite of nested policies.

PropertyTypeDescription
stakeholderStakeholderLeaf policy. It passes when the named stakeholder (a user or group) approves.
anyOfApprovalSetAny-of (OR) composite. It passes when at least one nested policy passes.
allOfApprovalSetAll-of (AND) composite. It passes when every nested policy passes.
quorumApprovalSetQuorum composite. It passes when at least min_approvals nested policies pass.

ApprovalSet​

Nested approval policies of a composite node.

For a quorum node, min_approvals sets how many children must pass.

PropertyTypeDescription
policieslist of ApprovalPolicyChild policies that the parent operator combines.
minApprovalsint32Minimum number of nested policies that must pass in a quorum composite. The any-of and all-of operators ignore it.

ArtifactRegistryAccessPermissions​

Access levels for Artifact Registry repositories.

Readers get roles/artifactregistry.reader. Writers get roles/artifactregistry.writer.

PropertyTypeDescription
readersDetailedAccessPermissionsUsers and groups with read-only access.
writersDetailedAccessPermissionsUsers and groups with read and write access.

BucketImageConverterConfig​

Automatic image conversion for a bucket.

NOT YET IMPLEMENTED. The engine ignores this message. It will re-encode and resize uploaded images.

PropertyTypeDescription
formatstringFormat to re-encode uploaded images to: WEBP, PNG or JPEG.
maxWidthint64Maximum output width in pixels (minimum 100). The converter scales down larger images.
maxHeightint64Maximum output height in pixels (minimum 100). The converter scales down larger images.

BucketNotificationConfig​

Bucket notification to Pub/Sub.

Sends an event record to a Pub/Sub topic when objects in the bucket change.

PropertyTypeDescription
topicstringName of the PubSub manifest that receives the notifications. It must exist.
eventslist of stringStorage event types that trigger a notification: OBJECT_FINALIZE (new object) or OBJECT_METADATA_UPDATE (metadata change).

BucketRouteConfig​

Target and behavior of one static path.

Serves a URL path prefix of a StaticAssetRoute from a Bucket (name) or a CDN application (site_config), with Cloud CDN. The load balancer cannot gate a bucket with IAP, GCIP or identity auth, so static paths are public.

PropertyTypeDescription
namestringName of the Bucket manifest that this path serves. Mutually exclusive with site_config: set exactly one. Must exist in the parent Project.
authenticationlist of RouteRuleAuthenticationConfigNOT ENFORCED for static (bucket-backed) paths. A bucket backend cannot use IAP, IDENTITY_PROVIDER or INTERNAL auth, so the engine ignores this field and serves the content publicly. To gate a single-page app, authenticate on the client side.
authorizationlist of ComputedAuthorizationAccessRuleCheckNOT ENFORCED for static (bucket-backed) paths. As with authentication, the engine ignores it and serves the content publicly.
siteConfigstringName of a SiteConfig manifest (a target: CDN application) whose bucket backs this path. Mutually exclusive with name: set exactly one. Must exist in the parent Project.
notFoundPagestringBucket object to serve when the bucket returns 404 (single-page-app fallback). The response keeps the URL and has status 200, not a redirect. Set it to the entry file of the app, for example /index.html or /admin/index.html. Leave it empty on a plain asset host such as /images to return real 404 errors. To keep the real 404 status, set not_found_status: 404. Defaults to /index.html for site_config targets.
notFoundStatusint32200 (the default) serves not_found_page with status 200, which suits a single-page app. 404 keeps the real 404 status, which suits a content site, because crawlers drop 404 URLs from their index. With 404, the bucket caches the error. A URL that you request just before you publish its page can answer 404 for about two minutes. It applies only if not_found_page has a value or the target is a site_config. The engine rejects it on a name path without not_found_page.

CodeOwnerConfig​

Configuration for GitHub code ownership and repository rules.

It sets the CODEOWNERS files and branch protection rules that make specific teams review changes to critical paths.

PropertyTypeDescription
githubOwnerstringGitHub organization that hosts the target repository. Defaults to the configured GitHub organization. It qualifies team references such as @<owner>/infrastream-<group> in the rules.
repositorystringRepository whose CODEOWNERS rules the engine computes. Defaults to <org>-infrastream-organization-manifests.
ruleslist of stringRendered CODEOWNERS lines, one for each protected path, with the teams and users that own it. Set by the engine.

ComputedAccessPermissions​

Computed access permissions of a resource.

The flat form of an AccessPermissions block, ready for IAM.

PropertyTypeDescription
administratorsComputedDetailedAccessPermissionsResolved users and groups with administrative privileges.
contributorsComputedDetailedAccessPermissionsResolved users and groups with contributor privileges.
viewersComputedDetailedAccessPermissionsResolved users and groups with viewer privileges.

ComputedAccessibleRegistry​

Computed Artifact Registry repository.

Holds the name and location that resolve image paths.

PropertyTypeDescription
namestringName of the Artifact Registry repository.
locationstringGCP region or multi-region of the registry. It forms part of the image path.
trustedRepositorieslist of stringTrusted repository children of an external registry. Binary Authorization allows each one separately, not the whole registry. Empty for internal repositories, which use attestation.

ComputedApplication​

Computed deployment configuration of an application.

Holds the mesh strategy, the migration requirements, and the container image layout.

PropertyTypeDescription
namestringResolved application name.
meshStrategystringService mesh strategy, for example SIDECAR, PROXYLESS, DISABLED, or EXCLUDED. It controls traffic routes and service URLs.
containerComputedContainerDefinitionResolved container image of the application.

ComputedArtifactRegistry​

Computed Artifact Registry resource.

The resolved state of an ArtifactRegistry manifest.

PropertyTypeDescription
namestringCopy of metadata.name.
typestringCopy of spec.type.
publishUrlstringURL that the engine composes from spec.type.
regionstringCopy of spec.region.
permissionsArtifactRegistryAccessPermissionsCopy of spec.permissions, with user and group names resolved to full Google Cloud Identity identifiers.

ComputedAuthorizationAccess​

Map of hostnames to authorization rules.

The authorization extensions use it as an in-memory index.

PropertyTypeDescription
ruleslist of RulesEntryMap of hostname to the rules of that host, from all child HttpRoute and GrpcRoute manifests.

RulesEntry​

PropertyTypeDescription
keystring
valueComputedAuthorizationAccessRules

ComputedAuthorizationAccessRule​

Computed authorization rule.

Part of the configuration that authorization extensions use to resolve user scopes.

PropertyTypeDescription
identitySourcestringCopy of spec.authorization.identitySource of the child HttpRoute or GrpcRoute manifest.
matcheslist of HttpRouteRuleMatchCopy of the spec.matches block of the child HttpRoute or GrpcRoute manifest.
checkslist of ComputedAuthorizationAccessRuleCheckCopy of the spec.authorization.checks block of the child HttpRoute or GrpcRoute manifest.

ComputedAuthorizationAccessRuleCheck​

Computed access check for a route rule.

The identity tuple (namespace, relation, object) that the authorization extension checks.

PropertyTypeDescription
namespacestringCopy of spec.authorization.namespace of the child HttpRoute or GrpcRoute manifest.
relationstringCopy of spec.authorization.relation of the child HttpRoute or GrpcRoute manifest.
objectstringCopy of spec.authorization.object of the child HttpRoute or GrpcRoute manifest.

ComputedAuthorizationAccessRules​

Authorization rules for one host.

Lists the rules that apply to the traffic of the host.

PropertyTypeDescription
ruleslist of ComputedAuthorizationAccessRuleRules from all child HttpRoute and GrpcRoute manifests for the host.

ComputedContainerDefinition​

Computed container image source of a deployment.

Gives the image URL for the deployment API.

PropertyTypeDescription
sourceRegistryComputedAccessibleRegistryArtifact Registry that stores the image.
imagestringAbsolute image reference, with registry host and repository path.

ComputedCoreCodeOwnerEntry​

Code owner entry for the core-manifest repository.

The engine resolves GitHub team IDs from it to set the required reviewers in repository rulesets.

PropertyTypeDescription
pathstringFile path pattern in the manifest repository, for example "organization/example-co/project/my-project.yaml".
teamslist of stringFull names of the GitHub teams that own this path, as in the GithubConnection, for example "infrastream-platform-team". Not OrganizationUserGroup names.

ComputedDatabaseAccessGrant​

Computed access grant on a database schema.

Maps an application service account to SQL privileges on a schema.

PropertyTypeDescription
deploymentConfigNamestringName of the Application manifest whose service account gets the grant.
schemastringSchema that the privileges apply to.
privilegeslist of stringSQL privileges (ALL, USAGE, CREATE) for the IAM role of the application.

ComputedDatabaseSchema​

Computed database schema to create on AlloyDB.

Collected from accessControl.database.name in Application manifests. Extensions merge by schema.

PropertyTypeDescription
namestringName of the schema to create.
extensionslist of stringExtensions that applications request for the schema.

ComputedDeploymentPlan​

Computed deployment sequence of a release track.

The path of a container image from pre-release stages to production.

PropertyTypeDescription
preReleaseStageslist of ComputedDeploymentStageOrdered stages before the main release progression, for example integration or canary.
releaseStageslist of ComputedDeploymentStageOrdered stages of the normal release progression, up to production.
hotfixStageslist of ComputedDeploymentStageOrdered stages for hotfix rollouts. They can skip some pre-release stages.

ComputedDeploymentStage​

Computed group of parallel deployment steps.

A phase such as staging or production. Stages can enforce sequential rollouts.

PropertyTypeDescription
idstringStable identifier of the stage.
stepslist of ComputedDeploymentStepSteps that run together in this stage before promotion to the next stage.

ComputedDeploymentStep​

Computed step of a release progression.

Holds the environment, project, and container for one deployment.

PropertyTypeDescription
idstringStable identifier of the step.
environmentstringName of the Environment that the step deploys to.
projectstringGCP project that receives the resources of the step.
containerComputedContainerDefinitionResolved container image of the step.
stakeholdersDetailedAccessPermissionsUsers and groups that approve or oversee the step.

ComputedDetailedAccessPermissions​

Computed members and groups of one permission level.

Holds the resolved IDs to bind to a resource.

PropertyTypeDescription
memberslist of int64Resolved OrganizationUser IDs.
groupslist of int64Resolved OrganizationUserGroup IDs.

ComputedDomainConfig​

Computed fully qualified domain names.

The engine builds them from the root domains of the Environment.

PropertyTypeDescription
internalstringInternal domain name, composed from parent configurations.
externalstringExternal domain name, composed from parent configurations.

ComputedExternalRegistry​

Computed external container registry dependency.

It holds fields of an ExternalRegistry manifest and links the registry to the secrets with its credentials.

PropertyTypeDescription
namestringCopy of metadata.name.
typestringCopy of spec.type.
publishUrlstringCopy of spec.url.
authenticationstringCopy of spec.authentication.
usernameGcpSecretIdstringGCP resource StateID of the Secret manifest that the engine finds by the typical name <registryName>-username.
usernameSourceControlSecretIdstringName of the GithubSecret manifest that the engine finds by the typical name <registryName>-username.
passwordGcpSecretIdstringGCP resource StateID of the Secret manifest that the engine finds by the typical name <registryName>-password.
passwordSourceControlSecretIdstringName of the GithubSecret manifest that the engine finds by the typical name <registryName>-password.
regionstringGCP region of the external registry, used to resolve image paths.

ComputedGithubBranchConfig​

Computed branch protection rules for a GitHub repository.

They set review counts, status checks and bypass roles.

PropertyTypeDescription
idstringUnique identifier of the rule set, for example primary-branches.
targetPatternslist of stringGlob patterns of the branches that the rules apply to, for example main or feat/*.
requiredReviewersint64Number of approvals that a pull request needs before merge.
canCreateboolWhether users can create branches that match these patterns.
bypassRoleslist of stringGitHub roles, for example Maintainer or Admin, that can bypass the rules.
statusCheckslist of stringStatus check contexts that must pass before merge.
releaseTypestringRelease type of the branch, for example major, minor or patch. It can influence versioning automation.
allowedSourceBranchPatternslist of stringGlob patterns of the branches that can merge into this branch. CI uses them to enforce the flow.
requiredBranchPatternstringOptional regex that the branches in target_patterns must match.
allowedMergeMethodslist of stringAllowed merge methods, for example merge, squash or rebase.
statusCheckAppslist of StatusCheckAppsEntryGitHub App for each required status check, keyed by check name. GitHub counts a check only when this app posts it. The engine pins a check that is not in the map to its own app.

StatusCheckAppsEntry​

PropertyTypeDescription
keystring
valueint64

ComputedGithubSecretRepositories​

Relation between a GitHub secret and its target repositories.

Internal state. It tracks the repositories that received a GithubSecret manifest.

PropertyTypeDescription
secretKeystringName of the secret.
repositorieslist of stringRepositories that receive the secret.

ComputedGithubTeamConfig​

Computed GitHub team and its members.

Holds the team, parent team, and member roles.

PropertyTypeDescription
namestringResolved GitHub team name.
parentstringParent team name for a nested team. Empty for a top-level team.
memberslist of MembersEntryMap from member login to team role, for example member or maintainer.

MembersEntry​

PropertyTypeDescription
keystring
valuestring

ComputedHibernationConfig​

Computed hibernation schedule.

The engine converts windows and exclusions into cron triggers that start and stop workloads.

PropertyTypeDescription
enabledboolWhether a hibernation schedule is active.
scheduledTriggerslist of ScheduledTriggersEntryResolved cron triggers, keyed by unique name.

ScheduledTriggersEntry​

PropertyTypeDescription
keystring
valuestring

ComputedIamServiceAccount​

Computed Google Cloud service account.

The engine uses it to create IAM bindings and Kubernetes Workload Identity bindings.

PropertyTypeDescription
namestringName of the service account, usually from the name of the Application manifest.
createboolWhether the platform creates the service account. Usually true, unless the application uses an account that already exists.
rolesComputedIamServiceAccountPermissionsResolved IAM roles, derived from the accessControl block of the Application manifest.
k8sNamestringName of the Kubernetes service account bound to this account. Relevant for applications on GKE.
k8sNamespacestringNamespace of the Kubernetes service account.

ComputedIamServiceAccountPermissions​

Computed IAM roles for a service account.

The engine derives them from the accessControl blocks of the application.

PropertyTypeDescription
organizationlist of stringRoles at the GCP organization level.
projectlist of stringRoles at the GCP project level.
artifactRegistrylist of stringRoles for specific Artifact Registry repositories.

ComputedLoadBalancerHost​

Compiled paths of a load balancer host.

Becomes the host rules in the URL map.

PropertyTypeDescription
iapPathslist of ComputedLoadBalancerPathPaths protected by IAP (Identity-Aware Proxy) authentication.
gcipPathslist of ComputedLoadBalancerPathPaths protected by GCIP (Identity Platform) authentication.
unauthPathslist of ComputedLoadBalancerPathPaths served without authentication.
bucketPathslist of ComputedLoadBalancerPathPaths served from a static GCS bucket backend.

ComputedLoadBalancerPath​

Compiled routing path of a load balancer.

Becomes one path matcher in the URL map.

PropertyTypeDescription
matcherslist of HttpRouteRuleMatchCompiled match conditions.
tenantstringTenant of this path. Set only for IDENTITY_PROVIDER authentication. Only used for IDENTITY_PROVIDER
hostRewritestringHost header rewrite for the backend request.
pathRewritestringPath rewrite for the backend request.
bucketstringGCS bucket name. Set for static bucket content. Used for static buckets (a Bucket manifest name)
siteConfigstringName of the SiteConfig (CDN application) whose engine-owned bucket backs this path. The ingress uses it in place of a Bucket manifest. Mutually exclusive with bucket.
notFoundPagestringResolved not-found page from BucketRouteConfig.not_found_page. Empty means no fallback. If set, a 404 on this path serves the page with status 200.
responseHeaderslist of stringResolved response headers for the backend bucket, one Name: value per entry. They are the security_headers preset of the StaticAssetRoute merged with its response_headers. An explicit header replaces a preset header of the same name. Bucket paths only.
notFoundStatusint32Resolved from BucketRouteConfig.not_found_status. 0 or 200 serves the not-found page with status 200. 404 keeps the real 404. It applies only if not_found_page has a value.
complexityint64Weight that sorts path matchers. A higher value is more specific and the load balancer evaluates it first.
timeoutstringRoute-level request timeout, as a Go-style duration string, for example 1800s. It overrides the default of the backend service.
idleTimeoutstringRoute-level idle timeout, as a Go-style duration string, for example 60s.
agentNamestringName of the agent this path routes to. If set, the path is rewritten to /agents/{agent_name}/ for the agentic proxy.

ComputedLoadBalancerRouteAuthorization​

Authorization context of a backend service.

Adds the external authorization plugin to the IAP or Cloud Service Mesh configuration.

PropertyTypeDescription
backendServicestringSelf-link of the backend service for the authorization extension Cloud Run service. Its name is usually <name>-authz-ext, where <name> is metadata.name of the PublicIngress manifest.
accessRulesComputedAuthorizationAccessAll spec.authorization.rules of the child HttpRoute and GrpcRoute manifests of this ingress.

ComputedPrivateCaPool​

Computed Private Certificate Authority pool.

It holds the state IDs and locations of the CA pools in the core control plane project.

PropertyTypeDescription
authorityIdstringStateID of the certificate authority in the pool.
poolIdstringStateID of the CA pool.
locationstringGCP region of the CA pool, inherited from default_region of the Organization.
projectIdstringStateID of the GCP project that holds the pool: infrastream_core_project_id.
organizationstringName of the parent Organization manifest.

ComputedRelatedArtifactRegistry​

Artifact Registry with its dependent repository names.

It links the registry of an environment to the application repositories built into it.

PropertyTypeDescription
repositorieslist of stringNames of the application repositories built into this registry.
registryComputedArtifactRegistryThe resolved Artifact Registry.

ComputedRelatedExternalRegistry​

External registry with its dependent repository names.

It links application repositories to an external registry.

PropertyTypeDescription
repositorieslist of stringNames of the application repositories that pull from this registry.
registryComputedExternalRegistryThe resolved external registry.

ComputedStaticArtifact​

Static-bundle source of a CDN deployment.

The CDN equivalent of ComputedContainerDefinition, for target: CDN. It points to a versioned GENERIC package (the React dist/ bundle) and to the bucket that serves it.

PropertyTypeDescription
sourceRegistryComputedAccessibleRegistrySTATIC (GENERIC-backed) Artifact Registry that holds the bundle.
packagestringGeneric package name (the BuildDefinition name). With version, it names the version that the deploy job exports.
versionstringGeneric-package version to serve. It mirrors the deployment version tag. The deploy job exports again only if it differs from the version marker of the bucket.
bucketstringName of the public Bucket that receives the exported bundle. The load balancer and Cloud CDN serve it through a StaticAssetRoute.
archiveFormatstringArchive format of the bundle: tar.gz or zip. It comes from publish.archive_format of the BuildDefinition. Empty means tar.gz.

ComputedVirtualMachineBucketConfig​

Computed bucket mount for a VM.

Links the VM configuration to the bucket that Cloud Storage FUSE mounts.

PropertyTypeDescription
sourcestringResolved bucket to mount. It comes from the volume name in the VirtualMachineConfiguration manifest.
mountOptionsstringFUSE mount option string. The engine computes it from the VM operating system.

ComputedVirtualMachineDiskConfig​

Computed specification of a VM attached disk.

Combines size, snapshot, and filesystem details.

PropertyTypeDescription
namestringResolved disk name, from the volume name in the VirtualMachineConfiguration manifest.
fileSystemstringDisk filesystem, from the volume fileSystem in the VirtualMachineConfiguration manifest.
mountOptionsstringDisk mount option string. The engine computes it from the filesystem and VM operating system.
sourceSnapshotstringSource snapshot, from the volume mount sourceSnapshot in the VirtualMachine manifest.
encryptedboolDisk encryption flag, from the volume encrypted in the VirtualMachineConfiguration manifest.
diskSizeGbint64Disk size, in GB, from the volume mount diskSizeGb in the VirtualMachine manifest.
diskTypestringCompute Engine disk type, from the volume mount diskType in the VirtualMachine manifest.

ContainerResource​

Single resource boundary for a container.

It sets the requests or the limits for CPU and memory.

PropertyTypeDescription
cpustringCPU quantity in Kubernetes/Cloud Run notation, for example "500m" or "2".
memorystringMemory quantity in the same notation, for example "256Mi" or "1Gi".

ContainerResources​

Compute requirements and limits of a container.

They map to the resource requests and limits of Kubernetes pods or Cloud Run services.

PropertyTypeDescription
requestsContainerResourceMinimum CPU and memory guaranteed to the container.
limitsContainerResourceMaximum CPU and memory that the container can use.

ContainerSpec​

Core configuration block for a runtime container.

It overrides the entrypoint, variables and compute constraints of the base image.

PropertyTypeDescription
enabledboolNOT YET IMPLEMENTED. The engine ignores this field. Intended use: turn the container off but keep its definition.
commandlist of stringContainer entrypoint. Overrides the image entrypoint (the container command).
argslist of stringArguments for the entrypoint (the container args).
envlist of EnvVariableDefinitionStatic environment variables. The engine merges them with variables from secrets and access control.
uidstringNOT YET IMPLEMENTED. The engine ignores this field. Intended use: the user ID of the container process.
gidstringNOT YET IMPLEMENTED. The engine ignores this field. Intended use: the group ID of the container process.
resourcesContainerResourcesCPU and memory requests and limits. See ContainerResources.

ContainerVolumeMount​

Generated files for a container volume.

The files typically become config maps or secrets on Kubernetes, or files on Cloud Run.

PropertyTypeDescription
fileslist of FilesEntryMap of relative file path to file content. Each entry becomes a file in the volume.

FilesEntry​

PropertyTypeDescription
keystring
valueVolumeMountFile

ControlPlaneDefinition​

Definition of the control plane of the platform.

It defines the foundational GCP resources (VPCs, identity, routing) and regions of the management plane.

PropertyTypeDescription
descriptionstringFree-text description, copied to the description of the GCP asset.
permissionsAccessPermissionsUsers and groups with administrator, contributor or viewer access to the GCP project of the control plane.
networkControlPlaneNetworkNOT YET IMPLEMENTED. The engine ignores this field. See ControlPlaneNetwork.
hibernationHibernationConfigSchedule to hibernate (scale to zero) the control plane resources to save cost.
regionstringPrimary GCP region of most control plane resources, such as VPCs, Cloud Run services and databases.
passiveRegionslist of stringNOT YET IMPLEMENTED. The engine ignores this field. Intended use: more regions for passive or failover deployment, for multi-region high availability.
maintenanceMaintenanceMaintenance windows and exclusions. See Maintenance.
defaultUrlRedirectstringURL to redirect to when an ingress request matches no other routing rule.
allowedEgresslist of stringExternal hostnames or IP addresses that control plane applications can connect to. The engine denies egress to all other destinations.
identityProviderConfigProjectIdpConfigIdentity provider settings for all tenants in the project. See ProjectIdpConfig.

ControlPlaneNetwork​

VPC flow log settings for the control plane.

NOT YET IMPLEMENTED. The engine ignores this message.

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

CorsPolicy​

CORS policy.

Sets how the load balancer answers CORS preflight OPTIONS requests.

PropertyTypeDescription
allowOriginslist of stringOrigins that can make cross-origin requests. The match is exact.
allowOriginRegexeslist of stringRegular expressions. The load balancer allows an origin that matches one of them.
allowMethodslist of stringAllowed HTTP methods. The preflight response returns them in Access-Control-Allow-Methods.
allowHeaderslist of stringAllowed request headers. The preflight response returns them in Access-Control-Allow-Headers.
exposeHeaderslist of stringResponse headers that the browser can expose to client script.
maxAgestringTime in seconds, as a string, for which clients can cache a preflight result.
allowCredentialsboolIf true, the response allows credentials (cookies and authorization headers).
disabledboolIf true, the CORS policy is present but not active.

DeploymentGpuConfig​

GPU accelerator for the application container of a deployment.

Cloud Run attaches at most one GPU to one container, so the block has no count or container selector. Validation rejects the block on targets other than CLOUD_RUN, even when accelerator is empty.

PropertyTypeDescription
acceleratorstringAccelerator model, nvidia-l4 or nvidia-rtx-pro-6000. Required when this block is present. nvidia-l4 has 24 GB VRAM and needs at least 4 CPU and 16Gi memory. nvidia-rtx-pro-6000 (RTX PRO 6000 Blackwell) has 96 GB VRAM and needs at least 20 CPU and 80Gi memory. The container resources.limits.cpu and resources.limits.memory must meet the minimum. Validation rejects a smaller container and does not raise the values. nvidia-l4 must also fit the Cloud Run matrix: 4, 6 or 8 CPU with at most 16Gi, 24Gi or 32Gi of memory. For nvidia-rtx-pro-6000, validation enforces only the minimum and a whole number of vCPU.
zonalRedundancyDisabledboolOpt out of GPU zonal redundancy. Zonal redundancy reserves GPU capacity in a second zone for zonal outages. It is the Cloud Run default and costs more. If true, you pay less but get a weaker SLA and no protection from a zonal outage.

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.

DirectResponse​

Immediate synthetic response.

The proxy answers with a fixed HTTP status and body and does not forward the request.

PropertyTypeDescription
statusint64Positive HTTP status code to return to the client. Required.
stringBodystringOptional response body as a UTF-8 string. Maximum 1024 characters.
bytesBodystringNOT YET IMPLEMENTED. The engine ignores this field. It will hold a base64-encoded binary body (maximum 4096 bytes).

DiskSnapshotConfiguration​

Source snapshot for an environment.

The snapshot link for a new compute disk of a VM.

PropertyTypeDescription
sourcestringFor a BUCKET volume, the bucket name to mount. For a DISK volume, an optional Compute snapshot self-link.
mountOptionslist of stringExtra mount options, for example FUSE or fstab flags.
diskConfigDiskSnapshotDiskConfigSize, type, and per-environment snapshot sources for a DISK volume.

DiskSnapshotDiskConfig​

Properties of a disk created from a snapshot.

Sets the size and type of the disk.

PropertyTypeDescription
sizeGbint64Disk size, in GB. Only for DISK volumes.
typestringCompute Engine disk type, for example pd-ssd. Only for DISK volumes.
snapshotslist of SnapshotsEntryMap from environment name to the source snapshot self-link in that environment.

SnapshotsEntry​

PropertyTypeDescription
keystring
valuestring

EnvVariableDefinition​

Static environment variable.

The engine adds it to the environment of the container.

PropertyTypeDescription
namestringVariable name.
valuestringLiteral value.

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.

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.

EventArcNotificationTarget​

Eventarc notification target.

Sends events from Eventarc to a deployed Cloud Run service.

PropertyTypeDescription
deploymentConfigstringName of the DeploymentConfig manifest of the target service.
pathstringRelative URL path on the target service for the event payload.

ExternalApplicationDefinition​

External application specification.

Spec body of the ExternalApplication manifest. The image comes from a trusted external repository, not from a build.

PropertyTypeDescription
descriptionstringFree text that describes the application. See ApplicationDefinition.description.
targetstringRuntime the application deploys to: KUBERNETES, CLOUD_RUN or COMPUTE.
meshStrategystringMesh strategy: SIDECAR, PROXYLESS or DISABLED. See ApplicationDefinition.mesh_strategy.
trustedRepositorystringName of the TrustedRepository manifest (a child of an ExternalRegistry) that hosts the image. Required. It must exist. The engine builds the image reference from the publish URL of the parent registry.
imagestringName of the image in the trusted repository. Required.
projectstringName of the Project manifest that receives the resources of the application. Required. See ApplicationDefinition.project.
accessControlApplicationAccessControlConfigAccess that the service account of the application gets to platform resources. See ApplicationDefinition.access_control.
bundleOnlyboolIf true, the engine does not promote the application through pre-release tracks. See ApplicationDefinition.bundle_only.
jobslist of ApplicationJobReferenceJobs of the application. See ApplicationDefinition.jobs.
clusterstringmetadata.name of the Kubernetes manifest to deploy to. Required when target is KUBERNETES. Ignored for CLOUD_RUN and COMPUTE. See ApplicationDefinition.cluster.

FaultInjectionAbort​

Simulated failure for a route.

Sets the abort block of the mesh route faultInjectionPolicy.

PropertyTypeDescription
httpStatusint64HTTP status code that aborted requests return.
percentageint64Percentage of matched requests that abort, from 0 to 100.

FaultInjectionDelay​

Simulated latency for a route.

Sets the delay block of the mesh route faultInjectionPolicy.

PropertyTypeDescription
fixedDelaystringFixed delay that the mesh adds before it forwards matched requests, as a duration string, for example 5s.
percentageint64Percentage of matched requests that get the delay, from 0 to 100.

FaultInjectionPolicy​

Fault injection to test resilience.

Uses the network disruption features of GCP Traffic Director or the Kubernetes Gateway API.

PropertyTypeDescription
delayFaultInjectionDelayOptional. Adds artificial delay to a percentage of matched requests.
abortFaultInjectionAbortOptional. Aborts a percentage of matched requests with a fixed HTTP status.

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.

GrpcRouteRule​

gRPC routing rule.

Pairs match conditions with an action.

PropertyTypeDescription
matcheslist of GrpcRouteRuleMatchConditions that select requests for this rule. A request matches if any condition holds.
authenticationlist of RouteRuleAuthenticationConfigAuthentication configuration. If not set, the rule needs no authentication.
authorizationlist of ComputedAuthorizationAccessRuleCheckAuthorization configuration. If not set, the rule is open to all users.

GrpcRouteRuleAction​

Action for a matched gRPC request.

Sends requests to backends and sets request policies.

PropertyTypeDescription
destinationslist of HttpRouteRuleActionDestinationBackends that receive the traffic, with optional weights to split it.
faultInjectionPolicyFaultInjectionPolicyOptional delay or abort faults for resilience tests.
timeoutstringMaximum total time of a request, as a Go-style duration string.
retryPolicyRetryPolicyRetry policy for failed requests. gRPC routes ignore per_try_timeout.
idleTimeoutstringMaximum idle time of the stream of a request, as a Go-style duration string.

GrpcRouteRuleMatch​

Match criteria for a gRPC request.

Selects requests by metadata or by service and method.

PropertyTypeDescription
headerslist of GrpcRouteRuleMatchHeaderConditions on gRPC metadata. All must match.
methodMethodMatchRestricts the rule to a gRPC service and method.

GrpcRouteRuleMatchHeader​

Condition on gRPC metadata.

Selects requests by custom metadata, the gRPC equivalent of HTTP headers.

PropertyTypeDescription
keystringName of the metadata entry to test.
valuestringExpected value of the entry. type sets whether it is an exact value or a regular expression.
typestringHow to compare value: EXACT for a literal match or REGULAR_EXPRESSION for a regex match. TYPE_UNSPECIFIED means EXACT.

HeaderModifier​

HTTP header changes.

The load balancer adds, replaces or removes these request or response headers.

PropertyTypeDescription
setlist of SetEntryMap of header name to value. Each value replaces the current value.
addlist of AddEntryMap of header name to value. The load balancer adds each header and keeps current headers of the same name.
removelist of stringNames of headers to remove from the request or the response.

AddEntry​

PropertyTypeDescription
keystring
valuestring

SetEntry​

PropertyTypeDescription
keystring
valuestring

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.

ExclusionsEntry​

PropertyTypeDescription
keystring
valueHibernationExclusion

WindowsEntry​

PropertyTypeDescription
keystring
valueHibernationWindow

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.

HostHealthConfig​

Health check for host endpoints.

Sets the probes and backend health checks for GCP load balancers.

PropertyTypeDescription
protocolstringHealth check protocol: http, http2, https, grpc, or tcp. It applies to container probes (Cloud Run, GKE) and the VM backend health check.
portint64TCP port that the health check targets.
checkIntervalSecint64Interval between checks, in seconds. The default is 30 for generated probes. Default 30
timeoutSecint64Seconds to wait for a probe response before it fails. The engine sets 10 for generated probes. Default 5
healthyThresholdint64Consecutive successful probes that mark the endpoint healthy. The default is 1. Default 1
unhealthyThresholdint64Consecutive failed probes that mark the endpoint unhealthy. The default is 2. Default 2
enableLogsboolNOT YET IMPLEMENTED. The engine ignores this field. Intended to enable health-check logs.
pathstringHTTP request path for HTTP-family probes. The default is /. Default "/"

HostRoutePortConfig​

Port-specific routing settings.

NOT YET IMPLEMENTED. The engine ignores this message. Intended to bind a protocol and namespace to named per-route settings.

PropertyTypeDescription
protocolstringProtocol on the port: http, http2, https, grpc, or tcp.
namespacestringNamespace that the routes bind into.
routeslist of RoutesEntryNOT YET IMPLEMENTED. The engine ignores this field. Map from route name to its settings.

RoutesEntry​

PropertyTypeDescription
keystring
valueRouteConfig

HttpRouteRedirect​

Immediate HTTP redirect.

The edge load balancer sends an HTTP 3xx redirect and does not forward the request. The in-mesh HTTP route skips redirect-only rules.

PropertyTypeDescription
hostRedirectstringHost to redirect to. The engine sets it on the login redirect that it injects.
pathRedirectstringAbsolute path to redirect to. It replaces the original path.
prefixRewritestringPrefix of the original path to replace in the redirect.
responseCodestringHTTP redirect response code, for example MOVED_PERMANENTLY_DEFAULT, SEE_OTHER or TEMPORARY_REDIRECT. The engine sets it on the login redirect that it injects.
httpsRedirectboolIf true, the redirect URL uses the https scheme.
stripQueryboolIf true, the redirect URL has no query string.
portRedirectstringPort in the redirect URL.

HttpRouteRule​

HTTP routing rule.

Pairs match conditions with an action.

PropertyTypeDescription
matcheslist of HttpRouteRuleMatchConditions that select requests for this rule. A request matches if any condition holds.
authenticationlist of RouteRuleAuthenticationConfigAuthentication configuration. If not set, the rule needs no authentication.
authorizationlist of ComputedAuthorizationAccessRuleCheckAuthorization configuration. If not set, the rule is open to all users.

HttpRouteRuleAction​

Action for a matched HTTP route rule.

Sends requests to backends or redirects them, and sets request policies.

PropertyTypeDescription
destinationslist of HttpRouteRuleActionDestinationBackends that receive the traffic, with optional weights to split it.
redirectHttpRouteRedirectIf set and destinations is empty, the rule answers with an HTTP redirect. The external load balancer applies it, not the in-mesh route.
faultInjectionPolicyFaultInjectionPolicyOptional delay or abort faults for resilience tests.
requestHeaderModifierHeaderModifierHeader changes for the request before it reaches the backend.
responseHeaderModifierHeaderModifierHeader changes for the response before it reaches the client.
urlRewriteUrlRewritePath prefix and host rewrites for the request.
timeoutstringMaximum total time of a request, as a Go-style duration string.
retryPolicyRetryPolicyRetry policy for failed requests.
requestMirrorPolicyRequestMirrorPolicyNOT YET IMPLEMENTED. The engine ignores this field. It will mirror traffic to a shadow backend.
corsPolicyCorsPolicyCORS rules for the traffic.
directResponseDirectResponseIf set, the proxy answers with a static status and body and does not forward the request.
idleTimeoutstringMaximum idle time of the stream of a request, as a Go-style duration string.

HttpRouteRuleActionDestination​

Upstream destination.

Names the backend that receives the traffic and its share of the traffic.

PropertyTypeDescription
deploymentConfigstringName of a DeploymentConfig manifest whose backend receives the traffic. Mutually exclusive with virtual_machine and agent.
virtualMachinestringName of a VirtualMachine manifest whose backend receives the traffic. Mutually exclusive with deployment_config and agent.
portint64Port on the backend.
weightint64Relative weight (0-100) of this destination when a rule splits traffic.
agentstringName of an Agent manifest. The route sends the traffic to the agentic proxy for the Reasoning Engine of that agent and rewrites the path to /agents/{agent}/. HTTP routes only.

HttpRouteRuleMatch​

Match criteria for an HTTP request.

Selects requests by path, header or query parameter.

PropertyTypeDescription
ignoreCaseboolIf true, path comparisons ignore case.
fullPathMatchstringMatches if the request path equals this value. Mutually exclusive with prefix_match and regex_match.
prefixMatchstringMatches if the request path starts with this prefix.
regexMatchstringMatches if the request path fully matches this regular expression.
headerslist of HttpRouteRuleMatchHeaderConditions on request headers. All must match.
queryParameterslist of QueryParameterMatchConditions on URL query parameters. All must match.

HttpRouteRuleMatchHeader​

Condition on an HTTP header.

A route match uses it to select requests by header.

PropertyTypeDescription
headerstringName of the request header to test.
invertMatchboolIf true, the rule applies when the header condition does NOT hold.
exactMatchstringMatches if the header value equals this string.
regexMatchstringMatches if the header value fully matches this regular expression.
prefixMatchstringMatches if the header value starts with this prefix.
presentMatchboolIf true, matches if the header is present, whatever its value.
suffixMatchstringMatches if the header value ends with this suffix.
rangeMatchRangeMatchMatches if the header value is an integer in this range.

IdentityProviderConfig​

Container configuration of an identity provider for a tenant.

It points to a source image and configuration layout for an Identity Provider solution, for example Keycloak.

PropertyTypeDescription
sourcestringName of the BuildDefinition manifest that supplies the container image. Required. The build must exist.
containerstringName of the container in the source BuildDefinition. Required. It must match one of the containers of that build.
versionstringTag of the container image to deploy. Required.
specContainerSpecOptional container overrides (command, args, env, resources). See ContainerSpec.

Jwks​

JSON Web Key configuration to verify tokens.

NOT YET IMPLEMENTED. The engine ignores this message.

PropertyTypeDescription
kidstringKey ID (kid).
typestringKey type, for example RSA or EC.
algstringAlgorithm of the key, for example RS256.
pemstringPEM-encoded public key.

Maintenance​

Weekly maintenance window and exclusions for resource upgrades.

It controls when Google Cloud upgrades resources, such as GKE clusters and Cloud SQL instances.

PropertyTypeDescription
startstringRFC3339 timestamp. Its time of day and day of week set the start of the weekly window. RFC3339
endstringRFC3339 timestamp for the end of the weekly window. RFC3339
exclusionslist of MaintenanceExclusionOne-time windows in which maintenance must not run, even inside the weekly window. Use them for business-critical periods.

MaintenanceExclusion​

One-time window in which platform maintenance must not run.

It overrides the weekly maintenance window.

PropertyTypeDescription
namestringUnique label for the reason, for example black-friday-freeze.
startstringWindow start, in RFC3339 format. RFC3339
endstringWindow end, in RFC3339 format. RFC3339

MethodMatch​

Match by gRPC service or method.

The main routing condition of a gRPC route, in place of a URL path match.

PropertyTypeDescription
grpcServicestringFully qualified gRPC service name, for example package.Service.
grpcMethodstringMethod of the service.
caseSensitiveboolIf true, service and method names are case-sensitive.

MetricConfig​

Custom metric collection for the Ops Agent.

Adds custom receivers to the Ops Agent configuration on the VM.

PropertyTypeDescription
typestringReceiver type. The only value is prometheus.
prometheusPrometheusConfigPrometheus scrape settings, used when type is prometheus.

MfaConfig​

Multi-factor authentication (MFA) requirements for users.

NOT YET IMPLEMENTED as a project-wide setting. Configure MFA for each tenant on the IdentityProvider manifest.

PropertyTypeDescription
modestringMFA enforcement mode: DISABLED, ENABLED (optional) or MANDATORY (required for all users).
testPhoneNumberslist of TestPhoneNumbersEntryMap of a phone number to its expected 6-digit OTP code. It tests MFA flows without real SMS.
allowedRegionslist of stringTwo-letter Unicode CLDR region codes of the regions where users can use MFA. See https://cldr.unicode.org/.

TestPhoneNumbersEntry​

PropertyTypeDescription
keystring
valuestring

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).

OauthClientConfig​

Configuration of an OAuth 2.0 client.

NOT YET IMPLEMENTED. The engine ignores this message.

PropertyTypeDescription
grantTypeslist of stringAllowed grant types, for example authorization_code or client_credentials.
responseTypeslist of stringAllowed response types, for example code or token.
scopeslist of stringAllowed OAuth scopes.
redirectUrislist of stringPermitted redirect URIs.
postLogoutRedirectUrislist of stringPermitted post-logout redirect URIs.
audiencelist of stringAudience values for issued tokens.
jwksJwksNOT YET IMPLEMENTED. The engine ignores this field. See Jwks.

OidcProviderConfig​

External OIDC provider for identity federation.

NOT YET IMPLEMENTED. The engine ignores this message.

PropertyTypeDescription
sourcestringUpstream OIDC provider: github or google.
clientIdstringClient ID registered with the upstream provider.
mapperstringExpression that maps upstream OIDC claims to local identity attributes.
scopeslist of stringOAuth scopes to request from the upstream provider.

OrganizationalUnitDefinition​

Definition of an Organizational Unit (OU) that groups environments and governs policies.

It maps to a GCP folder. IAM, network and hibernation defaults propagate down from it.

PropertyTypeDescription
displayNamestringDisplay name of the GCP folder. Defaults to metadata.name. Must have 3 to 30 characters: letters, digits, spaces, underscores and dashes.
descriptionstringFree-text description.
hibernationHibernationConfigDefault hibernation schedule for the OU. Child Environment or Project manifests can override it.
permissionsAccessPermissionsDefault permissions for the OU. Child Environment and Project manifests inherit them.
networkOrganizationalUnitNetworkNOT YET IMPLEMENTED. The engine ignores this field. See OrganizationalUnitNetwork.

OrganizationalUnitNetwork​

VPC flow log settings for an Organizational Unit (OU).

NOT YET IMPLEMENTED. The engine ignores this message.

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

ProjectDefinition​

Definition of a Project that holds workloads.

It maps to a GCP project and sets the region, IAM bindings, maintenance windows and default routing rules.

PropertyTypeDescription
displayNamestringDisplay name of the GCP project. Same rules as OrganizationalUnitDefinition.display_name.
descriptionstringFree-text description.
permissionsAccessPermissionsPermissions for the Project. The engine binds the IAM of the Project and of its folder from this block only. It does not merge this block with the permissions of the parent Environment or OrganizationalUnit. In a self-hosted installation, Google inherits the IAM that the engine binds on those parent folders.
networkProjectNetworkNOT YET IMPLEMENTED. The engine ignores this field. See ProjectNetwork.
hibernationHibernationConfigHibernation schedule for the Project. It overrides schedules from parent manifests.
regionstringPrimary GCP region for the Project and its resources. Defaults to the region of the parent Environment.
maintenanceMaintenanceMaintenance windows and exclusions. Required. See Maintenance.
defaultUrlRedirectstringURL to redirect to when a request matches no other routing rule in the Project. Required.
allowedEgresslist of stringExternal hostnames or IP ranges that applications in the Project can connect to. The engine enforces this policy on outbound traffic.
identityProviderConfigProjectIdpConfigIdentity provider settings for all tenants in the Project. See ProjectIdpConfig.
rsiRsiConfigPolicy for recursive self-improvement (RSI) in the Project. See RsiConfig. RSI is opt-in and it is off by default. It is on only if the block has enabled: true, and only in a non-production environment. The engine does not act on this field. The planned readers are Beck and the MCP server.
mcpGcpAccessMcpGcpAccessOpt-in for read-only GCP access through the Infrastream MCP. See McpGcpAccess. NOT a write path: the engine makes read-only reader service accounts. They hold the managed roles in managed hosting. In a self-hosted installation they hold two generated roles that the installer supplies. If the block is absent, or enabled is false, the feature is off.

ProjectIdpConfig​

Project-wide Identity Provider (IdP) configuration.

It applies identity and MFA settings to all Identity Platform tenants in the project.

PropertyTypeDescription
mfaMfaConfigNOT YET IMPLEMENTED. The engine ignores this field. See MfaConfig.
gdprComplianceboolEnables GDPR compliance for all tenants in the project. If true, users can delete their own accounts. The login app shows a terms of service checkbox and a "Delete my account" button. All child IdentityProvider manifests must then set terms_of_service and privacy_policy URLs. The engine enforces this at compute time.

ProjectNetwork​

VPC flow log settings for a Project.

NOT YET IMPLEMENTED. The engine ignores this message.

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

PrometheusConfig​

Prometheus receiver for the Ops Agent.

The Ops Agent scrapes the endpoint and port on the VM localhost.

PropertyTypeDescription
schemestringURL scheme for the scrape: http or https.
endpointstringMetrics path on the VM localhost, for example /metrics.
portint64Localhost port to scrape.

QueryParameterMatch​

Condition on an HTTP query parameter.

A route match uses it to select requests by URL query parameter.

PropertyTypeDescription
queryParameterstringName of the URL query parameter to test.
exactMatchstringMatches if the parameter value equals this string.
regexMatchstringMatches if the parameter value fully matches this regular expression.
presentMatchstringIf set, matches if the parameter is present, whatever its value.

RangeMatch​

Integer range for a header test.

A header condition matches a header value against this range.

PropertyTypeDescription
startint64Lower bound (inclusive): the smallest integer that matches.
endint64Upper bound (exclusive): one more than the largest integer that matches.

RequestMirrorDestination​

Destination for mirrored (shadow) traffic.

NOT YET IMPLEMENTED. The engine ignores this message. It will copy requests to this backend for shadow tests.

PropertyTypeDescription
deploymentConfigstringName of the DeploymentConfig manifest whose backend receives the mirrored request.
portint64Port on the mirror backend.
weightint64Relative weight (0-100) of this mirror destination.
requestHeaderModifierHeaderModifierHeader changes for the mirrored request.
responseHeaderModifierHeaderModifierHeader changes for the mirror response. The proxy discards this response.

RequestMirrorPolicy​

Request mirror policy.

NOT YET IMPLEMENTED. The engine ignores this message. It will copy part of the traffic to a secondary backend.

PropertyTypeDescription
destinationRequestMirrorDestinationBackend that receives the copied requests.
mirrorPercentint64Percentage (0-100) of requests to copy.

RetryPolicy​

Retry policy.

Sets when and how often the load balancer retries a failed request.

PropertyTypeDescription
retryConditionslist of stringFailure conditions that trigger a retry, for example 5xx, connect-failure or refused-stream.
numRetriesint64Maximum number of retries of a failed request.
perTryTimeoutstringTimeout of each retry attempt, as a Go-style duration string. HTTP routes only: gRPC routes ignore it.

RouteAuthentication​

Edge authentication requirements for a route.

NOT YET IMPLEMENTED. The engine ignores this message. Intended to gate a route with Identity-Aware Proxy, internal Organization IAM, or an identity provider.

PropertyTypeDescription
enabledboolIf true, the route requires authentication.
typestringAuthentication type: IdentityAwareProxy, OrgInternal, or IdentityProvider.
providerNamestringIdentity provider to enforce when type is IdentityProvider.

RouteConfig​

Per-route settings.

NOT YET IMPLEMENTED. The engine ignores this message. Intended for per-route settings such as authentication.

PropertyTypeDescription
authenticationRouteAuthenticationNOT YET IMPLEMENTED. The engine ignores this field. Authentication settings of the route.

RouteRuleAuthenticationConfig​

Authentication exceptions for a route rule.

Sets how authentication works for the paths that the rule matches.

PropertyTypeDescription
typestringIDENTITY_PROVIDER limits access to the identity providers in tenants. INTERNAL limits access to internal callers. Validation checks it against the declared identity providers.
tenantslist of stringIdentityProvider names that can access this route. Only for type IDENTITY_PROVIDER. Each entry must reference a provider that exists.

RsiConfig​

Policy for recursive self-improvement (RSI) in a Project.

RSI lets an agent open pull requests without a human confirmation. RSI is opt-in and it is off by default. The policy is on only if enabled is true. The engine does not act on this policy. It loads and validates the policy only. The planned readers are Beck and the MCP server.

RSI is off in these cases: no spec.rsi, rsi:, rsi: null, rsi: {}, enabled: false, and entries with no enabled. An entry never turns RSI on. A block with entries and no enabled is valid. The engine writes a warning that names the Project, because the author may think that RSI is on. A reader must apply the same rules.

The engine clears a block that is off and has no entry when it runs the defaulters. A YAML loader reads rsi: and rsi: {} as a block with a value.

RSI can be on only in a non-production environment. The environment is the value of metadata.environment. The engine rejects enabled: true unless that value is one of these names: development, dev, integration, int, qa, test, sandbox, preview and ephemeral. The engine compares the name exactly, with the case as written. It rejects every other name, so it rejects production and staging. Staging is not a non-production environment, and an unknown name is not safe.

The path of the manifest file must agree with metadata.environment. The path must have one directory named environment, and the name of the environment must follow it, for example environment/dev/project/web.yaml. The engine rejects enabled: true if the path has no such pair, or more than one, or if the name differs from metadata.environment. A reader must apply these two rules too, because the engine checks only the manifests that it scans.

A change to this block must need a human confirmation. This is a requirement on the clients that write manifests, and the engine does not enforce it.

A bad value in this block fails the scan in the same way as a bad value in any other manifest. The engine makes no exception for this block. If any value breaks a rule, a reader must treat the whole rsi block as invalid, and RSI is off for the Project. A reader must never drop the bad entry and use the rest, because a shorter list of protected paths is unsafe. A reader must read each entry as text. An entry that is not a string, such as ~, null, true or 1, breaks the rules.

The engine accepts only the YAML values true and false for enabled. A reader must treat any other value, such as yes, on, 1 or the text "true", as a break of the rules. If enabled appears more than once, the engine takes the last value. A reader must treat RSI as off unless every occurrence is true.

The engine joins repeated keys in a YAML manifest. If spec.rsi appears twice, or a list key appears twice, the engine takes the union of all the lists. A reader must take the union of every occurrence too, and never only the last one. A JSON manifest is different: the engine rejects a repeated key.

The policy is for one Project. The engine does not inherit it from the Environment or the OrganizationalUnit, and no child manifest receives it. The engine accepts the block in every environment, but it rejects enabled: true outside a non-production environment.

PropertyTypeDescription
enabledboolSwitch that turns RSI on for the Project. RSI is on only if the value is the boolean true. If the key is absent, or the value is false, RSI is off. The entries of this block never turn RSI on. RSI can be on only in a non-production environment. The engine rejects enabled: true in production, in staging and in any environment that it does not know. See RsiConfig for the allowed names and the rule for the path.
repositorieslist of stringGitHub repositories where an agent can open a pull request without a human confirmation. Each entry has the form owner/repo, for example acme/billing-api. If empty, no code repository is in scope of RSI. A reader must compare entries without regard to case, because GitHub treats Acme/API and acme/api as one repository. If the key repositories appears more than once, the engine joins the lists, and a reader must take the union of all of them.
protectedPathslist of stringPatterns of repository paths that always need a human confirmation, for example go.mod or scripts/ci/**. They add to the permanent list. A reader must always treat .github/** and every file named CODEOWNERS as protected. This field cannot remove them. A reader must read the keys protectedPaths and protected_paths, and take the union of every list. A pattern is a path from the repository root, with / as separator. It matches the whole path, case-sensitively, with the code points as stored and no Unicode normalisation. * matches any characters inside one segment, also a name that starts with a dot. ** matches any number of whole segments, also none, and /** at the end matches the paths below a directory. Every other character is literal.

McpGcpAccess​

Opt-in for read-only access to the GCP resources of a Project through the Infrastream MCP.

NOT a write path. The engine makes read-only reader service accounts. The MCP server uses them to read the resources of the Project for a person who has a tier in spec.permissions. No role of these service accounts can write.

If enabled is true, the engine makes the service account mcp-gcp-reader in the Project. The MCP server uses it for the tier viewers. The engine makes the service account mcp-gcp-editor-reader too, if the conditions below are true. The MCP server uses it for the tiers contributors and administrators.

A reader service account never has a permission that the own tier role of the person lacks. The roles depend on the hosting mode.

In managed hosting, mcp-gcp-reader holds the role managed_viewer. The engine makes mcp-gcp-editor-reader only if the installer supplies the role managed_editor_read. It holds that role.

In a self-hosted installation, the tier roles of the people are the basic roles roles/viewer, roles/editor and roles/owner. The managed roles have permissions that these roles lack. So mcp-gcp-reader holds the role managed_viewer_basic, and mcp-gcp-editor-reader holds the role managed_editor_read_basic. The installer makes both roles. Each one is never more than roles/viewer or roles/editor.

The engine makes both service accounts only if the installer supplies both roles. Both must be custom roles of the organization of the installation, and they must have these exact IDs.

The installer can supply the service account of the MCP server. If it does, the engine gives that one account, and no other account, the right to create tokens for the two reader service accounts. If the installer does not supply it, the engine gives no such right.

The engine makes none of these service accounts, and writes a warning, if a setting is missing or wrong. In managed hosting, the settings are the three tier roles managed_viewer, managed_editor and managed_admin, the role managed_editor_read and the service account of the MCP server. Without a tier role, the engine binds nobody for that tier, and a reader service account would give reads that the person does not have. In a self-hosted installation, the settings are the two basic roles and the service account of the MCP server. A basic role with another ID, or in another organization, is wrong.

A skipped Project is not an error. The engine builds the rest of the Project, and the rest of the organization, as for any other Project.

If the block is absent, or enabled is false, the engine makes none of these service accounts. It deletes the service accounts that an earlier run made.

The MCP server can serve a person only if it can find the tier of the person in the manifests. This works only if the workforce federation of the Organization is infrastreamManaged, because only then the manifests list the users. For Google Workspace and Microsoft Entra ID the tier is unknown. The MCP server then gives that person no access.

The policy is for one Project. The engine does not inherit it from the Environment or the OrganizationalUnit. In a self-hosted installation, a person can have more rights from the folders of the Environment and of the OrganizationalUnit. The MCP server does not count them. It uses the tier of the Project only, so it can give less than the person has, and never more.

PropertyTypeDescription
enabledboolSwitch that turns the reader service accounts on for the Project. They exist only if the value is the boolean true. If the key is absent, or the value is false, the engine makes none and deletes the ones that exist. The switch does not give a person any right. The tier of the person in spec.permissions decides what the MCP server reads for that person.

Scaling​

Boundaries of the autoscaler for compute workloads or replica sets.

It sets the minimum and maximum replica counts of the autoscaler.

PropertyTypeDescription
minint64Minimum number of active instances, for example Cloud Run min instances. Must be at least 1.
maxint64Maximum number of instances that the autoscaler can create.

SecretSourceConfig​

How to retrieve a secret and mount it into a workload.

The engine grants IAM access to the Secret Manager payload and resolves values JIT.

PropertyTypeDescription
envVarstringName of the environment variable that holds the secret. Mutually exclusive with file_path: set exactly one.
versionstringSecret Manager version: latest or a number such as 1. Defaults to latest.

SmtpConfig​

Configuration for outbound email delivery through SMTP.

NOT YET IMPLEMENTED. The engine ignores this message. Intended use: the sender identity for services that send email.

PropertyTypeDescription
fromAddressstringSender email address (the From address).
fromNamestringSender display name (the From name).

SourceProjectReference​

Fully qualified Project reference.

NOT YET IMPLEMENTED. The engine ignores this message. It will identify a Project by name, environment and organizational_unit, because project names are not unique alone.

PropertyTypeDescription
namestringmetadata.name of the Project manifest.
environmentstringmetadata.name of the parent Environment manifest of the project. Default: the current Environment.
organizationalUnitstringmetadata.name of the parent OrganizationalUnit manifest of the environment. Default: the current OrganizationalUnit.

Stage​

Phase of a deployment strategy.

Lists the environments that deploy together before the release continues.

PropertyTypeDescription
environmentslist of stringNames of the Environment manifests in this stage. The application must deploy to every one before promotion to the next stage.
approvalPolicyApprovalPolicyApproval policy that must pass before the release leaves this stage. The engine checks that the referenced stakeholders exist.

Stakeholder​

Approver identified by email address.

A stakeholder is a user or a group that exists in the organization.

PropertyTypeDescription
userEmailstringEmail address of an OrganizationUser.
groupEmailstringEmail address of an OrganizationUserGroup.

StartupConfig​

Startup script of a VM.

Sets metadata.startup-script of the instance and substitutes template variables on boot.

PropertyTypeDescription
scriptstringScript body. The engine substitutes the variables before the script runs on boot.
variableslist of VariablesEntryMap from variable name to its definition (default value and required flag).

VariablesEntry​

PropertyTypeDescription
keystring
valueVariableConfig

UrlRewrite​

URL rewrite.

Changes the request path or host before the load balancer forwards the request.

PropertyTypeDescription
pathPrefixRewritestringValue that replaces the matched path prefix of the request.
hostRewritestringValue that replaces the Host header of the request.

UserBasedAccessPermissions​

Access permissions for individual users.

Binds users directly to roles, where group-based authorization is not suitable.

PropertyTypeDescription
administratorslist of stringUsers and groups with administrative privileges, usually full control.
contributorslist of stringUsers and groups with contributor privileges, usually read and write access.
viewerslist of stringUsers and groups with viewer privileges, usually read-only access.

UserExternalAccount​

Link from a platform user to an external identity.

Adds the user to GitHub organizations and teams.

PropertyTypeDescription
sourceTypestringExternal identity system. The only value is GITHUB.
sourceNamestringName of the GithubConnection manifest that resolves the username.
usernamestringLogin name of the user in the external system.

VariableConfig​

Template variable of the startup script.

The engine injects resolved variables into the script.

PropertyTypeDescription
defaultValuestringValue used when the VM manifest gives none. The engine substitutes it into a text/template and does not escape it. Validation rejects shell metacharacters: ;, &, `
requiredboolIf true, the engine returns an error when the variable has no value.

VirtualMachineConfigurationDefinition​

Core configuration of a virtual machine blueprint.

A template for VirtualMachine manifests: OS image, agent, and baseline secrets.

PropertyTypeDescription
operatingSystemstringOperating system of the VM. It selects the boot disk image. One of the supported Debian, Ubuntu, or Windows Server values.
secretslist of SecretsEntryMap from Secret manifest name to how the VM gets the secret, as a file or environment variable.
agentAgentConfigOps Agent settings for the logs and metrics that the VM exports.
volumeslist of VolumesEntryMap from absolute mount path in the VM, for example /data, to the volume mounted there.
startupStartupConfigStartup script and template variables of the VM.

SecretsEntry​

PropertyTypeDescription
keystring
valueVirtualMachineSecretConfig

VolumesEntry​

PropertyTypeDescription
keystring
valueVirtualMachineVolumeConfig

VirtualMachineSecretConfig​

Secret delivery to a virtual machine.

The startup script writes each Secret Manager payload as a file or variable.

PropertyTypeDescription
typestringENV_VAR sets an environment variable. FILE writes a file with the startup script.
targetstringFor FILE, the absolute path of the file to create. For ENV_VAR, the name of the environment variable.

VirtualMachineVolumeConfig​

Storage volume for a virtual machine.

Creates a persistent disk or a bucket mount on the VM.

PropertyTypeDescription
namestringLogical name of the volume. VirtualMachine volume mounts refer to it.
typestringBUCKET (Cloud Storage FUSE mount), DISK (persistent disk), or SECRET (Secret Manager payload).
fileSystemstringOnly for DISK volumes. Filesystem of the disk. It must be compatible with the VM operating system.
encryptedboolOnly for DISK volumes. If true, the engine encrypts the disk.

VirtualMachineVolumeMount​

Mount of a volume in a VM application.

Sets the mount instructions (fstab entries or FUSE attachments) on the VM.

PropertyTypeDescription
sourcestringVolume source. Same as DiskSnapshotConfiguration.source.
mountOptionslist of stringExtra mount options. The engine joins them into the mount command.
diskConfigVirtualMachineVolumeMountDiskConfigSize, type, and snapshot settings for a DISK mount.

VirtualMachineVolumeMountDiskConfig​

Specification of an attached disk volume.

Sets the size and type of the disk behind the mount.

PropertyTypeDescription
sizeGbint64Disk size, in GB. Only for DISK volumes. The minimum is 200 GB.
typestringCompute Engine disk type, for example pd-ssd. Only for DISK volumes.
snapshotslist of DiskSnapshotConfigurationOptional snapshot configurations that seed the disk in specific environments.

VolumeMountBucketRef​

Bucket mounted as a volume.

Describes the Cloud Storage FUSE mount of a bucket.

PropertyTypeDescription
namestringName of the Bucket manifest to mount with Cloud Storage FUSE.
pathstringPath where the container mounts the bucket.
canWriteboolIf true, the mount is read-write and the service account of the container gets object-write permission on the bucket. If false, the mount is read-only.

VolumeMountFile​

Generated file in a volume mount.

Startup scripts write the file to disk.

PropertyTypeDescription
mimeTypestringMIME type of the file. If empty, the engine sets a default.
contentstringFile content: plain text, or base64 if base64_encoded is true.
base64EncodedboolIf true, the engine decodes content from base64 before it writes the file.