oracle.oci.oci_data_flow_pool – Manage a Pool 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_data_flow_pool.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • For state=present, create a pool to be used by dataflow runs or applications.

  • This resource has the following action operations in the oracle.oci.oci_data_flow_pool_actions module: change_compartment, 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
  • 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.
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.
compartment_id
string
The OCID of a 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.
configurations
list / elements=dictionary
List of PoolConfig items.
Required for create using state=present.
This parameter is updatable.
max
integer
Maximum number of compute instances in the pool for a given compute shape.
min
integer
Minimum number of compute instances in the pool for a given compute shape.
shape
string
The compute shape of the resources you would like to provision.
shape_config
dictionary
memory_in_gbs
float
The amount of memory used for the driver or executors.
ocpus
float
The total number of OCPUs used for the driver or executors. See here for details.
defined_tags
dictionary
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}`
This parameter is updatable.
description
string
A user-friendly description. Avoid entering confidential information.
This parameter is updatable.
display_name
string
A user-friendly name. It does not have to be unique. Avoid entering confidential information.
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
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{"Department": "Finance"}`
This parameter is updatable.
idle_timeout_in_minutes
integer
Optional timeout value in minutes used to auto stop Pools. A Pool will be auto stopped after inactivity for this amount of time period. If value not set, pool will not be auto stopped auto.
This parameter is updatable.
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.
pool_id
string
The unique ID for a pool.
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
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.
schedules
list / elements=dictionary
A list of schedules for pool to auto start and stop.
This parameter is updatable.
day_of_week
string
    Choices:
  • SUNDAY
  • MONDAY
  • TUESDAY
  • WEDNESDAY
  • THURSDAY
  • FRIDAY
  • SATURDAY
Day of the week SUN-SAT
start_time
integer
Hour of the day to start or stop pool.
stop_time
integer
Hour of the day to stop the pool.
state
string
    Choices:
  • present ←
  • absent
The state of the Pool.
Use state=present to create or update a Pool.
Use state=absent to delete a Pool.
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 pool
  oci_data_flow_pool:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    configurations:
    - # optional
      shape: shape_example
      shape_config:
        # optional
        ocpus: 3.4
        memory_in_gbs: 3.4
      min: 56
      max: 56

    # optional
    description: description_example
    schedules:
    - # optional
      day_of_week: SUNDAY
      start_time: 56
      stop_time: 56
    idle_timeout_in_minutes: 56
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update pool
  oci_data_flow_pool:
    # required
    pool_id: "ocid1.pool.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    display_name: display_name_example
    description: description_example
    configurations:
    - # optional
      shape: shape_example
      shape_config:
        # optional
        ocpus: 3.4
        memory_in_gbs: 3.4
      min: 56
      max: 56
    schedules:
    - # optional
      day_of_week: SUNDAY
      start_time: 56
      stop_time: 56
    idle_timeout_in_minutes: 56
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

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

    # optional
    description: description_example
    configurations:
    - # optional
      shape: shape_example
      shape_config:
        # optional
        ocpus: 3.4
        memory_in_gbs: 3.4
      min: 56
      max: 56
    schedules:
    - # optional
      day_of_week: SUNDAY
      start_time: 56
      stop_time: 56
    idle_timeout_in_minutes: 56
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Delete pool
  oci_data_flow_pool:
    # required
    pool_id: "ocid1.pool.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete pool using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_data_flow_pool:
    # 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
pool
complex
on success
Details of the Pool resource acted upon by the current operation

Sample:
{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'configurations': [{'max': 56, 'min': 56, 'shape': 'shape_example', 'shape_config': {'memory_in_gbs': 10, 'ocpus': 10}}], 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'idle_timeout_in_minutes': 56, 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'ACCEPTED', 'owner_principal_id': 'ocid1.ownerprincipal.oc1..xxxxxxEXAMPLExxxxxx', 'owner_user_name': 'owner_user_name_example', 'pool_metrics': {'active_runs_count': 56, 'actively_used_node_count': [{'count': 56, 'logical_shape': 'logical_shape_example'}], 'time_last_metrics_updated': '2013-10-20T19:20:30+01:00', 'time_last_started': '2013-10-20T19:20:30+01:00', 'time_last_stopped': '2013-10-20T19:20:30+01:00', 'time_last_used': '2013-10-20T19:20:30+01:00'}, 'schedules': [{'day_of_week': 'SUNDAY', 'start_time': 56, 'stop_time': 56}], 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}
 
compartment_id
string
on success
The OCID of a compartment.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
configurations
complex
on success
List of PoolConfig items.
   
max
integer
on success
Maximum number of compute instances in the pool for a given compute shape.

Sample:
56
   
min
integer
on success
Minimum number of compute instances in the pool for a given compute shape.

Sample:
56
   
shape
string
on success
The compute shape of the resources you would like to provision.

Sample:
shape_example
   
shape_config
complex
on success

     
memory_in_gbs
float
on success
The amount of memory used for the driver or executors.

Sample:
10
     
ocpus
float
on success
The total number of OCPUs used for the driver or executors. See here for details.

Sample:
10
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
description
string
on success
A user-friendly description. Avoid entering confidential information.

Sample:
description_example
 
display_name
string
on success
A user-friendly name. It does not have to be unique. Avoid entering confidential information.

Sample:
display_name_example
 
freeform_tags
dictionary
on success
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{"Department": "Finance"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
The OCID of a pool. Unique Id to indentify a dataflow pool resource.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
idle_timeout_in_minutes
integer
on success
Optional timeout value in minutes used to auto stop Pools. A Pool will be auto stopped after inactivity for this amount of time period. If value not set, pool will not be auto stopped auto.

Sample:
56
 
lifecycle_details
string
on success
The detailed messages about the lifecycle state.

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
The current state of this pool.

Sample:
ACCEPTED
 
owner_principal_id
string
on success
The OCID of the user who created the resource.

Sample:
ocid1.ownerprincipal.oc1..xxxxxxEXAMPLExxxxxx
 
owner_user_name
string
on success
The username of the user who created the resource. If the username of the owner does not exist, `null` will be returned and the caller should refer to the ownerPrincipalId value instead.

Sample:
owner_user_name_example
 
pool_metrics
complex
on success

   
active_runs_count
integer
on success
The number of runs that are currently running that are using this pool.

Sample:
56
   
actively_used_node_count
complex
on success
A count of the nodes that are currently being used for each shape in this pool.
     
count
integer
on success
The node count of this compute shape.

Sample:
56
     
logical_shape
string
on success
The compute shape of the nodes that the count is for.

Sample:
logical_shape_example
   
time_last_metrics_updated
string
on success
The last time the mertics were updated for this.

Sample:
2013-10-20T19:20:30+01:00
   
time_last_started
string
on success
The last time this pool was started.

Sample:
2013-10-20T19:20:30+01:00
   
time_last_stopped
string
on success
The last time this pool was stopped.

Sample:
2013-10-20T19:20:30+01:00
   
time_last_used
string
on success
The last time a run used this pool.

Sample:
2013-10-20T19:20:30+01:00
 
schedules
complex
on success
A list of schedules for pool to auto start and stop.
   
day_of_week
string
on success
Day of the week SUN-SAT

Sample:
SUNDAY
   
start_time
integer
on success
Hour of the day to start or stop pool.

Sample:
56
   
stop_time
integer
on success
Hour of the day to stop the pool.

Sample:
56
 
time_created
string
on success
The date and time the resource was created, expressed in RFC 3339 timestamp format. Example: `2018-04-03T21:10:29.600Z`

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example: `2018-04-03T21:10:29.600Z`

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


Authors

  • Oracle (@oracle)