oci_cluster - Manage Kubernetes clusters in OCI Container Engine for Kubernetes Service¶
New in version 2.5.
Synopsis¶
- This module allows the user to create, delete and update Kubernetes clusters in OCI Container Engine for Kubernetes Service.
Requirements¶
The below requirements are needed on the host that executes this module.
- python >= 2.6
- Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
Parameters¶
| Parameter | Choices/Defaults | Comments | ||
|---|---|---|---|---|
| api_user |
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_OCID 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 |
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 |
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 |
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_type |
|
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. |
||
| cluster_id |
The OCID of the cluster. Required to update/delete a cluster.
aliases: id |
|||
| compartment_id |
The OCID of the compartment in which to create the cluster. Required to create a cluster.
|
|||
| config_file_location |
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 |
Default: DEFAULT
|
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. |
||
|
force_create
bool |
|
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.
|
||
| key_by |
The list of comma-separated attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource except freeform_tags are used to uniquely identify a resource.
|
|||
| kubernetes_version |
The version of Kubernetes to install into the cluster masters. Required to create a cluster.
|
|||
| name |
The name of the cluster. Avoid entering confidential information. Required to create a cluster.
|
|||
| options |
Optional attributes for the cluster.
|
|||
| add_ons |
Configurable cluster add-ons.
|
|||
| is_tiller_enabled |
Whether or not to enable the Tiller add-on.
|
|||
| is_kubernetes_dashboard_enabled |
Whether or not to enable the Kubernetes Dashboard add-on.
|
|||
| service_lb_subnet_ids |
The OCIDs of the subnets used for Kubernetes services load balancers.
|
|||
| kubernetes_network_config |
Network configuration for Kubernetes.
|
|||
| services_cidr |
The CIDR block for Kubernetes services.
|
|||
| pods_cidr |
The CIDR block for Kubernetes pods.
|
|||
| region |
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 |
|
Create or update a cluster with state=present. Use state=absent to delete a cluster.
|
||
| tenancy |
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 |
|||
| vcn_id |
The OCID of the virtual cloud network (VCN) in which to create the cluster. Required to create a cluster.
|
|||
|
wait
bool |
|
Whether to wait for create or delete operation to complete.
|
||
| wait_timeout |
Default: 1200
|
Time, in seconds, to wait when wait=yes.
|
||
| wait_until |
The lifecycle state to wait for the resource to transition into when wait=yes. By default, when wait=yes, we wait for the resource to get into ACTIVE/ATTACHED/AVAILABLE/PROVISIONED/ RUNNING applicable lifecycle state during create operation & to get into DELETED/DETACHED/ TERMINATED lifecycle state during delete operation.
|
|||
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 a cluster
oci_cluster:
compartment_id: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
name: test_cluster
vcn_id: ocid1.vcn.oc1..xxxxxEXAMPLExxxxx
kubernetes_version: "v1.9.7"
options:
service_lb_subnet_ids:
- ocid1.subnet.oc1..xxxxxEXAMPLExxxxx
- ocid1.subnet.oc1..xxxxxEXAMPLExxxxx
- name: Update name and version of Kubernetes master
oci_cluster:
id: ocid1.cluster.oc1..xxxxxEXAMPLExxxxx
name: ansible_cluster
kubernetes_version: "v1.10.3"
- name: Delete a cluster
oci_cluster:
id: ocid1.cluster.oc1..xxxxxEXAMPLExxxxx
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | |
|---|---|---|---|
|
cluster
complex
|
On successful create, delete & update operations on cluster |
Information about the cluster
Sample:
{'available_kubernetes_upgrades': [], 'endpoints': {'kubernetes': 'xxxxxEXAMPLExxxxx.clusters.oci.oraclecloud.com:xxxx'}, 'name': 'test', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'lifecycle_state': 'ACTIVE', 'id': 'ocid1.cluster.oc1..xxxxxEXAMPLExxxxx', 'vcn_id': 'ocid1.vcn.oc1.iad.xxxxxEXAMPLExxxxx', 'lifecycle_details': '', 'kubernetes_version': 'v1.10.3', 'options': {'add_ons': {'is_tiller_enabled': True, 'is_kubernetes_dashboard_enabled': True}, 'service_lb_subnet_ids': [], 'kubernetes_network_config': {'services_cidr': '10.96.0.0/16', 'pods_cidr': '10.244.0.0/16'}}, 'metadata': {'created_by_user_id': 'ocid1.user.oc1..xxxxxEXAMPLExxxxx', 'deleted_by_work_request_id': None, 'time_updated': None, 'deleted_by_user_id': None, 'updated_by_user_id': None, 'time_created': '2018-07-26T18:42:25+00:00', 'time_deleted': None, 'created_by_work_request_id': 'ocid1.clustersworkrequest.oc1..xxxxxEXAMPLExxxxx', 'updated_by_work_request_id': None}}
|
|
|
available_kubernetes_upgrades
list
|
always |
Available Kubernetes versions to which the clusters masters may be upgraded.
Sample:
['v1.10.3']
|
|
|
endpoints
dict
|
always |
Endpoints served up by the cluster masters.
Sample:
{'kubernetes': 'xxxEXAMPLExxx.us-ashburn-1.clusters.oci.oraclecloud.com:6443'}
|
|
|
name
string
|
always |
The name of the cluster.
Sample:
sample_cluster
|
|
|
compartment_id
string
|
always |
The OCID of the compartment in which the cluster exists.
Sample:
ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
|
|
|
lifecycle_state
string
|
always |
The state of the cluster masters.
Sample:
ACTIVE
|
|
|
id
string
|
always |
The OCID of the cluster.
Sample:
ocid1.cluster.oc1..xxxxxEXAMPLExxxxx
|
|
|
vcn_id
string
|
always |
The OCID of the virtual cloud network (VCN) in which the cluster exists.
|
|
|
lifecycle_details
string
|
always |
Details about the state of the cluster masters.
|
|
|
kubernetes_version
string
|
always |
The version of Kubernetes running on the cluster masters.
Sample:
v1.9.7
|
|
|
options
dict
|
always |
Optional attributes for the cluster.
|
|
|
metadata
dict
|
always |
Metadata about the cluster.
|
|
|
work_request
complex
|
When a new work request is created |
Information of work request
Sample:
{'status': 'ACCEPTED', 'time_finished': '2018-07-26T18:44:13+00:00', 'time_started': '2018-07-26T18:43:26+00:00', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'operation_type': 'CLUSTER_CREATE', 'time_accepted': '2018-07-26T18:42:26+00:00', 'id': 'ocid1.clustersworkrequest.oc1..xxxxxEXAMPLExxxxx', 'resources': [{'entity_uri': '/clusters/ocid1.cluster.oc1..xxxxxEXAMPLExxxxx', 'identifier': 'ocid1.cluster.oc1..xxxxxEXAMPLExxxxx', 'action_type': 'IN_PROGRESS', 'entity_type': 'cluster'}]}
|
|
|
status
string
|
always |
The current status of the work request.
|
|
|
time_finished
datetime
|
always |
The time the work request was finished.
|
|
|
time_started
datetime
|
always |
The time the work request was started.
|
|
|
compartment_id
string
|
always |
The OCID of the compartment in which the work request exists.
|
|
|
operation_type
string
|
always |
The type of work the work request is doing.
|
|
|
time_accepted
datetime
|
always |
The time the work request was accepted.
|
|
|
id
string
|
always |
The OCID of the work request.
|
|
|
resources
list
|
always |
The resources this work request affects.
|
|
Status¶
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Author¶
- Rohit Chaware (@rohitChaware)
Hint
If you notice any issues in this documentation you can edit this document to improve it.