oracle.oci.oci_bds_instance – Manage 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.
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_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.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
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
|
|
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
|
|
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
|
|
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
|
|
Boolean flag specifying whether or not the cluster is highly available (HA).
Required for create using state=present.
|
||
|
is_secure
boolean
|
|
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
|
|
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.
|
|||
|
realm_specific_endpoint_template_enabled
boolean
|
|
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. |
|||
|
state
string
|
|
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
|
|
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.
|
|||
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
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:
Authors¶
Oracle (@oracle)