Merge pull request #2665 from GoogleCloudPlatform/acpana/dr-promo

feat: promote DataformRepository to beta

apis/dataform/v1beta1/doc.go

@@ -0,0 +1,17 @@
+// 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.
+
+// +kcc:proto=google.cloud.dataform.v1beta1
+
+package v1beta1

apis/dataform/v1beta1/groupversion_info.go

@@ -0,0 +1,40 @@
+// 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.
+
+// Package v1beta1 contains API Schema definitions for the dataform v1beta1 API group
+// +kubebuilder:object:generate=true
+// +groupName=dataform.cnrm.cloud.google.com
+package v1beta1
+
+import (
+	"k8s.io/apimachinery/pkg/runtime/schema"
+	"sigs.k8s.io/controller-runtime/pkg/scheme"
+)
+
+var (
+	// GroupVersion is group version used to register these objects
+	GroupVersion = schema.GroupVersion{Group: "dataform.cnrm.cloud.google.com", Version: "v1beta1"}
+
+	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
+	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}
+
+	// AddToScheme adds the types in this group-version to the given scheme.
+	AddToScheme = SchemeBuilder.AddToScheme
+
+	DataformRepositoryGVK = schema.GroupVersionKind{
+		Group:   GroupVersion.Group,
+		Version: GroupVersion.Version,
+		Kind:    "DataformRepository",
+	}
+)

apis/dataform/v1beta1/repository_types.go

@@ -0,0 +1,175 @@
+// 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.
+
+package v1beta1
+
+import (
+	refv1beta1 "github.com/GoogleCloudPlatform/k8s-config-connector/apis/refs/v1beta1"
+	"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/clients/generated/apis/k8s/v1alpha1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+type SSHAuthenticationConfig struct {
+	// 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/* .
+	// +required
+	UserPrivateKeySecretVersionRef *refv1beta1.SecretManagerSecretVersionRef `json:"userPrivateKeySecretVersionRef,omitempty"`
+
+	// Content of a public SSH key to verify an identity of a remote Git host.
+	// +required
+	HostPublicKey string `json:"hostPublicKey,omitempty"`
+}
+
+// +kcc:proto=google.cloud.dataform.v1beta1.Repository.GitRemoteSettings
+type RepositoryGitRemoteSettings struct {
+	/* 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/*. */
+	AuthenticationTokenSecretVersionRef *refv1beta1.SecretManagerSecretVersionRef `json:"authenticationTokenSecretVersionRef,omitempty"`
+
+	/* The Git remote's default branch name. */
+	// +required
+	DefaultBranch string `json:"defaultBranch"`
+
+	// This is a deprecated field so we are not including it anymore.
+	// +optional
+	//TokenStatus *string `json:"tokenStatus,omitempty"`
+
+	// Authentication fields for remote uris using SSH protocol.
+	// +optional
+	SSHAuthenticationConfig *SSHAuthenticationConfig `json:"sshAuthenticationConfig,omitempty"`
+
+	/* The Git remote's URL. */
+	// +required
+	Url string `json:"url"`
+}
+
+// +kcc:proto=google.cloud.dataform.v1beta1.Repository.WorkspaceCompilationOverrides
+type RepositoryWorkspaceCompilationOverrides struct {
+	/* Optional. The default database (Google Cloud project ID). */
+	// +optional
+	DefaultDatabase *string `json:"defaultDatabase,omitempty"`
+
+	/* Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names. */
+	// +optional
+	SchemaSuffix *string `json:"schemaSuffix,omitempty"`
+
+	/* Optional. The prefix that should be prepended to all table names. */
+	// +optional
+	TablePrefix *string `json:"tablePrefix,omitempty"`
+}
+
+// +kcc:proto=google.cloud.dataform.v1beta1.Repository
+type DataformRepositorySpec struct {
+	/* Optional. If set, configures this repository to be linked to a Git remote. */
+	// +optional
+	GitRemoteSettings *RepositoryGitRemoteSettings `json:"gitRemoteSettings,omitempty"`
+
+	// Optional. The repository's user-friendly name.
+	// +optional
+	DisplayName *string `json:"displayName,omitempty"`
+
+	// Optional. The name of the Secret Manager secret version to be used to
+	// interpolate variables into the .npmrc file for package installation
+	// operations.
+	// +optional
+	NpmrcEnvironmentVariablesSecretVersionRef *refv1beta1.SecretManagerSecretVersionRef `json:"npmrcEnvironmentVariablesSecretVersionRef,omitempty"`
+
+	/* The project that this resource belongs to. */
+	// +required
+	ProjectRef *refv1beta1.ProjectRef `json:"projectRef"`
+
+	/* Immutable. A reference to the region. */
+	Region string `json:"region"`
+
+	/* Immutable. Optional. The name of the resource. Used for creation and acquisition. When unset, the value of `metadata.name` is used as the default. */
+	// +optional
+	ResourceID *string `json:"resourceID,omitempty"`
+
+	// TODO(kcc): For now don't support labels while we decide on how to square resource labels with k8s labels.
+	// // Repository user labels. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
+	// // +optional
+	// Labels map[string]string `json:"labels,omitempty"`
+
+	// Optional. Input only. If set to true, the authenticated user will be granted the roles/dataform.admin role on the created repository.
+	// +optional
+	SetAuthenticatedUserAdmin bool `json:"setAuthenticatedUserAdmin,omitempty"`
+
+	/* Optional. If set, fields of workspaceCompilationOverrides override the default compilation settings that are specified in dataform.json when creating workspace-scoped compilation results. */
+	// +optional
+	WorkspaceCompilationOverrides *RepositoryWorkspaceCompilationOverrides `json:"workspaceCompilationOverrides,omitempty"`
+
+	// Not part of the proto yet
+	// // The reference to a KMS encryption key. If provided, it will be used to encrypt user data in the repository and all child resources.
+	// // It is not possible to add or update the encryption key after the repository is created.
+	// // +optional
+	// KmsKeyRef *refv1beta1.KMSCryptoKeyRef `json:"kmsKeyRef,omitempty"`
+
+	// Optional. The service account reference to run workflow invocations under.
+	ServiceAccountRef *refv1beta1.IAMServiceAccountRef `json:"serviceAccountRef,omitempty"`
+}
+
+type DataformRepositoryStatus struct {
+	/* Conditions represent the latest available observations of the
+	   DataformRepository's current state. */
+	Conditions []v1alpha1.Condition `json:"conditions,omitempty"`
+	/* 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. */
+	// +optional
+	ObservedGeneration *int64 `json:"observedGeneration,omitempty"`
+
+	// A unique specifier for the DataformReposity resource in GCP.
+	// +optional
+	ExternalRef *string `json:"externalRef,omitempty"`
+
+	// ObservedState is the state of the resource as most recently observed in GCP.
+	// +optional
+	ObservedState *DataformRepositoryObservedState `json:"observedState,omitempty"`
+}
+
+// +kcc:proto=google.cloud.dataform.v1beta1.Repository
+type DataformRepositoryObservedState struct {
+	// DataEncryptionState is output only! But not part of the proto yet.
+}
+
+// +genclient
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+// +kubebuilder:resource:categories=gcp,shortName=gcpdataformrepository;gcpdataformrepositories
+// +kubebuilder:subresource:status
+// +kubebuilder:metadata:labels="cnrm.cloud.google.com/managed-by-kcc=true";"cnrm.cloud.google.com/stability-level=alpha";"cnrm.cloud.google.com/system=true"
+// +kubebuilder:printcolumn:name="Age",JSONPath=".metadata.creationTimestamp",type="date"
+// +kubebuilder:printcolumn:name="Ready",JSONPath=".status.conditions[?(@.type=='Ready')].status",type="string",description="When 'True', the most recent reconcile of the resource succeeded"
+// +kubebuilder:printcolumn:name="Status",JSONPath=".status.conditions[?(@.type=='Ready')].reason",type="string",description="The reason for the value in 'Ready'"
+// +kubebuilder:printcolumn:name="Status Age",JSONPath=".status.conditions[?(@.type=='Ready')].lastTransitionTime",type="date",description="The last transition time for the value in 'Status'"
+
+// DataformRepository is the Schema for the dataform API
+// +k8s:openapi-gen=true
+// +kubebuilder:storageversion
+type DataformRepository struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	// +required
+	Spec   DataformRepositorySpec   `json:"spec,omitempty"`
+	Status DataformRepositoryStatus `json:"status,omitempty"`
+}
+
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+
+// DataformRepositoryList contains a list of DataformRepository
+type DataformRepositoryList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+	Items           []DataformRepository `json:"items"`
+}
+
+func init() {
+	SchemeBuilder.Register(&DataformRepository{}, &DataformRepositoryList{})
+}