ansible / ansible.builtin / v2.8.18 / module / kubevirt_cdi_upload Upload local VM images to CDI Upload Proxy. | "added in version" 2.8 of ansible.builtin" Authors: KubeVirt Team (@kubevirt) preview | supported by communityansible.builtin.kubevirt_cdi_upload (v2.8.18) — module
pip
Install with pip install ansible==2.8.18
Use Openshift Python SDK to create UploadTokenRequest objects.
Transfer contents of local files to the CDI Upload Proxy.
- 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
host: description: - Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable. type: str path: description: - Path of local image file to transfer. 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 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 no_proxy: description: - The comma separated list of hosts/domains/IP/CIDR that shouldn't go through proxy. Can also be specified via K8S_AUTH_NO_PROXY environment variable. - Please note that this module does not pick up typical proxy settings from the environment (e.g. NO_PROXY). - This feature requires kubernetes>=19.15.0. When kubernetes library is less than 19.15.0, it fails even no_proxy set in correct. - example value is "localhost,.local,.example.com,127.0.0.1,127.0.0.0/8,10.0.0.0/8,172.16.0.0/12,192.168.0.0/16" type: str version_added: 2.3.0 version_added_collection: kubernetes.core 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 pvc_name: description: - Use to specify the name of the target PersistentVolumeClaim. required: true 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 M(community.okd.k8s_auth) module, as that might do what you need. 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 kubeconfig: description: - Path to an existing Kubernetes config file. If not provided, and no other connection options are provided, the Kubernetes client will attempt to load the default configuration file from I(~/.kube/config). Can also be specified via K8S_AUTH_KUBECONFIG environment variable. - The kubernetes configuration can be provided as dictionary. This feature requires a python kubernetes client version >= 17.17.0. Added in version 2.2.0. type: raw 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 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 upload_host: description: - URL containing the host and port on which the CDI Upload Proxy is available. - 'More info: U(https://github.com/kubevirt/containerized-data-importer/blob/master/doc/upload.md#expose-cdi-uploadproxy-service)' proxy_headers: description: - The Header used for the HTTP proxy. - Documentation can be found here U(https://urllib3.readthedocs.io/en/latest/reference/urllib3.util.html?highlight=proxy_headers#urllib3.util.make_headers). suboptions: basic_auth: description: - Colon-separated username:password for basic authentication header. - Can also be specified via K8S_AUTH_PROXY_HEADERS_BASIC_AUTH environment. type: str proxy_basic_auth: description: - Colon-separated username:password for proxy basic authentication header. - Can also be specified via K8S_AUTH_PROXY_HEADERS_PROXY_BASIC_AUTH environment. type: str user_agent: description: - String representing the user-agent you want, such as foo/1.0. - Can also be specified via K8S_AUTH_PROXY_HEADERS_USER_AGENT environment. type: str type: dict version_added: 2.0.0 version_added_collection: kubernetes.core pvc_namespace: description: - Use to specify the namespace of the target PersistentVolumeClaim. required: true 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 impersonate_user: description: - Username to impersonate for the operation. - Can also be specified via K8S_AUTH_IMPERSONATE_USER environment. type: str version_added: 2.3.0 version_added_collection: kubernetes.core impersonate_groups: description: - Group(s) to impersonate for the operation. - 'Can also be specified via K8S_AUTH_IMPERSONATE_GROUPS environment. Example: Group1,Group2' elements: str type: list version_added: 2.3.0 version_added_collection: kubernetes.core upload_host_validate_certs: aliases: - upload_host_verify_ssl default: true description: - Whether or not to verify the CDI Upload Proxy's SSL certificates against your system's CA trust store. type: bool