PostgreSQL: DbSystem¶
Manage OCI PostgreSQL DB Systems. This page is generated from checked-in package metadata, CRD schemas, and sample manifests.
Resource Snapshot¶
| Field | Value |
|---|---|
| Service | psql |
| Resource | DbSystem |
| API Version | psql.oracle.com/v1beta1 |
| Package | PostgreSQL |
| Support Status | Preview |
| Latest Released Version | v2.0.0-alpha |
| Install Namespace | oci-service-operator-psql-system |
Quick Links¶
- Resource Guide Index
- Setup Guide
- Package Page
- API Reference
- Spec Reference
- Status Reference
- Rendered Sample (
config/samples/psql_v1beta1_dbsystem.yaml)
Spec Fields¶
This summary shows the top-level spec fields. Use the full API reference for nested fields, defaults, and enum values.
| Field | Description | Type | Required |
|---|---|---|---|
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 |
Status Fields¶
This summary shows the top-level status fields. Use the full API reference for nested fields, defaults, and enum values.
| Field | Description | Type | Required |
|---|---|---|---|
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 |
Sample Manifest¶
This example is generated from the checked-in sample manifest at config/samples/psql_v1beta1_dbsystem.yaml. Replace placeholder values before applying it.
#
# Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
# Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
#
apiVersion: psql.oracle.com/v1beta1
kind: DbSystem
metadata:
name: dbsystem-sample
spec:
compartmentId: ocid1.compartment.oc1..exampleuniqueID
displayName: dbsystem-sample
dbVersion: "14"
shape: PostgreSQL.VM.Standard.E5.Flex
instanceOcpuCount: 2
instanceMemorySizeInGBs: 32
storageDetails:
systemType: OCI_OPTIMIZED_STORAGE
isRegionallyDurable: true
networkDetails:
subnetId: ocid1.subnet.oc1..exampleuniqueID
adminUsername:
secret:
secretName: admin-secret
adminPassword:
secret:
secretName: admin-secret