psql.oracle.com/v1beta1¶

APIVersion: psql.oracle.com/v1beta1

This content is generated from the checked-in CRD schemas in config/crd/bases/. If a description is missing or incorrect, fix the source comments or generator inputs and rerun make generate manifests; do not hand-edit config/crd/bases/*.yaml.

Packages¶

Package	Support	Latest release	Resources
PostgreSQL	preview	`v2.0.0-alpha`	DbSystem

Resources¶

Kind	Scope	Sample	Packages
DbSystem	Namespaced	Sample	PostgreSQL (`v2.0.0-alpha`)

DbSystem¶

Manage OCI PostgreSQL DB Systems.

Plural: dbsystems
Scope: Namespaced
APIVersion: psql.oracle.com/v1beta1
Sample: Sample (config/samples/psql_v1beta1_dbsystem.yaml)
Packages: PostgreSQL (v2.0.0-alpha)

Spec¶

DbSystemSpec defines the desired state of DbSystem.

Field	Description	Type	Required	Default	Enum
`adminPassword`	The administrative password sourced from a Kubernetes Secret in the same namespace. The referenced Secret must contain a `password` key. If omitted, `spec.credentials.passwordDetails` remains available for plaintext or OCI Vault secret input.	`object`	No	-	-
`adminUsername`	The administrative username sourced from a Kubernetes Secret in the same namespace. The referenced Secret must contain a `username` key. If omitted, `spec.credentials.username` remains available for direct credential input.	`object`	No	-	-
`compartmentId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the database system.	`string`	Yes	-	-
`configId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the configuration associated with the database system.	`string`	No	-	-
`credentials`	DbSystemCredentials defines nested fields for DbSystem.Credentials.	`object`	Yes	-	-
`dbConfigurationParams`	DbSystemDbConfigurationParams defines nested fields for DbSystem.DbConfigurationParams.	`object`	No	-	-
`dbVersion`	Version of database system software.	`string`	Yes	-	-
`definedTags`	Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`	`map[string, map[string, string]]`	No	-	-
`description`	A user-provided description of a database system.	`string`	No	-	-
`displayName`	A user-friendly display name for the database system. Avoid entering confidential information.	`string`	Yes	-	-
`freeformTags`	Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`	`map[string, string]`	No	-	-
`instanceCount`	Count of database instances nodes to be created in the database system.	`integer`	No	-	-
`instanceMemorySizeInGBs`	The total amount of memory available to each database instance node, in gigabytes.	`integer`	No	-	-
`instanceOcpuCount`	The total number of OCPUs available to each database instance node.	`integer`	No	-	-
`instancesDetails`	Details of database instances nodes to be created. This parameter is optional. If specified, its size must match `instanceCount`.	`list[object]`	No	-	-
`managementPolicy`	DbSystemManagementPolicy defines nested fields for DbSystem.ManagementPolicy.	`object`	No	-	-
`networkDetails`	DbSystemNetworkDetails defines nested fields for DbSystem.NetworkDetails.	`object`	Yes	-	-
`shape`	The name of the shape for the database instance node. Use the /shapes API for accepted shapes. Example: `VM.Standard.E4.Flex`	`string`	Yes	-	-
`source`	DbSystemSource defines nested fields for DbSystem.Source.	`object`	No	-	-
`storageDetails`	DbSystemStorageDetails defines nested fields for DbSystem.StorageDetails.	`object`	Yes	-	-
`systemType`	Type of the database system.	`string`	No	-	-

Spec.adminPassword¶

Back to DbSystem spec

The administrative password sourced from a Kubernetes Secret in the same namespace. The referenced Secret must contain a password key. If omitted, spec.credentials.passwordDetails remains available for plaintext or OCI Vault secret input.

Field	Description	Type	Required	Default	Enum
`secret`	-	`object`	No	-	-

Spec.adminPassword.secret¶

Back to DbSystem spec

Field	Description	Type	Required	Default	Enum
`secretName`	-	`string`	No	-	-

Spec.adminUsername¶

Back to DbSystem spec

The administrative username sourced from a Kubernetes Secret in the same namespace. The referenced Secret must contain a username key. If omitted, spec.credentials.username remains available for direct credential input.

Field	Description	Type	Required	Default	Enum
`secret`	-	`object`	No	-	-

Spec.adminUsername.secret¶

Back to DbSystem spec

Field	Description	Type	Required	Default	Enum
`secretName`	-	`string`	No	-	-

Spec.credentials¶

Back to DbSystem spec

DbSystemCredentials defines nested fields for DbSystem.Credentials.

Field	Description	Type	Required	Default	Enum
`passwordDetails`	DbSystemCredentialsPasswordDetails defines nested fields for DbSystem.Credentials.PasswordDetails.	`object`	Yes	-	-
`username`	The database system administrator username.	`string`	Yes	-	-

Spec.credentials.passwordDetails¶

Back to DbSystem spec

DbSystemCredentialsPasswordDetails defines nested fields for DbSystem.Credentials.PasswordDetails.

Field	Description	Type	Required	Default	Enum
`jsonData`	-	`string`	No	-	-
`password`	The database system password.	`string`	No	-	-
`passwordType`	-	`string`	No	-	-
`secretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret where the password is stored.	`string`	No	-	-
`secretVersion`	The secret version of the stored password.	`string`	No	-	-

Spec.dbConfigurationParams¶

Back to DbSystem spec

DbSystemDbConfigurationParams defines nested fields for DbSystem.DbConfigurationParams.

Field	Description	Type	Required	Default	Enum
`applyConfig`	Whether a configuration update requires a restart of the database instance or a reload of the configuration. Some configuration changes require a restart of database instances to be applied.	`string`	No	-	-
`configId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the configuration.	`string`	Yes	-	-

Spec.instancesDetails[]¶

Back to DbSystem spec

DbSystemInstancesDetail defines nested fields for DbSystem.InstancesDetail.

Field	Description	Type	Required	Default	Enum
`description`	A user-provided description of the database instance node.	`string`	No	-	-
`displayName`	Display name of the database instance node. Avoid entering confidential information.	`string`	No	-	-
`privateIp`	Private IP in customer subnet that will be assigned to the database instance node. This value is optional. If the IP is not provided, the IP will be chosen from the available IP addresses in the specified subnet.	`string`	No	-	-

Spec.managementPolicy¶

Back to DbSystem spec

DbSystemManagementPolicy defines nested fields for DbSystem.ManagementPolicy.

Field	Description	Type	Required	Default	Enum
`backupPolicy`	DbSystemManagementPolicyBackupPolicy defines nested fields for DbSystem.ManagementPolicy.BackupPolicy.	`object`	No	-	-
`maintenanceWindowStart`	The start of the maintenance window in UTC. This string is of the format: "{day-of-week} {time-of-day}". "{day-of-week}" is a case-insensitive string like "mon", "tue", &c. "{time-of-day}" is the "Time" portion of an RFC3339-formatted timestamp. Any second or sub-second time data will be truncated to zero.	`string`	No	-	-

Spec.managementPolicy.backupPolicy¶

Back to DbSystem spec

DbSystemManagementPolicyBackupPolicy defines nested fields for DbSystem.ManagementPolicy.BackupPolicy.

Field	Description	Type	Required	Default	Enum
`backupStart`	Hour of the day when the backup starts.	`string`	No	-	-
`copyPolicy`	DbSystemManagementPolicyBackupPolicyCopyPolicy defines nested fields for DbSystem.ManagementPolicy.BackupPolicy.CopyPolicy.	`object`	No	-	-
`daysOfTheMonth`	Day of the month when the backup should start. To ensure that the backup runs monthly, the latest day of the month that you can use to schedule a backup is the the 28th day.	`list[integer]`	No	-	-
`daysOfTheWeek`	The day of the week that the backup starts.	`list[string]`	No	-	-
`jsonData`	-	`string`	No	-	-
`kind`	-	`string`	No	-	-
`retentionDays`	How many days the data should be stored after the database system deletion.	`integer`	No	-	-

Spec.managementPolicy.backupPolicy.copyPolicy¶

Back to DbSystem spec

DbSystemManagementPolicyBackupPolicyCopyPolicy defines nested fields for DbSystem.ManagementPolicy.BackupPolicy.CopyPolicy.

Field	Description	Type	Required	Default	Enum
`compartmentId`	target compartment to place a new backup	`string`	Yes	-	-
`regions`	List of region names of the remote region	`list[string]`	No	-	-
`retentionPeriod`	Retention period in days of the backup copy.	`integer`	No	-	-

Spec.networkDetails¶

Back to DbSystem spec

DbSystemNetworkDetails defines nested fields for DbSystem.NetworkDetails.

Field	Description	Type	Required	Default	Enum
`isReaderEndpointEnabled`	Specifies if the reader endpoint is enabled on the dbSystem.	`boolean`	No	-	-
`nsgIds`	List of customer Network Security Group OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) associated with the database system.	`list[string]`	No	-	-
`primaryDbEndpointPrivateIp`	Private IP in customer subnet. The value is optional. If the IP is not provided, the IP will be chosen from the available IP addresses from the specified subnet.	`string`	No	-	-
`subnetId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the customer subnet associated with the database system.	`string`	Yes	-	-

Spec.source¶

Back to DbSystem spec

DbSystemSource defines nested fields for DbSystem.Source.

Field	Description	Type	Required	Default	Enum
`backupId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the database system backup.	`string`	No	-	-
`isHavingRestoreConfigOverrides`	Deprecated. Don't use.	`boolean`	No	-	-
`jsonData`	-	`string`	No	-	-
`sourceType`	-	`string`	No	-	-

Spec.storageDetails¶

Back to DbSystem spec

DbSystemStorageDetails defines nested fields for DbSystem.StorageDetails.

Field	Description	Type	Required	Default	Enum
`availabilityDomain`	Specifies the availability domain of AD-local storage. If `isRegionallyDurable` is set to true, `availabilityDomain` should not be specified. If `isRegionallyDurable` is set to false, `availabilityDomain` must be specified.	`string`	No	-	-
`iops`	Guaranteed input/output storage requests per second (IOPS) available to the database system.	`integer (int64)`	No	-	-
`isRegionallyDurable`	Specifies if the block volume used for the database system is regional or AD-local. If not specified, it will be set to false. If `isRegionallyDurable` is set to true, `availabilityDomain` should not be specified. If `isRegionallyDurable` is set to false, `availabilityDomain` must be specified.	`boolean`	Yes	-	-
`jsonData`	-	`string`	No	-	-
`systemType`	-	`string`	No	-	-

Status¶

DbSystemStatus defines the observed state of DbSystem.

Field	Description	Type	Required	Default	Enum
`adminPasswordSource`	The last applied secret reference for the administrative password.	`object`	No	-	-
`adminUsername`	The database system administrator username.	`string`	No	-	-
`adminUsernameSource`	The last applied secret reference for the administrative username.	`object`	No	-	-
`compartmentId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the database system.	`string`	No	-	-
`configId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the configuration associated with the database system.	`string`	No	-	-
`dbVersion`	The major and minor versions of the database system software.	`string`	No	-	-
`definedTags`	Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`	`map[string, map[string, string]]`	No	-	-
`description`	A description of the database system.	`string`	No	-	-
`displayName`	A user-friendly display name for the database system. Avoid entering confidential information.	`string`	No	-	-
`freeformTags`	Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`	`map[string, string]`	No	-	-
`id`	A unique identifier for the database system. Immutable on creation.	`string`	No	-	-
`instanceCount`	Count of instances, or nodes, in the database system.	`integer`	No	-	-
`instanceMemorySizeInGBs`	The total amount of memory available to each database instance node, in gigabytes.	`integer`	No	-	-
`instanceOcpuCount`	The total number of OCPUs available to each database instance node.	`integer`	No	-	-
`instances`	The list of instances, or nodes, in the database system.	`list[object]`	No	-	-
`lifecycleDetails`	A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.	`string`	No	-	-
`lifecycleState`	The current state of the database system.	`string`	No	-	-
`managementPolicy`	DbSystemManagementPolicy defines nested fields for DbSystem.ManagementPolicy.	`object`	No	-	-
`networkDetails`	DbSystemNetworkDetails defines nested fields for DbSystem.NetworkDetails.	`object`	No	-	-
`shape`	The name of the shape for the database instance. Example: `VM.Standard.E4.Flex`	`string`	No	-	-
`source`	DbSystemSource defines nested fields for DbSystem.Source.	`object`	No	-	-
`status`	-	`object`	Yes	-	-
`storageDetails`	DbSystemStorageDetails defines nested fields for DbSystem.StorageDetails.	`object`	No	-	-
`systemTags`	System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`	`map[string, map[string, string]]`	No	-	-
`systemType`	Type of the database system.	`string`	No	-	-
`timeCreated`	The date and time that the database system was created, expressed in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z`	`string`	No	-	-
`timeUpdated`	The date and time that the database system was updated, expressed in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z`	`string`	No	-	-

Field	Description	Type	Required	Default	Enum
`availabilityDomain`	The availability domain in which the database instance node is located.	`string`	No	-	-
`description`	Description of the database instance node.	`string`	No	-	-
`displayName`	A user-friendly display name for the database instance node. Avoid entering confidential information.	`string`	No	-	-
`id`	A unique identifier for the database instance node. Immutable on creation.	`string`	No	-	-
`lifecycleDetails`	A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.	`string`	No	-	-
`lifecycleState`	The current state of the database instance node.	`string`	No	-	-
`timeCreated`	The date and time that the database instance node was created, expressed in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z`	`string`	No	-	-
`timeUpdated`	The date and time that the database instance node was updated, expressed in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z`	`string`	No	-	-

Field	Description	Type	Required	Default	Enum
`async`	Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.	`object`	No	-	-
`conditions`	-	`list[object]`	No	-	-
`createdAt`	-	`string (date-time)`	No	-	-
`deletedAt`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`ocid`	-	`string`	No	-	-
`opcRequestId`	OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact.	`string`	No	-	-
`reason`	-	`string`	No	-	-
`requestedAt`	-	`string (date-time)`	No	-	-
`updatedAt`	-	`string (date-time)`	No	-	-

Field	Description	Type	Required	Default	Enum
`message`	-	`string`	No	-	-
`normalizedClass`	-	`string`	Yes	-	`attention`, `canceled`, `failed`, `pending`, `succeeded`, `unknown`
`percentComplete`	-	`number`	No	-	-
`phase`	-	`string`	Yes	-	`create`, `delete`, `update`
`rawOperationType`	-	`string`	No	-	-
`rawStatus`	-	`string`	No	-	-
`source`	-	`string`	Yes	-	`lifecycle`, `none`, `workrequest`
`updatedAt`	-	`string (date-time)`	Yes	-	-
`workRequestId`	-	`string`	No	-	-

Field	Description	Type	Required	Default	Enum
`lastTransitionTime`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`reason`	-	`string`	No	-	-
`status`	-	`string`	Yes	-	-
`type`	-	`string`	Yes	-	-

psql.oracle.com/v1beta1¶

Packages¶

Resources¶

DbSystem¶

Spec¶

Spec.adminPassword¶

Spec.adminPassword.secret¶

Spec.adminUsername¶

Spec.adminUsername.secret¶

Spec.credentials¶

Spec.credentials.passwordDetails¶

Spec.dbConfigurationParams¶

Spec.instancesDetails[]¶

Spec.managementPolicy¶

Spec.managementPolicy.backupPolicy¶

Spec.managementPolicy.backupPolicy.copyPolicy¶

Spec.networkDetails¶

Spec.source¶

Spec.storageDetails¶

Status¶

Status.adminPasswordSource¶

Status.adminPasswordSource.secret¶

Status.adminUsernameSource¶

Status.adminUsernameSource.secret¶

Status.instances[]¶

Status.managementPolicy¶

Status.managementPolicy.backupPolicy¶

Status.managementPolicy.backupPolicy.copyPolicy¶

Status.networkDetails¶

Status.source¶

Status.status¶

Status.status.async¶

Status.status.async.current¶

Status.status.conditions[]¶

Status.storageDetails¶