Big Data Service: BdsInstance¶
Manage OCI Big Data Service instances. This page is generated from checked-in package metadata, CRD schemas, and sample manifests.
Resource Snapshot¶
| Field | Value |
|---|---|
| Service | bds |
| Resource | BdsInstance |
| API Version | bds.oracle.com/v1beta1 |
| Package | Big Data Service |
| Support Status | Preview |
| Latest Released Version | v2.1.0-alpha |
| Install Namespace | oci-service-operator-bds-system |
Quick Links¶
- Resource Guide Index
- Setup Guide
- Package Page
- API Reference
- Spec Reference
- Status Reference
- Rendered Sample (
config/samples/bds_v1beta1_bdsinstance.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 |
|---|---|---|---|
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 |
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 |
|---|---|---|---|
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 |
Sample Manifest¶
This example is generated from the checked-in sample manifest at config/samples/bds_v1beta1_bdsinstance.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: bds.oracle.com/v1beta1
kind: BdsInstance
metadata:
name: bdsinstance-sample
spec: {}