Skip to main content

Public Ingress

PublicIngress​

Defines a public entry point to platform services.

Creates external load balancing, SSL/TLS certificates, and DNS zones. It aggregates Identity-Aware Proxy (IAP) integration and authorization enforcement.

PropertyTypeDescription
apiVersionstringAPI schema version. Must be lowops.manifests.v1.
kindstringResource kind. Must be PublicIngress.
metadatamapFree-form key/value labels. The engine reads reserved keys (for example name, project) to resolve the identity of this manifest and its parent Project.
specSpecDesired public ingress configuration. See Spec.

Authorization​

Authorization enforcement details.

Set only if spec.authorization_database has a value.

PropertyTypeDescription
backendServicestringSelf-link of the backend service of the authorization extension, named <metadata.name>-authz-ext.
accessRulesComputedAuthorizationAccessAuthorization rules of all child HttpRoute and GrpcRoute manifests, aggregated. See ComputedAuthorizationAccess.

IdentityProviderUiConfigsEntry​

PropertyTypeDescription
keystring
valueTenantUiConfig

LoadBalancerEntry​

PropertyTypeDescription
keystring
valueComputedLoadBalancerHost

TenantUiConfig​

Per-tenant login UI configuration.

Login page settings of one tenant, keyed by IdentityProvider manifest name.

PropertyTypeDescription
signInFlowstringSign-in flow type, for example "redirect" or "popup".
displayNamestringDisplay name on the login page.
iconUrlstringTenant icon URL.
logoUrlstringTenant logo URL.
buttonColorstringHex color of the sign-in button.
tosUrlstringTerms of service URL.
privacyPolicyUrlstringPrivacy policy URL.
signInOptionslist of SignInOptionEnabled sign-in providers.
styleUrlstringCustom CSS stylesheet URL for this tenant.
heroImageUrlstringHero image URL.
heroBackgroundstringCSS background of the hero panel.
immediateFederatedRedirectboolIf true and exactly one federated provider exists, skip the sign-in UI and redirect at once.
redirectOnLoginstringRedirect URL after sign-in.
redirectOnLogoutstringRedirect URL after sign-out.
gdprComplianceboolIf true, the login app shows GDPR-compliant UI: a TOS acceptance checkbox before sign-in and a "Delete my account" button on the profile page.

SignInOption​

A single sign-in provider option.

One provider that the login page offers for this tenant.

PropertyTypeDescription
providerstringProvider identifier, for example password, google.com, anonymous.
useRecaptchaboolIf true, the provider uses invisible reCAPTCHA.

Spec​

User-defined configuration for the public ingress.

Covers the domain, access control, authorization database, and login-app UI. Child route manifests (Http, Grpc, Tls, StaticAsset) attach to it.

PropertyTypeDescription
descriptionstringOptional free text. AI assistants use it as context. The engine does not use it otherwise.
regionstringPreferred GCP region. If empty, it inherits the region of the parent Project. The resolved value is in computed.region.
domainDomainConfigCustom domain configuration. See DomainConfig. If unset, the ingress uses the default domain from the parent Project.
identityProviderApplicationIdentityProviderConfigSource application of the identity-provider login UI. The engine validates it against the build definitions of the project and resolves it into computed.idp_login_application. If omitted, default configuration applies. See IdentityProviderConfig.
iapPermissionsDetailedAccessPermissionsUsers and groups that can reach applications behind this ingress when IAP is on. They resolve into computed.iap_permissions and become IAP IAM bindings. See DetailedAccessPermissions.
authorizationDatabasestringName of a Database manifest in the same project that stores fine-grained authorization policies. It must exist. If set, the engine provisions two more Cloud Run services. -authz-ext is a read-only gRPC authorizer. -authz-svc is an Ory Keto read-write service for policies, with a one-time schema migration.
configConfigNOT YET IMPLEMENTED. The engine ignores this block. See Config.
loginAppLoginAppConfigLogin app UI settings. See LoginAppConfig.
securityPolicySecurityPolicyOptional Cloud Armor policy for this ingress. If absent, the engine creates no policy and changes no backend service. See SecurityPolicy. The policy covers the IAP, GCIP, unauthenticated, session-refresh, and login-app backend services. It does NOT cover backend buckets (static sites, default static pages, login-app assets), which accept only CLOUD_ARMOR_EDGE policies. The unauthenticated backend uses Cloud CDN, and the policy runs only on cache misses. So content cached after an allowed request also reaches requests that the policy would deny.
allowDirectRoutesboolNOT RECOMMENDED. If true, a child HttpRoute can set ingress_path to DIRECT, which skips the mesh gateway. The default is false. A DIRECT route has no sign-in and no authorization from the engine. The service must check every request itself. The route also needs a security_policy that does not allow all traffic.

Config​

Advanced backend-service tuning.

NOT YET IMPLEMENTED. The engine ignores this block.

PropertyTypeDescription
timeoutSecint64Backend response timeout in seconds.
connectionDrainingTimeoutSecint64Connection-draining timeout in seconds.
customRequestHeaderslist of stringCustom headers to add to requests to backends.
customResponseHeaderslist of stringCustom headers to add to responses to clients.
loadBalancingLoadBalancingNOT YET IMPLEMENTED. The engine ignores this field. See LoadBalancing.

LoadBalancing​

Load-balancing policy of the backend services.

NOT YET IMPLEMENTED. The engine ignores this block.

PropertyTypeDescription
balancingModestringLoad-balancing algorithm: UTILIZATION, RATE, or CONNECTION.
capacityScalerdoubleScales the advertised backend-service capacity, from 0.0 to 1.0.
descriptionstringOptional free text. The engine does not read it.
maxConnectionsint64Maximum concurrent connections per instance.
maxRateint64Maximum requests per second per instance.
maxUtilizationdoubleTarget CPU utilization (0.0-1.0) for the UTILIZATION mode.

DomainConfig​

Custom, user-owned domain and DNS records.

If set, name is the base of computed.domain, and the platform provisions a DNS zone with the required records (see dns). The operator MUST delegate the domain: point its NS records at the name servers of the created zone.

PropertyTypeDescription
namestringBase domain for hostnames of child HTTP/gRPC routes and for computed.domain. Must be a hostname. The engine ignores empty values.
txtRecordslist of stringExtra TXT records for the zone apex. Engine runs do not erase them. Each entry must be a valid TXT value, for example google-site-verification=xxxxx.
apexstringHow the engine serves the bare zone apex (name itself). Routes are always at <route-name>.<name>. By default (empty) the engine leaves the apex untouched. There is no apex A record, and a TLS handshake for the bare apex fails, because the certificate map answers only for *.<name>.
dnsstringWho hosts the DNS for name. MANAGED (the default when empty): the engine creates a Cloud DNS zone for name with all records. These are the certificate-validation CNAME, the wildcard and apex A records, and the Firebase TXT/DKIM records.

LoginAppConfig​

Login app UI configuration.

Applies when Google Cloud Identity Platform (GCIP) is on.

PropertyTypeDescription
displayModestringSign-in display mode: optionFirst (all providers at once) or identifierFirst (email first).
selectTenantUiTitlestringTitle of the tenant selector screen. Required when GCIP is on with more than one identity provider.
selectTenantUiLogostringLogo URL of the tenant selector screen.
redirectOnLoginstringDefault redirect URL after sign-in. A per-tenant value overrides it.
redirectOnLogoutstringDefault redirect URL after sign-out. A per-tenant value overrides it.
supportedLocaleslist of stringLocale codes that the login app offers, for example ["en", "fr"]. More than one needs locale_cookie.name.
localeCookieLocaleCookieYou must set it when supported_locales has more than one entry. See LocaleCookie.
styleUrlstringGlobal custom CSS stylesheet URL. A per-tenant URL overrides it. Must be an HTTPS URL or a relative path.
tosUrlstringDefault Terms of Service URL. A per-tenant value overrides it.
privacyPolicyUrlstringDefault Privacy Policy URL. A per-tenant value overrides it.
redirectUrislist of stringNOT YET IMPLEMENTED. The engine ignores this field. It will allowlist OAuth redirect URI patterns.

LocaleCookie​

Locale cookie.

Names and scopes the cookie that stores the locale choice across sessions and subdomains.

PropertyTypeDescription
namestringCookie name, for example locale. You must set it when supported_locales has more than one entry.
domainstringCookie domain, so that all subdomains share the cookie, for example .example.com.

SecurityPolicy​

Google Cloud Armor policy for the load balancer.

The engine creates one CLOUD_ARMOR policy in the project of the ingress and attaches it to every external backend service. Cloud Armor evaluates it BEFORE IAP, so it can only narrow access: a denied request never reaches IAP, and allow never bypasses IAP or GCIP.

PropertyTypeDescription
ruleslist of RuleCustom rules, in any order: priority sets the order. At most 20 rules in total, with the rules from denied_region_codes (one per five regions). Cloud Armor allows 20 expression rules per project by default. The engine checks this per ingress only, so ingresses in one project can still exceed the quota at apply time.
deniedRegionCodeslist of stringRegions whose requests the policy refuses with 403: ISO 3166-1 alpha-2 upper-case codes, for example CU, KP (XK for Kosovo is also valid). The engine adds deny rules, five regions per rule, at priorities 1000 and up in alphabetical order. Each code can appear once.
defaultActionstringAction for requests that match no rule: allow (the default when empty), deny(403), deny(404), or deny(502). A deny default makes the policy an allowlist. Health checks bypass Cloud Armor, so the backends stay healthy.

Rule​

A single ordered rule of the policy.

Matches requests with a Common Expression Language (CEL) expression and applies action. The lowest priority number goes first, and the first match wins.

PropertyTypeDescription
priorityint32Evaluation order: lower numbers go first. Must be unique within the policy, from 0 to 2147483646 (2147483647 is the default rule). Must not be in the range of denied_region_codes (1000 upwards, one priority per five regions).
descriptionstringOptional free text. The Cloud Console shows it.
expressionstringRequired CEL expression that a request must satisfy. To match source IP ranges, use inIpRange(origin.ip, '<cidr>'). Maximum 2048 characters and five subexpressions joined by `

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.

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.

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.

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.

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.

RulesEntry​

PropertyTypeDescription
keystring
valueComputedAuthorizationAccessRules

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.

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.

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.

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.

EnvVariableDefinition​

Static environment variable.

The engine adds it to the environment of the container.

PropertyTypeDescription
namestringVariable name.
valuestringLiteral value.

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

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.

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.

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.

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.

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.