oracle.oci.oci_mysql_heat_wave_cluster – Manage a HeatWaveCluster resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.2.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_mysql_heat_wave_cluster
.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to update and delete a HeatWaveCluster resource in Oracle Cloud Infrastructure
This resource has the following action operations in the oracle.oci.oci_mysql_heat_wave_cluster_actions module: add, restart, 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. |
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_size
integer
|
A change to the number of nodes in the HeatWave cluster will result in the entire cluster being torn down and re-created with the new cluster of nodes. This may result in a significant downtime for the analytics capability while the HeatWave cluster is re-provisioned.
This parameter is updatable.
|
|
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 . |
|
db_system_id
string
/ required
|
The DB System OCID.
aliases: id |
|
is_lakehouse_enabled
boolean
|
|
Enable/disable Lakehouse for the HeatWave cluster.
This parameter is updatable.
|
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. |
|
shape_name
string
|
A change to the shape of the nodes in the HeatWave cluster will result in the entire cluster being torn down and re-created with Compute instances of the new Shape. This may result in significant downtime for the analytics capability while the HeatWave cluster is re-provisioned.
This parameter is updatable.
|
|
state
string
|
|
The state of the HeatWaveCluster.
Use state=present to update an existing a HeatWaveCluster.
Use state=absent to delete a HeatWaveCluster.
|
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: Update heat_wave_cluster
oci_mysql_heat_wave_cluster:
# required
db_system_id: "ocid1.dbsystem.oc1..xxxxxxEXAMPLExxxxxx"
# optional
shape_name: shape_name_example
cluster_size: 56
is_lakehouse_enabled: true
- name: Delete heat_wave_cluster
oci_mysql_heat_wave_cluster:
# required
db_system_id: "ocid1.dbsystem.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | ||
---|---|---|---|---|
heat_wave_cluster
complex
|
on success |
Details of the HeatWaveCluster resource acted upon by the current operation
Sample:
{'cluster_nodes': [{'lifecycle_state': 'CREATING', 'node_id': 'ocid1.node.oc1..xxxxxxEXAMPLExxxxxx', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}], 'cluster_size': 56, 'db_system_id': 'ocid1.dbsystem.oc1..xxxxxxEXAMPLExxxxxx', 'is_lakehouse_enabled': True, 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'shape_name': 'shape_name_example', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}
|
||
cluster_nodes
complex
|
on success |
A HeatWave node is a compute host that is part of a HeatWave cluster.
|
||
lifecycle_state
string
|
on success |
The current state of the MySQL HeatWave node.
Sample:
CREATING
|
||
node_id
string
|
on success |
The ID of the node within MySQL HeatWave cluster.
Sample:
ocid1.node.oc1..xxxxxxEXAMPLExxxxxx
|
||
time_created
string
|
on success |
The date and time the MySQL HeatWave node was created, as described by RFC 3339.
Sample:
2013-10-20T19:20:30+01:00
|
||
time_updated
string
|
on success |
The date and time the MySQL HeatWave node was updated, as described by RFC 3339.
Sample:
2013-10-20T19:20:30+01:00
|
||
cluster_size
integer
|
on success |
The number of analytics-processing compute instances, of the specified shape, in the HeatWave cluster.
Sample:
56
|
||
db_system_id
string
|
on success |
The OCID of the parent DB System this HeatWave cluster is attached to.
Sample:
ocid1.dbsystem.oc1..xxxxxxEXAMPLExxxxxx
|
||
is_lakehouse_enabled
boolean
|
on success |
Lakehouse enabled status for the HeatWave cluster.
Sample:
True
|
||
lifecycle_details
string
|
on success |
Additional information about the current lifecycleState.
Sample:
lifecycle_details_example
|
||
lifecycle_state
string
|
on success |
The current state of the HeatWave cluster.
Sample:
CREATING
|
||
shape_name
string
|
on success |
The shape determines resources to allocate to the HeatWave nodes - CPU cores, memory.
Sample:
shape_name_example
|
||
time_created
string
|
on success |
The date and time the HeatWave cluster was created, as described by RFC 3339.
Sample:
2013-10-20T19:20:30+01:00
|
||
time_updated
string
|
on success |
The time the HeatWave cluster was last updated, as described by RFC 3339.
Sample:
2013-10-20T19:20:30+01:00
|
Authors¶
Oracle (@oracle)