Core Concepts
This page defines the terms that the rest of the documentation uses. Other pages link here and do not repeat these definitions.
- The grey text in a box is the metadata key that names the parent of the manifest.
- Solid arrow: parent to child, in metadata.
- Dashed arrow: a reference in spec, or the same name.
- GithubConnection and ArtifactRegistry also name the Organization in
organization:. The picture draws no arrow for these two. - A folder never links manifests.
Point at a box, or move to it with the Tab key. Its lines stay lit, and its links show here.
Manifest
A manifest is a YAML file that declares one resource. You declare what you want. The platform decides how to build it. The platform calls this model Manifest Driven Secure Execution (MDSE).
apiVersion: lowops.manifests.v1
kind: Database
metadata:
name: my-app-db
project: your-project-name
environment: development
organizational-unit: your-ou
organization: your-org
spec:
alloydb: # 'alloydb' (PostgreSQL) or 'spanner'
clusterSize: 3 # 1 = single primary; >1 adds read-pool instances
cpuCount: 4 # vCPUs per instance
metadataholds the name of the resource and the names of its parents.specholds the settings that you choose. Fields use camelCase.computedholds output values. The engine writes it. Never write it yourself.
The Manifest Reference lists every field of every kind. The engine schema generates it.
Metadata links manifests, not folders
The engine reads every .yaml file in the repository. It finds the parents of a manifest from its metadata keys: organization, organizational-unit, environment, project, release-track, application-set, github-connection, github-repository, public-ingress, private-ingress, external-registry, artifact-registry and kubernetes. The location of a file has no effect. This layout is a convention:
manifests/
├── organization.yaml # kind: Organization
├── organization-user/… # people
├── organization-user-group/… # teams
├── github-connection/
│ └── default/
│ ├── default.yaml # kind: GithubConnection
│ └── github-repository/
│ └── hello-service/
│ ├── hello-service.yaml # kind: GithubRepository
│ └── build-definition/
│ └── hello-service.yaml # kind: BuildDefinition
├── artifact-registry/… # private registries
├── external-registry/… # upstream registries + trusted repos
└── organizational-unit/
└── retail-banking/
├── retail-banking.yaml # kind: OrganizationalUnit
├── environment/
│ └── prod/
│ ├── prod.yaml # kind: Environment
│ └── project/
│ └── login-svc/
│ ├── login-svc.yaml # kind: Project
│ ├── database/… # kind: Database, Bucket, Redis, …
│ └── deployment-config/ # kind: DeploymentConfig (per env)
└── release-track/
└── main-track/
├── main-track.yaml # kind: ReleaseTrack
└── application-set/
└── core-apis/
├── core-apis.yaml # kind: ApplicationSet
└── application/… # kind: Application / ExternalApplication
The three axes
Manifests form a graph along three axes.
Landscape: where resources live
Organizationis the top-level container. The central platform team manages it. It holds global security policies, workforce federation and billing.OrganizationalUnit(OU) is a line of business or a product area. It inherits the policies of the organization.Environmentis a stage in an OU, such asdev,stagingorprod.Projectis a Google Cloud project. It hosts related resources: databases, buckets, topics and secrets.
Delivery: how software ships
ReleaseTrackis the ordered path that a version follows through environments.ApplicationSetis a bundle of applications that release together.Applicationis a service that the platform builds from your source.ExternalApplicationis a service that runs an image built elsewhere.DeploymentConfigholds the settings of one application in one environment. Itsmetadata.nameis the name of the application.
Source and build: where images come from
GithubConnection,GithubRepositoryandBuildDefinitionconnect a GitHub organization, manage repositories and generate CI.ArtifactRegistryholds your private images.ExternalRegistryandTrustedRepositorysupply approved images from other registries.
An Application joins the axes. It names a buildDefinition, belongs to an ApplicationSet on a ReleaseTrack, runs in a Project and gets its settings from a DeploymentConfig. See CI/CD for how a build moves through the delivery axis.
State ledger
The engine records state in Cloud Spanner as an append-only ledger. Three tables hold it: States, StateDependencies and RunEvents. The ledger records each change with a millisecond timestamp. It can rebuild the graph as it was at any recorded time. You can use it as a record for audits. Compliance remains your own assessment.
Core Project
The Core Project is one Google Cloud project that serves all other projects in the organization. It hosts the Spanner ledger, the engine, the Shared VPC hub network and shared registries. You never edit a manifest for it. The engine manages it.