KRM API alloydbomni.dbadmin.gdc.goog/v1

alloydbomni.dbadmin.gdc.goog/v1

AlInstanceSpec

Appears in: - DBClusterSpec

Field Description
version string Version of a database.
images object (keys:string, values:string) Service agent and other data plane GCR images. This is an optional map that allows a customer to specify GCR images different from those chosen/provided.
component object (keys:InstanceComponentName, values:InstanceComponentSpec) The list of instance components An instance is composed of dataplane and controlPlaneAgent components
dbLoadBalancerOptions DBLoadBalancerOptions DBNetworkServiceOptions allows to override some details of kubernetes Service created to expose a connection to database.
sourceCidrRanges string array Source IP CIDR ranges allowed for a client.
parameters object (keys:string, values:string) Parameters contains the database flags in the map format
services object (keys:Service, values:boolean) Services list the optional semi-managed services that the customers can choose from.
resources Resource Resource specification for the database container.
mode InstanceMode Mode specifies how this instance will be managed by the operator.
databasePatchingTimeout Duration Max threshold for database patching. This timeout is used independently for sts patching and OPatch/datapatch execution.
adminUser AdminUserSpec AdminUser represents the admin user specification
isStopped boolean IsStopped indicates whether instance is stopped by users
availabilityOptions AvailabilityOptions AvailabilityOptions contains adjustable settings for HA features
allowExternalIncomingTrafficToInstance boolean AllowExternalIncomingTrafficToInstance will be used to configure the external LB creation.
auditLogTarget AuditLogTargetSpec AuditLogTarget configures the sink for the database audit logs
replication ReplicationSpec Replication configures replication connections to other db instances
tls TLSSpec TLS configures encryption for connections to the database instance. Immutable.
features Features

DBCluster

DBCluster is the Schema for the dbclusters API

Appears in: - DBClusterList

Field Description
apiVersion string alloydbomni.dbadmin.gdc.goog/v1
kind string DBCluster
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec DBClusterSpec
status DBClusterStatus

DBClusterList

DBClusterList contains a list of DBCluster

Field Description
apiVersion string alloydbomni.dbadmin.gdc.goog/v1
kind string DBClusterList
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items DBCluster array

DBClusterSpec

DBClusterSpec defines the desired state of DBCluster

Appears in: - DBCluster

Field Description
primaryCluster string
isDeleted boolean Indicate if a DBCluster object is soft-deleted. The default is false.
mode string Indicate the mode of this DBCluster.
availability Availability Availability contains adjustable settings for DbCluster HA features
allowExternalIncomingTraffic boolean
tls TLSSpec TLS configures encryption for connections to the database instance. Immutable.
databaseImage string DatabaseImage is the path of the customized database image provided by users.
primarySpec AlInstanceSpec

DBClusterStatus

DBClusterStatus defines the observed state of DBCluster

Appears in: - DBCluster

Field Description
observedGeneration integer
reconciled boolean
criticalIncidents CriticalIncident array CriticalIncidents is a flat list of all active Critical Incidents.
conditions Condition array Conditions represents the latest available observations of the Entity's current state.
phase DBClusterPhase
primary PrimaryStatus
restoredFrom RestoredFrom
maintenanceStatus MaintenancePolicyStatus
upgradeScheduledAt Time UpgradeScheduledAt is a timestamp that indicates when the next upgrade is scheduled to start. If it is nil, it means there is no upcoming upgrade scheduled.
serviceAccounts object (keys:OpType, values:ServiceAccountRef) ServiceAccounts is a map of k8s service accounts created during dbcluster provision time to be used by different operations. Currently, only import is supported.
certificateReference CertificateRef CertificateReference refers to a secret and a key to look up an X.509 certificate that can be used to connect to the database.
latestFailoverStatus FailoverStatus LatestFailoverStatus represents the status of the most recently updated failover for the database cluster
migrationStatus MigrationStatus MigrationStatus represents the status of migration for the database cluster.