openstack.cloud.coe_cluster module – Add/Remove COE cluster from OpenStack Cloud
Note
This module is part of the openstack.cloud collection (version 1.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 openstack.cloud.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: openstack.cloud.coe_cluster.
Synopsis
Add or Remove COE cluster from the OpenStack Container Infra service.
Requirements
The below requirements are needed on the host that executes this module.
openstacksdk
openstacksdk >= 0.36, < 0.99.0
python >= 3.6
Parameters
Parameter |
Comments |
|---|---|
How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. |
|
Dictionary containing auth information as needed by the cloud’s auth plugin strategy. For the default password plugin, this would contain auth_url, username, password, project_name and any information about domains (for example, user_domain_name or project_domain_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS_* environment variables are present. |
|
Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. |
|
Ignored. Present for backwards compatibility |
|
A path to a CA Cert bundle that can be used as part of verifying SSL API requests. |
|
A path to a client certificate to use as part of the SSL transaction. |
|
A path to a client key to use as part of the SSL transaction. |
|
Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth_type. This parameter is not needed if auth is provided or if OpenStack OS_* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. |
|
The template ID of cluster template. |
|
Url used for cluster node discovery |
|
The size in GB of the docker volume |
|
The flavor of the minion node for this ClusterTemplate |
|
Endpoint URL type to fetch from the service catalog. Choices:
|
|
Name of the keypair to use. |
|
One or more key/value pairs |
|
The number of master nodes for this cluster Default: |
|
The flavor of the master node for this ClusterTemplate |
|
Name that has to be given to the cluster template |
|
The number of nodes for this cluster Default: |
|
Name of the region. |
|
Log level of the OpenStackSDK Choices:
|
|
Path to the logfile of the OpenStackSDK. If empty no log is written |
|
Indicate desired state of the resource. Choices:
|
|
Timeout for creating the cluster in minutes. Default to 60 mins if not set Default: |
|
Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to Choices:
|
|
Should ansible wait until the requested resource is complete. Choices:
|
Notes
Note
The standard OpenStack environment variables, such as
OS_USERNAMEmay be used instead of providing explicit values.Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at https://docs.openstack.org/openstacksdk/
Examples
# Create a new Kubernetes cluster
- openstack.cloud.coe_cluster:
name: k8s
cluster_template_id: k8s-ha
keypair: mykey
master_count: 3
node_count: 5
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Dictionary describing the cluster. Returned: On success when state is ‘present’ |
|
Api address of cluster master node Returned: success Sample: |
|
The cluster_template UUID Returned: success Sample: |
|
Version of the COE software currently running in this cluster Returned: success Sample: |
|
Version of the container software. Example: docker version. Returned: success Sample: |
|
Timeout for creating the cluster in minutes. Default to 60 if not set. Returned: success Sample: |
|
The time in UTC at which the cluster is created Returned: success Sample: |
|
Url used for cluster node discovery Returned: success Sample: |
|
Fault info collected from the Heat resources of this cluster Returned: success Sample: |
|
The flavor of the minion node for this cluster Returned: success Sample: |
|
Unique UUID for this cluster Returned: success Sample: |
|
Name of the keypair to use. Returned: success Sample: |
|
One or more key/value pairs Returned: success Sample: |
|
IP addresses of cluster master nodes Returned: success Sample: |
|
The number of master nodes for this cluster. Returned: success Sample: |
|
The flavor of the master node for this cluster Returned: success Sample: |
|
Name that has to be given to the cluster Returned: success Sample: |
|
IP addresses of cluster slave nodes Returned: success Sample: |
|
The number of master nodes for this cluster. Returned: success Sample: |
|
Stack id of the Heat stack Returned: success Sample: |
|
Status of the cluster from the heat stack Returned: success Sample: |
|
Status reason of the cluster from the heat stack Returned: success Sample: |
|
The time in UTC at which the cluster is updated Returned: success Sample: |
|
The cluster UUID. Returned: On success when state is ‘present’ Sample: |