- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# kubevirt_cdi_upload – Upload local VM images to CDI Upload Proxy

New in version 2.8.

- Synopsis

- Requirements

- Parameters

- Notes

- Examples

- Status

## Synopsis

- Use Openshift Python SDK to create UploadTokenRequest objects.

- Transfer contents of local files to the CDI Upload Proxy.

## Requirements

The below requirements are needed on the host that executes this module.

- python >= 2.7

- openshift >= 0.8.2

- requests >= 2.0.0

## 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.
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 | Choices: json merge strategic-merge | 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. More info: https://github.com/kubevirt/containerized-data-importer/blob/master/doc/upload.md#expose-cdi-uploadproxy-service
upload_host_validate_certs boolean | Choices: no yes ← | 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 | Choices: no yes | 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

## 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 via `ca_cert` or in the kubeconfig file.

## Examples

    - 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

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]

- This module is maintained by the Ansible Community. [community]

### Authors

- KubeVirt Team (@kubevirt)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.