oracle.oci.oci_bds_instance – Manage a BdsInstance resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.10.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.

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create, update and delete a BdsInstance resource in Oracle Cloud Infrastructure

  • For state=present, creates a Big Data Service cluster.

  • This resource has the following action operations in the oracle.oci.oci_bds_instance_actions module: add_block_storage, add_cloud_sql, add_worker_nodes, change_compartment, change_shape, install_patch, remove_cloud_sql, remove_node, restart_node, start, stop.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
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
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
The OCID of the cluster.
Required for update using state=present when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.
Required for delete using state=absent when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: id
bootstrap_script_url
string
Pre-authenticated URL of the script in Object Store that is downloaded and executed.
This parameter is updatable.
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 create using state=present.
cluster_profile
string
Profile of the Big Data Service cluster.
cluster_public_key
string
The SSH public key used to authenticate the cluster connection.
Required for create using state=present.
cluster_version
string
Version of the Hadoop distribution.
Required for create using state=present.
compartment_id
string
The OCID of the compartment.
Required for create using state=present.
Required for update when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
Required for delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
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.
defined_tags
dictionary
Defined tags for this resource. Each key is predefined and scoped to a namespace. For example, `{"foo-namespace": {"bar-key": "value"}}`
This parameter is updatable.
display_name
string
Name of the Big Data Service cluster.
Required for create using state=present.
Required for update, delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
This parameter is updatable when OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: name
force_create
boolean
    Choices:
  • no ←
  • yes
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
freeform_tags
dictionary
Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. For example, `{"bar-key": "value"}`
This parameter is updatable.
is_high_availability
boolean
    Choices:
  • no
  • yes
Boolean flag specifying whether or not the cluster is highly available (HA).
Required for create using state=present.
is_secure
boolean
    Choices:
  • no
  • yes
Boolean flag specifying whether or not the cluster should be set up as secure.
Required for create using state=present.
kerberos_realm_name
string
The user-defined kerberos realm name.
key_by
list / elements=string
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
kms_key_id
string
The OCID of the Key Management master encryption key.
This parameter is updatable.
network_config
dictionary
cidr_block
string
The CIDR IP address block of the VCN.
is_nat_gateway_required
boolean
    Choices:
  • no
  • yes
A boolean flag whether to configure a NAT gateway.
nodes
list / elements=dictionary
The list of nodes in the Big Data Service cluster.
Required for create using state=present.
block_volume_size_in_gbs
integer / required
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.
node_type
string / required
The Big Data Service cluster node type.
shape
string / required
Shape of the node.
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.
subnet_id
string / required
The OCID of the subnet in which the node will be created.
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.
state
string
    Choices:
  • present ←
  • absent
The state of the BdsInstance.
Use state=present to create or update a BdsInstance.
Use state=absent to delete a BdsInstance.
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
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: Create bds_instance
  oci_bds_instance:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    cluster_version: cluster_version_example
    cluster_public_key: "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAQEAz..."
    cluster_admin_password: example-password
    is_high_availability: true
    is_secure: true
    nodes:
    - # required
      node_type: node_type_example
      shape: shape_example
      block_volume_size_in_gbs: 56
      subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"

      # optional
      shape_config:
        # optional
        ocpus: 56
        memory_in_gbs: 56
        nvmes: 56
    display_name: display_name_example

    # optional
    network_config:
      # optional
      is_nat_gateway_required: true
      cidr_block: cidr_block_example
    kerberos_realm_name: kerberos_realm_name_example
    cluster_profile: cluster_profile_example
    bootstrap_script_url: bootstrap_script_url_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    kms_key_id: "ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx"

- name: Update bds_instance
  oci_bds_instance:
    # required
    bds_instance_id: "ocid1.bdsinstance.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    display_name: display_name_example
    bootstrap_script_url: bootstrap_script_url_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    kms_key_id: "ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx"

- name: Update bds_instance using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_bds_instance:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example

    # optional
    bootstrap_script_url: bootstrap_script_url_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    kms_key_id: "ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx"

- name: Delete bds_instance
  oci_bds_instance:
    # required
    bds_instance_id: "ocid1.bdsinstance.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete bds_instance using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_bds_instance:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    state: absent

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_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_updated': '2013-10-20T19:20:30+01:00'}], 'number_of_nodes': 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_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_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
 
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


Authors

  • Oracle (@oracle)