Skip to main content

External Application

ExternalApplication​

Workload backed by an image built outside the workspace.

It mirrors Application, but the container comes from a TrustedRepository (field trusted_repository) and not from an in-workspace BuildDefinition. The engine creates the same identity, network, and service-mesh resources as for an Application.

PropertyTypeDescription
apiVersionstringAPI schema version. Must be lowops.manifests.v1.
kindstringResource kind. Must be ExternalApplication.
metadatamapThe engine reads reserved keys to resolve the identity and the parents, for example its Project and its parent ApplicationSet.
specExternalApplicationDefinitionDesired external-application configuration. Required. See ExternalApplicationDefinition.

ExternalApplicationDefinition​

External application specification.

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

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

ApplicationJobReference​

Job that is part of the lifecycle of an Application.

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

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

ApplicationAccessControlConfig​

All external access rules of an application.

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

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

ApplicationAccessControlDatabaseConfig​

PostgreSQL access for a workload.

Runs CREATE USER and GRANT on the target SQL instance.

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

SecretsEntry​

PropertyTypeDescription
keystring
valueSecretSourceConfig

ApplicationAccessControlJobConfig​

Permission to trigger a Cloud Run Job of another application.

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

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

ApplicationAccessControlRedisConfig​

Redis cache access for a workload.

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

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

ApplicationAccessControlBucketConfig​

Cloud Storage access for a workload.

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

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

ApplicationAccessControlPubsubConfig​

Pub/Sub permissions for a workload.

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

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

ApplicationAccessControlPubsubPullConfig​

Pub/Sub subscription that a workload consumes.

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

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

SecretSourceConfig​

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

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

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