KubeVirt Collection for Ansible Release Notes
+KubeVirt Collection for Ansible Release Notes
This changelog describes changes after version 1.0.0.
v1.5.0
+v1.5.0
Release Summary
+Release Summary
Support for stopped VMs, deprecation of the ‘connections’ parameter and many cleanups.
Major Changes
+Major Changes
Minor Changes
+Minor Changes
Breaking Changes / Porting Guide
+-
+
cleanup(inventory): Drop support for multiple connections #117
+
Bugfixes
+Bugfixes
fix(tests,kubevirt_vm): Fix assertion in verify.yml #106
v1.4.0
-Release Summary
+v1.4.0
+Release Summary
Compatibility with kubernetes.core >=3.1.0,<4.1.0 and some minor enhancements.
Minor Changes
+Minor Changes
Bugfixes
+Bugfixes
v1.3.2
-Release Summary
+v1.3.2
+Release Summary
No functional changes, hotfix release to retrigger the downstream build and to keep in sync with Ansible Automation Hub.
v1.3.1
-Release Summary
+v1.3.1
+Release Summary
No functional changes, only updates to the shipped documentation.
v1.3.0
-Minor Changes
+v1.3.0
+Minor Changes
Bugfixes
+Bugfixes
v1.2.3
-Release Summary
+v1.2.3
+Release Summary
No functional changes, hotfix release to retrigger the downstream build and to keep in sync with Ansible Automation Hub.
v1.2.2
-Release Summary
+v1.2.2
+Release Summary
No functional changes, only cleanup of files included in the release tarball and vendoring of documentation fragments.
v1.2.1
-Release Summary
+v1.2.1
+Release Summary
Mostly code cleanups and dependency updates to ensure compatibility with KubeVirt >= 1.1.0
v1.2.0
-Release Summary
+v1.2.0
+Release Summary
Not released due to issues in the release process
v1.1.0
-Minor Changes
+v1.1.0
+Minor Changes
Add kubevirt_vm_info module to describe existing VirtualMachines
inventory: Allow to control creation of additional groups
@@ -337,9 +345,9 @@
v1.0.0
-Release Summary
+v1.0.0
+Release Summary
Initial release
Token used to authenticate with the API.
+Can also be specified via K8S_AUTH_API_KEY environment variable.
Specify the used KubeVirt API version.
+Default: "kubevirt.io/v1"
Append the base domain of the cluster to host names constructed from SSH Services of type NodePort.
Choices:
+-
+
false← (default)
+ true
+
Override the base domain used to construct host names. Used in case of kubesecondarydns or Services of type NodePort if append_base_domain is set.
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.
cache
@@ -123,7 +204,7 @@ Parameterscache_connection
@@ -157,7 +238,7 @@ Parameterscache_plugin
@@ -192,7 +273,7 @@ Parameterscache_prefix
@@ -227,7 +308,7 @@ Parameterscache_timeout
@@ -262,7 +343,41 @@ ParametersPath to a certificate used to authenticate with the API.
+Can also be specified via K8S_AUTH_CERT_FILE environment variable.
Path to a key file used to authenticate with the API.
+Can also be specified via K8S_AUTH_KEY_FILE environment variable.
compose
@@ -277,159 +392,48 @@ ParametersDefault: {}
Optional list of cluster connection settings. If no connections are provided, the default ~/.kube/config and active context will be used, and objects will be returned for all namespaces the active user is authorized to access.
+Optional list of cluster connection settings.
This parameter is deprecated. Split your connections into multiple configuration files and move parameters of each connection to the configuration top level.
Deprecated in version 1.5.0, will be removed in version 3.0.0.
Token used to authenticate with the API. Can also be specified via K8S_AUTH_API_KEY environment variable.
Specify the used KubeVirt API version.
-Default: "kubevirt.io/v1"
Append the base domain of the cluster to host names constructed from SSH Services of type NodePort.
Choices:
--
-
false← (default)
- true
-
Override the base domain used to construct host names. Used in case of kubesecondarydns or Services of type NodePort if connections.append_base_domain is set.
Path to a CA certificate used to authenticate with the API. Can also be specified via K8S_AUTH_SSL_CA_CERT environment variable.
Path to a certificate used to authenticate with the API. Can also be specified via K8S_AUTH_CERT_FILE environment variable.
Path to a key file used to authenticate with the API. Can also be specified via K8S_AUTH_KEY_FILE environment variable.
Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable.
Enable kubesecondarydns derived host names when using a secondary network interface.
Choices:
--
-
false← (default)
- true
-
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 ~/.kube/config. Can also be specified via K8S_AUTH_KUBECONFIG environment variable.
Define a label selector to select a subset of the fetched virtual machines.
-Optional name to assign to the cluster. If not provided, a name is constructed from the server and port.
-List of namespaces. If not specified, will fetch virtual machines from all namespaces the user is authorized to access.
-In case multiple networks are attached to a virtual machine, define which interface should be returned as primary IP address.
-Provide a password for authenticating with the API. Can also be specified via K8S_AUTH_PASSWORD environment variable.
Enable the use of Services to establish an SSH connection to a virtual machine.
Services are only used if no connections.network_name was provided.
Choices:
--
-
false
- true← (default)
-
Provide a username for authenticating with the API. Can also be specified via K8S_AUTH_USERNAME environment variable.
Whether or not to verify the API server's SSL certificates. Can also be specified via K8S_AUTH_VERIFY_SSL environment variable.
Choices:
--
-
false
- true
-
groups
@@ -632,6 +458,21 @@ ParametersDefault: {}
Provide a URL for accessing the API.
+Can also be specified via K8S_AUTH_HOST environment variable.
Default: "{namespace}-{name}"
Group(s) to impersonate for the operation.
+Can also be specified via K8S_AUTH_IMPERSONATE_GROUPS environment variable, e.g. Group1,Group2.
Username to impersonate for the operation.
+Can also be specified via K8S_AUTH_IMPERSONATE_USER environment variable.
Enable kubesecondarydns derived host names when using a secondary network interface.
Choices:
+-
+
false← (default)
+ true
+
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 ~/.kube/config.
+Can also be specified via K8S_AUTH_KUBECONFIG environment variable.
Multiple Kubernetes config file can be provided using separator ; for Windows platform or : for others platforms.
The kubernetes configuration can be provided as dictionary. This feature requires a python kubernetes client version >= 17.17.0.
+Define a label selector to select a subset of the fetched virtual machines.
+leading_separator
@@ -786,7 +709,108 @@ ParametersOptional name to assign to the cluster. If not provided, a name is constructed from the server and port.
+List of namespaces. If not specified, will fetch virtual machines from all namespaces the user is authorized to access.
+In case multiple networks are attached to a virtual machine, define which interface should be returned as primary IP address.
+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.
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.
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.
+Disabled by default.
+Choices:
+-
+
false
+ true
+
plugin
@@ -807,6 +831,83 @@ ParametersThe 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).
The Header used for the HTTP proxy.
+Documentation can be found here https://urllib3.readthedocs.io/en/latest/reference/urllib3.util.html?highlight=proxy_headers#urllib3.util.make_headers.
+Colon-separated username:password for basic authentication header.
+Can also be specified via K8S_AUTH_PROXY_HEADERS_BASIC_AUTH environment variable.
Colon-separated username:password for proxy basic authentication header.
+Can also be specified via K8S_AUTH_PROXY_HEADERS_PROXY_BASIC_AUTH environment variable.
String representing the user-agent you want, such as foo/1.0.
+Can also be specified via K8S_AUTH_PROXY_HEADERS_USER_AGENT environment variable.
Enable the use of Services to establish an SSH connection to a virtual machine.
Services are only used if no network_name was provided.
Choices:
+-
+
false
+ true← (default)
+
Provide a username for authenticating with the API.
+Can also be specified via K8S_AUTH_USERNAME environment variable.
Whether or not to verify the API server's SSL certificates.
+Can also be specified via K8S_AUTH_VERIFY_SSL environment variable.
Choices:
+-
+
false
+ true
+
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 ~/.kube/config.
Can also be specified via K8S_AUTH_KUBECONFIG environment variable.
Multiple Kubernetes config file can be provided using separator ; for Windows platform or : for others platforms.
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.
+The kubernetes configuration can be provided as dictionary. This feature requires a python kubernetes client version >= 17.17.0.