Resource Types:

DatabaseConfig

↩ Parent

DatabaseConfig is the schema for the databaseConfigs API. A DatabaseConfig represents the desired specification and the observed status of a database config API object. A DatabaseConfig holds the db custom parameters which are consumed by the database (PostgresCluster, MySQLCluster, etc) to set custom parameters in the database.

Name Type Description Required
apiVersion string databases.dataservices.vmware.com/v1alpha1 true
kind string DatabaseConfig true
metadata object Refer to the Kubernetes API documentation for the fields of the `metadata` field. true
spec object DatabaseConfigSpec defines the desired state of the DatabaseConfig.
true
status object DatabaseConfigStatus describes the observed status of the DatabaseConfig.
false

DatabaseConfig.spec

↩ Parent

DatabaseConfigSpec defines the desired state of the DatabaseConfig.

Name Type Description Required
params map[string]string Params is a map key value pairs which correspond to valid configurable parameters for a database. For MySQL these go into one of the `mysql.cnf` files. For PostgreSQL these values go into the `postgresql.conf` file.
false

DatabaseConfig.status

↩ Parent

DatabaseConfigStatus describes the observed status of the DatabaseConfig.

Name Type Description Required
conditions []object Conditions contain the list of observed conditions of the DatabaseConfig. `ready` Indicates that the DatabaseConfig has been successfully created and is ready for use.
false

DatabaseConfig.status.conditions[index]

↩ Parent

Condition contains details for one aspect of the current state of this API Resource.

Name Type Description Required
lastTransitionTime string lastTransitionTime is the last time the condition transitioned from one status to another.

Format: date-time
true
message string message is a human readable message indicating details about the transition.
true
reason string reason contains a programmatic identifier indicating the reason for the condition's last transition.
true
status enum status of the condition, one of True, False, Unknown.

Enum: True, False, Unknown
true
type string type of condition in CamelCase
true
observedGeneration integer 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.

Format: int64
Minimum: 0
false

MySQLCluster

↩ Parent

MySQLCluster is the schema for the mysqlclusters API. A MySQLCluster represents the desired specification and the observed status of a MySQLCluster instance. A MySQLCluster is backed by one or more nodes containing the mysql service and supporting services managed as a single object by the Data Services Manager.

Name Type Description Required
apiVersion string databases.dataservices.vmware.com/v1alpha1 true
kind string MySQLCluster true
metadata object Refer to the Kubernetes API documentation for the fields of the `metadata` field. true
spec object MySQLClusterSpec defines the desired state of the MySQLCluster
true
status object MySQLClusterStatus describes the observed status of the MySQLCluster
false

MySQLCluster.spec

↩ Parent

MySQLClusterSpec defines the desired state of the MySQLCluster

Name Type Description Required
infrastructurePolicy object InfrastructurePolicy refers to the infrastructure policy resource used to create this cluster.
Required - Must refer to a valid `InfrastructurePolicy`.
Immutable.
true
storagePolicyName string StoragePolicyName declares the name of the storage policy that should be used to create this postgres cluster. It must be part of the InfrastructurePolicy used by this cluster.
Required - Must refer to a valid `StoragePolicyName`.
Immutable.
true
storageSpace string StorageSpace declares the disk size allocated to each node hosting the workload. You can express storage as a plain integer or as a fixed-point number using one of these suffixes - E, P, T, G, M, k. You can also use the power-of-two equivalents - Ei, Pi, Ti, Gi, Mi, Ki Range - 20Gi - 10Ti.
Required.
Mutable - (increase only).
true
version string Version declares the version of the database engine to be used. The list of supported engine versions is available in the VMware Data Services Manager UI.
Required.
Immutable.
true
vmClass object VMClass refers to the VM class that should be used to create this cluster. It must be part of the InfrastructurePolicy used by this cluster.
Required - Must refer to a valid `VMClass`.
Mutable - (Only increases in resources are allowed).
true
backupConfig object BackupConfig declares the cluster's backup configuration details. If specified a `BackupLocation` must also be specified.
Optional.
Mutable.
false
backupLocation object BackupLocation refers to the `Database Backup Storage` defined in the DSM Provider to be used by the database represented by this CR. A valid location must already be defined in DSM Provider. Once a BackupLocation is set the location can be changed but cannot be made empty. If specified, a `backupConfig` must also be specified.
Optional.
Mutable.
false
basedOn object Identifier of the source cluster on which this cluster will be based on.
Optional.
Immutable.
false
databaseConfig object DatabaseConfig refers to the database config object that will be applied to this cluster. Database Config is used to apply custom params/configs to the database represented by this CR. A Database Config can only be applied to a single cluster at a time and cannot be deleted if it is in use by a cluster. The DatabaseConfig must exist in same namespace as cluster.
Optional.
Mutable.
false
description string Description contains the human-readable description of the cluster.
Optional.
Mutable.
false
maintenanceWindow object MaintenanceWindow refers to the System maintenance window. Enabled Maintenance Window will allow CVEs, bug fixes and new Lifecycle Management features for the VM, OS, any supporting software to be addressed. Database minor version upgrades can also be performed. Changes applied during this window should only result in minimum downtime when the database is deployed with replication.
Optional.
Mutable.
false
members integer The number of members for cluster. Only accepts value `1` in this release. Default - `1`
Mutable.

Default: 1
Minimum: 1
Maximum: 1
false
placementSelector object PlacementSelector refers to a placement declared in the InfrastructurePolicy. Usually this field should be left empty to allow the system to determine it automatically. A placement should be found in the `InfrastructurePolicy` with the same datacenter, cluster and resource pool to be considered valid.
Optional.
Immutable.
false

MySQLCluster.spec.infrastructurePolicy

↩ Parent

InfrastructurePolicy refers to the infrastructure policy resource used to create this cluster.
Required - Must refer to a valid InfrastructurePolicy.
Immutable.

Name Type Description Required
name string Name of the referent.
false

MySQLCluster.spec.vmClass

↩ Parent

VMClass refers to the VM class that should be used to create this cluster. It must be part of the InfrastructurePolicy used by this cluster.
Required - Must refer to a valid VMClass.
Mutable - (Only increases in resources are allowed).

Name Type Description Required
name string Name of the referent.
false

MySQLCluster.spec.backupConfig

↩ Parent

BackupConfig declares the cluster's backup configuration details. If specified a BackupLocation must also be specified.
Optional.
Mutable.

Name Type Description Required
backupRetentionDays integer BackupRetentionDays describes the number of days to store backups Must be `1` or greater.
Required.
Mutable.

Format: int64
true
schedules []object Schedules user defined schedules of when the system will perform backups.
Required.
Mutable.
true

MySQLCluster.spec.backupConfig.schedules[index]

↩ Parent

Name Type Description Required
name string Name of the schedule.
Required.
Immutable.
true
schedule string The schedule in the form of a cron schedule.
Required.
Mutable.
true
type string Type of schedule. Can be `full` or `incremental`.
Required.
Immutable.
true

MySQLCluster.spec.backupLocation

↩ Parent

BackupLocation refers to the Database Backup Storage defined in the DSM Provider to be used by the database represented by this CR. A valid location must already be defined in DSM Provider. Once a BackupLocation is set the location can be changed but cannot be made empty. If specified, a backupConfig must also be specified.
Optional.
Mutable.

Name Type Description Required
name string Name of the referent.
false

MySQLCluster.spec.basedOn

↩ Parent

Identifier of the source cluster on which this cluster will be based on.
Optional.
Immutable.

Name Type Description Required
cluster object Cluster contains the name of the source cluster and timestamp to use as the clone point.
Optional.
Immutable.
true

MySQLCluster.spec.basedOn.cluster

↩ Parent

Cluster contains the name of the source cluster and timestamp to use as the clone point.
Optional.
Immutable.

Name Type Description Required
name string Name is the name of the source cluster from which to restore.
Required.
Immutable.
true
timestamp string Timestamp is the point in time to restore from. The restore will happen to the last available recovery time before the given time. If timestamp is not provided restore will be initiated to the latest available recovery time.
Optional.
Immutable.

Format: date-time
false

MySQLCluster.spec.databaseConfig

↩ Parent

DatabaseConfig refers to the database config object that will be applied to this cluster. Database Config is used to apply custom params/configs to the database represented by this CR. A Database Config can only be applied to a single cluster at a time and cannot be deleted if it is in use by a cluster. The DatabaseConfig must exist in same namespace as cluster.
Optional.
Mutable.

Name Type Description Required
name string Name of the referent.
false

MySQLCluster.spec.maintenanceWindow

↩ Parent

MaintenanceWindow refers to the System maintenance window. Enabled Maintenance Window will allow CVEs, bug fixes and new Lifecycle Management features for the VM, OS, any supporting software to be addressed. Database minor version upgrades can also be performed. Changes applied during this window should only result in minimum downtime when the database is deployed with replication.
Optional.
Mutable.

Name Type Description Required
duration string Duration describes the duration of the maintenance window.
Required.
Mutable.
true
startDay enum StartDay describes the day of the week the maintenance window will commence. Can be any of `MONDAY`;`TUESDAY`;`WEDNESDAY`;`THURSDAY`;`FRIDAY`;`SATURDAY`;`SUNDAY`
Required.
Mutable.

Enum: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
true
startTime string StartTime describes the time of the day to start the maintenance window.
Required.
Mutable.
true

MySQLCluster.spec.placementSelector

↩ Parent

PlacementSelector refers to a placement declared in the InfrastructurePolicy. Usually this field should be left empty to allow the system to determine it automatically. A placement should be found in the InfrastructurePolicy with the same datacenter, cluster and resource pool to be considered valid.
Optional.
Immutable.

Name Type Description Required
cluster string Cluster is the datacenter's cluster name to be used when placing the data service workload. Use the full qualified name of the cluster, relative to the datacenter. A cluster "Cluster1" inside a folder "clusters", should be declared as "clusters/Cluster1". Any slash in the name is considered a path delimiter, use the literal '%2f' if need to represent a slash in the cluster name.
Required.
Mutable.
true
datacenter string Datacenter is the vSphere Datacenter to be used when placing the data service workload. The full qualified path to the datacenter must be provided if the datacenter is placed inside a folder. Any slash in the name is considered a path delimiter, use the literal '%2f' if need to represent a slash in the datacenter name.
Required.
Mutable.
true
resourcePool string ResourcePool is the Cluster's resource pool to be used when placing the data service workload. If the resource pool is not provided, the whole cluster is used as the placement.
Optional.
Mutable.
false

MySQLCluster.status

↩ Parent

MySQLClusterStatus describes the observed status of the MySQLCluster

Name Type Description Required
alertLevel string AlertLevel indicates the level of the most severe alert raised for a database cluster.
false
backupId string BackupId is set only for clusters with enabled automatic backups. This is a unique Id that can be used to locate backup files in storage. For PostgreSQL it is the stanzaName of the database cluster. For MySQL it is the UID of the MySQL cluster object in the workload cluster.
false
conditions []object Conditions contain the list of observed conditions of the cluster. The following statuses can occur. `Ready` indicates if the cluster is fully operatational. `MachinesReady` indicates if the underlying VMs of the cluster have been created successfully. `DatabaseEngineReady` indicates if the datbase engine is up and ready to accept queries. `Provisioning` indicates if the provisioning of all resources neccessary for cluster operation has completed.
false
connection object Connection describes the details which can be used to to connect to the database represented by CR.
false
lastSuccessfulBackup string LastSuccessfulBackup indicates the time when the last successful backup completed. The time may refer to a incremental or full backup depending on which completed most recently.

Format: date-time
false
lastUpdate string LastUpdate gives the timestamp of when the desired state was last applied.

Format: date-time
false
nodes []object Nodes represents the underlying infrastructure of a database cluster.
false
upgradeStatus string UpgradeStatus represents that status of version upgrade - `available` or `running`.
false

MySQLCluster.status.conditions[index]

↩ Parent

Condition contains details for one aspect of the current state of this API Resource.

Name Type Description Required
lastTransitionTime string lastTransitionTime is the last time the condition transitioned from one status to another.

Format: date-time
true
message string message is a human readable message indicating details about the transition.
true
reason string reason contains a programmatic identifier indicating the reason for the condition's last transition.
true
status enum status of the condition, one of True, False, Unknown.

Enum: True, False, Unknown
true
type string type of condition in CamelCase
true
observedGeneration integer 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.

Format: int64
Minimum: 0
false

MySQLCluster.status.connection

↩ Parent

Connections to the database can be made over SSL.

Name Type Description Required
dbname string Name of the Database
true
host string Host describes the IP address of the database cluster's current primary node.
true
port integer Port describes the port on which the database cluster is listening.
true
passwordRef object Password for the admin account
false
username string Username for the admin account
false

MySQLCluster.status.connection.passwordRef

↩ Parent

Password for the admin account

Name Type Description Required
fieldPath string data. for secrets.
Optional. For most references there is a canonical key
false
name string The name of the secret
false
value string If an inline value is provided, the secret reference is skipped
false

MySQLCluster.status.nodes[index]

↩ Parent

Node represents the underlying infrastructure of a database cluster

Name Type Description Required
datacenter string Datacenter is the name or inventory path of the datacenter in which the virtual machine is created/located.
false
datastore string Datastore is the name or inventory path of the datastore in which the virtual machine is created/located.
false
folder string Folder is the name or inventory path of the folder in which the virtual machine is created/located.
false
network object Network is the network configuration for this VM.
false
resourcePool string ResourcePool is the name or inventory path of the resource pool in which the virtual machine is created/located.
false
server string Server is the IP address or FQDN of the vSphere server on which the virtual machine is created/located.
false
storagePolicyName string StoragePolicyName of the storage policy to use with this Virtual Machine
false
vmMoid string VmMoid is the VM's Managed Object Reference on vSphere.
false
vmName string VmName is the name of the virtual machine on vSphere.
false

MySQLCluster.status.nodes[index].network

↩ Parent

Network is the network configuration for this VM.

Name Type Description Required
devices []object Devices is the list of network devices used by the virtual machine.
false

MySQLCluster.status.nodes[index].network.devices[index]

↩ Parent

NetworkDevice defines the network configuration for a virtual machine's network device.

Name Type Description Required
ipPool string IPPool is the name of the IP Pool that was used to claim an IP address for the VM.
false
networkName string NetworkName is the name of the vSphere network to which the device will be connected.
false

PostgresCluster

↩ Parent

PostgresCluster is the schema for the postgresclusters API. A PostgresCluster represents the desired specification and the observed status of a PostgresCluster instance. A PostgresCluster is backed by one or more nodes containing the postgresql service and supporting services managed as a single object by the Data Services Manager.

Name Type Description Required
apiVersion string databases.dataservices.vmware.com/v1alpha1 true
kind string PostgresCluster true
metadata object Refer to the Kubernetes API documentation for the fields of the `metadata` field. true
spec object PostgresClusterSpec defines the desired state of the PostgresCluster.
true
status object PostgresClusterStatus describes the observed status of the PostgresCluster.
false

PostgresCluster.spec

↩ Parent

PostgresClusterSpec defines the desired state of the PostgresCluster.

Name Type Description Required
infrastructurePolicy object InfrastructurePolicy refers to the infrastructure policy resource used to create this cluster.
Required - Must refer to a valid `InfrastructurePolicy`.
Immutable.
true
storagePolicyName string StoragePolicyName declares the name of the storage policy that should be used to create this postgres cluster. It must be part of the InfrastructurePolicy used by this cluster.
Required - Must refer to a valid `StoragePolicyName`.
Immutable.
true
storageSpace string StorageSpace declares the disk size allocated to each node hosting the workload. You can express storage as a plain integer or as a fixed-point number using one of these suffixes - E, P, T, G, M, k. You can also use the power-of-two equivalents - Ei, Pi, Ti, Gi, Mi, Ki Range - 20Gi - 10Ti.
Required.
Mutable - (increase only).
true
version string Version declares the version of the database engine to be used. The list of supported engine versions is available in the VMware Data Services Manager UI.
Required.
Immutable.
true
vmClass object VMClass refers to the VM class that should be used to create this cluster. It must be part of the InfrastructurePolicy used by this cluster.
Required - Must refer to a valid `VMClass`.
Mutable - (Only increases in resources are allowed).
true
adminUsername string AdminUserName is the desired name of the privileged user to be used when connecting to the database. Default - pgadmin.
Mutable.
false
backupConfig object BackupConfig declares the cluster's backup configuration details. If specified a `BackupLocation` must also be specified.
Optional.
Mutable.
false
backupLocation object BackupLocation refers to the `Database Backup Storage` defined in the DSM Provider to be used by the database represented by this CR. A valid location must already be defined in DSM Provider. Once a BackupLocation is set the location can be changed but cannot be made empty. If specified, a `backupConfig` must also be specified.
Optional.
Mutable.
false
basedOn object Identifier of the source cluster on which this cluster will be based on.
Optional.
Immutable.
false
databaseConfig object DatabaseConfig refers to the database config object that will be applied to this cluster. Database Config is used to apply custom params/configs to the database represented by this CR. A Database Config can only be applied to a single cluster at a time and cannot be deleted if it is in use by a cluster. The DatabaseConfig must exist in same namespace as cluster.
Optional.
Mutable.
false
databaseName string DatabaseName is the name of the Database which the privileged user will have permissions on. Default - Same as database cluster name.
Mutable.
false
description string Description contains the human-readable description of the cluster.
Optional.
Mutable.
false
maintenanceWindow object MaintenanceWindow refers to the System maintenance window. Enabled Maintenance Window will allow CVEs, bug fixes and new Lifecycle Management features for the VM, OS, any supporting software to be addressed. Database minor version upgrades can also be performed. Changes applied during this window should only result in minimum downtime when the database is deployed with replication.
Optional.
Mutable.
false
placementSelector object PlacementSelector refers to a placement declared in the InfrastructurePolicy. Usually this field should be left empty to allow the system to determine it automatically. A placement should be found in the `InfrastructurePolicy` with the same datacenter, cluster and resource pool to be considered valid.
Optional.
Immutable.
false
replicas integer Represents the number of nodes that are replicating from the primary node. In event of a primary outage one of the replicas will be promoted to primary. Replicas can be set to 0, 1, 3. If you have replicas set to 1, then you will have 1 primary node and 1 replica node. Default - `0`
Mutable.

Default: 0
Minimum: 0
Maximum: 3
false

PostgresCluster.spec.infrastructurePolicy

↩ Parent

InfrastructurePolicy refers to the infrastructure policy resource used to create this cluster.
Required - Must refer to a valid InfrastructurePolicy.
Immutable.

Name Type Description Required
name string Name of the referent.
false

PostgresCluster.spec.vmClass

↩ Parent

VMClass refers to the VM class that should be used to create this cluster. It must be part of the InfrastructurePolicy used by this cluster.
Required - Must refer to a valid VMClass.
Mutable - (Only increases in resources are allowed).

Name Type Description Required
name string Name of the referent.
false

PostgresCluster.spec.backupConfig

↩ Parent

BackupConfig declares the cluster's backup configuration details. If specified a BackupLocation must also be specified.
Optional.
Mutable.

Name Type Description Required
backupRetentionDays integer BackupRetentionDays describes the number of days to store backups Must be `1` or greater.
Required.
Mutable.

Format: int64
true
schedules []object Schedules user defined schedules of when the system will perform backups.
Required.
Mutable.
true

PostgresCluster.spec.backupConfig.schedules[index]

↩ Parent

Name Type Description Required
name string Name of the schedule.
Required.
Immutable.
true
schedule string The schedule in the form of a cron schedule.
Required.
Mutable.
true
type string Type of schedule. Can be `full` or `incremental`.
Required.
Immutable.
true

PostgresCluster.spec.backupLocation

↩ Parent

BackupLocation refers to the Database Backup Storage defined in the DSM Provider to be used by the database represented by this CR. A valid location must already be defined in DSM Provider. Once a BackupLocation is set the location can be changed but cannot be made empty. If specified, a backupConfig must also be specified.
Optional.
Mutable.

Name Type Description Required
name string Name of the referent.
false

PostgresCluster.spec.basedOn

↩ Parent

Identifier of the source cluster on which this cluster will be based on.
Optional.
Immutable.

Name Type Description Required
cluster object Cluster contains the name of the source cluster and timestamp to use as the clone point.
Optional.
Immutable.
true

PostgresCluster.spec.basedOn.cluster

↩ Parent

Cluster contains the name of the source cluster and timestamp to use as the clone point.
Optional.
Immutable.

Name Type Description Required
name string Name is the name of the source cluster from which to restore.
Required.
Immutable.
true
timestamp string Timestamp is the point in time to restore from. The restore will happen to the last available recovery time before the given time. If timestamp is not provided restore will be initiated to the latest available recovery time.
Optional.
Immutable.

Format: date-time
false

PostgresCluster.spec.databaseConfig

↩ Parent

DatabaseConfig refers to the database config object that will be applied to this cluster. Database Config is used to apply custom params/configs to the database represented by this CR. A Database Config can only be applied to a single cluster at a time and cannot be deleted if it is in use by a cluster. The DatabaseConfig must exist in same namespace as cluster.
Optional.
Mutable.

Name Type Description Required
name string Name of the referent.
false

PostgresCluster.spec.maintenanceWindow

↩ Parent

MaintenanceWindow refers to the System maintenance window. Enabled Maintenance Window will allow CVEs, bug fixes and new Lifecycle Management features for the VM, OS, any supporting software to be addressed. Database minor version upgrades can also be performed. Changes applied during this window should only result in minimum downtime when the database is deployed with replication.
Optional.
Mutable.

Name Type Description Required
duration string Duration describes the duration of the maintenance window.
Required.
Mutable.
true
startDay enum StartDay describes the day of the week the maintenance window will commence. Can be any of `MONDAY`;`TUESDAY`;`WEDNESDAY`;`THURSDAY`;`FRIDAY`;`SATURDAY`;`SUNDAY`
Required.
Mutable.

Enum: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
true
startTime string StartTime describes the time of the day to start the maintenance window.
Required.
Mutable.
true

PostgresCluster.spec.placementSelector

↩ Parent

PlacementSelector refers to a placement declared in the InfrastructurePolicy. Usually this field should be left empty to allow the system to determine it automatically. A placement should be found in the InfrastructurePolicy with the same datacenter, cluster and resource pool to be considered valid.
Optional.
Immutable.

Name Type Description Required
cluster string Cluster is the datacenter's cluster name to be used when placing the data service workload. Use the full qualified name of the cluster, relative to the datacenter. A cluster "Cluster1" inside a folder "clusters", should be declared as "clusters/Cluster1". Any slash in the name is considered a path delimiter, use the literal '%2f' if need to represent a slash in the cluster name.
Required.
Mutable.
true
datacenter string Datacenter is the vSphere Datacenter to be used when placing the data service workload. The full qualified path to the datacenter must be provided if the datacenter is placed inside a folder. Any slash in the name is considered a path delimiter, use the literal '%2f' if need to represent a slash in the datacenter name.
Required.
Mutable.
true
resourcePool string ResourcePool is the Cluster's resource pool to be used when placing the data service workload. If the resource pool is not provided, the whole cluster is used as the placement.
Optional.
Mutable.
false

PostgresCluster.status

↩ Parent

PostgresClusterStatus describes the observed status of the PostgresCluster.

Name Type Description Required
alertLevel string AlertLevel indicates the level of the most severe alert raised for a database cluster.
false
backupId string BackupId is set only for clusters with enabled automatic backups. This is a unique Id that can be used to locate backup files in storage. For PostgreSQL it is the stanzaName of the database cluster. For MySQL it is the UID of the MySQL cluster object in the workload cluster.
false
conditions []object Conditions contain the list of observed conditions of the cluster. The following statuses can occur. `Ready` indicates if the cluster is fully operatational. `MachinesReady` indicates if the underlying VMs of the cluster have been created successfully. `DatabaseEngineReady` indicates if the datbase engine is up and ready to accept queries. `Provisioning` indicates if the provisioning of all resources neccessary for cluster operation has completed.
false
connection object Connection describes the details which can be used to to connect to the database represented by CR.
false
lastSuccessfulBackup string LastSuccessfulBackup indicates the time when the last successful backup completed. The time may refer to a incremental or full backup depending on which completed most recently.

Format: date-time
false
lastUpdate string LastUpdate gives the timestamp of when the desired state was last applied.

Format: date-time
false
nodes []object Nodes represents the underlying infrastructure of a database cluster.
false
upgradeStatus string UpgradeStatus represents that status of version upgrade - `available` or `running`.
false

PostgresCluster.status.conditions[index]

↩ Parent

Condition contains details for one aspect of the current state of this API Resource.

Name Type Description Required
lastTransitionTime string lastTransitionTime is the last time the condition transitioned from one status to another.

Format: date-time
true
message string message is a human readable message indicating details about the transition.
true
reason string reason contains a programmatic identifier indicating the reason for the condition's last transition.
true
status enum status of the condition, one of True, False, Unknown.

Enum: True, False, Unknown
true
type string type of condition in CamelCase
true
observedGeneration integer 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.

Format: int64
Minimum: 0
false

PostgresCluster.status.connection

↩ Parent

Connections to the database can be made over SSL.

Name Type Description Required
dbname string Name of the Database
true
host string Host describes the IP address of the database cluster's current primary node.
true
port integer Port describes the port on which the database cluster is listening.
true
passwordRef object Password for the admin account
false
username string Username for the admin account
false

PostgresCluster.status.connection.passwordRef

↩ Parent

Password for the admin account

Name Type Description Required
fieldPath string data. for secrets.
Optional. For most references there is a canonical key
false
name string The name of the secret
false
value string If an inline value is provided, the secret reference is skipped
false

PostgresCluster.status.nodes[index]

↩ Parent

Node represents the underlying infrastructure of a database cluster

Name Type Description Required
datacenter string Datacenter is the name or inventory path of the datacenter in which the virtual machine is created/located.
false
datastore string Datastore is the name or inventory path of the datastore in which the virtual machine is created/located.
false
folder string Folder is the name or inventory path of the folder in which the virtual machine is created/located.
false
network object Network is the network configuration for this VM.
false
resourcePool string ResourcePool is the name or inventory path of the resource pool in which the virtual machine is created/located.
false
server string Server is the IP address or FQDN of the vSphere server on which the virtual machine is created/located.
false
storagePolicyName string StoragePolicyName of the storage policy to use with this Virtual Machine
false
vmMoid string VmMoid is the VM's Managed Object Reference on vSphere.
false
vmName string VmName is the name of the virtual machine on vSphere.
false

PostgresCluster.status.nodes[index].network

↩ Parent

Network is the network configuration for this VM.

Name Type Description Required
devices []object Devices is the list of network devices used by the virtual machine.
false

PostgresCluster.status.nodes[index].network.devices[index]

↩ Parent

NetworkDevice defines the network configuration for a virtual machine's network device.

Name Type Description Required
ipPool string IPPool is the name of the IP Pool that was used to claim an IP address for the VM.
false
networkName string NetworkName is the name of the vSphere network to which the device will be connected.
false
check-circle-line exclamation-circle-line close-line
Scroll to top icon