Spec schema
DBClusterSpec defines the desired state of DBCluster.
allowExternalIncomingTraffic: boolean
availability:
autoFailoverTriggerThreshold: integer
autoHealTriggerThreshold: integer
enableAutoFailover: boolean
enableAutoHeal: boolean
enableStandbyAsReadReplica: boolean
healthcheckPeriodSeconds: integer
numberOfStandbys: integer
connectedModeSpec:
apiKeySecret: string
clusterId: string
displayLocation: string
gcpProjectId: string
gcpZone: string
controlPlaneAgentsVersion: string
databaseImage: string
databaseVersion: string
isDeleted: boolean
mode: string
primarySpec:
adminUser:
passwordRef:
name: string
allowExternalIncomingTrafficToInstance: boolean
auditLogTarget:
syslog:
certsSecretRef:
name: string
namespace: string
host: string
availabilityOptions:
healthcheckPeriodSeconds: integer
livenessProbe: string
dbLoadBalancerOptions:
annotations: object
gcp:
loadBalancerIP: string
loadBalancerType: string
features:
googleMLExtension:
config:
vertexAIKeyRef: string
vertexAIRegion: string
enabled: boolean
memoryAgent:
enabled: boolean
isStopped: boolean
mode: string
parameters: object
resources:
cpu: integer or string
disks:
- accessModes: string
annotations: object
name: string
selector:
matchExpressions:
- key: string
operator: string
values: string
matchLabels: object
size: string
storageClass: string
volumeName:
memory: string or integer
schedulingconfig:
nodeaffinity:
preferredDuringSchedulingIgnoredDuringExecution:
preference:
matchExpressions:
- key: string
operator: string
values: string
matchFields:
- key: string
operator: string
values: string
weight: integer
requiredDuringSchedulingIgnoredDuringExecution:
nodeSelectorTerms:
matchExpressions:
- key: string
operator: string
values: string
matchFields:
- key: string
operator: string
values: string
podAffinity:
preferredDuringSchedulingIgnoredDuringExecution:
- podAffinityTerm:
labelSelector:
matchExpressions:
- key: string
operator: string
values: string
matchLabels: object
namespaceSelector:
matchExpressions:
- key: string
operator: string
values: string
matchLabels: object
namespaces: string
topologyKey: string
weight: integer
requiredDuringSchedulingIgnoredDuringExecution:
labelSelector:
matchExpressions:
- key: string
operator: string
values: string
matchLabels: object
namespaceSelector:
matchExpressions:
- key: string
operator: string
values: string
matchLabels: object
namespaces: string
topologyKey: string
podAntiAffinity:
preferredDuringSchedulingIgnoredDuringExecution:
podAffinityTerm:
labelSelector:
matchExpressions:
- key: string
operator: string
type: string
matchLabels: object
namespaceSelector:
matchExpressions:
- key: string
operator: string
values: string
matchLabels: object
namespaces: string
topologyKey: string
weight: integer
requiredDuringSchedulingIgnoredDuringExecution:
labelSelector:
matchExpressions:
- key: string
operator: string
values: string
matchLabels: object
namespaceSelector:
matchExpressions:
- key: string
operator: string
type: string
matchLabels: object
namespaces: string
topologyKey: string
tolerations:
- effect: string
key: string
operator: string
tolerationSeconds: integer
value: string
services: object
sidecarRef:
name: string
sourceCidrRanges:
tls:
certSecret:
name: string
walArchiveSetting:
archiveMode: string
location: string
tls:
certSecret:
name: string
Field TypeRequired or optional |
Description |
---|---|
allowExternalIncomingTraffic
| |
boolean Optional | N/A |
availability
| |
object Optional | Availability contains adjustable settings for DBCluster high availability (HA) features. |
availability.autoFailoverTriggerThreshold
| |
integer Optional | AutoFailoverTriggerThreshold is the number of consecutive healthcheck failures on the primary instance that triggers an automatic failover. If set to 0, then it will use the system default value. Use the EnableAutoFailover flag to disable automatic failover. |
availability.autoHealTriggerThreshold
| |
integer Optional | AutoHealTriggerThreshold is the number of consecutive healthcheck failures on the standby instance that triggers automatic healing. Use the EnableAutoHeal flag to disable automatic healing. |
availability.enableAutoFailover
| |
boolean Optional | EnableAutoFailover means this DBCluster will trigger a failover if it detects the primary instance is unhealthy and standby instance is healthy. If set to true, then automatic failover is enabled. If set to false, then autofailover isn't triggered even if the system detects that the primary instance is unhealthy. The default value is true. When it is enabled, if the system detects that the primary instance is unhealthy for the given threshold, it will trigger a failover. This feature is only applicable if this is an HA DBCluster and if the standby is healthy. |
availability.enableAutoHeal
| |
boolean Optional | EnableAutoHeal means this DBCluster will trigger an autoheal if it detects the standby instance is unhealthy. If set to true, then autoheal is enabled. If set to false, then autoheal is not triggered even if the system detects that the standby instance is unhealthy. The default value is true. When it is enabled, if the system detects that the standby instance is unhealthy for the given threshold, it triggers an autoheal. This feature is only applicable if this is an HA DBCluster. |
availability.enableStandbyAsReadReplica
| |
boolean Required | EnableStandbyAsReadReplica determine whether the standbys can accept user queries or not. If set to true, a new endpoint is created to enable read-only access to the standbys. |
availability.healthcheckPeriodSeconds
| |
integer Optional | HealthcheckPeriodSeconds is the number of seconds the healthcheck prober waits before checking the health of the primary and standby instances again and updating the status accordingly. |
availability.numberOfStandbys
| |
integer Optional | NumberOfStandbys is the number of standbys that should be created for this DBCluster. If set to any value greater than 0, then HA is enabled on the cluster and the system will create the indicated number of standby instances. The maximum allowed standby instances is 5. To check the current status of HA on this DBCluster, look at the HAReady condition under the DBCluster status. If HAReady is true, then setup has been complete and ready. If set to 0, then HA is disabled on the cluster, and deletes any existing standby instances. Any number between 0 and 5 inclusive is supported. The default value is 0. For more information, see Manage high availability in Kubernetes. |
connectedModeSpec
| |
object Optional | N/A |
connectedModeSpec.apiSecretKey
| |
string Optional | N/A |
connectedModeSpec.clusterId
| |
string Optional | N/A |
connectedModeSpec.displayLocation
| |
string Optional | N/A |
connectedModeSpec.gcpProjectId
| |
string Optional | N/A |
connectedModeSpec.gcpZone
| |
string Optional | N/A |
controlPlaneAgentsVersion
| |
string Required | ControlPlaneAgentsVersion is the desired control plane agents version for the cluster for example, "0.5.2". The controlPlaneAgentsVersion must be compatible with the chosen databaseVersion. To know what versions are compatible, check the list of available versions in {link}. This version is applied to all instances of the database cluster. In the case of a new database cluster, the instance is be created using the specified version. In the case of an existing database cluster, the operator will aptempt to upgrade or downgrade to the specified controlPlaneAgentsVersion. The field status.currentControlPlaneAgentsVersion indicates the current version for control plane agents. |
databaseImage
| |
string Optional | DatabaseImage is the Uniform Resource Identifier of a customized database image within the container registry. If databaseImage is specified, then the operator uses this container image for the database instead of the default database container image of the specified databaseVersion. We recommend that the databaseImage container is based on the default database image used of the chosen databaseVersion. |
databaseVersion
| |
string Optional | DatabaseVersion is the desired database version for the cluster for example, "15.4.5". This field is required. This version is applied to all instances of the database cluster. In the case of a new database cluster, the instance is created using the specified version. In the case of an existing database cluster, the operator aptempts to upgrade or downgrade to the specified databaseVersion. The field status.currentDatabaseVersion indicates the current database version. |
isDeleted
| |
boolean Optional | IsDeleted indicates a request to delete the DBCluster. By default, this field is false. This fields applies to all instances of the database cluster. When set this to true, the control plane will attempt to release the related resources, including network endpoints. See the status fields for indication of success or failures, if any. |
mode
| |
string Optional | Indicates the mode of this DBCluster. |
primarySpec
| |
object Required | PrimarySpec contains the specifications of the Primary instance of the database cluster. The primary instance contains the compute and storage resources serving the read-write endpoints of the database cluster. |
primarySpec.adminUser
| |
object Required | AdminUser represents the admin user specification. This is the initial database user that the control plane creates. Additional database users are managed by the end-user directly. This field can also be used to reset the password of the initial user. |
primarySpec.adminUser.passwordRef
| |
object Optional |
PasswordRef is the name of the secret containing the admin user's password. This value is used during initial provisioning or password reset to set the admin user to that password. The secret must be under the same project as the Database cluster. The name of the secret must follow this pattern: db-pw- |
primarySpec.adminUser.passwordRef.name
| |
string Optional | The name of the referent. For more information, see Names. |
primarySpec.allowExternalIncomingTrafficToInstance
| |
boolean Optional | AllowExternalIncomingTrafficToInstance is used to configure the external LB creation. |
primarySpec.AuditLogTarget
| |
object Optional | AuditLogTarget configures the sink for the database audit logs. |
primarySpec.AuditLogTarget.syslog
| |
object Optional | N/A |
primarySpec.AuditLogTarget.certsSecretRef
| |
object Required | CertsSecretRef contains the certificates to be used for the TLS connection to the syslog server. |
primarySpec.AuditLogTarget.certsSecretRef.name
| |
string Optional | name is unique within a namespace to reference a secret resource. |
primarySpec.AuditLogTarget.certsSecretRef.namespace
| |
string Optional | namespace defines the space within which the secret name must be unique. |
primarySpec.AuditLogTarget.syslog.host
| |
string Required | Host is the syslog server FQDN or the IP address. |
primarySpec.availabilityOptions
| |
object Optional | AvailabilityOptions contains adjustable settings for HA features. |
primarySpec.availabilityOptions.healthcheckPeriodSeconds
| |
integer Optional | HealthcheckPeriodSeconds is the number of seconds the healthcheck prober will wait before checking the health of the primary and standby instances again and updating the status accordingly. This field is propagated down from the DBCluster's spec. |
primarySpec.availabilityOptions.livenessProbe
| |
string Optional | LivenessProbe enables or disables the liveness probe which is used to trigger a container restart. When set to Enabled, the liveness probe runs periodic health checks on the database. It restarts the container if it fails three consecutive health checks. LivenessProbe is automatically disabled for HA instances. When set to Disabled, the liveness probe is not running health checks on the database. The default value is Enabled. |
primarySpec.availabilityOptions.livenessProbe
| |
string Optional | LivenessProbe enables or disables the liveness probe which is used to trigger a container restart. When set to Enabled, the liveness probe runs periodic health checks on the database. It restarts the container if it fails three consecutive health checks. LivenessProbe is automatically disabled for HA instances. When set to Disabled, the liveness probe is not running health checks on the database. The default value is Enabled. |
primarySpec.dbLoadBalancerOptions
| |
object Optional | DBNetworkServiceOptions allows to override some details of the Kubernetes Service that are created to expose a connection to the database. |
primarySpec.dbLoadBalancerOptions.annotations
| |
object Optional | Annotations provided by the customer are added to the service object of type loadbalancer. |
primarySpec.dbLoadBalancerOptions.gcp
| |
object Optional | Contains Google Cloud-specific attributes for the Kubernetes LoadBalancer. |
primarySpec.dbLoadBalancerOptions.gcp.loadBalancerIP
| |
string Optional | LoadBalancerIP is a static IP address. For more information, see Configure static external IP addresses. |
primarySpec.dbLoadBalancerOptions.gcp.loadBalancerType
| |
string Optional | A LoadBalancer can be internal or external. For more information, see Internal load balancer. |
primarySpec.features
| |
object Optional | Feature specification. |
primarySpec.features.googleMLExtension
| |
object Optional | Google machine learning (ML) Extension Specification. |
primarySpec.features.googleMLExtension.config
| |
object Optional | Google ML Extension Configuration. |
primarySpec.features.googleMLExtension.config.vertexAIKeyRef
| |
string Optional | N/A |
primarySpec.features.googleMLExtension.config.vertexAIRegion
| |
string Optional | N/A |
primarySpec.features.googleMLExtension.enabled
| |
boolean Required | N/A |
primarySpec.features.memoryAgent
| |
object Optional | N/A |
primarySpec.features.memoryAgent.enabled
| |
boolean Required | Indicate interest to enable or disable memory agent for the database. The default is true. |
primarySpec.features.memoryAgent.enabled
| |
boolean Required | Indicate interest to enable or disable memory agent for the database. The default is true. |
primarySpec.isStopped
| |
boolean Optional | IsStopped stops the instance when set to true. By default, this field is set to false. When stopped, the compute resources (CPU, memory) of the instance are released. However, the instance keeps the storage resource and network endpoints so that restarting is transparent to the downstream services. See the status field for success or failures, if any. |
primarySpec.mode
| |
string Optional | Mode specifies how this instance is managed by the operator. |
primarySpec.parameters
| |
object Optional | Parameters allows to set database parameters for the database cluster. Parameters take a key/value pair corresponding to the parameter name/value as defined by the database engine. |
primarySpec.resources
| |
object Required | Resource specification for the database container. When any of the fields inside the resource changes, the operator restarts the database instance with the new resource specification. |
primarySpec.resources.cpu
| |
integer or string Required | The amount of CPU allocated to the database container. |
primarySpec.resources.disks
| |
object Required | The specifications of the disks allocated to the database container. |
primarySpec.resources.disks.accessModes
| |
string Optional | AccessModes contains the desired access modes for the volume. For more information, see Access Modes. |
primarySpec.resources.disks.annotations
| |
object Optional | Additional annotations added to the Persistent Volume Claim. This field lets you integrate with other tools. |
primarySpec.resources.disks.name
| |
string Required | Name of the disk. The allowed values are: DataDisk, LogDisk, BackupDisk, and ObsDisk. |
primarySpec.resources.disks.selector
| |
object Optional | A label query over volumes to consider for binding. If this field is set, then the volume with matching labels is used as the backing volume for the disk. For more information, see PersistentVolumeClaimSpec. |
primarySpec.resources.disks.selector.matchExpressions
| |
object Optional | matchExpressions is a list of label selector requirements. The requirements are ANDed. |
primarySpec.resources.disks.selector.matchExpressions.key
| |
string Required | key is the label key that the selector applies to. |
primarySpec.resources.disks.selector.matchExpressions.operator
| |
string Required | operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, and DoesNotExist. |
primarySpec.resources.disks.selector.matchExpressions.values
| |
string Optional | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
primarySpec.resources.disks.selector.matchLabels
| |
object Optional | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
primarySpec.resources.disks.size
| |
string Required | Disk size in bytes for example, "10Gi" for 10 Gibibytes. This field is required. The allowed size unit prefixes are: "Ki", "Mi", "Gi", "Ti, "Pi" and "Ei" for 2-base. Also "K", "M", "G", "T, "P" and "E" for 10-base. For more information, see Unit prefix. |
primarySpec.resources.disks.storageClass
| |
string Optional | StorageClass points to a particular CSI storage class. This field is optional. If the field is not set, then the default CSI storage class for the Kubernetes cluster is used. If there is no default for the Kubernetes cluster, then the Persistence Volume Claim will fail and the database cluster will fail to provision. For more information, see Storage Classes. |
primarySpec.resources.disks.volumeName
| |
string Optional | VolumeName is the binding reference to the Persistent Volume tied to this disk. This field is optional. This allows to reuse an existing volume. Note that if this field is specified, the value "storageClass" will not take effect. For more information, see Binding. |
primarySpec.resources.memory
| |
string or integer Required | The amount of memory allocated to the database container. |
primarySpec.resources.memory
| |
string or integer Required | The amount of memory allocated to the database container. |
primarySpec.schedulingConfig
| |
object Optional | SchedulingConfig specifies how the instance should be scheduled on Kubernetes nodes. When any field inside the scheduling config changes, it can lead to rescheduling of the Kubernetes pod onto a different node based on the config. |
primarySpec.schedulingConfig.nodeAffinity
| |
object Optional | NodeAffinity describes node affinity scheduling rules for the instance. |
primarySpec.schedulingConfig.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution
| |
object Optional | The scheduler prefers to schedule pods to nodes that satisfy the affinity expressions specified by this field, but the scheduler might choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, which means that for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum, if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. |
primarySpec.schedulingConfig.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference
| |
object Required | A node selector term, associated with the corresponding weight. |
primarySpec.schedulingConfig.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions
| |
object Optional | A list of node selector requirements by the node's labels. |
primarySpec.schedulingConfig.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.key
| |
string Required | The label key that the selector applies to. |
primarySpec.schedulingConfig.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.operator
| |
string Required | Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
primarySpec.schedulingConfig.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.values
| |
string Optional | An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |
primarySpec.schedulingConfig.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields
| |
object Optional | A list of node selector requirements by the node's fields. |
primarySpec.schedulingConfig.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.key
| |
string Required | The label key that the selector applies to. |
primarySpec.schedulingConfig.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.operator
| |
string Required | Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
primarySpec.schedulingConfig.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.values
| |
string Optional | An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which is interpreted as an integer. This array is replaced during a strategic merge patch. |
primarySpec.schedulingConfig.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.weight
| |
integer Required | Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. |
primarySpec.schedulingConfig.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution
| |
object Optional | If the affinity requirements specified by this field isn't met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field aren't met at some point during pod execution, for example due to an update, the system might or might not try to eventually evict the pod from its node. |
primarySpec.schedulingConfig.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms
| |
object Required | A list of node selector terms. The terms are ORed. |
primarySpec.schedulingConfig.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions
| |
object Optional | A list of node selector requirements by the node's labels. |
primarySpec.schedulingConfig.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.key
| |
string Required | The label key that the selector applies to. |
primarySpec.schedulingConfig.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.operator
| |
string Required | Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
primarySpec.schedulingConfig.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.values
| |
string Optional | An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which is interpreted as an integer. This array is replaced during a strategic merge patch. |
primarySpec.schedulingConfig.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields
| |
object Optional | A list of node selector requirements by the node's fields. |
primarySpec.schedulingConfig.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.key
| |
string Required | The label key that the selector applies to. |
primarySpec.schedulingConfig.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.operator
| |
string Required | Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
primarySpec.schedulingConfig.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.values
| |
string Optional | An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which is interpreted as an integer. This array is replaced during a strategic merge patch. |
primarySpec.schedulingConfig.podAffinity
| |
object Optional | PodAffinity describes pod affinity scheduling rules for the instance. |
primarySpec.schedulingConfig.podAffinity.preferredDuringSchedulingIgnoredDuringExecution
| |
object Optional | The scheduler will prioritize nodes that meet the affinity expressions specified in this field when scheduling pods. The scheduler might still choose a node that doesn't fully meet the criteria. The most preferred node is the one with the highest total weight. This weight is calculated by adding up values for each node that satisfies all scheduling requirements (such as resource requests or requiredDuringScheduling affinity expressions). For each matching podAffinityTerm, the node's weight increases, and the node(s) with the highest total weight are selected as the most preferred. |
primarySpec.schedulingConfig.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm
| |
object Required | A pod affinity term, associated with the corresponding weight. |
primarySpec.schedulingConfig.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector
| |
object Optional | A label query over a set of resources, in this case, pods. |
primarySpec.schedulingConfig.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions
| |
object Optional | matchExpressions is a list of label selector requirements. The requirements are ANDed. |
primarySpec.schedulingConfig.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.key
| |
string Required | key is the label key that the selector applies to. |
primarySpec.schedulingConfig.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.operator
| |
string Required | operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
primarySpec.schedulingConfig.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.values
| |
string Optional | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
primarySpec.schedulingConfig.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchLabels
| |
object Optional | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
primarySpec.schedulingConfig.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector
| |
object Optional | A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. |
primarySpec.schedulingConfig.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions
| |
object Optional | matchExpressions is a list of label selector requirements. The requirements are ANDed. |
primarySpec.schedulingConfig.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.key
| |
string Required | key is the label key that the selector applies to. |
primarySpec.schedulingConfig.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.operator
| |
string Required | operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
primarySpec.schedulingConfig.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.values
| |
string Optional | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
primarySpec.schedulingConfig.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchLabels
| |
object Optional | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
primarySpec.schedulingConfig.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaces
| |
string Optional | namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". |
primarySpec.schedulingConfig.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.topologyKey
| |
string Required | This pod must be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces. Co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. |
primarySpec.schedulingConfig.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.weight
| |
integer Required | weight associated with matching the corresponding podAffinityTerm, in the range 1-100. |
primarySpec.schedulingConfig.podAffinity.requiredDuringSchedulingIgnoredDuringExecution
| |
object Optional | If the affinity requirements specified by this field isn't met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field aren't met at some point during pod execution - for example, due to a pod label update - the system might or might not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, which means that all terms must be satisfied. |
primarySpec.schedulingConfig.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector
| |
object Optional | A label query over a set of resources, in this case, pods. |
primarySpec.schedulingConfig.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector
| |
object Optional | A label query over a set of resources, in this case, pods. |
primarySpec.schedulingConfig.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions
| |
object Optional | matchExpressions is a list of label selector requirements. The requirements are ANDed. |
primarySpec.schedulingConfig.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.key
| |
string Required | key is the label key that the selector applies to. |
primarySpec.schedulingConfig.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.operator
| |
string Required | operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
primarySpec.schedulingConfig.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.values
| |
string Optional | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
primarySpec.schedulingConfig.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchLabels
| |
object Optional | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
primarySpec.schedulingConfig.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector
| |
object Optional | A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. |
primarySpec.schedulingConfig.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions
| |
object Optional | matchExpressions is a list of label selector requirements. The requirements are ANDed. |
primarySpec.schedulingConfig.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.key
| |
string Required | key is the label key that the selector applies to. |
primarySpec.schedulingConfig.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.operator
| |
string Required | operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, and DoesNotExist. |
primarySpec.schedulingConfig.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.values
| |
string Optional | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
primarySpec.schedulingConfig.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchLabels
| |
object Optional | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
primarySpec.schedulingConfig.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchLabels
| |
object Optional | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
primarySpec.schedulingConfig.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaces
| |
string Optional | namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". |
primarySpec.schedulingConfig.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.topologyKey
| |
string Required | This pod must be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces. Co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. |
primarySpec.schedulingConfig.podAntiAffinity
| |
object Optional | PodAntiAffinity describes pod anti-affinity scheduling rules for the instance. |
primarySpec.schedulingConfig.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution
| |
object Optional | The scheduler prefers to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but the scheduler might choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, in other words, for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum, if the node has pods which matches the corresponding podAffinityTerm. The node(s) with the highest sum are the most preferred. |
primarySpec.schedulingConfig.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm
| |
object Required | A pod affinity term, associated with the corresponding weight. |
primarySpec.schedulingConfig.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector
| |
object Optional | A label query over a set of resources, in this case, pods. |
primarySpec.schedulingConfig.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions
| |
object Optional | matchExpressions is a list of label selector requirements. The requirements are ANDed. |
primarySpec.schedulingConfig.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.key
| |
string Required | key is the label key that the selector applies to. |
primarySpec.schedulingConfig.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.operator
| |
string Required | operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
primarySpec.schedulingConfig.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.values
| |
string Optional | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
primarySpec.schedulingConfig.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchLabels
| |
object Optional | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
primarySpec.schedulingConfig.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector
| |
object Optional | A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. |
primarySpec.schedulingConfig.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions
| |
object Optional | matchExpressions is a list of label selector requirements. The requirements are ANDed. |
primarySpec.schedulingConfig.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.key
| |
string Required | key is the label key that the selector applies to. |
primarySpec.schedulingConfig.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.operator
| |
string Required | operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
primarySpec.schedulingConfig.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.values
| |
string Optional | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
primarySpec.schedulingConfig.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchLabels
| |
object Optional | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
primarySpec.schedulingConfig.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaces
| |
string Optional | namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". |
primarySpec.schedulingConfig.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.topologyKey
| |
string Required | This pod must be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces. Co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. |
primarySpec.schedulingConfig.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.weight
| |
integer Required | weight associated with matching the corresponding podAffinityTerm, in the range 1-100. |
primarySpec.schedulingConfig.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution
| |
object Optional | If the anti-affinity requirements specified by this field isn't met at scheduling time, the pod is not scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (for example, due to a pod label update), the system might or might not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, which means that all terms must be satisfied. |
primarySpec.schedulingConfig.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector
| |
object Optional | A label query over a set of resources, in this case, pods. |
primarySpec.schedulingConfig.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions
| |
object Optional | matchExpressions is a list of label selector requirements. The requirements are ANDed. |
primarySpec.schedulingConfig.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.key
| |
string Required | key is the label key that the selector applies to. |
primarySpec.schedulingConfig.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.operator
| |
string Required | operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, and DoesNotExist. |
primarySpec.schedulingConfig.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.values
| |
string Optional | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
primarySpec.schedulingConfig.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchLabels
| |
object Optional | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
primarySpec.schedulingConfig.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector
| |
object Optional | A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. |
primarySpec.schedulingConfig.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions
| |
object Optional | matchExpressions is a list of label selector requirements. The requirements are ANDed. |
primarySpec.schedulingConfig.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.key
| |
string Required | key is the label key that the selector applies to. |
primarySpec.schedulingConfig.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.operator
| |
string Required | operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, and DoesNotExist. |
primarySpec.schedulingConfig.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.values
| |
string Optional | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
primarySpec.schedulingConfig.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchLabels
| |
object Optional | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
primarySpec.schedulingConfig.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaces
| |
string Optional | namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". |
primarySpec.schedulingConfig.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.topologyKey
| |
string Required | This pod must be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces. Co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. |
primarySpec.schedulingConfig.tolerations
| |
object Optional | Tolerations enable the management of whether to allow or disallow scheduling an instance on a Kubernetes node that has a specific taint applied. |
primarySpec.schedulingConfig.tolerations.effect
| |
string Optional | Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. |
primarySpec.schedulingConfig.tolerations.key
| |
string Optional | Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists. This combination means to match all values and all keys. |
primarySpec.schedulingConfig.tolerations.operator
| |
string Optional | Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. |
primarySpec.schedulingConfig.tolerations.tolerationSeconds
| |
integer Optional | TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, this field isn't set, which means tolerate the taint forever (do not evict). Zero and negative values are treated as 0 (evict immediately) by the system. |
primarySpec.schedulingConfig.tolerations.value
| |
string Optional | Value is the taint value the toleration matches to. If the operator is Exists, the value must be empty; otherwise, it must be a regular string. |
primarySpec.services
| |
object Optional | Services list the optional semi-managed services that you can choose from. |
primarySpec.sidecarRef
| |
object Optional | SidecarRef is a reference to a sidecar Custom Resource. If set, sidecar containers included in the sidecar Custom Resource are injected into the database pod. |
primarySpec.sidecarRef.name
| |
string Optional | Name of the referent. For more information, see Names. |
primarySpec.sourceCidrRanges
| |
string Optional | Source IP CIDR ranges allowed for a client. |
primarySpec.tls
| |
object Optional | TLS is the desired server certificate configuration for the instance. This field is optional. When this field is changed, the instance pods restart to load the specified certificate. |
primarySpec.tls.certSecret
| |
object Optional | CertSecret contains the name of a certificate secret within the same namespace. The secret must contain entries ca.crt (CA certificate), tls.key (server private key), and tls.crt (server leaf certificate). This secret is used to set the TLS config for the database instance. |
primarySpec.tls.certSecret.name
| |
string Optional | Name of the referent. For more information, see Names |
primarySpec.walArchiveSetting
| |
object Optional | WalArchiveSetting specifies wal archive settings. If set, archive_mode is enabled to archive wal logs to specified location. For more information, see Continuous Archiving and Point-in-Time Recovery (PITR). |
primarySpec.walArchiveSetting.archiveMode
| |
string Optional | ArchiveMode specifies archive_mode. For more information, see archive_mode. |
primarySpec.walArchiveSetting.location
| |
string Optional | Location is the location where archived WAL logs are stored. |
tls
| |
object Optional | TLS is the desired server certificate configuration for the cluster.By default, this field is empty and a new self-signed CA and leaf certificate are generated for the cluster. When this field is changed, the database cluster pods will restart to load the specified certificate. The field status.certificateReference indicates the current CA certificate secret and key. |
tls.certSecret
| |
object Optional | CertSecret references the certificate secret within the same namespace. The secret must contain entries ca.crt (CA certificate), tls.key (server private key), and tls.crt (server leaf certificate). This secret is used to set the TLS config for the database instances that a part of the database cluster. |
tls.certSecret.name
| |
string Optional | Name of the referent. For more information, see Names |
Status schema
DBClusterStatus defines the observed state of DBCluster.
healthCheck:
isRegistered: boolean
lastHealthCheckTime: string
certificateReference:
certificateKey: string
secretRef:
name: string
namespace: string
conditions:
- lastTransitionTime: string
message: string
observedGeneration: integer
reason: string
status: string
type: string
criticalIncidents:
- code: string
createTime: string
message: string
messageTemplateParams: object
resource:
component: string
location:
cluster: string
group: string
kind: string
name: string
namespace: string
version: string
stackTrace:
- component: string
message: string
transientUntil: string
latestFailoverStatus:
failoverName: string
status:
conditions:
- lastTransitionTime: string
message: string
observedGeneration: integer
reason: string
status: string
type: string
createTime: string
criticalIncidents:
- code: string
createTime: string
message: string
messageTemplateParams: object
resource:
component: string
location:
cluster: string
group: string
kind: string
name: string
namespace: string
version: string
stackTrace:
- component: string
message: string
transientUntil: string
endTime: string
internal:
newPrimary: string
oldPrimary: string
phase: string
observedGeneration: integer
reconciled: boolean
startTime: string
state: string
observedGeneration: integer
phase: string
primary:
allocatedResources:
cpu: integer or string
disks:
accessModes: string
annotations: string
name: string
selector:
matchExpressions:
- key: string
operator: string
values: string
matchLabels: object
size: string
storageClass: string
volumeName: string
memory: integer or string
conditions:
- lastTransitionTime: string
message: string
observedGeneration: integer
reason: string
status: string
type: string
currentControlPlaneAgentsVersion: string
currentDatabaseImage: string
currentDatabaseVersion: string
currentParameters: object
endpoint: string
endpoints:
- name: string
value: string
latestExport:
creationTimeStamp: string
exportName: string
spec:
dbclusterRef: string
exportLocation:
gcsOptions:
bucket: string
key: string
secretRef:
name: string
namespace: string
type: string
status:
completeTime: string
conditions:
- lastTransitionTime: string
message: string
observedGeneration: integer
reason: string
status: string
type: string
criticalIncidents:
- code: string
createTime: string
message: string
messageTemplateParams: object
resource:
component: string
location:
cluster: string
group: string
kind: string
name: string
namespace: string
version: string
stackTrace:
- component: string
message: string
transientUntil: string
exportSubDirectory: string
observedGeneration: integer
phase: string
reconciled: boolean
startTime: string
latestImport:
creationTimeStamp: string
importName: string
spec:
databaseName: string
dbclusterRef: string
downloadOnly: boolean
dumpStorage:
gcsOptions:
bucket: string
key: string
secretRef:
name: string
namespace: string
type: string
logStorage:
gcsOptions:
bucket: string
key: string
secretRef:
name: string
namespace: string
type: string
status:
completeTime: string
conditions:
- lastTransitionTime: string
message: string
observedGeneration: integer
reason: string
status: string
type: string
criticalIncidents:
- code: string
createTime: string
message: string
messageTemplateParams: object
resource:
component: string
location:
cluster: string
group: string
kind: string
name: string
namespace: string
version: string
stackTrace:
- component: string
message: string
transientUntil: string
dumpPath: string
observedGeneration: integer
phase: string
reconciled: boolean
startTime: string
phase: string
url: string
walArchiveSetting:
location: string
reconciled: boolean
registrationStatus:
IsHA: boolean
IsRegistered: boolean
RegistrationTime: string
restoredFrom:
restoredTime: string
sourceDBCluster: object
serviceAccounts: string
Field TypeRequired or optional |
Description |
---|---|
healthCheck
| |
object Optional | HealthStatus represents the health check. |
healthCheck.isRegistered
| |
boolean Optional | N/A |
healthCheck.lastHealthCheckTime
| |
string Optional | N/A |
certificateReference
| |
object Optional | CertificateReference refers to a secret and a key of the server CA certificate that can be used to connect to the database. If spec.TLS is provided, this value should refer to the same secret after the database has been configured to use the provided server certificate. |
certificateReference.certificateKey
| |
string Optional | CertificateKey is the key used to search the secret for the Certificate. |
certificateReference.secretRef
| |
object Optional | SecretRef is a reference to the secret that contains the Certificate. |
certificateReference.secretRef.name
| |
string Optional | name is unique within a namespace to reference a secret resource. |
certificateReference.secretRef.namespace
| |
string Optional | namespace defines the space within which the secret name must be unique. |
conditions
| |
list (object) Optional | Conditions represents the latest available observations of the Entity's current state. |
conditions[]
| |
object Optional | Conditions contains details for one aspect of the current state of this API Resource. |
conditions[].lastTransitionTime
| |
string Required | lastTransitionTime is the last time the condition transitioned from one status to another, which occurs when the underlying condition changed. If the time when the underlying condition changed is unknown, use the time when the API field changed. |
conditions[].message
| |
string Required | message is a human readable message indicating details about the transition. This can be an empty string. |
conditions[].observedGeneration
| |
integer Optional | observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is 12 and the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. |
conditions[].reason
| |
string Required | reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types can define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value must be a CamelCase string. This field might not be empty. |
conditions[].status
| |
string Required | The status of the condition, one of True, False, Unknown. |
conditions[].type
| |
string Required | The type of condition in CamelCase or in foo.example.com/CamelCase. Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regular expression that it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt). |
criticalIncidents
| |
object Optional | CriticalIncidents is a flat list of all active Critical Incidents. |
criticalIncidents[]
| |
object Optional | CriticalIncident contains all information about an ongoing critical incident. |
criticalIncidents[].code
| |
string Required | Code is the error code of this particular error. Error codes are DBSE+numeric strings, like "DBSE1012". |
criticalIncidents[].createTime
| |
string Required | CreateTime is the timestamp when this Incident was created at the origin. |
criticalIncidents[].message
| |
string Optional | Message describes the incident or error that occurred. |
criticalIncidents[].messageTemplateParams
| |
object Optional | MessageTemplateParams contains key-value pairs necessary for generating a user-friendly data-driven version of Message in the user interface. |
criticalIncidents[].resource
| |
object Required | Resource contains information about the Database Service component that reported the incident, as well as information about the Kubernetes resource. |
criticalIncidents[].resource.component
| |
string Required | Component is an internal identifier of the Database Service subsystem that reported the incident. |
criticalIncidents[].resource.location
| |
object Optional | Location |
criticalIncidents[].resource.location.cluster
| |
string Optional | Cluster is the name of the cluster of the affected Kubernetes resource. |
criticalIncidents[].resource.location.group
| |
string Optional | Group is the Group name of the Kubernetes resource. |
criticalIncidents[].resource.location.kind
| |
string Optional | Kind is the Kind of the Kubernetes resource. |
criticalIncidents[].resource.location.name
| |
string Optional | Name is the name of the affected Kubernetes resource. |
criticalIncidents[].resource.location.namespace
| |
string Optional | Namespace is the namespace of the affected Kubernetes resource. |
criticalIncidents[].resource.location.version
| |
string Optional | Group is the Version of the Kubernetes resource. |
criticalIncidents[].stackTrace
| |
object Optional | StackTrace contains an unstructured list of messages from the stack trace. |
criticalIncidents[].stackTrace.component
| |
string Optional | Component is the name of a Database Service component that logged the message. |
criticalIncidents[].stackTrace.message
| |
string Optional | Logged message. |
criticalIncidents[].transientUntil
| |
string Optional | TransientUntil, if present, indicates that the issue must be considered transient until the specified time. |
criticalIncidents[].transientUntil
| |
string Optional | TransientUntil, if present, indicates that the issue must be considered transient until the specified time. |
latestFailoverStatus
| |
object Optional | LatestFailoverStatus is the status of the most recently updated failover for the database cluster This status is a copy of the status of the current or most recently updated failover operation for the database cluster. This can be used to conveniently monitor the status of a currently running failover operation. |
latestFailoverStatus.failoverName
| |
string Optional | FailoverName is the Name of the latest failover. |
latestFailoverStatus.status
| |
object Optional | Status represents status of the latest failover for the database cluster. |
latestFailoverStatus.status.conditions
| |
object Optional | Conditions represents the latest available observations of the Entity's current state. |
latestFailoverStatus.status.conditions.lastTransitionTime
| |
string Required | lastTransitionTime is the last time the condition transitioned from one status to another, which occurs when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. |
latestFailoverStatus.status.conditions.message
| |
string Required | message is a human readable message indicating details about the transition. This may be an empty string. |
latestFailoverStatus.status.conditions.observedGeneration
| |
integer Optional | observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. |
latestFailoverStatus.status.conditions.reason
| |
string Required | reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types can define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty. |
latestFailoverStatus.status.conditions.status
| |
string Required | The status of the condition, one of True, False, Unknown. |
latestFailoverStatus.status.conditions.type
| |
string Required | The type of condition in CamelCase or in foo.example.com/CamelCase. Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regular expression that it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt). |
latestFailoverStatus.status.createTime
| |
string Optional | CreateTime is the time when the internal failover workflow mechanism was created. |
latestFailoverStatus.status.criticalIncidents
| |
object Optional | CriticalIncidents is a flat list of all active Critical Incidents. |
latestFailoverStatus.status.criticalIncidents.code
| |
string Required | Code is the error code of this particular error. Error codes are DBSE+numeric strings, like "DBSE1012". |
latestFailoverStatus.status.criticalIncidents.createTime
| |
string Required | CreateTime is the timestamp when this Incident was created at the origin. |
latestFailoverStatus.status.criticalIncidents.message
| |
string Optional | Message describes the incident or error that occurred. |
latestFailoverStatus.status.criticalIncidents.messageTemplateParams
| |
object Optional | MessageTemplateParams contains key-value pairs necessary for generating a user-friendly data-driven version of Message in the user interface. |
latestFailoverStatus.status.criticalIncidents.resource
| |
object Required | Resource contains information about the Database Service component that reported the incident as well as information about the Kubernetes resource. |
latestFailoverStatus.status.criticalIncidents.resource.component
| |
string Required | Component is an internal identifier of the Database Service subsystem that reported the incident. |
latestFailoverStatus.status.criticalIncidents.resource.location
| |
object Optional | Location |
latestFailoverStatus.status.criticalIncidents.resource.location.cluster
| |
string Optional | Cluster is the name of the cluster of the affected Kubernetes resource. |
latestFailoverStatus.status.criticalIncidents.resource.location.group
| |
string Optional | Group is the Group name of the Kubernetes resource. |
latestFailoverStatus.status.criticalIncidents.resource.location.kind
| |
string Optional | Kind is the Kind of the Kubernetes resource. |
latestFailoverStatus.status.criticalIncidents.resource.location.name
| |
string Optional | Name is the name of the affected Kubernetes resource. |
latestFailoverStatus.status.criticalIncidents.resource.location.namespace
| |
string Optional | Namespace is the namespace of the affected Kubernetes resource. |
latestFailoverStatus.status.criticalIncidents.resource.location.version
| |
string Optional | Group is the Version of the k8s resource. |
latestFailoverStatus.status.criticalIncidents.stackTrace
| |
object Optional | StackTrace contains an unstructured list of messages from the stack trace. |
latestFailoverStatus.status.criticalIncidents.stackTrace.component
| |
string Optional | Component is the name of a Database Service component that logged the message. |
latestFailoverStatus.status.criticalIncidents.stackTrace.message
| |
string Optional | Logged message. |
latestFailoverStatus.status.criticalIncidents.transientUntil
| |
string Optional | TransientUntil, if present, indicates that the issue must be considered transient until the specified time. |
latestFailoverStatus.status.endTime
| |
string Optional | EndTime is the time failover reached its final state. |
latestFailoverStatus.status.internal
| |
object Optional | Internal is used by the system controllers. Do not depend on the information in this section. |
latestFailoverStatus.status.internal.newPrimary
| |
string Required | NewPrimary is the instance that you're attempting to failover to. |
latestFailoverStatus.status.internal.oldPrimary
| |
string Required | OldPrimary is the instance that was the primary at the start of the failover. |
latestFailoverStatus.status.internal.phase
| |
string Optional | Phase is used to keep track of the current state of the failover. |
latestFailoverStatus.status.observedGeneration
| |
integer Optional | The generation observed by the controller. |
latestFailoverStatus.status.reconciled
| |
boolean Optional | Whether the resource was reconciled by the controller. |
latestFailoverStatus.status.startTime
| |
string Optional | StartTime is the time that the failover operation started. |
latestFailoverStatus.status.state
| |
string Optional |
State is the current state of the failover operation. The values are InProgress, Success, Failed_RollbackInProgress, Failed_RollbackSuccess, and Failed_RollbackFailed.
|
observedGeneration
| |
integer Optional | Internal: The generation observed by the controller. |
phase
| |
string Optional | N/A |
primary
| |
object Optional | Primary contains the status of the primary Instance. |
primary.allocatedResources
| |
object Optional | AllocatedResources represents the current configuration of memory, CPU, and disks. |
primary.allocatedResources.cpu
| |
integer or string Required | The amount of CPU allocated to the database container. |
primary.allocatedResources.disks
| |
object Required | The specifications of the disks allocated to the database container. |
primary.allocatedResources.disks.accessModes
| |
string Optional | AccessModes contains the desired access modes for the volume. For more information, see Access Modes. |
primary.allocatedResources.disks.annotations
| |
object Optional | Additional annotations added to the Persistent Volume Claim. This allows integration with other tools. |
primary.allocatedResources.disks.name
| |
string Required | Name of the disk. This field is required. The allowed values are: "DataDisk", "LogDisk" , "BackupDisk" and "ObsDisk". |
primary.allocatedResources.disks.selector
| |
object Optional | A label query over volumes to consider for binding. If this field is set, then the volume with matching labels is used as the backing volume for the disk. For more information, see PersistentVolumeClaimSpec |
primary.allocatedResources.disks.selector
| |
object Optional | A label query over volumes to consider for binding. If this field is set, then the volume with matching labels is used as the backing volume for the disk. For more information, see PersistentVolumeClaimSpec. |
primary.allocatedResources.disks.selector.matchExpressions
| |
object Optional | matchExpressions is a list of label selector requirements. The requirements are ANDed. |
primary.allocatedResources.disks.selector.matchExpressions.operator
| |
string Required | operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, and DoesNotExist. |
primary.allocatedResources.disks.selector.matchExpressions.values
| |
string Optional | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
primary.allocatedResources.disks.selector.matchlabels
| |
object Optional | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
primary.allocatedResources.disks.selector.matchlabels
| |
object Optional | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
primary.allocatedResources.disks.size
| |
string Required | Disk size in bytes for example, "10Gi" for 10 Gibibytes. This field is required. The allowed size unit prefixes are: "Ki", "Mi", "Gi", "Ti, "Pi" and "Ei" for 2-base. Also "K", "M", "G", "T, "P" and "E" for 10-base. For more information, see Unit prefix. |
primary.allocatedResources.disks.storageClass
| |
string Optional | StorageClass points to a particular CSI storage class. This field is optional. If the field is not set, then the default CSI storage class for the Kubernetes cluster is used. If there is no default for the Kubernetes cluster, then the Persistence Volume Claim will fail and the database cluster will fail to provision. For more information, see Storage Classes. |
primary.allocatedResources.disks.volumeName
| |
string Optional | VolumeName is the binding reference to the Persistent Volume tied to this disk. This field is optional. This allows to reuse an existing volume. Note that if this field is specified, the value "storageClass" will not take effect. For more information, see Binding. |
primary.allocatedResources.memory
| |
string or integer Required | The amount of memory allocated to the database container. |
primary.allocatedResources.memory
| |
string or integer Required | The amount of memory allocated to the database container. |
primary.conditions
| |
object Required | Conditions represents the latest available observations of the Instance's current state. |
primary.conditions.lastTransitionTime
| |
string Required | lastTransitionTime is the last time the condition transitioned from one status to another, which occurs when the underlying condition changed. If the time when the underlying condition changed is unknown, you can use the time when the API field changed. |
primary.conditions.message
| |
string Required | message is a human readable message indicating details about the transition. This can be an empty string. |
primary.conditions.observedGeneration
| |
integer Optional | observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is 12 but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. |
primary.conditions.reason
| |
string Required | reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types can define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field might not be empty. |
primary.conditions.status
| |
string Required | The status of the condition, one of True, False, Unknown. |
primary.conditions.type
| |
string Required | The type of condition in CamelCase or in foo.example.com/CamelCase. Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regular expression that it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt). |
primary.currentControlPlaneAgentsVersion
| |
string Optional | CurrentControlPlaneAgentsVersion is the control plane agents version that the primary instance is running. This value must match the value of spec.controlPlaneAgentsVersion after the primary instance is provisioned or the upgrade or downgrade completes successfully. |
primary.currentDatabaseImage
| |
string Optional | CurrentDatabaseImage is the customized database image that the primary instance is using. This value must match the value of spec.databaseImage after the primary instance is provisioned or the upgrade or downgrade completes successfully. |
primary.currentDatabaseVersion
| |
string Optional | CurrentDatabaseVersion is the current database version that the primary instance is running. This value should match the value of spec.databaseVersion after the primary instance is provisioned or the upgrade or downgrade has concluded successfully. |
primary.currentParameters
| |
object Optional | CurrentParameters indicates the current values of the parameters. CurrentParameters allows to verify that the spec.primarySpec.parameters field has been applied to the database. Only the parameters names in spec.primarySpec.parameters will be included in this field. |
primary.endpoint
| |
string Optional | Endpoint is the address that can be used to establish database connections. Deprecated: use the Endpoints field instead. |
primary.endpoints
| |
object Optional | Endpoints contains all the endpoint through which you can access this instance. |
primary.endpoints.name
| |
string Required | Name contains the name of the endpoint. |
primary.endpoints.value
| |
string Optional | Value contains the endpoint information. |
primary.endpoints.value
| |
string Optional | Value contains the endpoint information. |
primary.latestExport
| |
object Optional | LatestExport represents the latest export for the database instance. |
primary.latestExport.creationTimeStamp
| |
string Optional | CreationTimeStamp represents the creation time of the export for the database instance. |
primary.latestExport.exportName
| |
string Optional | ExportName is the Name of the latest export. |
primary.latestExport.spec
| |
object Optional | Spec represents the spec of the export for the database instance. |
primary.latestExport.spec.dbclusterRef
| |
string Optional | DBClusterRef is the dbcluster name within the same namespace to export from. |
primary.latestExport.spec.exportLocation
| |
object Required | ExportLocation specifies a storage location for the export files. You must ensure proper write access to the storage bucket from within the Operator. |
primary.latestExport.spec.exportLocation.gcsOptions
| |
object Optional | GCSOptions is a reference to Cloud Storage-dependent options. |
primary.latestExport.spec.exportLocation.gcsOptions.bucket
| |
string Required | Bucket is a required field, for example, dbs-dump-bucket. You must ensure proper write access to the storage bucket from within the Operator. |
primary.latestExport.spec.exportLocation.gcsOptions.key
| |
string Required | The object key for the dump files, for example, ods-dump/scottschema.dmp. |
primary.latestExport.spec.exportLocation.gcsOptions.secretRef
| |
object Optional | SecretRef is a reference to the secret that stores Cloud Storage access information. |
primary.latestExport.spec.exportLocation.gcsOptions.secretRef.name
| |
string Optional | name is unique within a namespace to reference a secret resource. |
primary.latestExport.spec.exportLocation.gcsOptions.secretRef.namespace
| |
string Optional | namespace defines the space within which the secret name must be unique. |
primary.latestExport.spec.exportLocation.type
| |
string Required | The type of Repository, for example, S3 or GCS, which tells the agent which storage system or API to use. |
primary.latestExport.status
| |
object Optional | Status represents the of the latest import for the database instance. |
primary.latestExport.status.completeTime
| |
string Optional | CompleteTime is the time when the export completed. |
primary.latestExport.status.conditions
| |
object Optional | Conditions represents the latest available observations of the Entity's current state. |
primary.latestExport.status.conditions.lastTransitionTime
| |
string Required | lastTransitionTime is the last time the condition transitioned from one status to another. This must be when the underlying condition changed. If the time when the underlying condition changed is unknown, use the time when the API field changed. |
primary.latestExport.status.conditions.message
| |
string Required | message is a human readable message indicating details about the transition. This may be an empty string. |
primary.latestExport.status.conditions.observedGeneration
| |
integer Optional | observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12 and the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. |
primary.latestExport.status.conditions.reason
| |
string Required | reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value must be a CamelCase string. This field might not be empty. |
primary.latestExport.status.conditions.status
| |
string Required | The status of the condition, one of True, False, Unknown. |
primary.latestExport.status.conditions.type
| |
string Required | The type of condition in CamelCase or in foo.example.com/CamelCase. Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regular expression that it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt). |
primary.latestExport.status.criticalIncidents
| |
object Optional | CriticalIncidents is a flat list of all active Critical Incidents. |
primary.latestExport.status.criticalIncidents.code
| |
string Required | Code is the error code of this particular error. Error codes are DBSE+numeric strings, like "DBSE1012". |
primary.latestExport.status.criticalIncidents.createTime
| |
string Required | CreateTime is the timestamp when this Incident was created at the origin. |
primary.latestExport.status.criticalIncidents.message
| |
string Optional | Message describes the incident or error that occurred. |
primary.latestExport.status.criticalIncidents.messageTemplateParams
| |
object Optional | MessageTemplateParams contains key-value pairs necessary for generating a user-friendly data-driven version of Message in the user interface. |
primary.latestExport.status.criticalIncidents.resource
| |
object Required | Resource contains information about the Database Service component that reported the incident, as well as information about the Kubernetes resource. |
primary.latestExport.status.criticalIncidents.resource.component
| |
string Required | Component is an internal identifier of the Database Service subsystem that reported the incident. |
primary.latestExport.status.criticalIncidents.resource.location
| |
object Optional | Location |
primary.latestExport.status.criticalIncidents.resource.location.cluster
| |
string Optional | Cluster is the name of the cluster of the affected Kubernetes resource. |
primary.latestExport.status.criticalIncidents.resource.location.group
| |
string Optional | Group is the Group name of the Kubernetes resource. |
primary.latestExport.status.criticalIncidents.resource.location.kind
| |
string Optional | Kind is the Kind name of the Kubernetes resource. |
primary.latestExport.status.criticalIncidents.resource.location.name
| |
string Optional | Name is the name of the affected Kubernetes resource. |
primary.latestExport.status.criticalIncidents.resource.location.namespace
| |
string Optional | Namespace is the namespace of the affected Kubernetes resource. |
primary.latestExport.status.criticalIncidents.resource.location.version
| |
string Optional | Group is the Version of the Kubernetes resource. |
primary.latestExport.status.criticalIncidents.resource.location.version
| |
string Optional | Group is the Version of the Kubernetes resource. |
primary.latestExport.status.criticalIncidents.stackTrace
| |
object Optional | StackTrace contains an unstructured list of messages from the stack trace. |
primary.latestExport.status.criticalIncidents.stackTrace.component
| |
string Optional | Component is the name of a Database Service component that logged the message. |
primary.latestExport.status.criticalIncidents.stackTrace.message
| |
string Optional | Logged message. |
primary.latestExport.status.criticalIncidents.transientUntil
| |
string Optional | TransientUntil, if present, indicates that the issue must be considered transient until the specified time. |
primary.latestExport.status.exportSubDirectory
| |
string Optional | ExportSubDirectory is the subdirectory appended to ExportLocation to store exported files. |
primary.latestExport.status.observedGeneration
| |
integer Optional | ExportSubDirectory is the subdirectory appended to ExportLocation to store exported files. |
primary.latestExport.status.phase
| |
string Optional | Phase is a summary of current state of the export. |
primary.latestExport.status.reconciled
| |
boolean Optional | Internal: Whether the resource was reconciled by the controller. |
primary.latestExport.status.startTime
| |
string Optional | StartTime is the time when the export started. |
primary.latestImport
| |
object Optional | LatestImport represents the latest import for the database instance. |
primary.latestImport.creationTimeStamp
| |
string Optional | CreationTimeStamp represents the creation time of the import for the database instance. |
primary.latestImport.importName
| |
string Optional | ImportName is the Name of the latest import. |
primary.latestImport.spec
| |
object Optional | Spec represents the spec of the import for the database instance. |
primary.latestImport.spec.databaseName
| |
string Optional | DatabaseName is the database resource name within Instance to import into. |
primary.latestImport.spec.dbclusterRef
| |
string Optional | DBClusterRef is the dbcluster name within the same namespace to import into. |
primary.latestImport.spec.downloadOnly
| |
boolean Optional | DownloadOnly when set to true means dump file will be downloaded but not imported into DB. Default is false. |
primary.latestImport.spec.dumpStorage
| |
object Required | DumpStorage specifies a storage location for the import dump files. You must ensure proper read access to the storage bucket from within the Operator. |
primary.latestImport.spec.dumpStorage.gcsOptions
| |
object Optional | GCSOptions is a reference to Cloud Storage-dependent options. |
primary.latestImport.spec.dumpStorage.gcsOptions.bucket
| |
string Required | Bucket is a required field, for example, dbs-dump-bucket. You must ensure proper write access to the storage bucket from within the Operator. |
primary.latestImport.spec.dumpStorage.gcsOptions.key
| |
string Required | The object key for the dump files, for example, ods-dump/scottschema.dmp. |
primary.latestImport.spec.dumpStorage.gcsOptions.secretRef
| |
object Optional | SecretRef is a reference to the secret that stores Cloud Storage access information. |
primary.latestImport.spec.dumpStorage.gcsOptions.secretRef.name
| |
string Optional | name is unique within a namespace to reference a secret resource. |
primary.latestImport.spec.dumpStorage.gcsOptions.secretRef.namespace
| |
string Optional | namespace defines the space within which the secret name must be unique. |
primary.latestImport.spec.dumpStorage.type
| |
string Required | The type of Repository, for example, S3 or GCS, which tells the agent which storage system or API to use. |
primary.latestImport.spec.logStorage
| |
object Optional | LogStorage optionally specifies a storage location to copy import log to. You must ensure proper write access to the storage bucket from within the Operator. |
primary.latestImport.spec.logStorage.gcsOptions
| |
object Optional | GCSOptions is a reference to Cloud Storage-dependent options. |
primary.latestImport.spec.logStorage.gcsOptions.bucket
| |
string Required | Bucket is a required field, for example, dbs-dump-bucket. You must ensure proper write access to the storage bucket from within the Operator. |
primary.latestImport.spec.logStorage.gcsOptions.key
| |
string Required | Object key for the dump files. |
primary.latestImport.spec.logStorage.gcsOptions.secretRef
| |
object Optional | SecretRef is a reference to the secret that stores Cloud Storage access information. |
primary.latestImport.spec.logStorage.gcsOptions.secretRef.name
| |
string Optional | name is unique within a namespace to reference a secret resource. |
primary.latestImport.spec.logStorage.gcsOptions.secretRef.namespace
| |
string Optional | namespace defines the space within which the secret name must be unique. |
primary.latestImport.spec.logStorage.type
| |
string Required | The type of Repository that tells the agent which storage system or API to use. |
primary.latestImport.status
| |
object Optional | Status represents the of the latest import for the database instance. |
primary.latestImport.status.completeTime
| |
string Optional | CompleteTime is the time import completed. |
primary.latestImport.status.conditions
| |
object Optional | Conditions represents the latest available observations of the Entity's current state. |
primary.latestImport.status.conditions.lastTransitionTime
| |
string Required | lastTransitionTime is the last time the condition transitioned from one status to another. This must be when the underlying condition changed. If the time when the underlying condition changed is unknown, use the time when the API field changed. |
primary.latestImport.status.conditions.message
| |
string Required | message is a human readable message indicating details about the transition. This may be an empty string. |
primary.latestImport.status.conditions.observedGeneration
| |
integer Optional | observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is 12 and the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. |
primary.latestImport.status.conditions.reason
| |
string Required | reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value must be a CamelCase string. This field might not be empty. |
primary.latestImport.status.conditions.status
| |
string Required | The status of the condition, one of True, False, Unknown. |
primary.latestImport.status.conditions.type
| |
string Required | type of condition in CamelCase or in foo.example.com/CamelCase. Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regula expression that it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt). |
primary.latestImport.status.criticalIncidents
| |
object Optional | CriticalIncidents is a flat list of all active Critical Incidents. |
primary.latestImport.status.criticalIncidents.code
| |
string Required | Code is the error code of this particular error. Error codes are DBSE+numeric strings, like "DBSE1012". |
primary.latestImport.status.criticalIncidents.createTime
| |
string Required | CreateTime is the timestamp when this Incident was created at the origin. |
primary.latestImport.status.criticalIncidents.message
| |
string Optional | Message describes the incident or error that occurred. |
primary.latestImport.status.criticalIncidents.messageTemplateParams
| |
object Optional | MessageTemplateParams contains key-value pairs necessary for generating a user-friendly data-driven version of Message in the user interface. |
primary.latestImport.status.criticalIncidents.resource
| |
object Required | Resource contains information about the Database Service component that reported the incident, as well as information about the Kubernetes resource. |
primary.latestImport.status.criticalIncidents.resource.component
| |
string Required | Component is an internal identifier of the Database Service subsystem that reported the incident. |
primary.latestImport.status.criticalIncidents.resource.location
| |
object Optional | Location |
primary.latestImport.status.criticalIncidents.resource.location.cluster
| |
string Optional | Cluster is the name of the cluster of the affected Kubernetes resource. |
primary.latestImport.status.criticalIncidents.resource.location.group
| |
string Optional | Group is the Group name of the Kubernetes resource. |
primary.latestImport.status.criticalIncidents.resource.location.kind
| |
string Optional | Kind is the Kind of the Kubernetes resource. |
primary.latestImport.status.criticalIncidents.resource.location.name
| |
string Optional | Name is the name of the affected Kubernetes resource. |
primary.latestImport.status.criticalIncidents.resource.location.namespace
| |
string Optional | Namespace is the namespace of the affected Kubernetes resource. |
primary.latestImport.status.criticalIncidents.resource.location.version
| |
string Optional | Group is the Version of the Kubernetes resource. |
primary.latestImport.status.criticalIncidents.stackTrace
| |
object Optional | StackTrace contains an unstructured list of messages from the stack trace. |
primary.latestImport.status.criticalIncidents.stackTrace.component
| |
string Optional | Component is the name of a Database Service component that logged the message. |
primary.latestImport.status.criticalIncidents.stackTrace.message
| |
string Optional | Logged message. |
primary.latestImport.status.criticalIncidents.transientUntil
| |
string Optional | TransientUntil, if present, indicates that the issue must be considered transient until the specified time. |
primary.latestImport.status.dumpPath
| |
string Optional | DumpPath is the path of the downloaded dump file for download only import. |
primary.latestImport.status.observedGeneration
| |
integer Optional | Internal: The generation observed by the controller. |
primary.latestImport.status.phase
| |
string Optional | Phase is a summary of current state of the import. |
primary.latestImport.status.reconciled
| |
boolean Optional | Internal: Whether the resource was reconciled by the controller. |
primary.latestImport.status.startTime
| |
string Optional | StartTime is the time import started. |
primary.phase
| |
string Optional | Phase is a summary of current state of the Instance. |
primary.walArchiveSetting
| |
object Optional | WalArchiveSetting represents the current write-ahead log (WAL) archive settings. |
primary.walArchiveSetting.location
| |
string Optional | N/A |
reconciled
| |
boolean Optional | Internal: Whether the resource was reconciled by the controller. |
registrationStatus
| |
object Optional | RegistrationStatus represents the status of migration for the database cluster. |
registrationStatus.isHA
| |
boolean Optional | IsHA is set to true when DBClusterSpec HA Availability setting has at least 1 numberOfStandbys setup. |
registrationStatus.isRegistered
| |
boolean Optional | N/A |
registrationStatus.isRegistered
| |
string Optional | RegistrationTime represents the time when the on-premises database cluster was registered with Google Cloud. |
restoredFrom
| |
object Optional | RestoredFrom is the status showing the most recent restore source for current DBCluster. |
restoredFrom.restoredTime
| |
string Optional | Time point of the source DBCluster that this DBCluster restores from. |
restoredFrom.sourceDBCluster
| |
string Optional | The source DBCluster that this DBCluster restores from. |
restoredFrom.sourceDBCluster
| |
string Optional | The source DBCluster that this DBCluster restores from. |
serviceAccounts
| |
object Optional | ServiceAccounts contains the service accounts created by the control plane to be used by different operations. By granting permissions to these service accounts, the database can interact with other services within the Kubernetes ecosystem. For further information, including what permissions is required, refer to the documentation of each operation. |