Skip to content

bds.oracle.com/v1beta1

Back to API Reference

APIVersion: bds.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

No customer-visible package currently exposes bds.oracle.com/v1beta1.

Resources

Kind Scope Sample Packages
BdsInstance Namespaced Sample -

BdsInstance

Manage OCI Big Data Service instances.

  • Plural: bdsinstances
  • Scope: Namespaced
  • APIVersion: bds.oracle.com/v1beta1
  • Sample: Sample (config/samples/bds_v1beta1_bdsinstance.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

BdsInstanceSpec defines the desired state of BdsInstance.

Field Description Type Required Default Enum
bdsClusterVersionSummary BdsInstanceBdsClusterVersionSummary defines nested fields for BdsInstance.BdsClusterVersionSummary. object No - -
bootstrapScriptUrl Pre-authenticated URL of the script in Object Store that is downloaded and executed. string No - -
clusterAdminPassword Base-64 encoded password for the cluster (and Cloudera Manager) admin user. Not required if the secretId is specified. string No - -
clusterProfile Profile of the Big Data Service cluster. string No - -
clusterPublicKey The SSH public key used to authenticate the cluster connection. string Yes - -
clusterVersion Version of the Hadoop distribution. string Yes - -
compartmentId The OCID of the compartment. string Yes - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. For example, {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
displayName Name of the Big Data Service cluster. string Yes - -
freeformTags Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. For example, {"bar-key": "value"} map[string, string] No - -
isHighAvailability Boolean flag specifying whether or not the cluster is highly available (HA). boolean Yes - -
isSecretReused Boolean flag specifying whether or not to persist the provided secret OCID and reuse it for future operations. boolean No - -
isSecure Boolean flag specifying whether or not the cluster should be set up as secure. boolean Yes - -
kerberosRealmName The user-defined kerberos realm name. string No - -
kmsKeyId The OCID of the Key Management master encryption key. string No - -
networkConfig BdsInstanceNetworkConfig defines nested fields for BdsInstance.NetworkConfig. object No - -
nodes The list of nodes in the Big Data Service cluster. list[object] Yes - -
secretId The secretId for the clusterAdminPassword. string No - -

Spec.bdsClusterVersionSummary

Back to BdsInstance spec

BdsInstanceBdsClusterVersionSummary defines nested fields for BdsInstance.BdsClusterVersionSummary.

Field Description Type Required Default Enum
bdsVersion BDS version to be used for cluster creation string Yes - -
odhVersion ODH version to be used for cluster creation string No - -

Spec.networkConfig

Back to BdsInstance spec

BdsInstanceNetworkConfig defines nested fields for BdsInstance.NetworkConfig.

Field Description Type Required Default Enum
cidrBlock The CIDR IP address block of the VCN. string No - -
isNatGatewayRequired A boolean flag whether to configure a NAT gateway. boolean No - -

Spec.nodes[]

Back to BdsInstance spec

BdsInstanceNode defines nested fields for BdsInstance.Node.

Field Description Type Required Default Enum
blockVolumeSizeInGBs The size of block volume in GB to be attached to a given node. All the details needed for attaching the block volume are managed by service itself. integer (int64) Yes - -
nodeType The Big Data Service cluster node type. string Yes - -
shape Shape of the node. string Yes - -
shapeConfig BdsInstanceNodeShapeConfig defines nested fields for BdsInstance.Node.ShapeConfig. object No - -
subnetId The OCID of the subnet in which the node will be created. string Yes - -

Spec.nodes[].shapeConfig

Back to BdsInstance spec

BdsInstanceNodeShapeConfig defines nested fields for BdsInstance.Node.ShapeConfig.

Field Description Type Required Default Enum
memoryInGBs The total amount of memory available to the node, in gigabytes. integer No - -
nvmes The number of NVMe drives to be used for storage. A single drive has 6.8 TB available. integer No - -
ocpus The total number of OCPUs available to the node. integer No - -

Status

BdsInstanceStatus defines the observed state of BdsInstance.

Field Description Type Required Default Enum
bdsClusterVersionSummary BdsInstanceBdsClusterVersionSummary defines nested fields for BdsInstance.BdsClusterVersionSummary. object No - -
bootstrapScriptUrl pre-authenticated URL of the bootstrap script in Object Store that can be downloaded and executed. string No - -
cloudSqlDetails BdsInstanceCloudSqlDetails defines nested fields for BdsInstance.CloudSqlDetails. object No - -
clusterDetails BdsInstanceClusterDetails defines nested fields for BdsInstance.ClusterDetails. object No - -
clusterProfile Profile of the Big Data Service cluster. string No - -
clusterVersion Version of the Hadoop distribution. string No - -
compartmentId The OCID of the compartment. string No - -
createdBy The user who created the cluster. string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. For example, {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
displayName The name of the cluster. string No - -
freeformTags Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. For example, {"bar-key": "value"} map[string, string] No - -
id The OCID of the Big Data Service resource. string No - -
isCloudSqlConfigured Boolean flag specifying whether or not Cloud SQL should be configured. boolean No - -
isHighAvailability Boolean flag specifying whether or not the cluster is highly available (HA) boolean No - -
isKafkaConfigured Boolean flag specifying whether or not Kafka should be configured. boolean No - -
isSecretReused Boolean flag specifying whether or not to persist the provided secret OCID and reuse it for future operations. boolean No - -
isSecure Boolean flag specifying whether or not the cluster should be set up as secure. boolean No - -
kmsKeyId The OCID of the Key Management master encryption key. string No - -
lifecycleState The state of the cluster. string No - -
networkConfig BdsInstanceNetworkConfig defines nested fields for BdsInstance.NetworkConfig. object No - -
nodes The list of nodes in the cluster. list[object] No - -
numberOfNodes Number of nodes that forming the cluster integer No - -
numberOfNodesRequiringMaintenanceReboot Number of nodes that require a maintenance reboot integer No - -
secretId The secretId for the clusterAdminPassword. string No - -
status - object Yes - -
timeCreated The time the cluster was created, shown as an RFC 3339 formatted datetime string. string No - -
timeEarliestCertificateExpiration The earliest time of certificate expiration date across the certificates of all current nodes under this cluster. string No - -
timeUpdated The time the cluster was updated, shown as an RFC 3339 formatted datetime string. string No - -

Status.bdsClusterVersionSummary

Back to BdsInstance status

BdsInstanceBdsClusterVersionSummary defines nested fields for BdsInstance.BdsClusterVersionSummary.

Field Description Type Required Default Enum
bdsVersion BDS version to be used for cluster creation string Yes - -
odhVersion ODH version to be used for cluster creation string No - -

Status.cloudSqlDetails

Back to BdsInstance status

BdsInstanceCloudSqlDetails defines nested fields for BdsInstance.CloudSqlDetails.

Field Description Type Required Default Enum
blockVolumeSizeInGBs The size of block volume in GB that needs to be attached to a given node. All the necessary details needed for attachment are managed by service itself. integer (int64) No - -
ipAddress IP address of the Cloud SQL node. string No - -
isKerberosMappedToDatabaseUsers Boolean flag specifying whether or not Kerberos principals are mapped to database users. boolean No - -
kerberosDetails Details about the Kerberos principals. list[object] No - -
shape Shape of the node string No - -

Status.cloudSqlDetails.kerberosDetails[]

Back to BdsInstance status

BdsInstanceCloudSqlDetailsKerberosDetail defines nested fields for BdsInstance.CloudSqlDetails.KerberosDetail.

Field Description Type Required Default Enum
keytabFile Location of the keytab file string No - -
principalName Name of the Kerberos principal. string No - -

Status.clusterDetails

Back to BdsInstance status

BdsInstanceClusterDetails defines nested fields for BdsInstance.ClusterDetails.

Field Description Type Required Default Enum
ambariUrl The URL of Ambari string No - -
bdCellVersion Cloud SQL cell version. string No - -
bdaVersion BDA version installed in the cluster string No - -
bdmVersion Big Data Manager version installed in the cluster. string No - -
bdsVersion Big Data Service version installed in the cluster. string No - -
bigDataManagerUrl The URL of Big Data Manager. string No - -
clouderaManagerUrl The URL of Cloudera Manager string No - -
csqlCellVersion Big Data SQL version. string No - -
dbVersion Cloud SQL query server database version. string No - -
hueServerUrl The URL of the Hue server. string No - -
jupyterHubUrl The URL of the Jupyterhub. string No - -
odhVersion Version of the ODH (Oracle Distribution including Apache Hadoop) installed on the cluster. string No - -
osVersion Oracle Linux version installed in the cluster. string No - -
timeCreated The time the cluster was created, shown as an RFC 3339 formatted datetime string. string No - -
timeRefreshed The time the cluster was automatically or manually refreshed, shown as an RFC 3339 formatted datetime string. string No - -

Status.networkConfig

Back to BdsInstance status

BdsInstanceNetworkConfig defines nested fields for BdsInstance.NetworkConfig.

Field Description Type Required Default Enum
cidrBlock The CIDR IP address block of the VCN. string No - -
isNatGatewayRequired A boolean flag whether to configure a NAT gateway. boolean No - -

Status.nodes[]

Back to BdsInstance status

BdsInstanceNode defines nested fields for BdsInstance.Node.

Field Description Type Required Default Enum
blockVolumeSizeInGBs The size of block volume in GB to be attached to a given node. All the details needed for attaching the block volume are managed by service itself. integer (int64) Yes - -
nodeType The Big Data Service cluster node type. string Yes - -
shape Shape of the node. string Yes - -
shapeConfig BdsInstanceNodeShapeConfig defines nested fields for BdsInstance.Node.ShapeConfig. object No - -
subnetId The OCID of the subnet in which the node will be created. string Yes - -

Status.nodes[].shapeConfig

Back to BdsInstance status

BdsInstanceNodeShapeConfig defines nested fields for BdsInstance.Node.ShapeConfig.

Field Description Type Required Default Enum
memoryInGBs The total amount of memory available to the node, in gigabytes. integer No - -
nvmes The number of NVMe drives to be used for storage. A single drive has 6.8 TB available. integer No - -
ocpus The total number of OCPUs available to the node. integer No - -

Status.status

Back to BdsInstance status

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 - -

Status.status.async

Back to BdsInstance status

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.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to BdsInstance status

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 - -

Status.status.conditions[]

Back to BdsInstance status

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