Skip to main content

Github Connection

GithubConnection​

Defines the connection between the platform and a GitHub organization.

Provisions the API credentials, memberships and teams of the organization. It is the parent of its licenses, PR templates, secrets, repository templates and repositories.

PropertyTypeDescription
apiVersionstringAPI schema version. Must be lowops.manifests.v1.
kindstringResource kind. Must be GithubConnection.
metadatamapReserved keys such as name and organization resolve the manifest identity and its parent Organization.
specSpecUser-authored specification of the connection. See Spec.

Executors​

Aggregate CI/CD runner footprint.

Requested counts of self-hosted runners by OS, summed from child build definitions.

PropertyTypeDescription
ubuntuint64Number of Ubuntu runners requested.
macosint64Number of macOS runners requested.
windowsint64Number of Windows runners requested.

ManagedWorkflowsPrivateEntry​

PropertyTypeDescription
keystring
valuestring

ManagedWorkflowsPublicEntry​

PropertyTypeDescription
keystring
valuestring

RelatedArtifactRegistriesEntry​

PropertyTypeDescription
keystring
valueComputedRelatedArtifactRegistry

RelatedExternalRegistriesEntry​

PropertyTypeDescription
keystring
valueComputedRelatedExternalRegistry

SecretsEntry​

PropertyTypeDescription
keystring
valueComputedGithubSecretRepositories

Spec​

User-provided connection configuration.

Names the GitHub organization, the authentication method and the administrators.

PropertyTypeDescription
descriptionstringOptional free-text description. The engine does not copy it to any GitHub resource.
ownerstringName of the target GitHub organization (account owner). It is the root scope for all repository, team and secret generation. The engine compares it with the GitHub organization of the parent Organization to decide whether to reuse core credentials. Required.
authenticationMethodstringHow the engine authenticates to the GitHub API: PERSONAL_ACCESS_TOKEN or GITHUB_APP. With PERSONAL_ACCESS_TOKEN, the engine creates a secret in the core project to hold the token. Credential reuse currently depends on this value.
hostnamestringHostname of the GitHub instance, for example github.my-company.com. Set it only for GitHub Enterprise Server. Defaults to github.com. Child repositories inherit it as connection_hostname.
administratorslist of stringGitHub usernames that get the admin role in the organization. The engine resolves each name through its OrganizationUser GitHub external account. Each administrator is also a maintainer on generated teams.

ComputedGithubSecretRepositories​

Relation between a GitHub secret and its target repositories.

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

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

ComputedRelatedArtifactRegistry​

Artifact Registry with its dependent repository names.

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

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

ComputedRelatedExternalRegistry​

External registry with its dependent repository names.

It links application repositories to an external registry.

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

ComputedExternalRegistry​

Computed external container registry dependency.

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

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

ComputedArtifactRegistry​

Computed Artifact Registry resource.

The resolved state of an ArtifactRegistry manifest.

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

ArtifactRegistryAccessPermissions​

Access levels for Artifact Registry repositories.

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

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

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.