community.kubevirt.kubevirt_template – Manage KubeVirt templates¶
Note
This plugin is part of the community.kubevirt collection (version 1.0.0).
To install it use: ansible-galaxy collection install community.kubevirt
.
To use it in a playbook, specify: community.kubevirt.kubevirt_template
.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 2.7
openshift >= 0.8.2
Parameters¶
Parameter | Choices/Defaults | Comments |
---|---|---|
api_key
string
|
Token used to authenticate with the API. Can also be specified via K8S_AUTH_API_KEY environment variable.
|
|
ca_cert
path
|
Path to a CA certificate used to authenticate with the API. The full certificate chain must be provided to avoid certificate validation errors. Can also be specified via K8S_AUTH_SSL_CA_CERT environment variable.
aliases: ssl_ca_cert |
|
client_cert
path
|
Path to a certificate used to authenticate with the API. Can also be specified via K8S_AUTH_CERT_FILE environment variable.
aliases: cert_file |
|
client_key
path
|
Path to a key file used to authenticate with the API. Can also be specified via K8S_AUTH_KEY_FILE environment variable.
aliases: key_file |
|
context
string
|
The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT environment variable.
|
|
default_disk
dictionary
|
The goal of default disk is to define what kind of disk is supported by the OS mainly in terms of bus (ide, scsi, sata, virtio, ...)
The
default_disk parameter define configuration overlay for disks that will be applied on top of disks during virtual machine creation to define global compatibility and/or performance defaults defined here.This is parameter can be used only when kubevirt addon is installed on your openshift cluster.
|
|
default_network
dictionary
|
The goal of default network is similar to default_volume and should be used as a template that specifies performance and connection parameters (L2 bridge for example)
The
default_network parameter define configuration overlay for networks that will be applied on top of networks during virtual machine creation to define global compatibility and/or performance defaults defined here.This is parameter can be used only when kubevirt addon is installed on your openshift cluster.
|
|
default_nic
dictionary
|
The goal of default network is similar to default_disk and should be used as a template to ensure OS compatibility and performance.
The
default_nic parameter define configuration overlay for nic that will be applied on top of nics during virtual machine creation to define global compatibility and/or performance defaults defined here.This is parameter can be used only when kubevirt addon is installed on your openshift cluster.
|
|
default_volume
dictionary
|
The goal of default volume is to be able to configure mostly performance parameters like caches if those are exposed by the underlying volume implementation.
The
default_volume parameter define configuration overlay for volumes that will be applied on top of volumes during virtual machine creation to define global compatibility and/or performance defaults defined here.This is parameter can be used only when kubevirt addon is installed on your openshift cluster.
|
|
description
string
|
A description of the template.
Include enough detail that the user will understand what is being deployed... and any caveats they need to know before deploying. It should also provide links to additional information, such as a README file."
|
|
display_name
string
|
A brief, user-friendly name, which can be employed by user interfaces.
|
|
documentation_url
string
|
A URL referencing further documentation for the template.
|
|
editable
list
/ elements=string
|
Extension for hinting at which elements should be considered editable. List of jsonpath selectors. The jsonpath root is the objects: element of the template.
This is parameter can be used only when kubevirt addon is installed on your openshift cluster.
|
|
force
boolean
|
|
If set to
yes , and state is present , an existing object will be replaced. |
host
string
|
Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable.
|
|
icon_class
string
|
An icon to be displayed with your template in the web console. Choose from our existing logo icons when possible. You can also use icons from FontAwesome. Alternatively, provide icons through CSS customizations that can be added to an OpenShift Container Platform cluster that uses your template. You must specify an icon class that exists, or it will prevent falling back to the generic icon.
|
|
kubeconfig
path
|
Path to an existing Kubernetes config file. If not provided, and no other connection options are provided, the openshift client will attempt to load the default configuration file from ~/.kube/config.json. Can also be specified via K8S_AUTH_KUBECONFIG environment variable.
|
|
long_description
string
|
Additional template description. This may be displayed by the service catalog, for example.
|
|
merge_type
list
/ elements=string
|
|
Whether to override the default patch merge approach with a specific type. By default, the strategic merge will typically be used.
|
name
string
/ required
|
Name of the Template object.
|
|
namespace
string
/ required
|
Namespace where the Template object exists.
|
|
objects
list
/ elements=string
|
List of any valid API objects, such as a DeploymentConfig, Service, etc. The object will be created exactly as defined here, with any parameter values substituted in prior to creation. The definition of these objects can reference parameters defined earlier.
As part of the list user can pass also VirtualMachine kind. When passing VirtualMachine user must use Ansible structure of the parameters not the Kubernetes API structure. For more information please take a look at community.kubevirt.kubevirt_vm module and at EXAMPLES section, where you can see example.
|
|
parameters
list
/ elements=string
|
Parameters allow a value to be supplied by the user or generated when the template is instantiated. Then, that value is substituted wherever the parameter is referenced. References can be defined in any field in the objects list field. This is useful for generating random passwords or allowing the user to supply a host name or other user-specific value that is required to customize the template.
More information can be found at: https://docs.openshift.com/container-platform/3.6/dev_guide/templates.html#writing-parameters
|
|
password
string
|
Provide a password for authenticating with the API. Can also be specified via K8S_AUTH_PASSWORD environment variable.
Please read the description of the
username option for a discussion of when this option is applicable. |
|
persist_config
boolean
|
|
Whether or not to save the kube config refresh tokens. Can also be specified via K8S_AUTH_PERSIST_CONFIG environment variable.
When the k8s context is using a user credentials with refresh tokens (like oidc or gke/gcloud auth), the token is refreshed by the k8s python client library but not saved by default. So the old refresh token can expire and the next auth might fail. Setting this flag to true will tell the k8s python client to save the new refresh token to the kube config file.
Default to false.
Please note that the current version of the k8s python client library does not support setting this flag to True yet.
The fix for this k8s python library is here: https://github.com/kubernetes-client/python-base/pull/169
|
provider_display_name
string
|
The name of the person or organization providing the template.
|
|
proxy
string
|
The URL of an HTTP proxy to use for the connection. Can also be specified via K8S_AUTH_PROXY environment variable.
Please note that this module does not pick up typical proxy settings from the environment (e.g. HTTP_PROXY).
|
|
state
string
|
|
Determines if an object should be created, patched, or deleted. When set to
present , an object will be created, if it does not already exist. If set to absent , an existing object will be deleted. If set to present , an existing object will be patched, if its attributes differ from those specified using resource_definition or src. |
support_url
string
|
A URL where support can be obtained for the template.
|
|
username
string
|
Provide a username for authenticating with the API. Can also be specified via K8S_AUTH_USERNAME environment variable.
Please note that this only works with clusters configured to use HTTP Basic Auth. If your cluster has a different form of authentication (e.g. OAuth2 in OpenShift), this option will not work as expected and you should look into the
k8s_auth module, as that might do what you need. |
|
validate_certs
boolean
|
|
Whether or not to verify the API server's SSL certificates. Can also be specified via K8S_AUTH_VERIFY_SSL environment variable.
aliases: verify_ssl |
version
string
|
Template structure version.
This is parameter can be used only when kubevirt addon is installed on your openshift cluster.
|
Notes¶
Note
The OpenShift Python client wraps the K8s Python client, providing full access to all of the APIS and models available on both platforms. For API version details and additional information visit https://github.com/openshift/openshift-restclient-python
To avoid SSL certificate validation errors when
validate_certs
is True, the full certificate chain for the API server must be provided viaca_cert
or in the kubeconfig file.
Examples¶
- name: Create template 'mytemplate'
community.kubevirt.kubevirt_template:
state: present
name: myvmtemplate
namespace: templates
display_name: Generic cirros template
description: Basic cirros template
long_description: Verbose description of cirros template
provider_display_name: Just Be Cool, Inc.
documentation_url: http://theverycoolcompany.com
support_url: http://support.theverycoolcompany.com
icon_class: icon-linux
default_disk:
disk:
bus: virtio
default_nic:
model: virtio
default_network:
resource:
resourceName: bridge.network.kubevirt.io/cnvmgmt
default_volume:
containerDisk:
image: kubevirt/cirros-container-disk-demo:latest
objects:
- name: ${NAME}
kind: VirtualMachine
memory: ${MEMORY_SIZE}
state: present
namespace: vms
parameters:
- name: NAME
description: VM name
generate: expression
from: 'vm-[A-Za-z0-9]{8}'
- name: MEMORY_SIZE
description: Memory size
value: 1Gi
- name: Remove template 'myvmtemplate'
community.kubevirt.kubevirt_template:
state: absent
name: myvmtemplate
namespace: templates
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
kubevirt_template
complex
|
success |
The template dictionary specification returned by the API.
|
Authors¶
KubeVirt Team (@kubevirt)