postgresql.dbadmin.gdc.goog/v1
Backup
Backup is the Schema for the backups API
Appears in: - BackupList
| Field | Description |
|---|---|
apiVersion string |
postgresql.dbadmin.gdc.goog/v1 |
kind string |
Backup |
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
spec BackupSpec |
|
status BackupStatus |
BackupList
BackupList contains a list of Backup
| Field | Description |
|---|---|
apiVersion string |
postgresql.dbadmin.gdc.goog/v1 |
kind string |
BackupList |
metadata ListMeta |
Refer to Kubernetes API documentation for fields of metadata. |
items Backup array |
BackupPlan
BackupPlan is the Schema for the backupplans API
Appears in: - BackupPlanList
| Field | Description |
|---|---|
apiVersion string |
postgresql.dbadmin.gdc.goog/v1 |
kind string |
BackupPlan |
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
spec BackupPlanSpec |
|
status BackupPlanStatus |
BackupPlanList
BackupPlanList contains a list of BackupPlan
| Field | Description |
|---|---|
apiVersion string |
postgresql.dbadmin.gdc.goog/v1 |
kind string |
BackupPlanList |
metadata ListMeta |
Refer to Kubernetes API documentation for fields of metadata. |
items BackupPlan array |
BackupPlanSpec
BackupPlanSpec defines the desired state of BackupPlan.
Appears in: - BackupPlan
| Field | Description |
|---|---|
dbclusterRef DBClusterRef |
The DBCluster name this backupplan configures. This field is required and immutable. |
backupRetainDays integer |
Number of days after which the service will delete a Backup. If specified, a Backup created under this BackupPlan will be automatically deleted after its age reaches create_time + backup_retain_days. The valid values are from 1 to 90 days. Default to 14 retain days if not specified. |
paused boolean |
A flag to indicate if the backup creation under this BackupPlan is paused. If set to true, the service will pause the scheduling of new Backups under this BackupPlan. Default to False. |
PITREnabled boolean |
A flag to indicate whether logs replication is enabled to support point-in-time recovery. Default to False. nullon(samwise-fleet) |
BackupPlanStatus
BackupPlanStatus defines the observed state of BackupPlan.
Appears in: - BackupPlan
| Field | Description |
|---|---|
observedGeneration integer |
Internal: The generation observed by the controller. |
reconciled boolean |
Internal: Whether the resource was reconciled by the controller. |
criticalIncidents CriticalIncident array |
CriticalIncidents is a flat list of all active Critical Incidents. |
conditions Condition array |
Conditions represents the latest available observations of the Entity's current state. |
phase BackupPlanPhase |
|
lastBackupTime Time |
LastBackupTime is the timestamp for the most recently executed backup. |
nextBackupTime Time |
NextBackupTime is the timestamp for the next scheduled backup. |
recoveryWindow TimeWindow |
RecoveryWindow is the currently available recovery window. |
BackupSpec
BackupSpec defines the desired state of Backup.
Appears in: - Backup
| Field | Description |
|---|---|
dbclusterRef DBClusterRef |
The DBCluster name this backup belongs to. This field is required. |
backupPlanRef BackupPlanRef |
Name of the BackupPlan from which this backup was created. This field is required. |
manual boolean |
Indicate whether this backup is a scheduled or manual backup. This field is optional. Default to false (scheduled backup) if not specified. |
BackupStatus
BackupStatus defines the observed state of Backup.
Appears in: - Backup
| Field | Description |
|---|---|
observedGeneration integer |
Internal: The generation observed by the controller. |
reconciled boolean |
Internal: Whether the resource was reconciled by the controller. |
criticalIncidents CriticalIncident array |
CriticalIncidents is a flat list of all active Critical Incidents. |
conditions Condition array |
Conditions represents the latest available observations of the Entity's current state. |
phase BackupPhase |
|
createTime Time |
Creation time of the Backup |
completeTime Time |
Completion time of the Backup |
CreateStandbyJob
CreateStandbyJob is an internal workflow tracking object. Users should not directly interact with this.
Appears in: - CreateStandbyJobList
| Field | Description |
|---|---|
apiVersion string |
postgresql.dbadmin.gdc.goog/v1 |
kind string |
CreateStandbyJob |
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
spec WorkflowSpec |
|
status EntityStatus |
CreateStandbyJobList
CreateStandbyJobList contains a list of CreateStandbyJobs
| Field | Description |
|---|---|
apiVersion string |
postgresql.dbadmin.gdc.goog/v1 |
kind string |
CreateStandbyJobList |
metadata ListMeta |
Refer to Kubernetes API documentation for fields of metadata. |
items CreateStandbyJob array |
DBCluster
DBCluster is the Schema for the dbclusters API
Appears in: - DBClusterList
| Field | Description |
|---|---|
apiVersion string |
postgresql.dbadmin.gdc.goog/v1 |
kind string |
DBCluster |
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
spec DBClusterSpec |
|
status DBClusterStatus |
DBClusterList
DBClusterList contains a list of DBCluster
| Field | Description |
|---|---|
apiVersion string |
postgresql.dbadmin.gdc.goog/v1 |
kind string |
DBClusterList |
metadata ListMeta |
Refer to Kubernetes API documentation for fields of metadata. |
items DBCluster array |
DBClusterSpec
DBClusterSpec defines the desired state of DBCluster
Appears in: - DBCluster
| Field | Description |
|---|---|
primaryCluster string |
nullon(samwise-fleet) |
isDeleted boolean |
IsDeleted indicates a request to delete the DBCluster. This field is optional, and by default it 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 |
Indicate the mode of this DBCluster. |
availability Availability |
Availability contains adjustable settings for DBCluster HA features |
allowExternalIncomingTraffic boolean |
|
tls TLSSpec |
TLS is the desired server certificate configuration for the cluster. This field is optional. 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. |
databaseVersion string |
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. |
controlPlaneAgentsVersion string |
ControlPlaneAgentsVersion is the desired control plane agents version for the cluster for example, "0.5.2". This field is required. 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 |
DatabaseImage is the URI of a customized database image within the container registry, for example, "gcr.io/foo/bar/alloydbomni:15-7-2-customized". This field is optional. 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 will be based on the default database image used of the chosen databaseVersion. For more information about using a customized database image visit {link}. |
primarySpec PgInstanceSpec |
DBClusterStatus
DBClusterStatus defines the observed state of DBCluster
Appears in: - DBCluster
| Field | Description |
|---|---|
observedGeneration integer |
Internal: The generation observed by the controller. |
reconciled boolean |
Internal: Whether the resource was reconciled by the controller. |
criticalIncidents CriticalIncident array |
CriticalIncidents is a flat list of all active Critical Incidents. |
conditions Condition array |
Conditions represents the latest available observations of the Entity's current state. |
phase DBClusterPhase |
|
primary PrimaryStatus |
Primary contains the status of the primary Instance. |
restoredFrom RestoredFrom |
|
maintenanceStatus MaintenancePolicyStatus |
MaintenanceStatus provides information about upcoming maintenance. nullon(samwise-fleet) |
upgradeScheduledAt Time |
UpgradeScheduledAt is a timestamp that indicates when the next upgrade is scheduled to start. If it is nil, it means there is no upcoming upgrade scheduled. nullon(samwise-fleet) |
serviceAccounts object (keys:OpType, values:ServiceAccountRef) |
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. |
certificateReference CertificateRef |
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. |
latestFailoverStatus FailoverStatus |
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. |
migrationStatus MigrationStatus |
MigrationStatus represents the status of migration for the database cluster. nullon(samwise-fleet) |
DeleteStandbyJob
DeleteStandbyJob is an internal workflow tracking object. Users should not directly interact with this.
Appears in: - DeleteStandbyJobList
| Field | Description |
|---|---|
apiVersion string |
postgresql.dbadmin.gdc.goog/v1 |
kind string |
DeleteStandbyJob |
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
spec WorkflowSpec |
|
status EntityStatus |
DeleteStandbyJobList
DeleteStandbyJobList contains a list of DeleteStandbyJobs
| Field | Description |
|---|---|
apiVersion string |
postgresql.dbadmin.gdc.goog/v1 |
kind string |
DeleteStandbyJobList |
metadata ListMeta |
Refer to Kubernetes API documentation for fields of metadata. |
items DeleteStandbyJob array |
Export
Export is the Schema for the export API.
Appears in: - ExportList
| Field | Description |
|---|---|
apiVersion string |
postgresql.dbadmin.gdc.goog/v1 |
kind string |
Export |
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
spec ExportSpec |
|
status ExportStatus |
ExportList
| Field | Description |
|---|---|
apiVersion string |
postgresql.dbadmin.gdc.goog/v1 |
kind string |
ExportList |
metadata ListMeta |
Refer to Kubernetes API documentation for fields of metadata. |
items Export array |
ExportSpec
ExportSpec defines the desired state of Export.
Appears in: - Export
| Field | Description |
|---|---|
dbclusterRef DBClusterRef |
DBClusterRef is the dbcluster name within the same namespace to export from. |
exportLocation StorageSpec |
ExportLocation specifies a storage location for the export files. A user is to ensure proper write access to the storage bucket from within the Operator. |
ExportStatus
ExportStatus defines the observed state of Export.
Appears in: - Export
| Field | Description |
|---|---|
observedGeneration integer |
Internal: The generation observed by the controller. |
reconciled boolean |
Internal: Whether the resource was reconciled by the controller. |
criticalIncidents CriticalIncident array |
CriticalIncidents is a flat list of all active Critical Incidents. |
conditions Condition array |
Conditions represents the latest available observations of the Entity's current state. |
phase ExportPhase |
Phase is a summary of current state of the export. |
startTime Time |
StartTime is the time export started. |
completeTime Time |
CompleteTime is the time export completed. |
exportSubDirectory string |
ExportSubDirectory is the subdirectory appended to ExportLocation to store exported files. |
ExternalServer
ExternalServer is the Schema for the ExternalServer API.
Appears in: - ExternalServerList
| Field | Description |
|---|---|
apiVersion string |
postgresql.dbadmin.gdc.goog/v1 |
kind string |
ExternalServer |
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
spec ExternalServerSpec |
|
status ExternalServerStatus |
ExternalServerList
| Field | Description |
|---|---|
apiVersion string |
postgresql.dbadmin.gdc.goog/v1 |
kind string |
ExternalServerList |
metadata ListMeta |
Refer to Kubernetes API documentation for fields of metadata. |
items ExternalServer array |
ExternalServerSpec
ExternalServerSpec defines metadata of an external database server used for migration.
Appears in: - ExternalServer
| Field | Description |
|---|---|
host string |
Host is the host ip of the external database server. |
port integer |
Port is the port of the external database server. |
username string |
UserName is the name of the user used to connect to the external database. |
password SecretReference |
Password is the reference to the secret storing external database server password. |
certRef SecretReference |
CertRef is the reference to the secret storing external database server certificate. |
ExternalServerStatus
Appears in: - ExternalServer
| Field | Description |
|---|---|
observedGeneration integer |
Internal: The generation observed by the controller. |
reconciled boolean |
Internal: Whether the resource was reconciled by the controller. |
criticalIncidents CriticalIncident array |
CriticalIncidents is a flat list of all active Critical Incidents. |
conditions Condition array |
Conditions represents the latest available observations of the Entity's current state. |
Import
Import is the Schema for the import API.
Appears in: - ImportList
| Field | Description |
|---|---|
apiVersion string |
postgresql.dbadmin.gdc.goog/v1 |
kind string |
Import |
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
spec ImportSpec |
|
status ImportStatus |
ImportList
| Field | Description |
|---|---|
apiVersion string |
postgresql.dbadmin.gdc.goog/v1 |
kind string |
ImportList |
metadata ListMeta |
Refer to Kubernetes API documentation for fields of metadata. |
items Import array |
ImportSpec
ImportSpec defines the desired state of Import.
Appears in: - Import
| Field | Description |
|---|---|
dbclusterRef DBClusterRef |
DBClusterRef is the dbcluster name within the same namespace to import into. |
databaseName string |
DatabaseName is the database resource name within Instance to import into. |
dumpStorage StorageSpec |
DumpStorage specifies a storage location for the import dump files. A user is to ensure proper read access to the storage bucket from within the Operator. |
logStorage StorageSpec |
LogStorage optionally specifies a storage location to copy import log to. A user is to ensure proper write access to the storage bucket from within the Operator. |
downloadOnly boolean |
DownloadOnly when set to true means dump file will be downloaded but not imported into DB. Default is false. |
tableExistAction string |
TableExistAction is the action to take when importing into an existing table. The default is to skip. |
ImportStatus
ImportStatus defines the observed state of Import.
Appears in: - Import
| Field | Description |
|---|---|
observedGeneration integer |
Internal: The generation observed by the controller. |
reconciled boolean |
Internal: Whether the resource was reconciled by the controller. |
criticalIncidents CriticalIncident array |
CriticalIncidents is a flat list of all active Critical Incidents. |
conditions Condition array |
Conditions represents the latest available observations of the Entity's current state. |
phase ImportPhase |
Phase is a summary of current state of the import. |
startTime Time |
StartTime is the time import started. |
completeTime Time |
CompleteTime is the time import completed. |
dumpPath string |
DumpPath is the path of the downloaded dump file for download only import. |
Migration
Migration is the Schema for the migration API.
Appears in: - MigrationList
| Field | Description |
|---|---|
apiVersion string |
postgresql.dbadmin.gdc.goog/v1 |
kind string |
Migration |
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
spec MigrationSpec |
|
status MigrationStatus |
MigrationList
| Field | Description |
|---|---|
apiVersion string |
postgresql.dbadmin.gdc.goog/v1 |
kind string |
MigrationList |
metadata ListMeta |
Refer to Kubernetes API documentation for fields of metadata. |
items Migration array |
MigrationSpec
MigrationSpec defines the spec of the migration job.
Appears in: - Migration
| Field | Description |
|---|---|
source SourceDatabaseServer |
Source is a database server that acts as the source for migration. |
target TargetDatabaseServer |
Target is a database server that acts as the target of migration. |
control MigrationControl |
Control is used to control the state of a migration job. |
MigrationStatus
MigrationStatus defines the status of the migration job.
Appears in: - Migration
| Field | Description |
|---|---|
observedGeneration integer |
Internal: The generation observed by the controller. |
reconciled boolean |
Internal: Whether the resource was reconciled by the controller. |
criticalIncidents CriticalIncident array |
CriticalIncidents is a flat list of all active Critical Incidents. |
conditions Condition array |
Conditions represents the latest available observations of the Entity's current state. |
PgInstanceSpec
Appears in: - DBClusterSpec
| Field | Description |
|---|---|
version string |
Version of a database. nullon(samwise-fleet,samwise-local) |
images object (keys:string, values:string) |
Deprecated: Replacement images for the database instance. nullon(samwise-fleet,samwise-local) |
component object (keys:InstanceComponentName, values:InstanceComponentSpec) |
The list of instance components An instance is composed of dataplane and controlPlaneAgent components nullon(samwise-fleet) |
dbLoadBalancerOptions DBLoadBalancerOptions |
DBNetworkServiceOptions allows to override some details of kubernetes Service created to expose a connection to database. |
sourceCidrRanges string array |
Source IP CIDR ranges allowed for a client. |
parameters object (keys:string, values:string) |
Parameters allows to set database parameters for the database cluster. This field is optional. Parameters will take a key/value pair corresponding to the parameter name/value as defined by the database engine. |
services object (keys:Service, values:boolean) |
Services list the optional semi-managed services that the customers can choose from. |
resources Resource |
Resource specification for the database container. When any of the fields inside the resource changes, the operator restarts the database instance with the new resource specification. |
mode InstanceMode |
Mode specifies how this instance will be managed by the operator. |
databasePatchingTimeout Duration |
Max threshold for database patching. This timeout is used independently for sts patching and OPatch/datapatch execution. nullon(samwise-fleet) |
adminUser AdminUserSpec |
AdminUser represents the admin user specification. This field is required. 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. |
isStopped boolean |
IsStopped stops the instance when set to true. This field is optional and default to false. When stopped, the compute resources (CPU, memory) of the instance are released. However, the instance still 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. |
availabilityOptions AvailabilityOptions |
AvailabilityOptions contains adjustable settings for HA features |
allowExternalIncomingTrafficToInstance boolean |
AllowExternalIncomingTrafficToInstance will be used to configure the external LB creation. |
auditLogTarget AuditLogTargetSpec |
AuditLogTarget configures the sink for the database audit logs |
replication ReplicationSpec |
Replication configures replication connections to other db instances nullon(samwise-fleet) |
tls TLSSpec |
TLS is the desired server certificate configuration for the instance. This field is optional. When this field is changed, the instance pods will restart to load the specified certificate |
schedulingconfig SchedulingConfig |
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 k8s pod onto a different node based on the config. |
Restore
Restore is the Schema for the restores API
Appears in: - RestoreList
| Field | Description |
|---|---|
apiVersion string |
postgresql.dbadmin.gdc.goog/v1 |
kind string |
Restore |
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
spec RestoreSpec |
|
status RestoreStatus |
RestoreList
RestoreList contains a list of Restores
| Field | Description |
|---|---|
apiVersion string |
postgresql.dbadmin.gdc.goog/v1 |
kind string |
RestoreList |
metadata ListMeta |
Refer to Kubernetes API documentation for fields of metadata. |
items Restore array |
RestoreSpec
RestoreSpec defines the desired state of Restore.
Appears in: - Restore
| Field | Description |
|---|---|
sourceDBCluster DBClusterRef |
The name of the source DBCluster to restore from. This field is required. |
pointInTime Time |
Previous point in time to restore to. This field is optional. Default to restore the latest available time point if not specified. |
clonedDBClusterConfig ClonedDBClusterConfig |
Settings for the cloned DBCluster. This lets you specify the name for the cloned DBCluster. This field is optional. Default to restore the source DBCluster if not specified. |
RestoreStatus
RestoreStatus defines the observed state of Restore.
Appears in: - Restore
| Field | Description |
|---|---|
observedGeneration integer |
Internal: The generation observed by the controller. |
reconciled boolean |
Internal: Whether the resource was reconciled by the controller. |
criticalIncidents CriticalIncident array |
CriticalIncidents is a flat list of all active Critical Incidents. |
conditions Condition array |
Conditions represents the latest available observations of the Entity's current state. |
phase RestorePhase |
|
createTime Time |
Creation time of the Restore |
completeTime Time |
Completion time of the Restore |
restoredPointInTime Time |
Actual point-in-time this restore brings the target DBCluster into. Might be different from value specified in spec.PointInTime. nullon(samwise-fleet) |