openstack.cloud.coe_cluster_template module – Add/Remove COE cluster template 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_template
.
Synopsis
Add or Remove COE cluster template 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 Container Orchestration Engine for this clustertemplate Choices:
|
|
The DNS nameserver address Default: |
|
Docker storage driver Choices:
|
|
The size in GB of the docker volume |
|
The external network to attach to the Cluster |
|
The fixed network name to attach to the Cluster |
|
The fixed subnet name to attach to the Cluster |
|
The flavor of the minion node for this ClusterTemplate |
|
Indicates whether created clusters should have a floating ip or not Choices:
|
|
Address of a proxy that will receive all HTTP requests and relay them The format is a URL including a port number |
|
Address of a proxy that will receive all HTTPS requests and relay them. The format is a URL including a port number |
|
Image id the cluster will be based on |
|
Endpoint URL type to fetch from the service catalog. Choices:
|
|
Name or ID of the keypair to use. |
|
One or more key/value pairs |
|
The flavor of the master node for this ClusterTemplate |
|
Indicates whether created clusters should have a load balancer for master nodes or not Choices:
|
|
Name that has to be given to the cluster template |
|
The name of the driver used for instantiating container networks Choices:
|
|
A comma separated list of IPs for which proxies should not be used in the cluster |
|
Indicates whether the ClusterTemplate is public or not Choices:
|
|
Name of the region. |
|
Indicates whether the docker registry is enabled Choices:
|
|
Log level of the OpenStackSDK Choices:
|
|
Path to the logfile of the OpenStackSDK. If empty no log is written |
|
Server type for this ClusterTemplate Choices:
|
|
Indicate desired state of the resource. Choices:
|
|
How long should ansible wait for the requested resource. Default: |
|
Indicates whether the TLS should be disabled Choices:
|
|
Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to Choices:
|
|
The name of the driver used for instantiating container volumes Choices:
|
|
Should ansible wait until the requested resource is complete. Choices:
|
Notes
Note
The standard OpenStack environment variables, such as
OS_USERNAME
may 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 template
- openstack.cloud.coe_cluster_template:
name: k8s
coe: kubernetes
keypair_id: mykey
image_id: 2a8c9888-9054-4b06-a1ca-2bb61f9adb72
public: no
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Dictionary describing the template. Returned: On success when state is ‘present’ |
|
The Container Orchestration Engine for this clustertemplate Returned: success Sample: |
|
The DNS nameserver address Returned: success Sample: |
|
Docker storage driver Returned: success Sample: |
|
The size in GB of the docker volume Returned: success Sample: |
|
The external network to attach to the Cluster Returned: success Sample: |
|
The fixed network name to attach to the Cluster Returned: success Sample: |
|
The fixed subnet name to attach to the Cluster Returned: success Sample: |
|
The flavor of the minion node for this ClusterTemplate Returned: success Sample: |
|
Indicates whether created clusters should have a floating ip or not Returned: success Sample: |
|
Address of a proxy that will receive all HTTP requests and relay them The format is a URL including a port number Returned: success Sample: |
|
Address of a proxy that will receive all HTTPS requests and relay them. The format is a URL including a port number Returned: success Sample: |
|
Image id the cluster will be based on Returned: success Sample: |
|
Name or ID of the keypair to use. Returned: success Sample: |
|
One or more key/value pairs Returned: success Sample: |
|
The flavor of the master node for this ClusterTemplate Returned: success Sample: |
|
Indicates whether created clusters should have a load balancer for master nodes or not Returned: success Sample: |
|
Name that has to be given to the cluster template Returned: success Sample: |
|
The name of the driver used for instantiating container networks Returned: success Sample: |
|
A comma separated list of IPs for which proxies should not be used in the cluster Returned: success Sample: |
|
Indicates whether the ClusterTemplate is public or not Returned: success Sample: |
|
Indicates whether the docker registry is enabled Returned: success Sample: |
|
Server type for this ClusterTemplate Returned: success Sample: |
|
Indicates whether the TLS should be disabled Returned: success Sample: |
|
The name of the driver used for instantiating container volumes Returned: success Sample: |
|
The cluster UUID. Returned: On success when state is ‘present’ Sample: |