DataformRepository

Property Value
Google Cloud Service Name Dataform
Google Cloud Service Documentation /dataform/docs/
Google Cloud REST Resource Name v1beta1.projects.locations.repositories
Google Cloud REST Resource Documentation /dataform/docs/reference/rest/v1beta1/projects.locations.repositories
Config Connector Resource Short Names gcpdataformrepository
gcpdataformrepositories
dataformrepository
Config Connector Service Name dataform.googleapis.com
Config Connector Resource Fully Qualified Name dataformrepositories.dataform.cnrm.cloud.google.com
Can Be Referenced by IAMPolicy/IAMPolicyMember No
Config Connector Default Average Reconcile Interval In Seconds 600

Custom Resource Definition Properties

Spec

Schema

displayName: string
gitRemoteSettings:
  authenticationTokenSecretVersionRef:
    external: string
    name: string
    namespace: string
  defaultBranch: string
  sshAuthenticationConfig:
    hostPublicKey: string
    userPrivateKeySecretVersionRef:
      external: string
      name: string
      namespace: string
  url: string
npmrcEnvironmentVariablesSecretVersionRef:
  external: string
  name: string
  namespace: string
projectRef:
  external: string
  kind: string
  name: string
  namespace: string
region: string
resourceID: string
serviceAccountRef:
  external: string
  name: string
  namespace: string
setAuthenticatedUserAdmin: boolean
workspaceCompilationOverrides:
  defaultDatabase: string
  schemaSuffix: string
  tablePrefix: string
Fields

displayName

Optional

string

Optional. The repository's user-friendly name.

gitRemoteSettings

Optional

object

Optional. If set, configures this repository to be linked to a Git remote.

gitRemoteSettings.authenticationTokenSecretVersionRef

Optional

object

The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format projects/* /secrets/* /versions/*.

gitRemoteSettings.authenticationTokenSecretVersionRef.external

Optional

string

If provided must be in the format `projects/*/secrets/*/versions/*`.

gitRemoteSettings.authenticationTokenSecretVersionRef.name

Optional

string

The `name` field of a `SecretManagerSecretVersion` resource.

gitRemoteSettings.authenticationTokenSecretVersionRef.namespace

Optional

string

The `metadata.namespace` field of a `SecretManagerSecretVersion` resource.

gitRemoteSettings.defaultBranch

Required*

string

The Git remote's default branch name.

gitRemoteSettings.sshAuthenticationConfig

Optional

object

Authentication fields for remote uris using SSH protocol.

gitRemoteSettings.sshAuthenticationConfig.hostPublicKey

Required*

string

Content of a public SSH key to verify an identity of a remote Git host.

gitRemoteSettings.sshAuthenticationConfig.userPrivateKeySecretVersionRef

Required*

object

The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format projects/*/secrets/*/versions/* .

gitRemoteSettings.sshAuthenticationConfig.userPrivateKeySecretVersionRef.external

Optional

string

If provided must be in the format `projects/*/secrets/*/versions/*`.

gitRemoteSettings.sshAuthenticationConfig.userPrivateKeySecretVersionRef.name

Optional

string

The `name` field of a `SecretManagerSecretVersion` resource.

gitRemoteSettings.sshAuthenticationConfig.userPrivateKeySecretVersionRef.namespace

Optional

string

The `metadata.namespace` field of a `SecretManagerSecretVersion` resource.

gitRemoteSettings.url

Required*

string

The Git remote's URL.

npmrcEnvironmentVariablesSecretVersionRef

Optional

object

Optional. The name of the Secret Manager secret version to be used to interpolate variables into the .npmrc file for package installation operations.

npmrcEnvironmentVariablesSecretVersionRef.external

Optional

string

If provided must be in the format `projects/*/secrets/*/versions/*`.

npmrcEnvironmentVariablesSecretVersionRef.name

Optional

string

The `name` field of a `SecretManagerSecretVersion` resource.

npmrcEnvironmentVariablesSecretVersionRef.namespace

Optional

string

The `metadata.namespace` field of a `SecretManagerSecretVersion` resource.

projectRef

Required

object

The project that this resource belongs to.

projectRef.external

Optional

string

The `projectID` field of a project, when not managed by Config Connector.

projectRef.kind

Optional

string

The kind of the Project resource; optional but must be `Project` if provided.

projectRef.name

Optional

string

The `name` field of a `Project` resource.

projectRef.namespace

Optional

string

The `namespace` field of a `Project` resource.

region

Required

string

Immutable. A reference to the region.

resourceID

Optional

string

Immutable. Optional. The name of the resource. Used for creation and acquisition. When unset, the value of `metadata.name` is used as the default.

serviceAccountRef

Optional

object

Optional. The service account reference to run workflow invocations under.

serviceAccountRef.external

Optional

string

The `email` field of an `IAMServiceAccount` resource.

serviceAccountRef.name

Optional

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

serviceAccountRef.namespace

Optional

string

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

setAuthenticatedUserAdmin

Optional

boolean

Optional. Input only. If set to true, the authenticated user will be granted the roles/dataform.admin role on the created repository.

workspaceCompilationOverrides

Optional

object

Optional. If set, fields of workspaceCompilationOverrides override the default compilation settings that are specified in dataform.json when creating workspace-scoped compilation results.

workspaceCompilationOverrides.defaultDatabase

Optional

string

Optional. The default database (Google Cloud project ID).

workspaceCompilationOverrides.schemaSuffix

Optional

string

Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.

workspaceCompilationOverrides.tablePrefix

Optional

string

Optional. The prefix that should be prepended to all table names.

* Field is required when parent field is specified

Status

Schema

conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
externalRef: string
observedGeneration: integer
observedState: {}
Fields
conditions

list (object)

Conditions represent the latest available observations of the DataformRepository's current state.
conditions[]

object
conditions[].lastTransitionTime

string

Last time the condition transitioned from one status to another.
conditions[].message

string

Human-readable message indicating details about last transition.
conditions[].reason

string

Unique, one-word, CamelCase reason for the condition's last transition.
conditions[].status

string

Status is the status of the condition. Can be True, False, Unknown.
conditions[].type

string

Type is the type of the condition.
externalRef

string

A unique specifier for the DataformReposity resource in GCP.
observedGeneration

integer

ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource.
observedState

object

ObservedState is the state of the resource as most recently observed in GCP.

Sample YAML(s)

Typical Use Case

# Copyright 2024 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

apiVersion: dataform.cnrm.cloud.google.com/v1alpha1
kind: DataformRepository
metadata:
  name: dataformrepository-sample
spec:
  projectRef:
    external: ${PROJECT_ID?}
  region: us-west2