oracle.oci.oci_bds_instance_actions – Perform actions on a BdsInstance resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 5.3.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_bds_instance_actions.

New in version 2.9.0: of oracle.oci

Synopsis

  • Perform actions on a BdsInstance resource in Oracle Cloud Infrastructure

  • For action=add_block_storage, adds block storage to existing worker/compute only worker nodes. The same amount of storage will be added to all worker/compute only worker nodes. No change will be made to storage that is already attached. Block storage cannot be removed.

  • For action=add_cloud_sql, adds Cloud SQL to your cluster. You can use Cloud SQL to query against non-relational data stored in multiple big data sources, including Apache Hive, HDFS, Oracle NoSQL Database, and Apache HBase. Adding Cloud SQL adds a query server node to the cluster and creates cell servers on all the worker nodes in the cluster.

  • For action=add_kafka, adds Kafka to a cluster.

  • For action=add_master_nodes, increases the size (scales out) of a cluster by adding master nodes. The added master nodes will have the same shape and will have the same amount of attached block storage as other master nodes in the cluster.

  • For action=add_utility_nodes, increases the size (scales out) of a cluster by adding utility nodes. The added utility nodes will have the same shape and will have the same amount of attached block storage as other utility nodes in the cluster.

  • For action=add_worker_nodes, increases the size (scales out) a cluster by adding worker nodes(data/compute). The added worker nodes will have the same shape and will have the same amount of attached block storage as other worker nodes in the cluster.

  • For action=certificate_service_info, a list of services and their certificate details.

  • For action=change_compartment, moves a Big Data Service cluster into a different compartment.

  • For action=change_shape, changes the size of a cluster by scaling up or scaling down the nodes. Nodes are scaled up or down by changing the shapes of all the nodes of the same type to the next larger or smaller shape. The node types are master, utility, worker, and Cloud SQL. Only nodes with VM-STANDARD shapes can be scaled.

  • For action=disable_certificate, disabling TLS/SSL for various ODH services running on the BDS cluster.

  • For action=enable_certificate, configuring TLS/SSL for various ODH services running on the BDS cluster.

  • For action=execute_bootstrap_script, execute bootstrap script.

  • For action=get_os_patch_details, get the details of an os patch

  • For action=install_os_patch, install an os patch on a cluster

  • For action=install_patch, install the specified patch to this cluster.

  • For action=list_os_patches, list all available os patches for a given cluster

  • For action=remove_cloud_sql, removes Cloud SQL from the cluster.

  • For action=remove_kafka, remove Kafka from the cluster.

  • For action=remove_node, remove a single node of a Big Data Service cluster

  • For action=renew_certificate, renewing TLS/SSL for various ODH services running on the BDS cluster.

  • For action=restart_node, restarts a single node of a Big Data Service cluster

  • For action=start, starts the BDS cluster that was stopped earlier.

  • For action=stop, stops the BDS cluster that can be started at later point of time.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
action
string / required
    Choices:
  • add_block_storage
  • add_cloud_sql
  • add_kafka
  • add_master_nodes
  • add_utility_nodes
  • add_worker_nodes
  • certificate_service_info
  • change_compartment
  • change_shape
  • disable_certificate
  • enable_certificate
  • execute_bootstrap_script
  • get_os_patch_details
  • install_os_patch
  • install_patch
  • list_os_patches
  • remove_cloud_sql
  • remove_kafka
  • remove_node
  • renew_certificate
  • restart_node
  • start
  • stop
The action to perform on the BdsInstance.
api_user
string
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See config_file_location). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint
string
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See config_file_location). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file
string
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See config_file_location). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided.
api_user_key_pass_phrase
string
Passphrase used by the key referenced in api_user_key_file, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location).
auth_purpose
string
    Choices:
  • service_principal
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
  • security_token
The type of authentication to use for making API requests. By default auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
bds_instance_id
string / required
The OCID of the cluster.

aliases: id
block_volume_size_in_gbs
integer
The size of block volume in GB to be added to each worker node. All the details needed for attaching the block volume are managed by service itself.
Required for action=add_block_storage.
bootstrap_script_url
string
pre-authenticated URL of the bootstrap script in Object Store that can be downloaded and executed.
Applicable only for action=execute_bootstrap_script.
cert_bundle
string
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
cluster_admin_password
string
Base-64 encoded password for the cluster (and Cloudera Manager) admin user.
Required for action=add_block_storage, action=add_cloud_sql, action=add_kafka, action=add_master_nodes, action=add_utility_nodes, action=add_worker_nodes, action=change_shape, action=disable_certificate, action=enable_certificate, action=execute_bootstrap_script, action=install_os_patch, action=install_patch, action=remove_cloud_sql, action=remove_kafka, action=remove_node, action=renew_certificate, action=start, action=stop.
compartment_id
string
The OCID of the compartment.
Required for action=change_compartment.
config_file_location
string
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name
string
The profile to load from the config file referenced by config_file_location. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location.
host_cert_details
list / elements=dictionary
List of leaf certificates to use for services on each host. If custom host certificate is provided the root certificate becomes required.
Applicable only for action=enable_certificateaction=renew_certificate.
certificate
string / required
Certificate value in string format
host_name
string / required
Fully qualified domain name (FQDN) of the host
private_key
string / required
Private key of the provided certificate
is_force_remove_enabled
boolean
    Choices:
  • no
  • yes
Boolean flag specifying whether or not to force remove node if graceful removal fails.
Applicable only for action=remove_node.
is_force_stop_jobs
boolean
    Choices:
  • no
  • yes
Boolean indicating whether to force stop jobs while stopping cluster. Defaults to false.
Applicable only for action=stop.
node_id
string
OCID of the node to be removed.
Required for action=remove_node, action=restart_node.
node_type
string
    Choices:
  • WORKER
  • COMPUTE_ONLY_WORKER
  • KAFKA_BROKER
  • EDGE
Worker node types.
Required for action=add_block_storage, action=add_worker_nodes.
nodes
dictionary
Required for action=change_shape.
cloudsql
string
Change shape of the Cloud SQL node to the desired target shape. Both VM_STANDARD and E4 Flex shapes are allowed here.
cloudsql_shape_config
dictionary
memory_in_gbs
integer
The total amount of memory available to the node, in gigabytes.
nvmes
integer
The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.
ocpus
integer
The total number of OCPUs available to the node.
compute_only_worker
string
Change shape of compute only worker nodes to the desired target shape. Both VM_STANDARD and E4 Flex shapes are allowed here.
compute_only_worker_shape_config
dictionary
memory_in_gbs
integer
The total amount of memory available to the node, in gigabytes.
nvmes
integer
The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.
ocpus
integer
The total number of OCPUs available to the node.
edge
string
Change shape of edge nodes to the desired target shape. Both VM_STANDARD and E4 Flex shapes are allowed here.
edge_shape_config
dictionary
memory_in_gbs
integer
The total amount of memory available to the node, in gigabytes.
nvmes
integer
The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.
ocpus
integer
The total number of OCPUs available to the node.
kafka_broker
string
Change shape of Kafka Broker nodes to the desired target shape. Both VM_STANDARD and E4 Flex shapes are allowed here.
kafka_broker_shape_config
dictionary
memory_in_gbs
integer
The total amount of memory available to the node, in gigabytes.
nvmes
integer
The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.
ocpus
integer
The total number of OCPUs available to the node.
master
string
Change shape of master nodes to the desired target shape. Both VM_STANDARD and E4 Flex shapes are allowed here.
master_shape_config
dictionary
memory_in_gbs
integer
The total amount of memory available to the node, in gigabytes.
nvmes
integer
The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.
ocpus
integer
The total number of OCPUs available to the node.
utility
string
Change shape of utility nodes to the desired target shape. Both VM_STANDARD and E4 Flex shapes are allowed here.
utility_shape_config
dictionary
memory_in_gbs
integer
The total amount of memory available to the node, in gigabytes.
nvmes
integer
The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.
ocpus
integer
The total number of OCPUs available to the node.
worker
string
Change shape of worker nodes to the desired target shape. Both VM_STANDARD and E4 Flex shapes are allowed here.
worker_shape_config
dictionary
memory_in_gbs
integer
The total amount of memory available to the node, in gigabytes.
nvmes
integer
The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.
ocpus
integer
The total number of OCPUs available to the node.
number_of_kafka_nodes
integer
Number of Kafka nodes for the cluster.
Required for action=add_kafka.
number_of_master_nodes
integer
Number of additional master nodes for the cluster.
Required for action=add_master_nodes.
number_of_utility_nodes
integer
Number of additional utility nodes for the cluster.
Required for action=add_utility_nodes.
number_of_worker_nodes
integer
Number of additional worker nodes for the cluster.
Required for action=add_worker_nodes.
os_patch_version
string
The version of the OS patch.
Required for action=get_os_patch_details, action=install_os_patch.
realm_specific_endpoint_template_enabled
boolean
    Choices:
  • no
  • yes
Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
region
string
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See config_file_location). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
root_certificate
string
Plain text certificate/s in order, separated by new line character. If not provided in request a self-signed root certificate is generated inside the cluster. In case hostCertDetails is provided, root certificate is mandatory.
Applicable only for action=enable_certificateaction=renew_certificate.
server_key_password
string
Base-64 encoded password for CA certificate's private key. This value can be empty.
Applicable only for action=enable_certificateaction=renew_certificate.
services
list / elements=string
List of services for which TLS/SSL needs to be enabled.
Required for action=certificate_service_info, action=disable_certificate, action=enable_certificate.
shape
string
Shape of the node.
Required for action=add_cloud_sql, action=add_kafka.
shape_config
dictionary
Applicable only for action=add_cloud_sqlaction=add_kafkaaction=add_master_nodesaction=add_utility_nodesaction=add_worker_nodes.
memory_in_gbs
integer
The total amount of memory available to the node, in gigabytes.
nvmes
integer
The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.
ocpus
integer
The total number of OCPUs available to the node.
sort_by
string
    Choices:
  • timeCreated
  • displayName
The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.
Applicable only for action=list_os_patches.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either 'asc' or 'desc'.
Applicable only for action=list_os_patches.
tenancy
string
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See config_file_location). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm
version
string
The version of the patch to be installed.
Required for action=install_patch.
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Examples

- name: Perform action add_block_storage on bds_instance
  oci_bds_instance_actions:
    # required
    node_type: WORKER
    block_volume_size_in_gbs: 56
    bds_instance_id: "ocid1.bdsinstance.oc1..xxxxxxEXAMPLExxxxxx"
    cluster_admin_password: example-password
    action: add_block_storage

- name: Perform action add_cloud_sql on bds_instance
  oci_bds_instance_actions:
    # required
    shape: shape_example
    bds_instance_id: "ocid1.bdsinstance.oc1..xxxxxxEXAMPLExxxxxx"
    cluster_admin_password: example-password
    action: add_cloud_sql

    # optional
    block_volume_size_in_gbs: 56
    shape_config:
      # optional
      ocpus: 56
      memory_in_gbs: 56
      nvmes: 56

- name: Perform action add_kafka on bds_instance
  oci_bds_instance_actions:
    # required
    number_of_kafka_nodes: 56
    shape: shape_example
    bds_instance_id: "ocid1.bdsinstance.oc1..xxxxxxEXAMPLExxxxxx"
    cluster_admin_password: example-password
    action: add_kafka

    # optional
    block_volume_size_in_gbs: 56
    shape_config:
      # optional
      ocpus: 56
      memory_in_gbs: 56
      nvmes: 56

- name: Perform action add_master_nodes on bds_instance
  oci_bds_instance_actions:
    # required
    number_of_master_nodes: 56
    bds_instance_id: "ocid1.bdsinstance.oc1..xxxxxxEXAMPLExxxxxx"
    cluster_admin_password: example-password
    action: add_master_nodes

    # optional
    shape: shape_example
    block_volume_size_in_gbs: 56
    shape_config:
      # optional
      ocpus: 56
      memory_in_gbs: 56
      nvmes: 56

- name: Perform action add_utility_nodes on bds_instance
  oci_bds_instance_actions:
    # required
    number_of_utility_nodes: 56
    bds_instance_id: "ocid1.bdsinstance.oc1..xxxxxxEXAMPLExxxxxx"
    cluster_admin_password: example-password
    action: add_utility_nodes

    # optional
    shape: shape_example
    block_volume_size_in_gbs: 56
    shape_config:
      # optional
      ocpus: 56
      memory_in_gbs: 56
      nvmes: 56

- name: Perform action add_worker_nodes on bds_instance
  oci_bds_instance_actions:
    # required
    number_of_worker_nodes: 56
    node_type: WORKER
    bds_instance_id: "ocid1.bdsinstance.oc1..xxxxxxEXAMPLExxxxxx"
    cluster_admin_password: example-password
    action: add_worker_nodes

    # optional
    shape: shape_example
    block_volume_size_in_gbs: 56
    shape_config:
      # optional
      ocpus: 56
      memory_in_gbs: 56
      nvmes: 56

- name: Perform action certificate_service_info on bds_instance
  oci_bds_instance_actions:
    # required
    services: [ "services_example" ]
    bds_instance_id: "ocid1.bdsinstance.oc1..xxxxxxEXAMPLExxxxxx"
    action: certificate_service_info

- name: Perform action change_compartment on bds_instance
  oci_bds_instance_actions:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    bds_instance_id: "ocid1.bdsinstance.oc1..xxxxxxEXAMPLExxxxxx"
    action: change_compartment

- name: Perform action change_shape on bds_instance
  oci_bds_instance_actions:
    # required
    nodes:
      # optional
      worker: worker_example
      worker_shape_config:
        # optional
        ocpus: 56
        memory_in_gbs: 56
        nvmes: 56
      compute_only_worker: compute_only_worker_example
      compute_only_worker_shape_config:
        # optional
        ocpus: 56
        memory_in_gbs: 56
        nvmes: 56
      master: master_example
      master_shape_config:
        # optional
        ocpus: 56
        memory_in_gbs: 56
        nvmes: 56
      utility: utility_example
      utility_shape_config:
        # optional
        ocpus: 56
        memory_in_gbs: 56
        nvmes: 56
      cloudsql: cloudsql_example
      cloudsql_shape_config:
        # optional
        ocpus: 56
        memory_in_gbs: 56
        nvmes: 56
      edge: edge_example
      edge_shape_config:
        # optional
        ocpus: 56
        memory_in_gbs: 56
        nvmes: 56
      kafka_broker: kafka_broker_example
      kafka_broker_shape_config:
        # optional
        ocpus: 56
        memory_in_gbs: 56
        nvmes: 56
    bds_instance_id: "ocid1.bdsinstance.oc1..xxxxxxEXAMPLExxxxxx"
    cluster_admin_password: example-password
    action: change_shape

- name: Perform action disable_certificate on bds_instance
  oci_bds_instance_actions:
    # required
    services: [ "services_example" ]
    bds_instance_id: "ocid1.bdsinstance.oc1..xxxxxxEXAMPLExxxxxx"
    cluster_admin_password: example-password
    action: disable_certificate

- name: Perform action enable_certificate on bds_instance
  oci_bds_instance_actions:
    # required
    services: [ "services_example" ]
    bds_instance_id: "ocid1.bdsinstance.oc1..xxxxxxEXAMPLExxxxxx"
    cluster_admin_password: example-password
    action: enable_certificate

    # optional
    root_certificate: "-----BEGIN CERTIFICATE----MIIBIjANBgkqhkiG9w0BA..-----END PUBLIC KEY-----"
    host_cert_details:
    - # required
      host_name: host_name_example
      certificate: "-----BEGIN CERTIFICATE----MIIBIjANBgkqhkiG9w0BA..-----END PUBLIC KEY-----"
      private_key: private_key_example
    server_key_password: example-password

- name: Perform action execute_bootstrap_script on bds_instance
  oci_bds_instance_actions:
    # required
    bds_instance_id: "ocid1.bdsinstance.oc1..xxxxxxEXAMPLExxxxxx"
    cluster_admin_password: example-password
    action: execute_bootstrap_script

    # optional
    bootstrap_script_url: bootstrap_script_url_example

- name: Perform action get_os_patch_details on bds_instance
  oci_bds_instance_actions:
    # required
    os_patch_version: os_patch_version_example
    bds_instance_id: "ocid1.bdsinstance.oc1..xxxxxxEXAMPLExxxxxx"
    action: get_os_patch_details

- name: Perform action install_os_patch on bds_instance
  oci_bds_instance_actions:
    # required
    os_patch_version: os_patch_version_example
    bds_instance_id: "ocid1.bdsinstance.oc1..xxxxxxEXAMPLExxxxxx"
    cluster_admin_password: example-password
    action: install_os_patch

- name: Perform action install_patch on bds_instance
  oci_bds_instance_actions:
    # required
    version: version_example
    bds_instance_id: "ocid1.bdsinstance.oc1..xxxxxxEXAMPLExxxxxx"
    cluster_admin_password: example-password
    action: install_patch

- name: Perform action list_os_patches on bds_instance
  oci_bds_instance_actions:
    # required
    bds_instance_id: "ocid1.bdsinstance.oc1..xxxxxxEXAMPLExxxxxx"
    action: list_os_patches

    # optional
    sort_by: timeCreated
    sort_order: ASC

- name: Perform action remove_cloud_sql on bds_instance
  oci_bds_instance_actions:
    # required
    bds_instance_id: "ocid1.bdsinstance.oc1..xxxxxxEXAMPLExxxxxx"
    cluster_admin_password: example-password
    action: remove_cloud_sql

- name: Perform action remove_kafka on bds_instance
  oci_bds_instance_actions:
    # required
    bds_instance_id: "ocid1.bdsinstance.oc1..xxxxxxEXAMPLExxxxxx"
    cluster_admin_password: example-password
    action: remove_kafka

- name: Perform action remove_node on bds_instance
  oci_bds_instance_actions:
    # required
    node_id: "ocid1.node.oc1..xxxxxxEXAMPLExxxxxx"
    bds_instance_id: "ocid1.bdsinstance.oc1..xxxxxxEXAMPLExxxxxx"
    cluster_admin_password: example-password
    action: remove_node

    # optional
    is_force_remove_enabled: true

- name: Perform action renew_certificate on bds_instance
  oci_bds_instance_actions:
    # required
    bds_instance_id: "ocid1.bdsinstance.oc1..xxxxxxEXAMPLExxxxxx"
    cluster_admin_password: example-password
    action: renew_certificate

    # optional
    services: [ "services_example" ]
    root_certificate: "-----BEGIN CERTIFICATE----MIIBIjANBgkqhkiG9w0BA..-----END PUBLIC KEY-----"
    host_cert_details:
    - # required
      host_name: host_name_example
      certificate: "-----BEGIN CERTIFICATE----MIIBIjANBgkqhkiG9w0BA..-----END PUBLIC KEY-----"
      private_key: private_key_example
    server_key_password: example-password

- name: Perform action restart_node on bds_instance
  oci_bds_instance_actions:
    # required
    node_id: "ocid1.node.oc1..xxxxxxEXAMPLExxxxxx"
    bds_instance_id: "ocid1.bdsinstance.oc1..xxxxxxEXAMPLExxxxxx"
    action: restart_node

- name: Perform action start on bds_instance
  oci_bds_instance_actions:
    # required
    bds_instance_id: "ocid1.bdsinstance.oc1..xxxxxxEXAMPLExxxxxx"
    cluster_admin_password: example-password
    action: start

- name: Perform action stop on bds_instance
  oci_bds_instance_actions:
    # required
    bds_instance_id: "ocid1.bdsinstance.oc1..xxxxxxEXAMPLExxxxxx"
    cluster_admin_password: example-password
    action: stop

    # optional
    is_force_stop_jobs: true

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
bds_instance
complex
on success
Details of the BdsInstance resource acted upon by the current operation

Sample:
{'bootstrap_script_url': 'bootstrap_script_url_example', 'cloud_sql_details': {'block_volume_size_in_gbs': 56, 'ip_address': 'ip_address_example', 'is_kerberos_mapped_to_database_users': True, 'kerberos_details': [{'keytab_file': 'keytab_file_example', 'principal_name': 'principal_name_example'}], 'shape': 'shape_example'}, 'cluster_details': {'ambari_url': 'ambari_url_example', 'bd_cell_version': 'bd_cell_version_example', 'bda_version': 'bda_version_example', 'bdm_version': 'bdm_version_example', 'bds_version': 'bds_version_example', 'big_data_manager_url': 'big_data_manager_url_example', 'cloudera_manager_url': 'cloudera_manager_url_example', 'csql_cell_version': 'csql_cell_version_example', 'db_version': 'db_version_example', 'hue_server_url': 'hue_server_url_example', 'jupyter_hub_url': 'jupyter_hub_url_example', 'odh_version': 'odh_version_example', 'os_version': 'os_version_example', 'time_created': '2013-10-20T19:20:30+01:00', 'time_refreshed': '2013-10-20T19:20:30+01:00'}, 'cluster_profile': 'HADOOP_EXTENDED', 'cluster_version': 'CDH5', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'created_by': 'created_by_example', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_cloud_sql_configured': True, 'is_high_availability': True, 'is_kafka_configured': True, 'is_secure': True, 'kms_key_id': 'ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'CREATING', 'network_config': {'cidr_block': 'cidr_block_example', 'is_nat_gateway_required': True}, 'nodes': [{'attached_block_volumes': [{'volume_attachment_id': 'ocid1.volumeattachment.oc1..xxxxxxEXAMPLExxxxxx', 'volume_size_in_gbs': 56}], 'availability_domain': 'Uocm:PHX-AD-1', 'display_name': 'display_name_example', 'fault_domain': 'FAULT-DOMAIN-1', 'hostname': 'hostname_example', 'image_id': 'ocid1.image.oc1..xxxxxxEXAMPLExxxxxx', 'instance_id': 'ocid1.instance.oc1..xxxxxxEXAMPLExxxxxx', 'ip_address': 'ip_address_example', 'lifecycle_state': 'CREATING', 'local_disks_total_size_in_gbs': 1.2, 'memory_in_gbs': 56, 'node_type': 'MASTER', 'nvmes': 56, 'ocpus': 56, 'shape': 'shape_example', 'ssh_fingerprint': 'ssh_fingerprint_example', 'subnet_id': 'ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx', 'time_created': '2013-10-20T19:20:30+01:00', 'time_maintenance_reboot_due': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}], 'number_of_nodes': 56, 'number_of_nodes_requiring_maintenance_reboot': 56, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}
 
bootstrap_script_url
string
on success
pre-authenticated URL of the bootstrap script in Object Store that can be downloaded and executed.

Sample:
bootstrap_script_url_example
 
cloud_sql_details
complex
on success

   
block_volume_size_in_gbs
integer
on success
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.

Sample:
56
   
ip_address
string
on success
IP address of the Cloud SQL node.

Sample:
ip_address_example
   
is_kerberos_mapped_to_database_users
boolean
on success
Boolean flag specifying whether or not Kerberos principals are mapped to database users.

Sample:
True
   
kerberos_details
complex
on success
Details about the Kerberos principals.

     
keytab_file
string
on success
Location of the keytab file

Sample:
keytab_file_example
     
principal_name
string
on success
Name of the Kerberos principal.

Sample:
principal_name_example
   
shape
string
on success
Shape of the node

Sample:
shape_example
 
cluster_details
complex
on success

   
ambari_url
string
on success
The URL of Ambari

Sample:
ambari_url_example
   
bd_cell_version
string
on success
Cloud SQL cell version.

Sample:
bd_cell_version_example
   
bda_version
string
on success
BDA version installed in the cluster

Sample:
bda_version_example
   
bdm_version
string
on success
Big Data Manager version installed in the cluster.

Sample:
bdm_version_example
   
bds_version
string
on success
Big Data Service version installed in the cluster.

Sample:
bds_version_example
   
big_data_manager_url
string
on success
The URL of Big Data Manager.

Sample:
big_data_manager_url_example
   
cloudera_manager_url
string
on success
The URL of Cloudera Manager

Sample:
cloudera_manager_url_example
   
csql_cell_version
string
on success
Big Data SQL version.

Sample:
csql_cell_version_example
   
db_version
string
on success
Cloud SQL query server database version.

Sample:
db_version_example
   
hue_server_url
string
on success
The URL of the Hue server.

Sample:
hue_server_url_example
   
jupyter_hub_url
string
on success
The URL of the Jupyterhub.

Sample:
jupyter_hub_url_example
   
odh_version
string
on success
Version of the ODH (Oracle Distribution including Apache Hadoop) installed on the cluster.

Sample:
odh_version_example
   
os_version
string
on success
Oracle Linux version installed in the cluster.

Sample:
os_version_example
   
time_created
string
on success
The time the cluster was created, shown as an RFC 3339 formatted datetime string.

Sample:
2013-10-20T19:20:30+01:00
   
time_refreshed
string
on success
The time the cluster was automatically or manually refreshed, shown as an RFC 3339 formatted datetime string.

Sample:
2013-10-20T19:20:30+01:00
 
cluster_profile
string
on success
Profile of the Big Data Service cluster.

Sample:
HADOOP_EXTENDED
 
cluster_version
string
on success
Version of the Hadoop distribution.

Sample:
CDH5
 
compartment_id
string
on success
The OCID of the compartment.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
created_by
string
on success
The user who created the cluster.

Sample:
created_by_example
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. For example, `{"foo-namespace": {"bar-key": "value"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
display_name
string
on success
The name of the cluster.

Sample:
display_name_example
 
freeform_tags
dictionary
on success
Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. For example, `{"bar-key": "value"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
The OCID of the Big Data Service resource.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
is_cloud_sql_configured
boolean
on success
Boolean flag specifying whether or not Cloud SQL should be configured.

Sample:
True
 
is_high_availability
boolean
on success
Boolean flag specifying whether or not the cluster is highly available (HA)

Sample:
True
 
is_kafka_configured
boolean
on success
Boolean flag specifying whether or not Kafka should be configured.

Sample:
True
 
is_secure
boolean
on success
Boolean flag specifying whether or not the cluster should be set up as secure.

Sample:
True
 
kms_key_id
string
on success
The OCID of the Key Management master encryption key.

Sample:
ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_state
string
on success
The state of the cluster.

Sample:
CREATING
 
network_config
complex
on success

   
cidr_block
string
on success
The CIDR IP address block of the VCN.

Sample:
cidr_block_example
   
is_nat_gateway_required
boolean
on success
A boolean flag whether to configure a NAT gateway.

Sample:
True
 
nodes
complex
on success
The list of nodes in the cluster.

   
attached_block_volumes
complex
on success
The list of block volumes attached to a given node.

     
volume_attachment_id
string
on success
The OCID of the volume attachment.

Sample:
ocid1.volumeattachment.oc1..xxxxxxEXAMPLExxxxxx
     
volume_size_in_gbs
integer
on success
The size of the volume in GBs.

Sample:
56
   
availability_domain
string
on success
The name of the availability domain in which the node is running.

Sample:
Uocm:PHX-AD-1
   
display_name
string
on success
The name of the node.

Sample:
display_name_example
   
fault_domain
string
on success
The name of the fault domain in which the node is running.

Sample:
FAULT-DOMAIN-1
   
hostname
string
on success
The fully-qualified hostname (FQDN) of the node.

Sample:
hostname_example
   
image_id
string
on success
The OCID of the image from which the node was created.

Sample:
ocid1.image.oc1..xxxxxxEXAMPLExxxxxx
   
instance_id
string
on success
The OCID of the underlying Oracle Cloud Infrastructure Compute instance.

Sample:
ocid1.instance.oc1..xxxxxxEXAMPLExxxxxx
   
ip_address
string
on success
IP address of the node.

Sample:
ip_address_example
   
lifecycle_state
string
on success
The state of the node.

Sample:
CREATING
   
local_disks_total_size_in_gbs
float
on success
The aggregate size of all local disks, in gigabytes. If the instance does not have any local disks, this field is null.

Sample:
1.2
   
memory_in_gbs
integer
on success
The total amount of memory available to the node, in gigabytes.

Sample:
56
   
node_type
string
on success
Cluster node type.

Sample:
MASTER
   
nvmes
integer
on success
The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.

Sample:
56
   
ocpus
integer
on success
The total number of OCPUs available to the node.

Sample:
56
   
shape
string
on success
Shape of the node.

Sample:
shape_example
   
ssh_fingerprint
string
on success
The fingerprint of the SSH key used for node access.

Sample:
ssh_fingerprint_example
   
subnet_id
string
on success
The OCID of the subnet in which the node is to be created.

Sample:
ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
   
time_created
string
on success
The time the node was created, shown as an RFC 3339 formatted datetime string.

Sample:
2013-10-20T19:20:30+01:00
   
time_maintenance_reboot_due
string
on success
The date and time the instance is expected to be stopped / started, in the format defined by RFC3339.

Sample:
2013-10-20T19:20:30+01:00
   
time_updated
string
on success
The time the cluster was updated, shown as an RFC 3339 formatted datetime string.

Sample:
2013-10-20T19:20:30+01:00
 
number_of_nodes
integer
on success
Number of nodes that forming the cluster

Sample:
56
 
number_of_nodes_requiring_maintenance_reboot
integer
on success
Number of nodes that require a maintenance reboot

Sample:
56
 
time_created
string
on success
The time the cluster was created, shown as an RFC 3339 formatted datetime string.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The time the cluster was updated, shown as an RFC 3339 formatted datetime string.

Sample:
2013-10-20T19:20:30+01:00
certificate_service_info_summary
complex
on success
Details of the BdsInstance resource acted upon by the current operation

Sample:
{'host_specific_certificate_details': [{'certificate_type': 'CUSTOM_SIGNED', 'host_name': 'host_name_example', 'time_expiry': '2013-10-20T19:20:30+01:00'}], 'service': 'ZOOKEEPER', 'service_certificate_status': 'ENABLED'}
 
host_specific_certificate_details
complex
on success
List of Host specific certificate details

   
certificate_type
string
on success
Type of certificate self signed or CA signed

Sample:
CUSTOM_SIGNED
   
host_name
string
on success
Name of the host.

Sample:
host_name_example
   
time_expiry
string
on success
The time the certificate expires, shown as an RFC 3339 formatted datetime string.

Sample:
2013-10-20T19:20:30+01:00
 
service
string
on success
Name of the service

Sample:
ZOOKEEPER
 
service_certificate_status
string
on success
Whether certificate is enabled or disabled

Sample:
ENABLED
os_patch_details
complex
on success
Details of the BdsInstance resource acted upon by the current operation

Sample:
{'min_bds_version': 'min_bds_version_example', 'min_compatible_odh_version_map': {}, 'os_patch_version': 'os_patch_version_example', 'patch_type': 'REGULAR', 'release_date': '2013-10-20T19:20:30+01:00', 'target_packages': [{'package_name': 'package_name_example', 'related_cv_es': [], 'target_version': 'target_version_example', 'update_type': 'INSTALL'}]}
 
min_bds_version
string
on success
Minimum BDS version required to install current OS patch.

Sample:
min_bds_version_example
 
min_compatible_odh_version_map
dictionary
on success
Map of major ODH version to minimum ODH version required to install current OS patch. e.g. {ODH0.9: 0.9.1}

 
os_patch_version
string
on success
Version of the os patch.

Sample:
os_patch_version_example
 
patch_type
string
on success
Type of a specific os patch. REGULAR means standard released os patches. CUSTOM means os patches with some customizations. EMERGENT means os patches with some emergency fixes that should be prioritized.

Sample:
REGULAR
 
release_date
string
on success
Released date of the OS patch.

Sample:
2013-10-20T19:20:30+01:00
 
target_packages
complex
on success
List of summaries of individual target packages.

   
package_name
string
on success
The package's name.

Sample:
package_name_example
   
related_cv_es
list / elements=string
on success
Related CVEs of the package update.

   
target_version
string
on success
The target version of the package.

Sample:
target_version_example
   
update_type
string
on success
The action that current package will be executed on the cluster.

Sample:
INSTALL
os_patch_summary
complex
on success
Details of the BdsInstance resource acted upon by the current operation

Sample:
{'os_patch_version': 'os_patch_version_example', 'release_date': '2013-10-20T19:20:30+01:00'}
 
os_patch_version
string
on success
Patch version of the os patch.

Sample:
os_patch_version_example
 
release_date
string
on success
The time when the OS patch was released.

Sample:
2013-10-20T19:20:30+01:00


Authors

  • Oracle (@oracle)