Common
AccessPermissions
Administrator, contributor, and viewer privileges for an asset.
The engine aggregates the users and groups into IAM policies.
| Property | Type | Description |
|---|---|---|
| administrators | DetailedAccessPermissions | Users and groups with administrative privileges, usually full control. |
| contributors | DetailedAccessPermissions | Users and groups with contributor privileges, usually read and write access. |
| viewers | DetailedAccessPermissions | Users 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.
| Property | Type | Description |
|---|---|---|
| additionalRoles | list of string | Extra IAM roles for the agent service account, beyond the base roles (monitoring, logging, tracing, and aiplatform.user). |
| pubsub | ApplicationAccessControlPubsubConfig | Publish and subscribe grants for specific Pub/Sub topics. |
| buckets | list of ApplicationAccessControlBucketConfig | Cloud Storage buckets that the agent can read or write. |
| database | ApplicationAccessControlDatabaseConfig | PostgreSQL database access: instance and schema. |
| secrets | list of SecretsEntry | Map from Secret manifest name to how the agent gets the secret, typically as an environment variable. |
SecretsEntry
| Property | Type | Description |
|---|---|---|
| key | string | |
| value | SecretSourceConfig |
AgentConfig
Ops Agent settings for a VM.
Selects the logs and metrics that go to Cloud Monitoring.
| Property | Type | Description |
|---|---|---|
| logFiles | list of string | Glob patterns of log files that the Ops Agent ships to Cloud Logging. |
| metrics | list of MetricConfig | Custom 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.
| Property | Type | Description |
|---|---|---|
| name | string | Name of the Bucket manifest. It must exist in every environment of the parent ReleaseTrack. Required. |
| source | string | Name of a GithubRepository manifest whose contents seed the bucket through a gcloud storage rsync job in CI/CD. Optional. |
| permission | string | READ_ONLY grants roles/storage.objectViewer. WRITE grants roles/storage.objectUser. |
| mountPath | string | Absolute path in the container where Cloud Storage FUSE mounts the bucket. If omitted, the engine grants access but does not mount the bucket. |
| subPath | string | Bucket prefix that limits access, for example to mount one folder. If omitted, access covers the whole bucket. |
| promote | bool | If true, the engine promotes the bucket content through the ReleaseTrack with the application. |
| envVar | string | Environment 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.
| Property | Type | Description |
|---|---|---|
| additionalRoles | list of string | Extra IAM roles for the application service account, beyond the roles from the other blocks. |
| pubsub | ApplicationAccessControlPubsubConfig | Publish and subscribe grants for specific Pub/Sub topics. |
| buckets | list of ApplicationAccessControlBucketConfig | Cloud Storage buckets that the application can read or write. |
| database | ApplicationAccessControlDatabaseConfig | PostgreSQL database access: instance, schema, privileges, and credential source. |
| secrets | list of SecretsEntry | Map from Secret manifest name to how the application gets the secret. |
| redis | list of ApplicationAccessControlRedisConfig | Redis instances that the application can use. |
| jobs | list of ApplicationAccessControlJobConfig | Cloud Run Jobs of other applications that this application can trigger with the RunJob API. |
SecretsEntry
| Property | Type | Description |
|---|---|---|
| key | string | |
| value | SecretSourceConfig |
ApplicationAccessControlDatabaseConfig
PostgreSQL access for a workload.
Runs CREATE USER and GRANT on the target SQL instance.
| Property | Type | Description |
|---|---|---|
| name | string | Name of the Database manifest (an AlloyDB/PostgreSQL instance) that the application needs. |
| schema | string | Database (schema) in the instance that the application connects to. |
| privileges | list of string | SQL privileges for the application database role on the schema: USAGE, CREATE, or ALL. Each one becomes a GRANT statement. |
| readOnly | bool | If true, the application has read-only access, typically to a read replica. |
| extensions | list of string | PostgreSQL extensions to enable. Each entry runs CREATE EXTENSION IF NOT EXISTS. The engine merges the lists of all applications that share a schema. |
| secretSource | SecretSourceConfig | Source 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.
| Property | Type | Description |
|---|---|---|
| application | string | Name of the Application manifest that owns the target job. Required. |
| job | string | Name of the job. It matches an ApplicationJobReference.name of that application. Required. |
| envVar | string | Environment 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.
| Property | Type | Description |
|---|---|---|
| publishTo | list of string | Names of PubSub manifests that the workload can publish to. Each entry grants roles/pubsub.publisher on the topic. |
| subscribeTo | list of string | Each 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. |
| pullFrom | list of ApplicationAccessControlPubsubPullConfig | Each 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.
| Property | Type | Description |
|---|---|---|
| topic | string | Name of the PubSub manifest (topic) that declares the subscription. Required. |
| subscription | string | Name of the subscription in spec.subscriptions of that manifest. Required. |
| deadLetter | bool | If 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).
| Property | Type | Description |
|---|---|---|
| name | string | Name of the Redis manifest. The application deploys after the DNS record of the instance resolves. Required. |
| envVar | string | Environment 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. |
| caCertPath | string | Absolute 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.
| Property | Type | Description |
|---|---|---|
| description | string | Free text that describes what the application does. Used as documentation and as context for AI assistants. |
| target | string | Runtime 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. |
| meshStrategy | string | SIDECAR 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. |
| project | string | Name of the Project manifest that receives the resources of the application. Required. It must be present in every environment of the parent ReleaseTrack. |
| accessControl | ApplicationAccessControlConfig | Access that the service account of the application gets to platform resources such as Buckets, Databases, Pub/Sub topics and Secrets. |
| bundleOnly | bool | If 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. |
| jobs | list of ApplicationJobReference | Jobs that run BEFORE deploy, AFTER deploy, SCHEDULED by cron or ON_DEMAND. Each reference needs a JobConfig manifest in every environment. |
| buildDefinition | string | Name 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. |
| cluster | string | metadata.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.
| Property | Type | Description |
|---|---|---|
| name | string | Unique name of the job in the application, for example migrate. It links to the JobConfig manifest. Required. |
| type | string | BEFORE 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.
| Property | Type | Description |
|---|---|---|
| stakeholder | Stakeholder | Leaf policy. It passes when the named stakeholder (a user or group) approves. |
| anyOf | ApprovalSet | Any-of (OR) composite. It passes when at least one nested policy passes. |
| allOf | ApprovalSet | All-of (AND) composite. It passes when every nested policy passes. |
| quorum | ApprovalSet | Quorum 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.
| Property | Type | Description |
|---|---|---|
| policies | list of ApprovalPolicy | Child policies that the parent operator combines. |
| minApprovals | int32 | Minimum 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.
| Property | Type | Description |
|---|---|---|
| readers | DetailedAccessPermissions | Users and groups with read-only access. |
| writers | DetailedAccessPermissions | Users 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.
| Property | Type | Description |
|---|---|---|
| format | string | Format to re-encode uploaded images to: WEBP, PNG or JPEG. |
| maxWidth | int64 | Maximum output width in pixels (minimum 100). The converter scales down larger images. |
| maxHeight | int64 | Maximum 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.
| Property | Type | Description |
|---|---|---|
| topic | string | Name of the PubSub manifest that receives the notifications. It must exist. |
| events | list of string | Storage 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.
| Property | Type | Description |
|---|---|---|
| name | string | Name of the Bucket manifest that this path serves. Mutually exclusive with site_config: set exactly one. Must exist in the parent Project. |
| authentication | list of RouteRuleAuthenticationConfig | NOT 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. |
| authorization | list of ComputedAuthorizationAccessRuleCheck | NOT ENFORCED for static (bucket-backed) paths. As with authentication, the engine ignores it and serves the content publicly. |
| siteConfig | string | Name 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. |
| notFoundPage | string | Bucket 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. |
| notFoundStatus | int32 | 200 (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.
| Property | Type | Description |
|---|---|---|
| githubOwner | string | GitHub organization that hosts the target repository. Defaults to the configured GitHub organization. It qualifies team references such as @<owner>/infrastream-<group> in the rules. |
| repository | string | Repository whose CODEOWNERS rules the engine computes. Defaults to <org>-infrastream-organization-manifests. |
| rules | list of string | Rendered 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.
| Property | Type | Description |
|---|---|---|
| administrators | ComputedDetailedAccessPermissions | Resolved users and groups with administrative privileges. |
| contributors | ComputedDetailedAccessPermissions | Resolved users and groups with contributor privileges. |
| viewers | ComputedDetailedAccessPermissions | Resolved users and groups with viewer privileges. |
ComputedAccessibleRegistry
Computed Artifact Registry repository.
Holds the name and location that resolve image paths.
| Property | Type | Description |
|---|---|---|
| name | string | Name of the Artifact Registry repository. |
| location | string | GCP region or multi-region of the registry. It forms part of the image path. |
| trustedRepositories | list of string | Trusted 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.
| Property | Type | Description |
|---|---|---|
| name | string | Resolved application name. |
| meshStrategy | string | Service mesh strategy, for example SIDECAR, PROXYLESS, DISABLED, or EXCLUDED. It controls traffic routes and service URLs. |
| container | ComputedContainerDefinition | Resolved container image of the application. |
ComputedArtifactRegistry
Computed Artifact Registry resource.
The resolved state of an ArtifactRegistry manifest.
| Property | Type | Description |
|---|---|---|
| name | string | Copy of metadata.name. |
| type | string | Copy of spec.type. |
| publishUrl | string | URL that the engine composes from spec.type. |
| region | string | Copy of spec.region. |
| permissions | ArtifactRegistryAccessPermissions | Copy 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.
| Property | Type | Description |
|---|---|---|
| rules | list of RulesEntry | Map of hostname to the rules of that host, from all child HttpRoute and GrpcRoute manifests. |
RulesEntry
| Property | Type | Description |
|---|---|---|
| key | string | |
| value | ComputedAuthorizationAccessRules |
ComputedAuthorizationAccessRule
Computed authorization rule.
Part of the configuration that authorization extensions use to resolve user scopes.
| Property | Type | Description |
|---|---|---|
| identitySource | string | Copy of spec.authorization.identitySource of the child HttpRoute or GrpcRoute manifest. |
| matches | list of HttpRouteRuleMatch | Copy of the spec.matches block of the child HttpRoute or GrpcRoute manifest. |
| checks | list of ComputedAuthorizationAccessRuleCheck | Copy 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.
| Property | Type | Description |
|---|---|---|
| namespace | string | Copy of spec.authorization.namespace of the child HttpRoute or GrpcRoute manifest. |
| relation | string | Copy of spec.authorization.relation of the child HttpRoute or GrpcRoute manifest. |
| object | string | Copy 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.
| Property | Type | Description |
|---|---|---|
| rules | list of ComputedAuthorizationAccessRule | Rules 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.
| Property | Type | Description |
|---|---|---|
| sourceRegistry | ComputedAccessibleRegistry | Artifact Registry that stores the image. |
| image | string | Absolute 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.
| Property | Type | Description |
|---|---|---|
| path | string | File path pattern in the manifest repository, for example "organization/example-co/project/my-project.yaml". |
| teams | list of string | Full 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.
| Property | Type | Description |
|---|---|---|
| deploymentConfigName | string | Name of the Application manifest whose service account gets the grant. |
| schema | string | Schema that the privileges apply to. |
| privileges | list of string | SQL 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.
| Property | Type | Description |
|---|---|---|
| name | string | Name of the schema to create. |
| extensions | list of string | Extensions 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.
| Property | Type | Description |
|---|---|---|
| preReleaseStages | list of ComputedDeploymentStage | Ordered stages before the main release progression, for example integration or canary. |
| releaseStages | list of ComputedDeploymentStage | Ordered stages of the normal release progression, up to production. |
| hotfixStages | list of ComputedDeploymentStage | Ordered 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.
| Property | Type | Description |
|---|---|---|
| id | string | Stable identifier of the stage. |
| steps | list of ComputedDeploymentStep | Steps 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.
| Property | Type | Description |
|---|---|---|
| id | string | Stable identifier of the step. |
| environment | string | Name of the Environment that the step deploys to. |
| project | string | GCP project that receives the resources of the step. |
| container | ComputedContainerDefinition | Resolved container image of the step. |
| stakeholders | DetailedAccessPermissions | Users 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.
| Property | Type | Description |
|---|---|---|
| members | list of int64 | Resolved OrganizationUser IDs. |
| groups | list of int64 | Resolved OrganizationUserGroup IDs. |
ComputedDomainConfig
Computed fully qualified domain names.
The engine builds them from the root domains of the Environment.
| Property | Type | Description |
|---|---|---|
| internal | string | Internal domain name, composed from parent configurations. |
| external | string | External 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.
| Property | Type | Description |
|---|---|---|
| name | string | Copy of metadata.name. |
| type | string | Copy of spec.type. |
| publishUrl | string | Copy of spec.url. |
| authentication | string | Copy of spec.authentication. |
| usernameGcpSecretId | string | GCP resource StateID of the Secret manifest that the engine finds by the typical name <registryName>-username. |
| usernameSourceControlSecretId | string | Name of the GithubSecret manifest that the engine finds by the typical name <registryName>-username. |
| passwordGcpSecretId | string | GCP resource StateID of the Secret manifest that the engine finds by the typical name <registryName>-password. |
| passwordSourceControlSecretId | string | Name of the GithubSecret manifest that the engine finds by the typical name <registryName>-password. |
| region | string | GCP 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.
| Property | Type | Description |
|---|---|---|
| id | string | Unique identifier of the rule set, for example primary-branches. |
| targetPatterns | list of string | Glob patterns of the branches that the rules apply to, for example main or feat/*. |
| requiredReviewers | int64 | Number of approvals that a pull request needs before merge. |
| canCreate | bool | Whether users can create branches that match these patterns. |
| bypassRoles | list of string | GitHub roles, for example Maintainer or Admin, that can bypass the rules. |
| statusChecks | list of string | Status check contexts that must pass before merge. |
| releaseType | string | Release type of the branch, for example major, minor or patch. It can influence versioning automation. |
| allowedSourceBranchPatterns | list of string | Glob patterns of the branches that can merge into this branch. CI uses them to enforce the flow. |
| requiredBranchPattern | string | Optional regex that the branches in target_patterns must match. |
| allowedMergeMethods | list of string | Allowed merge methods, for example merge, squash or rebase. |
| statusCheckApps | list of StatusCheckAppsEntry | GitHub 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
| Property | Type | Description |
|---|---|---|
| key | string | |
| value | int64 |
ComputedGithubSecretRepositories
Relation between a GitHub secret and its target repositories.
Internal state. It tracks the repositories that received a GithubSecret manifest.
| Property | Type | Description |
|---|---|---|
| secretKey | string | Name of the secret. |
| repositories | list of string | Repositories that receive the secret. |
ComputedGithubTeamConfig
Computed GitHub team and its members.
Holds the team, parent team, and member roles.
| Property | Type | Description |
|---|---|---|
| name | string | Resolved GitHub team name. |
| parent | string | Parent team name for a nested team. Empty for a top-level team. |
| members | list of MembersEntry | Map from member login to team role, for example member or maintainer. |
MembersEntry
| Property | Type | Description |
|---|---|---|
| key | string | |
| value | string |
ComputedHibernationConfig
Computed hibernation schedule.
The engine converts windows and exclusions into cron triggers that start and stop workloads.
| Property | Type | Description |
|---|---|---|
| enabled | bool | Whether a hibernation schedule is active. |
| scheduledTriggers | list of ScheduledTriggersEntry | Resolved cron triggers, keyed by unique name. |
ScheduledTriggersEntry
| Property | Type | Description |
|---|---|---|
| key | string | |
| value | string |
ComputedIamServiceAccount
Computed Google Cloud service account.
The engine uses it to create IAM bindings and Kubernetes Workload Identity bindings.
| Property | Type | Description |
|---|---|---|
| name | string | Name of the service account, usually from the name of the Application manifest. |
| create | bool | Whether the platform creates the service account. Usually true, unless the application uses an account that already exists. |
| roles | ComputedIamServiceAccountPermissions | Resolved IAM roles, derived from the accessControl block of the Application manifest. |
| k8sName | string | Name of the Kubernetes service account bound to this account. Relevant for applications on GKE. |
| k8sNamespace | string | Namespace of the Kubernetes service account. |
ComputedIamServiceAccountPermissions
Computed IAM roles for a service account.
The engine derives them from the accessControl blocks of the application.
| Property | Type | Description |
|---|---|---|
| organization | list of string | Roles at the GCP organization level. |
| project | list of string | Roles at the GCP project level. |
| artifactRegistry | list of string | Roles for specific Artifact Registry repositories. |
ComputedLoadBalancerHost
Compiled paths of a load balancer host.
Becomes the host rules in the URL map.
| Property | Type | Description |
|---|---|---|
| iapPaths | list of ComputedLoadBalancerPath | Paths protected by IAP (Identity-Aware Proxy) authentication. |
| gcipPaths | list of ComputedLoadBalancerPath | Paths protected by GCIP (Identity Platform) authentication. |
| unauthPaths | list of ComputedLoadBalancerPath | Paths served without authentication. |
| bucketPaths | list of ComputedLoadBalancerPath | Paths served from a static GCS bucket backend. |
ComputedLoadBalancerPath
Compiled routing path of a load balancer.
Becomes one path matcher in the URL map.
| Property | Type | Description |
|---|---|---|
| matchers | list of HttpRouteRuleMatch | Compiled match conditions. |
| tenant | string | Tenant of this path. Set only for IDENTITY_PROVIDER authentication. Only used for IDENTITY_PROVIDER |
| hostRewrite | string | Host header rewrite for the backend request. |
| pathRewrite | string | Path rewrite for the backend request. |
| bucket | string | GCS bucket name. Set for static bucket content. Used for static buckets (a Bucket manifest name) |
| siteConfig | string | Name 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. |
| notFoundPage | string | Resolved 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. |
| responseHeaders | list of string | Resolved 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. |
| notFoundStatus | int32 | Resolved 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. |
| complexity | int64 | Weight that sorts path matchers. A higher value is more specific and the load balancer evaluates it first. |
| timeout | string | Route-level request timeout, as a Go-style duration string, for example 1800s. It overrides the default of the backend service. |
| idleTimeout | string | Route-level idle timeout, as a Go-style duration string, for example 60s. |
| agentName | string | Name 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.
| Property | Type | Description |
|---|---|---|
| backendService | string | Self-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. |
| accessRules | ComputedAuthorizationAccess | All 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.
| Property | Type | Description |
|---|---|---|
| authorityId | string | StateID of the certificate authority in the pool. |
| poolId | string | StateID of the CA pool. |
| location | string | GCP region of the CA pool, inherited from default_region of the Organization. |
| projectId | string | StateID of the GCP project that holds the pool: infrastream_core_project_id. |
| organization | string | Name 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.
| Property | Type | Description |
|---|---|---|
| repositories | list of string | Names of the application repositories built into this registry. |
| registry | ComputedArtifactRegistry | The resolved Artifact Registry. |
ComputedRelatedExternalRegistry
External registry with its dependent repository names.
It links application repositories to an external registry.
| Property | Type | Description |
|---|---|---|
| repositories | list of string | Names of the application repositories that pull from this registry. |
| registry | ComputedExternalRegistry | The 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.
| Property | Type | Description |
|---|---|---|
| sourceRegistry | ComputedAccessibleRegistry | STATIC (GENERIC-backed) Artifact Registry that holds the bundle. |
| package | string | Generic package name (the BuildDefinition name). With version, it names the version that the deploy job exports. |
| version | string | Generic-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. |
| bucket | string | Name of the public Bucket that receives the exported bundle. The load balancer and Cloud CDN serve it through a StaticAssetRoute. |
| archiveFormat | string | Archive 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.
| Property | Type | Description |
|---|---|---|
| source | string | Resolved bucket to mount. It comes from the volume name in the VirtualMachineConfiguration manifest. |
| mountOptions | string | FUSE 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.
| Property | Type | Description |
|---|---|---|
| name | string | Resolved disk name, from the volume name in the VirtualMachineConfiguration manifest. |
| fileSystem | string | Disk filesystem, from the volume fileSystem in the VirtualMachineConfiguration manifest. |
| mountOptions | string | Disk mount option string. The engine computes it from the filesystem and VM operating system. |
| sourceSnapshot | string | Source snapshot, from the volume mount sourceSnapshot in the VirtualMachine manifest. |
| encrypted | bool | Disk encryption flag, from the volume encrypted in the VirtualMachineConfiguration manifest. |
| diskSizeGb | int64 | Disk size, in GB, from the volume mount diskSizeGb in the VirtualMachine manifest. |
| diskType | string | Compute 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.
| Property | Type | Description |
|---|---|---|
| cpu | string | CPU quantity in Kubernetes/Cloud Run notation, for example "500m" or "2". |
| memory | string | Memory 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.
| Property | Type | Description |
|---|---|---|
| requests | ContainerResource | Minimum CPU and memory guaranteed to the container. |
| limits | ContainerResource | Maximum 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.
| Property | Type | Description |
|---|---|---|
| enabled | bool | NOT YET IMPLEMENTED. The engine ignores this field. Intended use: turn the container off but keep its definition. |
| command | list of string | Container entrypoint. Overrides the image entrypoint (the container command). |
| args | list of string | Arguments for the entrypoint (the container args). |
| env | list of EnvVariableDefinition | Static environment variables. The engine merges them with variables from secrets and access control. |
| uid | string | NOT YET IMPLEMENTED. The engine ignores this field. Intended use: the user ID of the container process. |
| gid | string | NOT YET IMPLEMENTED. The engine ignores this field. Intended use: the group ID of the container process. |
| resources | ContainerResources | CPU 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.
| Property | Type | Description |
|---|---|---|
| files | list of FilesEntry | Map of relative file path to file content. Each entry becomes a file in the volume. |
FilesEntry
| Property | Type | Description |
|---|---|---|
| key | string | |
| value | VolumeMountFile |
ControlPlaneDefinition
Definition of the control plane of the platform.
It defines the foundational GCP resources (VPCs, identity, routing) and regions of the management plane.
| Property | Type | Description |
|---|---|---|
| description | string | Free-text description, copied to the description of the GCP asset. |
| permissions | AccessPermissions | Users and groups with administrator, contributor or viewer access to the GCP project of the control plane. |
| network | ControlPlaneNetwork | NOT YET IMPLEMENTED. The engine ignores this field. See ControlPlaneNetwork. |
| hibernation | HibernationConfig | Schedule to hibernate (scale to zero) the control plane resources to save cost. |
| region | string | Primary GCP region of most control plane resources, such as VPCs, Cloud Run services and databases. |
| passiveRegions | list of string | NOT YET IMPLEMENTED. The engine ignores this field. Intended use: more regions for passive or failover deployment, for multi-region high availability. |
| maintenance | Maintenance | Maintenance windows and exclusions. See Maintenance. |
| defaultUrlRedirect | string | URL to redirect to when an ingress request matches no other routing rule. |
| allowedEgress | list of string | External hostnames or IP addresses that control plane applications can connect to. The engine denies egress to all other destinations. |
| identityProviderConfig | ProjectIdpConfig | Identity 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.
| Property | Type | Description |
|---|---|---|
| logs | NetworkLogs | NOT YET IMPLEMENTED. The engine ignores this field. See NetworkLogs. |
CorsPolicy
CORS policy.
Sets how the load balancer answers CORS preflight OPTIONS requests.
| Property | Type | Description |
|---|---|---|
| allowOrigins | list of string | Origins that can make cross-origin requests. The match is exact. |
| allowOriginRegexes | list of string | Regular expressions. The load balancer allows an origin that matches one of them. |
| allowMethods | list of string | Allowed HTTP methods. The preflight response returns them in Access-Control-Allow-Methods. |
| allowHeaders | list of string | Allowed request headers. The preflight response returns them in Access-Control-Allow-Headers. |
| exposeHeaders | list of string | Response headers that the browser can expose to client script. |
| maxAge | string | Time in seconds, as a string, for which clients can cache a preflight result. |
| allowCredentials | bool | If true, the response allows credentials (cookies and authorization headers). |
| disabled | bool | If 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.
| Property | Type | Description |
|---|---|---|
| accelerator | string | Accelerator 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. |
| zonalRedundancyDisabled | bool | Opt 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.
| Property | Type | Description |
|---|---|---|
| members | list of string | Names of OrganizationUser manifests. |
| groups | list of string | Names of OrganizationUserGroup manifests. |
DirectResponse
Immediate synthetic response.
The proxy answers with a fixed HTTP status and body and does not forward the request.
| Property | Type | Description |
|---|---|---|
| status | int64 | Positive HTTP status code to return to the client. Required. |
| stringBody | string | Optional response body as a UTF-8 string. Maximum 1024 characters. |
| bytesBody | string | NOT 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.
| Property | Type | Description |
|---|---|---|
| source | string | For a BUCKET volume, the bucket name to mount. For a DISK volume, an optional Compute snapshot self-link. |
| mountOptions | list of string | Extra mount options, for example FUSE or fstab flags. |
| diskConfig | DiskSnapshotDiskConfig | Size, 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.
| Property | Type | Description |
|---|---|---|
| sizeGb | int64 | Disk size, in GB. Only for DISK volumes. |
| type | string | Compute Engine disk type, for example pd-ssd. Only for DISK volumes. |
| snapshots | list of SnapshotsEntry | Map from environment name to the source snapshot self-link in that environment. |
SnapshotsEntry
| Property | Type | Description |
|---|---|---|
| key | string | |
| value | string |
EnvVariableDefinition
Static environment variable.
The engine adds it to the environment of the container.
| Property | Type | Description |
|---|---|---|
| name | string | Variable name. |
| value | string | Literal 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.
| Property | Type | Description |
|---|---|---|
| displayName | string | Display name of the GCP folder. Same rules as OrganizationalUnitDefinition.display_name. |
| description | string | Free-text description. |
| hibernation | HibernationConfig | Default hibernation schedule for the environment. It overrides the schedule of the parent OrganizationalUnit. Child Project manifests inherit it. |
| permissions | AccessPermissions | Default permissions for the environment. Child Project manifests inherit them. The engine combines them with the permissions of the parent OrganizationalUnit. |
| network | EnvironmentNetwork | NOT 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.
| Property | Type | Description |
|---|---|---|
| logs | NetworkLogs | NOT YET IMPLEMENTED. The engine ignores this field. See NetworkLogs. |
EventArcNotificationTarget
Eventarc notification target.
Sends events from Eventarc to a deployed Cloud Run service.
| Property | Type | Description |
|---|---|---|
| deploymentConfig | string | Name of the DeploymentConfig manifest of the target service. |
| path | string | Relative 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.
| Property | Type | Description |
|---|---|---|
| description | string | Free text that describes the application. See ApplicationDefinition.description. |
| target | string | Runtime the application deploys to: KUBERNETES, CLOUD_RUN or COMPUTE. |
| meshStrategy | string | Mesh strategy: SIDECAR, PROXYLESS or DISABLED. See ApplicationDefinition.mesh_strategy. |
| trustedRepository | string | Name 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. |
| image | string | Name of the image in the trusted repository. Required. |
| project | string | Name of the Project manifest that receives the resources of the application. Required. See ApplicationDefinition.project. |
| accessControl | ApplicationAccessControlConfig | Access that the service account of the application gets to platform resources. See ApplicationDefinition.access_control. |
| bundleOnly | bool | If true, the engine does not promote the application through pre-release tracks. See ApplicationDefinition.bundle_only. |
| jobs | list of ApplicationJobReference | Jobs of the application. See ApplicationDefinition.jobs. |
| cluster | string | metadata.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.
| Property | Type | Description |
|---|---|---|
| httpStatus | int64 | HTTP status code that aborted requests return. |
| percentage | int64 | Percentage of matched requests that abort, from 0 to 100. |
FaultInjectionDelay
Simulated latency for a route.
Sets the delay block of the mesh route faultInjectionPolicy.
| Property | Type | Description |
|---|---|---|
| fixedDelay | string | Fixed delay that the mesh adds before it forwards matched requests, as a duration string, for example 5s. |
| percentage | int64 | Percentage 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.
| Property | Type | Description |
|---|---|---|
| delay | FaultInjectionDelay | Optional. Adds artificial delay to a percentage of matched requests. |
| abort | FaultInjectionAbort | Optional. 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.
| Property | Type | Description |
|---|---|---|
| organization | string | Name of the GitHub organization that owns the central GitOps repository. Required. |
| administrators | list of string | NOT 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.
| Property | Type | Description |
|---|---|---|
| matches | list of GrpcRouteRuleMatch | Conditions that select requests for this rule. A request matches if any condition holds. |
| authentication | list of RouteRuleAuthenticationConfig | Authentication configuration. If not set, the rule needs no authentication. |
| authorization | list of ComputedAuthorizationAccessRuleCheck | Authorization 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.
| Property | Type | Description |
|---|---|---|
| destinations | list of HttpRouteRuleActionDestination | Backends that receive the traffic, with optional weights to split it. |
| faultInjectionPolicy | FaultInjectionPolicy | Optional delay or abort faults for resilience tests. |
| timeout | string | Maximum total time of a request, as a Go-style duration string. |
| retryPolicy | RetryPolicy | Retry policy for failed requests. gRPC routes ignore per_try_timeout. |
| idleTimeout | string | Maximum 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.
| Property | Type | Description |
|---|---|---|
| headers | list of GrpcRouteRuleMatchHeader | Conditions on gRPC metadata. All must match. |
| method | MethodMatch | Restricts the rule to a gRPC service and method. |
GrpcRouteRuleMatchHeader
Condition on gRPC metadata.
Selects requests by custom metadata, the gRPC equivalent of HTTP headers.
| Property | Type | Description |
|---|---|---|
| key | string | Name of the metadata entry to test. |
| value | string | Expected value of the entry. type sets whether it is an exact value or a regular expression. |
| type | string | How 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.
| Property | Type | Description |
|---|---|---|
| set | list of SetEntry | Map of header name to value. Each value replaces the current value. |
| add | list of AddEntry | Map of header name to value. The load balancer adds each header and keeps current headers of the same name. |
| remove | list of string | Names of headers to remove from the request or the response. |
AddEntry
| Property | Type | Description |
|---|---|---|
| key | string | |
| value | string |
SetEntry
| Property | Type | Description |
|---|---|---|
| key | string | |
| value | string |
HibernationConfig
Hibernation schedule configuration.
The engine combines windows and exclusions from the OU, Environment and Project into the final state.
| Property | Type | Description |
|---|---|---|
| hibernate | bool | If true, the resource hibernates immediately and overrides all windows and exclusions. Defaults to false. |
| windows | list of WindowsEntry | Time windows that repeat, in which the resource hibernates. The map key is a unique name. |
| exclusions | list of ExclusionsEntry | One-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
| Property | Type | Description |
|---|---|---|
| key | string | |
| value | HibernationExclusion |
WindowsEntry
| Property | Type | Description |
|---|---|---|
| key | string | |
| value | HibernationWindow |
HibernationExclusion
Suspension of the hibernation schedule.
Workloads stay active in the given time frame.
| Property | Type | Description |
|---|---|---|
| start | string | Window start, in RFC3339 format. RFC3339 |
| end | string | Window 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.
| Property | Type | Description |
|---|---|---|
| start | string | Cron expression for the start of the window. |
| end | string | Cron expression for the end of the window. |
HostHealthConfig
Health check for host endpoints.
Sets the probes and backend health checks for GCP load balancers.
| Property | Type | Description |
|---|---|---|
| protocol | string | Health check protocol: http, http2, https, grpc, or tcp. It applies to container probes (Cloud Run, GKE) and the VM backend health check. |
| port | int64 | TCP port that the health check targets. |
| checkIntervalSec | int64 | Interval between checks, in seconds. The default is 30 for generated probes. Default 30 |
| timeoutSec | int64 | Seconds to wait for a probe response before it fails. The engine sets 10 for generated probes. Default 5 |
| healthyThreshold | int64 | Consecutive successful probes that mark the endpoint healthy. The default is 1. Default 1 |
| unhealthyThreshold | int64 | Consecutive failed probes that mark the endpoint unhealthy. The default is 2. Default 2 |
| enableLogs | bool | NOT YET IMPLEMENTED. The engine ignores this field. Intended to enable health-check logs. |
| path | string | HTTP 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.
| Property | Type | Description |
|---|---|---|
| protocol | string | Protocol on the port: http, http2, https, grpc, or tcp. |
| namespace | string | Namespace that the routes bind into. |
| routes | list of RoutesEntry | NOT YET IMPLEMENTED. The engine ignores this field. Map from route name to its settings. |
RoutesEntry
| Property | Type | Description |
|---|---|---|
| key | string | |
| value | RouteConfig |
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.
| Property | Type | Description |
|---|---|---|
| hostRedirect | string | Host to redirect to. The engine sets it on the login redirect that it injects. |
| pathRedirect | string | Absolute path to redirect to. It replaces the original path. |
| prefixRewrite | string | Prefix of the original path to replace in the redirect. |
| responseCode | string | HTTP redirect response code, for example MOVED_PERMANENTLY_DEFAULT, SEE_OTHER or TEMPORARY_REDIRECT. The engine sets it on the login redirect that it injects. |
| httpsRedirect | bool | If true, the redirect URL uses the https scheme. |
| stripQuery | bool | If true, the redirect URL has no query string. |
| portRedirect | string | Port in the redirect URL. |
HttpRouteRule
HTTP routing rule.
Pairs match conditions with an action.
| Property | Type | Description |
|---|---|---|
| matches | list of HttpRouteRuleMatch | Conditions that select requests for this rule. A request matches if any condition holds. |
| authentication | list of RouteRuleAuthenticationConfig | Authentication configuration. If not set, the rule needs no authentication. |
| authorization | list of ComputedAuthorizationAccessRuleCheck | Authorization 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.
| Property | Type | Description |
|---|---|---|
| destinations | list of HttpRouteRuleActionDestination | Backends that receive the traffic, with optional weights to split it. |
| redirect | HttpRouteRedirect | If set and destinations is empty, the rule answers with an HTTP redirect. The external load balancer applies it, not the in-mesh route. |
| faultInjectionPolicy | FaultInjectionPolicy | Optional delay or abort faults for resilience tests. |
| requestHeaderModifier | HeaderModifier | Header changes for the request before it reaches the backend. |
| responseHeaderModifier | HeaderModifier | Header changes for the response before it reaches the client. |
| urlRewrite | UrlRewrite | Path prefix and host rewrites for the request. |
| timeout | string | Maximum total time of a request, as a Go-style duration string. |
| retryPolicy | RetryPolicy | Retry policy for failed requests. |
| requestMirrorPolicy | RequestMirrorPolicy | NOT YET IMPLEMENTED. The engine ignores this field. It will mirror traffic to a shadow backend. |
| corsPolicy | CorsPolicy | CORS rules for the traffic. |
| directResponse | DirectResponse | If set, the proxy answers with a static status and body and does not forward the request. |
| idleTimeout | string | Maximum 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.
| Property | Type | Description |
|---|---|---|
| deploymentConfig | string | Name of a DeploymentConfig manifest whose backend receives the traffic. Mutually exclusive with virtual_machine and agent. |
| virtualMachine | string | Name of a VirtualMachine manifest whose backend receives the traffic. Mutually exclusive with deployment_config and agent. |
| port | int64 | Port on the backend. |
| weight | int64 | Relative weight (0-100) of this destination when a rule splits traffic. |
| agent | string | Name 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.
| Property | Type | Description |
|---|---|---|
| ignoreCase | bool | If true, path comparisons ignore case. |
| fullPathMatch | string | Matches if the request path equals this value. Mutually exclusive with prefix_match and regex_match. |
| prefixMatch | string | Matches if the request path starts with this prefix. |
| regexMatch | string | Matches if the request path fully matches this regular expression. |
| headers | list of HttpRouteRuleMatchHeader | Conditions on request headers. All must match. |
| queryParameters | list of QueryParameterMatch | Conditions on URL query parameters. All must match. |
HttpRouteRuleMatchHeader
Condition on an HTTP header.
A route match uses it to select requests by header.
| Property | Type | Description |
|---|---|---|
| header | string | Name of the request header to test. |
| invertMatch | bool | If true, the rule applies when the header condition does NOT hold. |
| exactMatch | string | Matches if the header value equals this string. |
| regexMatch | string | Matches if the header value fully matches this regular expression. |
| prefixMatch | string | Matches if the header value starts with this prefix. |
| presentMatch | bool | If true, matches if the header is present, whatever its value. |
| suffixMatch | string | Matches if the header value ends with this suffix. |
| rangeMatch | RangeMatch | Matches 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.
| Property | Type | Description |
|---|---|---|
| source | string | Name of the BuildDefinition manifest that supplies the container image. Required. The build must exist. |
| container | string | Name of the container in the source BuildDefinition. Required. It must match one of the containers of that build. |
| version | string | Tag of the container image to deploy. Required. |
| spec | ContainerSpec | Optional container overrides (command, args, env, resources). See ContainerSpec. |
Jwks
JSON Web Key configuration to verify tokens.
NOT YET IMPLEMENTED. The engine ignores this message.
| Property | Type | Description |
|---|---|---|
| kid | string | Key ID (kid). |
| type | string | Key type, for example RSA or EC. |
| alg | string | Algorithm of the key, for example RS256. |
| pem | string | PEM-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.
| Property | Type | Description |
|---|---|---|
| start | string | RFC3339 timestamp. Its time of day and day of week set the start of the weekly window. RFC3339 |
| end | string | RFC3339 timestamp for the end of the weekly window. RFC3339 |
| exclusions | list of MaintenanceExclusion | One-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.
| Property | Type | Description |
|---|---|---|
| name | string | Unique label for the reason, for example black-friday-freeze. |
| start | string | Window start, in RFC3339 format. RFC3339 |
| end | string | Window 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.
| Property | Type | Description |
|---|---|---|
| grpcService | string | Fully qualified gRPC service name, for example package.Service. |
| grpcMethod | string | Method of the service. |
| caseSensitive | bool | If 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.
| Property | Type | Description |
|---|---|---|
| type | string | Receiver type. The only value is prometheus. |
| prometheus | PrometheusConfig | Prometheus 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.
| Property | Type | Description |
|---|---|---|
| mode | string | MFA enforcement mode: DISABLED, ENABLED (optional) or MANDATORY (required for all users). |
| testPhoneNumbers | list of TestPhoneNumbersEntry | Map of a phone number to its expected 6-digit OTP code. It tests MFA flows without real SMS. |
| allowedRegions | list of string | Two-letter Unicode CLDR region codes of the regions where users can use MFA. See https://cldr.unicode.org/. |
TestPhoneNumbersEntry
| Property | Type | Description |
|---|---|---|
| key | string | |
| value | string |
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.
| Property | Type | Description |
|---|---|---|
| interval | string | Aggregation interval. One of the INTERVAL_* values, from INTERVAL_5_SEC to INTERVAL_15_MIN. |
| sampling | double | Fraction 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.
| Property | Type | Description |
|---|---|---|
| grantTypes | list of string | Allowed grant types, for example authorization_code or client_credentials. |
| responseTypes | list of string | Allowed response types, for example code or token. |
| scopes | list of string | Allowed OAuth scopes. |
| redirectUris | list of string | Permitted redirect URIs. |
| postLogoutRedirectUris | list of string | Permitted post-logout redirect URIs. |
| audience | list of string | Audience values for issued tokens. |
| jwks | Jwks | NOT YET IMPLEMENTED. The engine ignores this field. See Jwks. |
OidcProviderConfig
External OIDC provider for identity federation.
NOT YET IMPLEMENTED. The engine ignores this message.
| Property | Type | Description |
|---|---|---|
| source | string | Upstream OIDC provider: github or google. |
| clientId | string | Client ID registered with the upstream provider. |
| mapper | string | Expression that maps upstream OIDC claims to local identity attributes. |
| scopes | list of string | OAuth 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.
| Property | Type | Description |
|---|---|---|
| displayName | string | Display name of the GCP folder. Defaults to metadata.name. Must have 3 to 30 characters: letters, digits, spaces, underscores and dashes. |
| description | string | Free-text description. |
| hibernation | HibernationConfig | Default hibernation schedule for the OU. Child Environment or Project manifests can override it. |
| permissions | AccessPermissions | Default permissions for the OU. Child Environment and Project manifests inherit them. |
| network | OrganizationalUnitNetwork | NOT 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.
| Property | Type | Description |
|---|---|---|
| logs | NetworkLogs | NOT 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.
| Property | Type | Description |
|---|---|---|
| displayName | string | Display name of the GCP project. Same rules as OrganizationalUnitDefinition.display_name. |
| description | string | Free-text description. |
| permissions | AccessPermissions | Permissions 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. |
| network | ProjectNetwork | NOT YET IMPLEMENTED. The engine ignores this field. See ProjectNetwork. |
| hibernation | HibernationConfig | Hibernation schedule for the Project. It overrides schedules from parent manifests. |
| region | string | Primary GCP region for the Project and its resources. Defaults to the region of the parent Environment. |
| maintenance | Maintenance | Maintenance windows and exclusions. Required. See Maintenance. |
| defaultUrlRedirect | string | URL to redirect to when a request matches no other routing rule in the Project. Required. |
| allowedEgress | list of string | External hostnames or IP ranges that applications in the Project can connect to. The engine enforces this policy on outbound traffic. |
| identityProviderConfig | ProjectIdpConfig | Identity provider settings for all tenants in the Project. See ProjectIdpConfig. |
| rsi | RsiConfig | Policy 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. |
| mcpGcpAccess | McpGcpAccess | Opt-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.
| Property | Type | Description |
|---|---|---|
| mfa | MfaConfig | NOT YET IMPLEMENTED. The engine ignores this field. See MfaConfig. |
| gdprCompliance | bool | Enables 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.
| Property | Type | Description |
|---|---|---|
| logs | NetworkLogs | NOT 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.
| Property | Type | Description |
|---|---|---|
| scheme | string | URL scheme for the scrape: http or https. |
| endpoint | string | Metrics path on the VM localhost, for example /metrics. |
| port | int64 | Localhost port to scrape. |
QueryParameterMatch
Condition on an HTTP query parameter.
A route match uses it to select requests by URL query parameter.
| Property | Type | Description |
|---|---|---|
| queryParameter | string | Name of the URL query parameter to test. |
| exactMatch | string | Matches if the parameter value equals this string. |
| regexMatch | string | Matches if the parameter value fully matches this regular expression. |
| presentMatch | string | If 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.
| Property | Type | Description |
|---|---|---|
| start | int64 | Lower bound (inclusive): the smallest integer that matches. |
| end | int64 | Upper 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.
| Property | Type | Description |
|---|---|---|
| deploymentConfig | string | Name of the DeploymentConfig manifest whose backend receives the mirrored request. |
| port | int64 | Port on the mirror backend. |
| weight | int64 | Relative weight (0-100) of this mirror destination. |
| requestHeaderModifier | HeaderModifier | Header changes for the mirrored request. |
| responseHeaderModifier | HeaderModifier | Header 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.
| Property | Type | Description |
|---|---|---|
| destination | RequestMirrorDestination | Backend that receives the copied requests. |
| mirrorPercent | int64 | Percentage (0-100) of requests to copy. |
RetryPolicy
Retry policy.
Sets when and how often the load balancer retries a failed request.
| Property | Type | Description |
|---|---|---|
| retryConditions | list of string | Failure conditions that trigger a retry, for example 5xx, connect-failure or refused-stream. |
| numRetries | int64 | Maximum number of retries of a failed request. |
| perTryTimeout | string | Timeout 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.
| Property | Type | Description |
|---|---|---|
| enabled | bool | If true, the route requires authentication. |
| type | string | Authentication type: IdentityAwareProxy, OrgInternal, or IdentityProvider. |
| providerName | string | Identity 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.
| Property | Type | Description |
|---|---|---|
| authentication | RouteAuthentication | NOT 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.
| Property | Type | Description |
|---|---|---|
| type | string | IDENTITY_PROVIDER limits access to the identity providers in tenants. INTERNAL limits access to internal callers. Validation checks it against the declared identity providers. |
| tenants | list of string | IdentityProvider 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.
| Property | Type | Description |
|---|---|---|
| enabled | bool | Switch 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. |
| repositories | list of string | GitHub 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. |
| protectedPaths | list of string | Patterns 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.
| Property | Type | Description |
|---|---|---|
| enabled | bool | Switch 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.
| Property | Type | Description |
|---|---|---|
| min | int64 | Minimum number of active instances, for example Cloud Run min instances. Must be at least 1. |
| max | int64 | Maximum 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.
| Property | Type | Description |
|---|---|---|
| envVar | string | Name of the environment variable that holds the secret. Mutually exclusive with file_path: set exactly one. |
| version | string | Secret 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.
| Property | Type | Description |
|---|---|---|
| fromAddress | string | Sender email address (the From address). |
| fromName | string | Sender 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.
| Property | Type | Description |
|---|---|---|
| name | string | metadata.name of the Project manifest. |
| environment | string | metadata.name of the parent Environment manifest of the project. Default: the current Environment. |
| organizationalUnit | string | metadata.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.
| Property | Type | Description |
|---|---|---|
| environments | list of string | Names of the Environment manifests in this stage. The application must deploy to every one before promotion to the next stage. |
| approvalPolicy | ApprovalPolicy | Approval 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.
| Property | Type | Description |
|---|---|---|
| userEmail | string | Email address of an OrganizationUser. |
| groupEmail | string | Email address of an OrganizationUserGroup. |
StartupConfig
Startup script of a VM.
Sets metadata.startup-script of the instance and substitutes template variables on boot.
| Property | Type | Description |
|---|---|---|
| script | string | Script body. The engine substitutes the variables before the script runs on boot. |
| variables | list of VariablesEntry | Map from variable name to its definition (default value and required flag). |
VariablesEntry
| Property | Type | Description |
|---|---|---|
| key | string | |
| value | VariableConfig |
UrlRewrite
URL rewrite.
Changes the request path or host before the load balancer forwards the request.
| Property | Type | Description |
|---|---|---|
| pathPrefixRewrite | string | Value that replaces the matched path prefix of the request. |
| hostRewrite | string | Value 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.
| Property | Type | Description |
|---|---|---|
| administrators | list of string | Users and groups with administrative privileges, usually full control. |
| contributors | list of string | Users and groups with contributor privileges, usually read and write access. |
| viewers | list of string | Users 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.
| Property | Type | Description |
|---|---|---|
| sourceType | string | External identity system. The only value is GITHUB. |
| sourceName | string | Name of the GithubConnection manifest that resolves the username. |
| username | string | Login name of the user in the external system. |
VariableConfig
Template variable of the startup script.
The engine injects resolved variables into the script.
| Property | Type | Description |
|---|---|---|
| defaultValue | string | Value used when the VM manifest gives none. The engine substitutes it into a text/template and does not escape it. Validation rejects shell metacharacters: ;, &, ` |
| required | bool | If 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.
| Property | Type | Description |
|---|---|---|
| operatingSystem | string | Operating system of the VM. It selects the boot disk image. One of the supported Debian, Ubuntu, or Windows Server values. |
| secrets | list of SecretsEntry | Map from Secret manifest name to how the VM gets the secret, as a file or environment variable. |
| agent | AgentConfig | Ops Agent settings for the logs and metrics that the VM exports. |
| volumes | list of VolumesEntry | Map from absolute mount path in the VM, for example /data, to the volume mounted there. |
| startup | StartupConfig | Startup script and template variables of the VM. |
SecretsEntry
| Property | Type | Description |
|---|---|---|
| key | string | |
| value | VirtualMachineSecretConfig |
VolumesEntry
| Property | Type | Description |
|---|---|---|
| key | string | |
| value | VirtualMachineVolumeConfig |
VirtualMachineSecretConfig
Secret delivery to a virtual machine.
The startup script writes each Secret Manager payload as a file or variable.
| Property | Type | Description |
|---|---|---|
| type | string | ENV_VAR sets an environment variable. FILE writes a file with the startup script. |
| target | string | For 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.
| Property | Type | Description |
|---|---|---|
| name | string | Logical name of the volume. VirtualMachine volume mounts refer to it. |
| type | string | BUCKET (Cloud Storage FUSE mount), DISK (persistent disk), or SECRET (Secret Manager payload). |
| fileSystem | string | Only for DISK volumes. Filesystem of the disk. It must be compatible with the VM operating system. |
| encrypted | bool | Only 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.
| Property | Type | Description |
|---|---|---|
| source | string | Volume source. Same as DiskSnapshotConfiguration.source. |
| mountOptions | list of string | Extra mount options. The engine joins them into the mount command. |
| diskConfig | VirtualMachineVolumeMountDiskConfig | Size, 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.
| Property | Type | Description |
|---|---|---|
| sizeGb | int64 | Disk size, in GB. Only for DISK volumes. The minimum is 200 GB. |
| type | string | Compute Engine disk type, for example pd-ssd. Only for DISK volumes. |
| snapshots | list of DiskSnapshotConfiguration | Optional snapshot configurations that seed the disk in specific environments. |
VolumeMountBucketRef
Bucket mounted as a volume.
Describes the Cloud Storage FUSE mount of a bucket.
| Property | Type | Description |
|---|---|---|
| name | string | Name of the Bucket manifest to mount with Cloud Storage FUSE. |
| path | string | Path where the container mounts the bucket. |
| canWrite | bool | If 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.
| Property | Type | Description |
|---|---|---|
| mimeType | string | MIME type of the file. If empty, the engine sets a default. |
| content | string | File content: plain text, or base64 if base64_encoded is true. |
| base64Encoded | bool | If true, the engine decodes content from base64 before it writes the file. |