ansible / ansible.builtin / v2.9.4 / module / kubevirt_template Manage KubeVirt templates | "added in version" 2.8 of ansible.builtin" Authors: KubeVirt Team (@kubevirt) preview | supported by communityansible.builtin.kubevirt_template (v2.9.4) — module
pip
Install with pip install ansible==2.9.4
Use Openshift Python SDK to manage the state of KubeVirt templates.
- name: Create template 'mytemplate' 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' kubevirt_template: state: absent name: myvmtemplate namespace: templates
host: description: - Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable. type: str name: description: - Name of the Template object. required: true type: str force: default: false description: - If set to C(yes), and I(state) is C(present), an existing object will be replaced. type: bool proxy: description: - 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). type: str state: choices: - absent - present default: present description: - Determines if an object should be created, patched, or deleted. When set to C(present), an object will be created, if it does not already exist. If set to C(absent), an existing object will be deleted. If set to C(present), an existing object will be patched, if its attributes differ from those specified using I(resource_definition) or I(src). type: str api_key: description: - Token used to authenticate with the API. Can also be specified via K8S_AUTH_API_KEY environment variable. type: str ca_cert: aliases: - ssl_ca_cert description: - 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. type: path context: description: - The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT environment variable. type: str objects: description: - List of any valid API objects, such as a I(DeploymentConfig), I(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 the list user can pass also I(VirtualMachine) kind. When passing I(VirtualMachine) user must use Ansible structure of the parameters not the Kubernetes API structure. For more information please take a look at M(kubevirt_vm) module and at EXAMPLES section, where you can see example. type: list version: description: - Template structure version. - This is parameter can be used only when kubevirt addon is installed on your openshift cluster. type: str editable: description: - '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. type: list password: description: - Provide a password for authenticating with the API. Can also be specified via K8S_AUTH_PASSWORD environment variable. - Please read the description of the C(username) option for a discussion of when this option is applicable. type: str username: description: - 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 C(k8s_auth) module, as that might do what you need. type: str namespace: description: - Namespace where the Template object exists. required: true type: str client_key: aliases: - key_file description: - Path to a key file used to authenticate with the API. Can also be specified via K8S_AUTH_KEY_FILE environment variable. type: path icon_class: description: - 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. type: str kubeconfig: description: - 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 I(~/.kube/config.json). Can also be specified via K8S_AUTH_KUBECONFIG environment variable. type: path merge_type: choices: - json - merge - strategic-merge description: - Whether to override the default patch merge approach with a specific type. By default, the strategic merge will typically be used. type: list parameters: description: - 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: U(https://docs.openshift.com/container-platform/3.6/dev_guide/templates.html#writing-parameters)' type: list client_cert: aliases: - cert_file description: - Path to a certificate used to authenticate with the API. Can also be specified via K8S_AUTH_CERT_FILE environment variable. type: path default_nic: description: - The goal of default network is similar to I(default_disk) and should be used as a template to ensure OS compatibility and performance. - The C(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. type: dict description: description: - 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." type: str support_url: description: - A URL where support can be obtained for the template. type: str default_disk: description: - 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 C(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. type: dict display_name: description: - A brief, user-friendly name, which can be employed by user interfaces. type: str default_volume: description: - 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 C(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. type: dict persist_config: description: - 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' type: bool validate_certs: aliases: - verify_ssl description: - Whether or not to verify the API server's SSL certificates. Can also be specified via K8S_AUTH_VERIFY_SSL environment variable. type: bool default_network: description: - The goal of default network is similar to I(default_volume) and should be used as a template that specifies performance and connection parameters (L2 bridge for example) - The C(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. type: dict long_description: description: - Additional template description. This may be displayed by the service catalog, for example. type: str documentation_url: description: - A URL referencing further documentation for the template. type: str provider_display_name: description: - The name of the person or organization providing the template. type: str
kubevirt_template: contains: {} description: - The template dictionary specification returned by the API. returned: success type: complex