New in version 2.8.
The below requirements are needed on the host that executes this module.
| 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. | |
| host string | Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable. | |
| 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. | |
| merge_type list |
| Whether to override the default patch merge approach with a specific type. By default, the strategic merge will typically be used. |
| 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. | |
| path - | Path of local image file to transfer. | |
| proxy - added in 2.9 | 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). | |
| pvc_name - / required | Use to specify the name of the target PersistentVolumeClaim. | |
| pvc_namespace - / required | Use to specify the namespace of the target PersistentVolumeClaim. | |
| upload_host - | URL containing the host and port on which the CDI Upload Proxy is available. | |
| upload_host_validate_certs boolean |
| Whether or not to verify the CDI Upload Proxy's SSL certificates against your system's CA trust store. aliases: upload_host_verify_ssl |
| 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 |
Note
validate_certs is True, the full certificate chain for the API server must be provided via ca_cert or in the kubeconfig file.- name: Upload local image to pvc-vm1
kubevirt_cdi_upload:
pvc_namespace: default
pvc_name: pvc-vm1
upload_host: https://localhost:8443
upload_host_validate_certs: false
path: /tmp/cirros-0.4.0-x86_64-disk.img
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/kubevirt_cdi_upload_module.html