This collection has been tested against following Ansible versions: >=2.9.10.
+
This collection has been tested against following Ansible versions: >=2.14.0.
diff --git a/main/_sources/README.md.txt b/main/_sources/README.md.txt
index 9963b1e..cb90fc6 100644
--- a/main/_sources/README.md.txt
+++ b/main/_sources/README.md.txt
@@ -8,7 +8,7 @@ This repository hosts the `kubevirt.core` Ansible Collection, which provides vir
## Ansible version compatibility
-This collection has been tested against following Ansible versions: **>=2.9.10**.
+This collection has been tested against following Ansible versions: **>=2.14.0**.
## Included content
diff --git a/main/_sources/plugins/kubevirt.rst.txt b/main/_sources/plugins/kubevirt.rst.txt
index 4461092..1d9c855 100644
--- a/main/_sources/plugins/kubevirt.rst.txt
+++ b/main/_sources/plugins/kubevirt.rst.txt
@@ -6,23 +6,8 @@
.. |antsibull-internal-nbsp| unicode:: 0xA0
:trim:
-.. role:: ansible-attribute-support-label
-.. role:: ansible-attribute-support-property
-.. role:: ansible-attribute-support-full
-.. role:: ansible-attribute-support-partial
-.. role:: ansible-attribute-support-none
-.. role:: ansible-attribute-support-na
-.. role:: ansible-option-type
-.. role:: ansible-option-elements
-.. role:: ansible-option-required
-.. role:: ansible-option-versionadded
-.. role:: ansible-option-aliases
-.. role:: ansible-option-choices
-.. role:: ansible-option-choices-default-mark
-.. role:: ansible-option-default-bold
-.. role:: ansible-option-configuration
-.. role:: ansible-option-returned-bold
-.. role:: ansible-option-sample-bold
+.. meta::
+ :antsibull-docs: 2.5.0
.. Anchors
@@ -38,7 +23,10 @@ kubevirt -- KubeVirt inventory source
.. Collection note
.. note::
- This inventory plugin is part of the `kubevirt.core collection `_.
+ This inventory plugin is part of the `kubevirt.core collection `_.
+
+ It is not included in ``ansible-core``.
+ To check whether it is installed, run :code:`ansible-galaxy collection list`.
To install it, use: :code:`ansible-galaxy collection install kubevirt.core`.
You need further requirements to be able to use this inventory plugin,
@@ -92,1742 +80,753 @@ The below requirements are needed on the local controller node that executes thi
Parameters
----------
-.. rst-class:: ansible-option-table
+.. raw:: html
+
+
+
+
+
Parameter
+
Comments
+
+
+
+
+
+
+
cache
+
+
+ boolean
+
+
+
+
+
Toggle to enable/disable the caching of the inventory's source data, requires a cache plugin setup to work.
+
Choices:
+
+
false← (default)
+
true
+
+
+
Configuration:
+
+
+
INI entry
+
[inventory]
+ cache = false
+
+
+
+
Environment variable: ANSIBLE_INVENTORY_CACHE
+
+
+
+
+
+
+
+
+
cache_connection
+
+
+ string
+
+
+
+
+
Cache connection data or path, read cache plugin documentation for specifics.
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.
+
+
+
+
+
+
api_key
+
+
+ string
+
+
+
+
+
Token used to authenticate with the API. Can also be specified via K8S_AUTH_API_KEY environment variable.
+
+
+
+
+
+
api_version
+
+
+ string
+
+
+
+
+
Specify the used KubeVirt API version.
+
Default:"kubevirt.io/v1"
+
+
+
+
+
+
+
ca_cert
+
+
aliases: ssl_ca_cert
+
+ string
+
+
+
+
+
Path to a CA certificate used to authenticate with the API. Can also be specified via K8S_AUTH_SSL_CA_CERT environment variable.
+
+
+
+
+
+
+
client_cert
+
+
aliases: cert_file
+
+ string
+
+
+
+
+
Path to a certificate used to authenticate with the API. Can also be specified via K8S_AUTH_CERT_FILE environment variable.
+
+
+
+
+
+
+
client_key
+
+
aliases: key_file
+
+ string
+
+
+
+
+
Path to a key file used to authenticate with the API. Can also be specified via K8S_AUTH_KEY_FILE environment variable.
+
+
+
+
+
+
context
+
+
+ string
+
+
+
+
+
The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT environment variable.
+
+
+
+
+
+
create_groups
+
+
+ boolean
+
+
+
+
+
Enable the creation of groups from labels on VirtualMachines.
+
Choices:
+
+
false← (default)
+
true
+
+
+
+
+
+
+
+
host
+
+
+ string
+
+
+
+
+
Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable.
+
+
+
+
+
+
kube_secondary_dns
+
+
+ boolean
+
+
+
+
+
Enable kubesecondarydns derived host names when using a secondary network interface.
+
Choices:
+
+
false← (default)
+
true
+
+
+
+
+
+
+
+
kubeconfig
+
+
+ string
+
+
+
+
+
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.
+
+
+
+
+
+
label_selector
+
+
+ string
+
+
+
+
+
Define a label selector to select a subset of the fetched VirtualMachineInstances.
+
+
+
+
+
+
name
+
+
+ string
+
+
+
+
+
Optional name to assign to the cluster. If not provided, a name is constructed from the server and port.
+
+
+
+
+
+
namespaces
+
+
+ string
+
+
+
+
+
List of namespaces. If not specified, will fetch all VirtualMachineInstances for all namespaces the user is authorized to access.
+
+
+
+
+
+
+
network_name
+
+
aliases: interface_name
+
+ string
+
+
+
+
+
In case multiple networks are attached to a VirtualMachineInstance, define which interface should be returned as primary IP address.
+
+
+
+
+
+
password
+
+
+ string
+
+
+
+
+
Provide a password for authenticating with the API. Can also be specified via K8S_AUTH_PASSWORD environment variable.
+
+
+
+
+
+
use_service
+
+
+ boolean
+
+
+
+
+
Enable the use of services to establish an SSH connection to the VirtualMachine.
+
Choices:
+
+
false
+
true← (default)
+
+
+
+
+
+
+
+
username
+
+
+ string
+
+
+
+
+
Provide a username for authenticating with the API. Can also be specified via K8S_AUTH_USERNAME environment variable.
+
+
+
+
+
+
+
validate_certs
+
+
aliases: verify_ssl
+
+ boolean
+
+
+
+
+
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
+
+
+ dictionary
+
+
+
+
+
Add hosts to group based on Jinja2 conditionals.
+
Default:{}
+
+
+
+
+
+
host_format
+
+
+ string
+
+
+
+
+
Specify the format of the host in the inventory group. Available specifiers: name, namespace, uid.
+
Default:"{namespace}-{name}"
+
+
+
+
+
+
keyed_groups
+
+
+ list
+ / elements=dictionary
+
+
+
+
+
Add hosts to group based on the values of a variable.
+
Default:[]
+
+
+
+
+
+
default_value
+
+
+ string
+
+
added in ansible-core 2.12
+
+
+
+
The default value when the host variable's value is an empty string.
-
- Optional list of cluster connection settings. If no connections are provided, the default \ :emphasis:`~/.kube/config`\ and active context will be used, and objects will be returned for all namespaces the active user is authorized to access.
-
-
- .. raw:: html
-
-
-
- Path to a CA certificate used to authenticate with the API. Can also be specified via K8S\_AUTH\_SSL\_CA\_CERT environment variable.
-
-
- .. raw:: html
-
-
-
- Path to a certificate used to authenticate with the API. Can also be specified via K8S\_AUTH\_CERT\_FILE environment variable.
-
-
- .. raw:: html
-
-
-
- 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 \ :emphasis:`~/.kube/config`\ . Can also be specified via K8S\_AUTH\_KUBECONFIG environment variable.
-
-
- .. raw:: html
-
-
-
- List of namespaces. If not specified, will fetch all VirtualMachineInstances for all namespaces the user is authorized to access.
-
-
- .. raw:: html
-
-
-
- In case multiple networks are attached to a VirtualMachineInstance, define which interface should be returned as primary IP address.
-
-
- .. raw:: html
-
-
-
- Whether or not to verify the API server's SSL certificates. Can also be specified via K8S\_AUTH\_VERIFY\_SSL environment variable.
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-choices:`Choices:`
-
- - :ansible-option-choices-entry:`false`
- - :ansible-option-choices-entry:`true`
-
-
- .. raw:: html
-
-
-
- Specify the format of the host in the inventory group. Available specifiers: name, namespace, uid.
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-default-bold:`Default:` :ansible-option-default:`"{namespace}-{name}"`
-
- .. raw:: html
-
-
-
- Add hosts to group based on the values of a variable.
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-default-bold:`Default:` :ansible-option-default:`[]`
-
- .. raw:: html
-
-
-
- The default value when the host variable's value is an empty string.
-
- This option is mutually exclusive with \ :literal:`trailing\_separator`\ .
-
-
- .. raw:: html
-
-
-
- A keyed group name will start with this prefix
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-default-bold:`Default:` :ansible-option-default:`""`
-
- .. raw:: html
-
-
-
- separator used to build the keyed group name
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-default-bold:`Default:` :ansible-option-default:`"\_"`
-
- .. raw:: html
-
-
-
- Set this option to \ :emphasis:`False`\ to omit the \ :literal:`separator`\ after the host variable when the value is an empty string.
-
- This option is mutually exclusive with \ :literal:`default\_value`\ .
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-choices:`Choices:`
-
- - :ansible-option-choices-entry:`false`
- - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)`
-
-
- .. raw:: html
-
-
-
- Use in conjunction with keyed\_groups.
-
- By default, a keyed group that does not have a prefix or a separator provided will have a name that starts with an underscore.
-
- This is because the default prefix is "" and the default separator is "\_".
-
- Set this option to False to omit the leading underscore (or other separator) if no prefix is given.
-
- If the group name is derived from a mapping the separator is still used to concatenate the items.
-
- To not use a separator in the group name at all, set the separator for the keyed group to an empty string instead.
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-choices:`Choices:`
-
- - :ansible-option-choices-entry:`false`
- - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)`
-
-
- .. raw:: html
-
-
-
- If \ :literal:`yes`\ make invalid entries a fatal error, otherwise skip and continue.
-
- Since it is possible to use facts in the expressions they might not always be available and we ignore those errors by default.
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-choices:`Choices:`
-
- - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)`
- - :ansible-option-choices-entry:`true`
-
-
- .. raw:: html
-
-
-
- Merge extra vars into the available variables for composition (highest precedence).
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-choices:`Choices:`
-
- - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)`
- - :ansible-option-choices-entry:`true`
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-configuration:`Configuration:`
-
- - INI entry:
-
- .. code-block::
-
- [inventory_plugins]
- use_extra_vars = false
-
-
- - Environment variable: :envvar:`ANSIBLE\_INVENTORY\_USE\_EXTRA\_VARS`
-
-
- .. raw:: html
-
-
.. Attributes
@@ -1852,31 +851,31 @@ Examples
# Authenticate with token, and return all VirtualMachineInstances for all accessible namespaces
plugin: kubevirt.core.kubevirt
connections:
- - host: https://192.168.64.4:8443
- api_key: xxxxxxxxxxxxxxxx
- validate_certs: false
+ - host: https://192.168.64.4:8443
+ api_key: xxxxxxxxxxxxxxxx
+ validate_certs: false
# Use default config (~/.kube/config) file and active context, and return VirtualMachineInstances
# from namespace testing with interfaces connected to network bridge-network
plugin: kubevirt.core.kubevirt
connections:
- - namespaces:
- - testing
- network_name: bridge-network
+ - namespaces:
+ - testing
+ network_name: bridge-network
# Use default config (~/.kube/config) file and active context, and return VirtualMachineInstances
# from namespace testing with label app=test
plugin: kubevirt.core.kubevirt
connections:
- - namespaces:
- - testing
- label_selector: app=test
+ - namespaces:
+ - testing
+ label_selector: app=test
# Use a custom config file, and a specific context.
plugin: kubevirt.core.kubevirt
connections:
- - kubeconfig: /path/to/config
- context: 'awx/192-168-64-4:8443/developer'
+ - kubeconfig: /path/to/config
+ context: 'awx/192-168-64-4:8443/developer'
diff --git a/main/_sources/plugins/kubevirt_vm.rst.txt b/main/_sources/plugins/kubevirt_vm.rst.txt
index 5bc60a3..7705985 100644
--- a/main/_sources/plugins/kubevirt_vm.rst.txt
+++ b/main/_sources/plugins/kubevirt_vm.rst.txt
@@ -6,23 +6,8 @@
.. |antsibull-internal-nbsp| unicode:: 0xA0
:trim:
-.. role:: ansible-attribute-support-label
-.. role:: ansible-attribute-support-property
-.. role:: ansible-attribute-support-full
-.. role:: ansible-attribute-support-partial
-.. role:: ansible-attribute-support-none
-.. role:: ansible-attribute-support-na
-.. role:: ansible-option-type
-.. role:: ansible-option-elements
-.. role:: ansible-option-required
-.. role:: ansible-option-versionadded
-.. role:: ansible-option-aliases
-.. role:: ansible-option-choices
-.. role:: ansible-option-choices-default-mark
-.. role:: ansible-option-default-bold
-.. role:: ansible-option-configuration
-.. role:: ansible-option-returned-bold
-.. role:: ansible-option-sample-bold
+.. meta::
+ :antsibull-docs: 2.5.0
.. Anchors
@@ -38,7 +23,10 @@ kubevirt_vm -- Create or delete KubeVirt VirtualMachines on Kubernetes
.. Collection note
.. note::
- This module is part of the `kubevirt.core collection `_.
+ This module is part of the `kubevirt.core collection `_.
+
+ It is not included in ``ansible-core``.
+ To check whether it is installed, run :code:`ansible-galaxy collection list`.
To install it, use: :code:`ansible-galaxy collection install kubevirt.core`.
You need further requirements to be able to use this module,
@@ -94,1586 +82,650 @@ The below requirements are needed on the host that executes this module.
Parameters
----------
-.. rst-class:: ansible-option-table
+.. raw:: html
+
+
+
+
+
Parameter
+
Comments
+
+
+
+
+
+
+
annotations
+
+
+ dictionary
+
+
+
+
Specify annotations to set on the VirtualMachine.
+
Only used when state=present.
+
+
+
+
+
+
api_key
+
+
+ string
+
+
+
+
Token used to authenticate with the API. Can also be specified via K8S_AUTH_API_KEY environment variable.
+
+
+
+
+
+
api_version
+
+
+ string
+
+
+
+
Use this to set the API version of KubeVirt.
+
Default:"kubevirt.io/v1"
+
+
+
+
+
+
+
ca_cert
+
+
aliases: ssl_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.
+
+
+
+
+
+
+
client_cert
+
+
aliases: cert_file
+
+ path
+
+
+
+
Path to a certificate used to authenticate with the API. Can also be specified via K8S_AUTH_CERT_FILE environment variable.
+
+
+
+
+
+
+
client_key
+
+
aliases: key_file
+
+ path
+
+
+
+
Path to a key file used to authenticate with the API. Can also be specified via K8S_AUTH_KEY_FILE environment variable.
+
+
+
+
+
+
context
+
+
+ string
+
+
+
+
The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT environment variable.
+
+
+
+
+
+
data_volume_templates
+
+
+ list
+ / elements=dictionary
+
+
+
+
Specify the DataVolume templates of the VirtualMachine.
Specify how many seconds to wait before forcefully terminating.
+
Only implemented for Pod resources.
+
If not specified, the default grace period for the object type will be used.
+
+
+
+
+
+
preconditions
+
+
+ dictionary
+
+
+
+
Specify condition that must be met for delete to proceed.
+
+
+
+
+
+
resourceVersion
+
+
+ string
+
+
+
+
Specify the resource version of the target object.
+
+
+
+
+
+
uid
+
+
+ string
+
+
+
+
Specify the UID of the target object.
+
+
+
+
+
+
+
propagationPolicy
+
+
+ string
+
+
+
+
Use to control how dependent objects are deleted.
+
If not specified, the default policy for the object type will be used. This may vary across object types.
+
Choices:
+
+
"Foreground"
+
"Background"
+
"Orphan"
+
+
+
+
+
+
+
+
+
force
+
+
+ boolean
+
+
+
+
If set to yes, and state is present, an existing object will be replaced.
+
Choices:
+
+
false← (default)
+
true
+
+
+
+
+
+
+
+
generate_name
+
+
+ string
+
+
+
+
Specify the basis of the VirtualMachine name and random characters will be added automatically on server to generate a unique name.
+
Only used when state=present.
+
mutually exclusive with name.
+
+
+
+
+
+
host
+
+
+ string
+
+
+
+
Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable.
+
+
+
+
+
+
impersonate_groups
+
+
+ list
+ / elements=string
+
+
added in kubernetes.core 2.3.0
+
+
+
Group(s) to impersonate for the operation.
+
Can also be specified via K8S_AUTH_IMPERSONATE_GROUPS environment. Example: Group1,Group2
+
+
+
+
+
+
impersonate_user
+
+
+ string
+
+
added in kubernetes.core 2.3.0
+
+
+
Username to impersonate for the operation.
+
Can also be specified via K8S_AUTH_IMPERSONATE_USER environment.
+
+
+
+
+
+
instancetype
+
+
+ dictionary
+
+
+
+
Specify the instancetype matcher of the VirtualMachine.
+
Only used when state=present.
+
+
+
+
+
+
kubeconfig
+
+
+ any
+
+
+
+
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.
+
+
+
+
+
+
labels
+
+
+ dictionary
+
+
+
+
Specify labels to set on the VirtualMachine.
+
+
+
+
+
+
name
+
+
+ string
+
+
+
+
Specify the name of the VirtualMachine.
+
This option is ignored when state is not set to present.
+
mutually exclusive with generate_name.
+
+
+
+
+
+
namespace
+
+
+ string
+ / required
+
+
+
+
Specify the namespace of the VirtualMachine.
+
+
+
+
+
+
no_proxy
+
+
+ string
+
+
added in kubernetes.core 2.3.0
+
+
+
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"
+
+
+
+
+
+
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.
+
+
+
+
+
+
persist_config
+
+
+ boolean
+
+
+
+
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
+
Choices:
+
+
false
+
true
+
+
+
+
+
+
+
+
preference
+
+
+ dictionary
+
+
+
+
Specify the preference matcher of the VirtualMachine.
+
Only used when state=present.
+
+
+
+
+
+
proxy
+
+
+ string
+
+
+
+
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).
Determines if an object should be created, patched, or deleted. When set to present, an object will be created, if it does not already exist. If set to absent, an existing object will be deleted. If set to present, an existing object will be patched, if its attributes differ from those specified using resource_definition or src.
+
Choices:
+
+
"absent"
+
"present"← (default)
+
+
+
+
+
+
+
+
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 community.okd.k8s_auth module, as that might do what you need.
+
+
+
+
+
+
+
validate_certs
+
+
aliases: verify_ssl
+
+ boolean
+
+
+
+
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
+
+
+
+
+
+
+
+
wait
+
+
+ boolean
+
+
+
+
Whether to wait for the VirtualMachine to end up in the ready state.
+
Choices:
+
+
false← (default)
+
true
+
+
+
+
+
+
+
+
wait_sleep
+
+
+ integer
+
+
+
+
Number of seconds to sleep between checks.
+
Ignored if wait is not set.
+
Default:5
+
+
+
+
+
+
wait_timeout
+
+
+ integer
+
+
+
+
How long in seconds to wait for the resource to end up in the desired state.
-
- Use this to set the API version of KubeVirt.
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-default-bold:`Default:` :ansible-option-default:`"kubevirt.io/v1"`
-
- .. raw:: html
-
-
-
- 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.
-
-
- .. raw:: html
-
-
-
- Path to a certificate used to authenticate with the API. Can also be specified via K8S\_AUTH\_CERT\_FILE environment variable.
-
-
- .. raw:: html
-
-
-
- Specify how many seconds to wait before forcefully terminating.
-
- Only implemented for Pod resources.
-
- If not specified, the default grace period for the object type will be used.
-
-
- .. raw:: html
-
-
-
- Use to control how dependent objects are deleted.
-
- If not specified, the default policy for the object type will be used. This may vary across object types.
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-choices:`Choices:`
-
- - :ansible-option-choices-entry:`"Foreground"`
- - :ansible-option-choices-entry:`"Background"`
- - :ansible-option-choices-entry:`"Orphan"`
-
-
- .. raw:: html
-
-
-
- Specify the basis of the VirtualMachine name and random characters will be added automatically on server to generate a unique name.
-
- Only used when \ :emphasis:`state=present`\ .
-
- mutually exclusive with \ :literal:`name`\ .
-
-
- .. raw:: html
-
-
-
- Group(s) to impersonate for the operation.
-
- Can also be specified via K8S\_AUTH\_IMPERSONATE\_GROUPS environment. Example: Group1,Group2
-
-
- .. raw:: html
-
-
-
- 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 \ :emphasis:`~/.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.
-
-
- .. raw:: html
-
-
-
- Specify the name of the VirtualMachine.
-
- This option is ignored when \ :emphasis:`state`\ is not set to \ :literal:`present`\ .
-
- mutually exclusive with \ :literal:`generate\_name`\ .
-
-
- .. raw:: html
-
-
-
- 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"
-
-
- .. raw:: html
-
-
-
- Provide a password for authenticating with the API. Can also be specified via K8S\_AUTH\_PASSWORD environment variable.
-
- Please read the description of the \ :literal:`username`\ option for a discussion of when this option is applicable.
-
-
- .. raw:: html
-
-
-
- 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
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-choices:`Choices:`
-
- - :ansible-option-choices-entry:`false`
- - :ansible-option-choices-entry:`true`
-
-
- .. raw:: html
-
-
-
- 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).
-
-
- .. raw:: html
-
-
-
- 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\ .
-
-
- .. raw:: html
-
-
-
- Colon-separated username:password for basic authentication header.
-
- Can also be specified via K8S\_AUTH\_PROXY\_HEADERS\_BASIC\_AUTH environment.
-
-
- .. raw:: html
-
-
-
- Colon-separated username:password for proxy basic authentication header.
-
- Can also be specified via K8S\_AUTH\_PROXY\_HEADERS\_PROXY\_BASIC\_AUTH environment.
-
-
- .. raw:: html
-
-
-
- String representing the user-agent you want, such as foo/1.0.
-
- Can also be specified via K8S\_AUTH\_PROXY\_HEADERS\_USER\_AGENT environment.
-
-
- .. raw:: html
-
-
-
- Determines if an object should be created, patched, or deleted. When set to \ :literal:`present`\ , an object will be created, if it does not already exist. If set to \ :literal:`absent`\ , an existing object will be deleted. If set to \ :literal:`present`\ , an existing object will be patched, if its attributes differ from those specified using \ :emphasis:`resource\_definition`\ or \ :emphasis:`src`\ .
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-choices:`Choices:`
-
- - :ansible-option-choices-entry:`"absent"`
- - :ansible-option-choices-entry-default:`"present"` :ansible-option-choices-default-mark:`← (default)`
-
-
- .. raw:: html
-
-
-
- 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 \ :ref:`community.okd.k8s\_auth `\ module, as that might do what you need.
-
-
- .. raw:: html
-
-
-
- Whether or not to verify the API server's SSL certificates. Can also be specified via K8S\_AUTH\_VERIFY\_SSL environment variable.
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-choices:`Choices:`
-
- - :ansible-option-choices-entry:`false`
- - :ansible-option-choices-entry:`true`
-
-
- .. raw:: html
-
-
-
- Whether to wait for the VirtualMachine to end up in the ready state.
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-choices:`Choices:`
-
- - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)`
- - :ansible-option-choices-entry:`true`
-
-
- .. raw:: html
-
-
-
- Number of seconds to sleep between checks.
-
- Ignored if \ :literal:`wait`\ is not set.
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-default-bold:`Default:` :ansible-option-default:`5`
-
- .. raw:: html
-
-
-
- How long in seconds to wait for the resource to end up in the desired state.
-
- Ignored if \ :literal:`wait`\ is not set.
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-default-bold:`Default:` :ansible-option-default:`120`
-
- .. raw:: html
-
-
-
- The created object. Will be empty in the case of a deletion.
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` success
-
-
- .. raw:: html
-
-
-
- Method executed on the Kubernetes API.
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` success
-
-
- .. raw:: html
-
-
-
+.. raw:: html
+
+
+
+
+
Key
+
Description
+
+
+
+
+
+
+
result
+
+
+ complex
+
+
+
+
The created object. Will be empty in the case of a deletion.
+
Returned: success
+
+
+
+
+
+
changed
+
+
+ boolean
+
+
+
+
Whether the VirtualMachine was changed
+
Returned: success
+
Sample:true
+
+
+
+
+
+
duration
+
+
+ integer
+
+
+
+
elapsed time of task in seconds
+
Returned: when wait is true
+
Sample:48
+
+
+
+
+
+
method
+
+
+ string
+
+
+
+
Method executed on the Kubernetes API.
+
Returned: success
+
+
+
+
+
diff --git a/main/_sources/plugins/kubevirt_vm_info.rst.txt b/main/_sources/plugins/kubevirt_vm_info.rst.txt
index 8e87e61..ff48aa5 100644
--- a/main/_sources/plugins/kubevirt_vm_info.rst.txt
+++ b/main/_sources/plugins/kubevirt_vm_info.rst.txt
@@ -6,23 +6,8 @@
.. |antsibull-internal-nbsp| unicode:: 0xA0
:trim:
-.. role:: ansible-attribute-support-label
-.. role:: ansible-attribute-support-property
-.. role:: ansible-attribute-support-full
-.. role:: ansible-attribute-support-partial
-.. role:: ansible-attribute-support-none
-.. role:: ansible-attribute-support-na
-.. role:: ansible-option-type
-.. role:: ansible-option-elements
-.. role:: ansible-option-required
-.. role:: ansible-option-versionadded
-.. role:: ansible-option-aliases
-.. role:: ansible-option-choices
-.. role:: ansible-option-choices-default-mark
-.. role:: ansible-option-default-bold
-.. role:: ansible-option-configuration
-.. role:: ansible-option-returned-bold
-.. role:: ansible-option-sample-bold
+.. meta::
+ :antsibull-docs: 2.5.0
.. Anchors
@@ -38,7 +23,10 @@ kubevirt_vm_info -- Describe VirtualMachines on Kubernetes
.. Collection note
.. note::
- This module is part of the `kubevirt.core collection `_.
+ This module is part of the `kubevirt.core collection `_.
+
+ It is not included in ``ansible-core``.
+ To check whether it is installed, run :code:`ansible-galaxy collection list`.
To install it, use: :code:`ansible-galaxy collection install kubevirt.core`.
You need further requirements to be able to use this module,
@@ -91,1054 +79,429 @@ The below requirements are needed on the host that executes this module.
Parameters
----------
-.. rst-class:: ansible-option-table
+.. raw:: html
+
+
+
+
+
Parameter
+
Comments
+
+
+
+
+
+
+
api_key
+
+
+ string
+
+
+
+
Token used to authenticate with the API. Can also be specified via K8S_AUTH_API_KEY environment variable.
+
+
+
+
+
+
api_version
+
+
+ string
+
+
+
+
Use this to set the API version of KubeVirt.
+
Default:"kubevirt.io/v1"
+
+
+
+
+
+
+
ca_cert
+
+
aliases: ssl_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.
+
+
+
+
+
+
+
client_cert
+
+
aliases: cert_file
+
+ path
+
+
+
+
Path to a certificate used to authenticate with the API. Can also be specified via K8S_AUTH_CERT_FILE environment variable.
+
+
+
+
+
+
+
client_key
+
+
aliases: key_file
+
+ path
+
+
+
+
Path to a key file used to authenticate with the API. Can also be specified via K8S_AUTH_KEY_FILE environment variable.
+
+
+
+
+
+
context
+
+
+ string
+
+
+
+
The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT environment variable.
+
+
+
+
+
+
field_selectors
+
+
+ list
+ / elements=string
+
+
+
+
List of field selectors to use to filter results
+
Default:[]
+
+
+
+
+
+
host
+
+
+ string
+
+
+
+
Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable.
+
+
+
+
+
+
impersonate_groups
+
+
+ list
+ / elements=string
+
+
added in kubernetes.core 2.3.0
+
+
+
Group(s) to impersonate for the operation.
+
Can also be specified via K8S_AUTH_IMPERSONATE_GROUPS environment. Example: Group1,Group2
+
+
+
+
+
+
impersonate_user
+
+
+ string
+
+
added in kubernetes.core 2.3.0
+
+
+
Username to impersonate for the operation.
+
Can also be specified via K8S_AUTH_IMPERSONATE_USER environment.
+
+
+
+
+
+
kubeconfig
+
+
+ any
+
+
+
+
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.
+
+
+
+
+
+
label_selectors
+
+
+ list
+ / elements=string
+
+
+
+
List of label selectors to use to filter results
+
Default:[]
+
+
+
+
+
+
name
+
+
+ string
+
+
+
+
Specify the name of the VirtualMachine.
+
+
+
+
+
+
namespace
+
+
+ string
+
+
+
+
Specify the namespace of VirtualMachines.
+
+
+
+
+
+
no_proxy
+
+
+ string
+
+
added in kubernetes.core 2.3.0
+
+
+
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"
+
+
+
+
+
+
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.
+
+
+
+
+
+
persist_config
+
+
+ boolean
+
+
+
+
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
+
Choices:
+
+
false
+
true
+
+
+
+
+
+
+
+
proxy
+
+
+ string
+
+
+
+
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).
Colon-separated username:password for basic authentication header.
+
Can also be specified via K8S_AUTH_PROXY_HEADERS_BASIC_AUTH environment.
+
+
+
+
+
+
proxy_basic_auth
+
+
+ string
+
+
+
+
Colon-separated username:password for proxy basic authentication header.
+
Can also be specified via K8S_AUTH_PROXY_HEADERS_PROXY_BASIC_AUTH environment.
+
+
+
+
+
+
user_agent
+
+
+ string
+
+
+
+
String representing the user-agent you want, such as foo/1.0.
+
Can also be specified via K8S_AUTH_PROXY_HEADERS_USER_AGENT environment.
+
+
+
+
+
+
+
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 community.okd.k8s_auth module, as that might do what you need.
+
+
+
+
+
+
+
validate_certs
+
+
aliases: verify_ssl
+
+ boolean
+
+
+
+
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
+
+
+
+
+
+
+
+
wait
+
+
+ boolean
+
+
+
+
Whether to wait for the VirtualMachine to end up in the ready state.
+
Choices:
+
+
false← (default)
+
true
+
+
+
+
+
+
+
+
wait_sleep
+
+
+ integer
+
+
+
+
Number of seconds to sleep between checks.
+
Ignored if wait is not set.
+
Default:5
+
+
+
+
+
+
wait_timeout
+
+
+ integer
+
+
+
+
How long in seconds to wait for the resource to end up in the desired state.
-
- Use this to set the API version of KubeVirt.
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-default-bold:`Default:` :ansible-option-default:`"kubevirt.io/v1"`
-
- .. raw:: html
-
-
-
- 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.
-
-
- .. raw:: html
-
-
-
- Path to a certificate used to authenticate with the API. Can also be specified via K8S\_AUTH\_CERT\_FILE environment variable.
-
-
- .. raw:: html
-
-
-
- List of field selectors to use to filter results
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-default-bold:`Default:` :ansible-option-default:`[]`
-
- .. raw:: html
-
-
-
- Group(s) to impersonate for the operation.
-
- Can also be specified via K8S\_AUTH\_IMPERSONATE\_GROUPS environment. Example: Group1,Group2
-
-
- .. raw:: html
-
-
-
- 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 \ :emphasis:`~/.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.
-
-
- .. raw:: html
-
-
-
- List of label selectors to use to filter results
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-default-bold:`Default:` :ansible-option-default:`[]`
-
- .. raw:: html
-
-
-
- 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"
-
-
- .. raw:: html
-
-
-
- Provide a password for authenticating with the API. Can also be specified via K8S\_AUTH\_PASSWORD environment variable.
-
- Please read the description of the \ :literal:`username`\ option for a discussion of when this option is applicable.
-
-
- .. raw:: html
-
-
-
- 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
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-choices:`Choices:`
-
- - :ansible-option-choices-entry:`false`
- - :ansible-option-choices-entry:`true`
-
-
- .. raw:: html
-
-
-
- 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).
-
-
- .. raw:: html
-
-
-
- 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\ .
-
-
- .. raw:: html
-
-
-
- Colon-separated username:password for basic authentication header.
-
- Can also be specified via K8S\_AUTH\_PROXY\_HEADERS\_BASIC\_AUTH environment.
-
-
- .. raw:: html
-
-
-
- Colon-separated username:password for proxy basic authentication header.
-
- Can also be specified via K8S\_AUTH\_PROXY\_HEADERS\_PROXY\_BASIC\_AUTH environment.
-
-
- .. raw:: html
-
-
-
- String representing the user-agent you want, such as foo/1.0.
-
- Can also be specified via K8S\_AUTH\_PROXY\_HEADERS\_USER\_AGENT environment.
-
-
- .. raw:: html
-
-
-
- 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 \ :ref:`community.okd.k8s\_auth `\ module, as that might do what you need.
-
-
- .. raw:: html
-
-
-
- Whether or not to verify the API server's SSL certificates. Can also be specified via K8S\_AUTH\_VERIFY\_SSL environment variable.
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-choices:`Choices:`
-
- - :ansible-option-choices-entry:`false`
- - :ansible-option-choices-entry:`true`
-
-
- .. raw:: html
-
-
-
- Whether to wait for the VirtualMachine to end up in the ready state.
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-choices:`Choices:`
-
- - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)`
- - :ansible-option-choices-entry:`true`
-
-
- .. raw:: html
-
-
-
- Number of seconds to sleep between checks.
-
- Ignored if \ :literal:`wait`\ is not set.
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-default-bold:`Default:` :ansible-option-default:`5`
-
- .. raw:: html
-
-
-
- How long in seconds to wait for the resource to end up in the desired state.
-
- Ignored if \ :literal:`wait`\ is not set.
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-default-bold:`Default:` :ansible-option-default:`120`
-
- .. raw:: html
-
-
.. Attributes
@@ -1201,295 +564,117 @@ Return Values
-------------
Common return values are documented :ref:`here `, the following are the fields unique to this module:
-.. rst-class:: ansible-option-table
-
-.. list-table::
- :width: 100%
- :widths: auto
- :header-rows: 1
-
- * - Key
- - Description
-
- * - .. raw:: html
-
-
-
- Whether the specified api\_version and VirtualMachine kind were successfully mapped to an existing API on the targeted cluster.
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` always
-
-
- .. raw:: html
-
-
-
- The versioned schema of this representation of an object.
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` success
-
-
- .. raw:: html
-
-
-
- Specific attributes of the VirtualMachine. Can vary based on the \ :emphasis:`api\_version`\ .
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` success
-
-
- .. raw:: html
-
-
It is not included in ansible-core.
+To check whether it is installed, run ansible-galaxycollectionlist.
To install it, use: ansible-galaxycollectioninstallkubevirt.core.
You need further requirements to be able to use this inventory plugin,
see Requirements for details.
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.
-
+
+
+
+
connections
+
+
+ string
+
+
+
+
+
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.
+
-
-
api_key
-
string
-
-
Token used to authenticate with the API. Can also be specified via K8S_AUTH_API_KEY environment variable.
-
+
+
+
+
api_key
+
+
+ string
+
+
+
+
+
Token used to authenticate with the API. Can also be specified via K8S_AUTH_API_KEY environment variable.
+
-
-
api_version
-
string
-
-
Specify the used KubeVirt API version.
-
Default:"kubevirt.io/v1"
-
+
+
+
+
api_version
+
+
+ string
+
+
+
+
+
Specify the used KubeVirt API version.
+
Default:"kubevirt.io/v1"
+
-
-
-
ca_cert
-
aliases: ssl_ca_cert
-
string
-
-
Path to a CA certificate used to authenticate with the API. Can also be specified via K8S_AUTH_SSL_CA_CERT environment variable.
-
+
+
+
+
+
ca_cert
+
+
aliases: ssl_ca_cert
+
+ string
+
+
+
+
+
Path to a CA certificate used to authenticate with the API. Can also be specified via K8S_AUTH_SSL_CA_CERT environment variable.
+
-
-
-
client_cert
-
aliases: cert_file
-
string
-
-
Path to a certificate used to authenticate with the API. Can also be specified via K8S_AUTH_CERT_FILE environment variable.
-
+
+
+
+
+
client_cert
+
+
aliases: cert_file
+
+ string
+
+
+
+
+
Path to a certificate used to authenticate with the API. Can also be specified via K8S_AUTH_CERT_FILE environment variable.
+
-
-
-
client_key
-
aliases: key_file
-
string
-
-
Path to a key file used to authenticate with the API. Can also be specified via K8S_AUTH_KEY_FILE environment variable.
-
+
+
+
+
+
client_key
+
+
aliases: key_file
+
+ string
+
+
+
+
+
Path to a key file used to authenticate with the API. Can also be specified via K8S_AUTH_KEY_FILE environment variable.
+
-
-
context
-
string
-
-
The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT environment variable.
-
+
+
+
+
context
+
+
+ string
+
+
+
+
+
The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT environment variable.
+
-
-
create_groups
-
boolean
-
-
Enable the creation of groups from labels on VirtualMachines.
-
Choices:
-
-
false← (default)
-
true
-
-
+
+
+
+
create_groups
+
+
+ boolean
+
+
+
+
+
Enable the creation of groups from labels on VirtualMachines.
+
Choices:
+
+
false← (default)
+
true
+
+
+
-
-
host
-
string
-
-
Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable.
-
+
+
+
+
host
+
+
+ string
+
+
+
+
+
Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable.
+
-
-
kube_secondary_dns
-
boolean
-
-
Enable kubesecondarydns derived host names when using a secondary network interface.
-
Choices:
-
-
false← (default)
-
true
-
-
+
+
+
+
kube_secondary_dns
+
+
+ boolean
+
+
+
+
+
Enable kubesecondarydns derived host names when using a secondary network interface.
+
Choices:
+
+
false← (default)
+
true
+
+
+
-
-
kubeconfig
-
string
-
-
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.
-
+
+
+
+
kubeconfig
+
+
+ string
+
+
+
+
+
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.
+
-
-
label_selector
-
string
-
-
Define a label selector to select a subset of the fetched VirtualMachineInstances.
-
+
+
+
+
label_selector
+
+
+ string
+
+
+
+
+
Define a label selector to select a subset of the fetched VirtualMachineInstances.
+
-
-
name
-
string
-
-
Optional name to assign to the cluster. If not provided, a name is constructed from the server and port.
-
+
+
+
+
name
+
+
+ string
+
+
+
+
+
Optional name to assign to the cluster. If not provided, a name is constructed from the server and port.
+
-
-
namespaces
-
string
-
-
List of namespaces. If not specified, will fetch all VirtualMachineInstances for all namespaces the user is authorized to access.
-
+
+
+
+
namespaces
+
+
+ string
+
+
+
+
+
List of namespaces. If not specified, will fetch all VirtualMachineInstances for all namespaces the user is authorized to access.
+
-
-
-
network_name
-
aliases: interface_name
-
string
-
-
In case multiple networks are attached to a VirtualMachineInstance, define which interface should be returned as primary IP address.
-
+
+
+
+
+
network_name
+
+
aliases: interface_name
+
+ string
+
+
+
+
+
In case multiple networks are attached to a VirtualMachineInstance, define which interface should be returned as primary IP address.
+
-
-
password
-
string
-
-
Provide a password for authenticating with the API. Can also be specified via K8S_AUTH_PASSWORD environment variable.
-
+
+
+
+
password
+
+
+ string
+
+
+
+
+
Provide a password for authenticating with the API. Can also be specified via K8S_AUTH_PASSWORD environment variable.
+
-
-
use_service
-
boolean
-
-
Enable the use of services to establish an SSH connection to the VirtualMachine.
-
Choices:
-
-
false
-
true← (default)
-
-
+
+
+
+
use_service
+
+
+ boolean
+
+
+
+
+
Enable the use of services to establish an SSH connection to the VirtualMachine.
+
Choices:
+
+
false
+
true← (default)
+
+
+
-
-
username
-
string
-
-
Provide a username for authenticating with the API. Can also be specified via K8S_AUTH_USERNAME environment variable.
-
+
+
+
+
username
+
+
+ string
+
+
+
+
+
Provide a username for authenticating with the API. Can also be specified via K8S_AUTH_USERNAME environment variable.
+
-
-
-
validate_certs
-
aliases: verify_ssl
-
boolean
-
-
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
-
-
+
+
+
+
+
validate_certs
+
+
aliases: verify_ssl
+
+ boolean
+
+
+
+
+
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
-
dictionary
-
-
Add hosts to group based on Jinja2 conditionals.
-
Default:{}
-
+
+
+
+
+
groups
+
+
+ dictionary
+
+
+
+
+
Add hosts to group based on Jinja2 conditionals.
+
Default:{}
+
-
-
host_format
-
string
-
-
Specify the format of the host in the inventory group. Available specifiers: name, namespace, uid.
-
Default:"{namespace}-{name}"
-
+
+
+
+
host_format
+
+
+ string
+
+
+
+
+
Specify the format of the host in the inventory group. Available specifiers: name, namespace, uid.
+
Default:"{namespace}-{name}"
+
-
-
keyed_groups
-
list / elements=dictionary
-
-
Add hosts to group based on the values of a variable.
-
Default:[]
-
+
+
+
+
keyed_groups
+
+
+ list
+ / elements=dictionary
+
+
+
+
+
Add hosts to group based on the values of a variable.
+
Default:[]
+
-
-
default_value
-
string
-
added in ansible-core 2.12
-
-
The default value when the host variable’s value is an empty string.
-
This option is mutually exclusive with trailing_separator.
-
+
+
+
+
default_value
+
+
+ string
+
+
added in ansible-core 2.12
+
+
+
+
The default value when the host variable's value is an empty string.
It is not included in ansible-core.
+To check whether it is installed, run ansible-galaxycollectionlist.
To install it, use: ansible-galaxycollectioninstallkubevirt.core.
You need further requirements to be able to use this module,
see Requirements for details.
Token used to authenticate with the API. Can also be specified via K8S_AUTH_API_KEY environment variable.
-
+
+
+
+
api_key
+
+
+ string
+
+
+
+
Token used to authenticate with the API. Can also be specified via K8S_AUTH_API_KEY environment variable.
+
-
-
api_version
-
string
-
-
Use this to set the API version of KubeVirt.
-
Default:"kubevirt.io/v1"
-
+
+
+
+
api_version
+
+
+ string
+
+
+
+
Use this to set the API version of KubeVirt.
+
Default:"kubevirt.io/v1"
+
-
-
-
ca_cert
-
aliases: ssl_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.
-
+
+
+
+
+
ca_cert
+
+
aliases: ssl_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.
+
-
-
-
client_cert
-
aliases: cert_file
-
path
-
-
Path to a certificate used to authenticate with the API. Can also be specified via K8S_AUTH_CERT_FILE environment variable.
-
+
+
+
+
+
client_cert
+
+
aliases: cert_file
+
+ path
+
+
+
+
Path to a certificate used to authenticate with the API. Can also be specified via K8S_AUTH_CERT_FILE environment variable.
+
-
-
-
client_key
-
aliases: key_file
-
path
-
-
Path to a key file used to authenticate with the API. Can also be specified via K8S_AUTH_KEY_FILE environment variable.
-
+
+
+
+
+
client_key
+
+
aliases: key_file
+
+ path
+
+
+
+
Path to a key file used to authenticate with the API. Can also be specified via K8S_AUTH_KEY_FILE environment variable.
+
-
-
context
-
string
-
-
The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT environment variable.
-
+
+
+
+
context
+
+
+ string
+
+
+
+
The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT environment variable.
+
-
-
data_volume_templates
-
list / elements=dictionary
-
-
Specify the DataVolume templates of the VirtualMachine.
Specify how many seconds to wait before forcefully terminating.
-
Only implemented for Pod resources.
-
If not specified, the default grace period for the object type will be used.
-
+
+
+
+
gracePeriodSeconds
+
+
+ integer
+
+
+
+
Specify how many seconds to wait before forcefully terminating.
+
Only implemented for Pod resources.
+
If not specified, the default grace period for the object type will be used.
+
-
-
preconditions
-
dictionary
-
-
Specify condition that must be met for delete to proceed.
-
+
+
+
+
preconditions
+
+
+ dictionary
+
+
+
+
Specify condition that must be met for delete to proceed.
+
-
-
resourceVersion
-
string
-
-
Specify the resource version of the target object.
-
+
+
+
+
resourceVersion
+
+
+ string
+
+
+
+
Specify the resource version of the target object.
+
-
-
uid
-
string
-
-
Specify the UID of the target object.
-
+
+
+
+
uid
+
+
+ string
+
+
+
+
Specify the UID of the target object.
+
-
-
propagationPolicy
-
string
-
-
Use to control how dependent objects are deleted.
-
If not specified, the default policy for the object type will be used. This may vary across object types.
-
Choices:
-
-
"Foreground"
-
"Background"
-
"Orphan"
-
-
+
+
+
+
+
propagationPolicy
+
+
+ string
+
+
+
+
Use to control how dependent objects are deleted.
+
If not specified, the default policy for the object type will be used. This may vary across object types.
+
Choices:
+
+
"Foreground"
+
"Background"
+
"Orphan"
+
+
+
-
-
force
-
boolean
-
-
If set to yes, and state is present, an existing object will be replaced.
-
Choices:
-
-
false← (default)
-
true
-
-
+
+
+
+
+
force
+
+
+ boolean
+
+
+
+
If set to yes, and state is present, an existing object will be replaced.
+
Choices:
+
+
false← (default)
+
true
+
+
+
-
-
generate_name
-
string
-
-
Specify the basis of the VirtualMachine name and random characters will be added automatically on server to generate a unique name.
-
Only used when state=present.
-
mutually exclusive with name.
-
+
+
+
+
generate_name
+
+
+ string
+
+
+
+
Specify the basis of the VirtualMachine name and random characters will be added automatically on server to generate a unique name.
+
Only used when state=present.
+
mutually exclusive with name.
+
-
-
host
-
string
-
-
Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable.
-
+
+
+
+
host
+
+
+ string
+
+
+
+
Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable.
+
-
-
impersonate_groups
-
list / elements=string
-
added in kubernetes.core 2.3.0
-
-
Group(s) to impersonate for the operation.
-
Can also be specified via K8S_AUTH_IMPERSONATE_GROUPS environment. Example: Group1,Group2
-
+
+
+
+
impersonate_groups
+
+
+ list
+ / elements=string
+
+
added in kubernetes.core 2.3.0
+
+
+
Group(s) to impersonate for the operation.
+
Can also be specified via K8S_AUTH_IMPERSONATE_GROUPS environment. Example: Group1,Group2
+
-
-
impersonate_user
-
string
-
added in kubernetes.core 2.3.0
-
-
Username to impersonate for the operation.
-
Can also be specified via K8S_AUTH_IMPERSONATE_USER environment.
-
+
+
+
+
impersonate_user
+
+
+ string
+
+
added in kubernetes.core 2.3.0
+
+
+
Username to impersonate for the operation.
+
Can also be specified via K8S_AUTH_IMPERSONATE_USER environment.
+
-
-
instancetype
-
dictionary
-
-
Specify the instancetype matcher of the VirtualMachine.
-
Only used when state=present.
-
+
+
+
+
instancetype
+
+
+ dictionary
+
+
+
+
Specify the instancetype matcher of the VirtualMachine.
+
Only used when state=present.
+
-
-
kubeconfig
-
any
-
-
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.
-
+
+
+
+
kubeconfig
+
+
+ any
+
+
+
+
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.
+
-
-
labels
-
dictionary
-
-
Specify labels to set on the VirtualMachine.
-
+
+
+
+
labels
+
+
+ dictionary
+
+
+
+
Specify labels to set on the VirtualMachine.
+
-
-
name
-
string
-
-
Specify the name of the VirtualMachine.
-
This option is ignored when state is not set to present.
-
mutually exclusive with generate_name.
-
+
+
+
+
name
+
+
+ string
+
+
+
+
Specify the name of the VirtualMachine.
+
This option is ignored when state is not set to present.
+
mutually exclusive with generate_name.
+
-
-
namespace
-
string / required
-
-
Specify the namespace of the VirtualMachine.
-
+
+
+
+
namespace
+
+
+ string
+ / required
+
+
+
+
Specify the namespace of the VirtualMachine.
+
-
-
no_proxy
-
string
-
added in kubernetes.core 2.3.0
-
-
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”
-
+
+
+
+
no_proxy
+
+
+ string
+
+
added in kubernetes.core 2.3.0
+
+
+
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"
+
-
-
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.
-
+
+
+
+
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.
+
-
-
persist_config
-
boolean
-
-
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.
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
+
Choices:
+
+
false
+
true
+
+
+
-
-
preference
-
dictionary
-
-
Specify the preference matcher of the VirtualMachine.
-
Only used when state=present.
-
+
+
+
+
preference
+
+
+ dictionary
+
+
+
+
Specify the preference matcher of the VirtualMachine.
+
Only used when state=present.
+
-
-
proxy
-
string
-
-
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).
-
+
+
+
+
proxy
+
+
+ string
+
+
+
+
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).
Determines if an object should be created, patched, or deleted. When set to present, an object will be created, if it does not already exist. If set to absent, an existing object will be deleted. If set to present, an existing object will be patched, if its attributes differ from those specified using resource_definition or src.
-
Choices:
-
-
"absent"
-
"present"← (default)
-
-
+
+
+
+
state
+
+
+ string
+
+
+
+
Determines if an object should be created, patched, or deleted. When set to present, an object will be created, if it does not already exist. If set to absent, an existing object will be deleted. If set to present, an existing object will be patched, if its attributes differ from those specified using resource_definition or src.
+
Choices:
+
+
"absent"
+
"present"← (default)
+
+
+
-
-
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 community.okd.k8s_auth module, as that might do what you need.
-
+
+
+
+
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 community.okd.k8s_auth module, as that might do what you need.
+
-
-
-
validate_certs
-
aliases: verify_ssl
-
boolean
-
-
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
-
-
+
+
+
+
+
validate_certs
+
+
aliases: verify_ssl
+
+ boolean
+
+
+
+
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
+
+
+
-
-
wait
-
boolean
-
-
Whether to wait for the VirtualMachine to end up in the ready state.
-
Choices:
-
-
false← (default)
-
true
-
-
+
+
+
+
wait
+
+
+ boolean
+
+
+
+
Whether to wait for the VirtualMachine to end up in the ready state.
+
Choices:
+
+
false← (default)
+
true
+
+
+
-
-
wait_sleep
-
integer
-
-
Number of seconds to sleep between checks.
-
Ignored if wait is not set.
-
Default:5
-
+
+
+
+
wait_sleep
+
+
+ integer
+
+
+
+
Number of seconds to sleep between checks.
+
Ignored if wait is not set.
+
Default:5
+
-
-
wait_timeout
-
integer
-
-
How long in seconds to wait for the resource to end up in the desired state.
-
Ignored if wait is not set.
-
Default:120
-
+
+
+
+
wait_timeout
+
+
+ integer
+
+
+
+
How long in seconds to wait for the resource to end up in the desired state.
It is not included in ansible-core.
+To check whether it is installed, run ansible-galaxycollectionlist.
To install it, use: ansible-galaxycollectioninstallkubevirt.core.
You need further requirements to be able to use this module,
see Requirements for details.
Token used to authenticate with the API. Can also be specified via K8S_AUTH_API_KEY environment variable.
-
+
+
+
+
api_key
+
+
+ string
+
+
+
+
Token used to authenticate with the API. Can also be specified via K8S_AUTH_API_KEY environment variable.
+
-
-
api_version
-
string
-
-
Use this to set the API version of KubeVirt.
-
Default:"kubevirt.io/v1"
-
+
+
+
+
api_version
+
+
+ string
+
+
+
+
Use this to set the API version of KubeVirt.
+
Default:"kubevirt.io/v1"
+
-
-
-
ca_cert
-
aliases: ssl_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.
-
+
+
+
+
+
ca_cert
+
+
aliases: ssl_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.
+
-
-
-
client_cert
-
aliases: cert_file
-
path
-
-
Path to a certificate used to authenticate with the API. Can also be specified via K8S_AUTH_CERT_FILE environment variable.
-
+
+
+
+
+
client_cert
+
+
aliases: cert_file
+
+ path
+
+
+
+
Path to a certificate used to authenticate with the API. Can also be specified via K8S_AUTH_CERT_FILE environment variable.
+
-
-
-
client_key
-
aliases: key_file
-
path
-
-
Path to a key file used to authenticate with the API. Can also be specified via K8S_AUTH_KEY_FILE environment variable.
-
+
+
+
+
+
client_key
+
+
aliases: key_file
+
+ path
+
+
+
+
Path to a key file used to authenticate with the API. Can also be specified via K8S_AUTH_KEY_FILE environment variable.
+
-
-
context
-
string
-
-
The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT environment variable.
-
+
+
+
+
context
+
+
+ string
+
+
+
+
The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT environment variable.
+
-
-
field_selectors
-
list / elements=string
-
-
List of field selectors to use to filter results
-
Default:[]
-
+
+
+
+
field_selectors
+
+
+ list
+ / elements=string
+
+
+
+
List of field selectors to use to filter results
+
Default:[]
+
-
-
host
-
string
-
-
Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable.
-
+
+
+
+
host
+
+
+ string
+
+
+
+
Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable.
+
-
-
impersonate_groups
-
list / elements=string
-
added in kubernetes.core 2.3.0
-
-
Group(s) to impersonate for the operation.
-
Can also be specified via K8S_AUTH_IMPERSONATE_GROUPS environment. Example: Group1,Group2
-
+
+
+
+
impersonate_groups
+
+
+ list
+ / elements=string
+
+
added in kubernetes.core 2.3.0
+
+
+
Group(s) to impersonate for the operation.
+
Can also be specified via K8S_AUTH_IMPERSONATE_GROUPS environment. Example: Group1,Group2
+
-
-
impersonate_user
-
string
-
added in kubernetes.core 2.3.0
-
-
Username to impersonate for the operation.
-
Can also be specified via K8S_AUTH_IMPERSONATE_USER environment.
-
+
+
+
+
impersonate_user
+
+
+ string
+
+
added in kubernetes.core 2.3.0
+
+
+
Username to impersonate for the operation.
+
Can also be specified via K8S_AUTH_IMPERSONATE_USER environment.
+
-
-
kubeconfig
-
any
-
-
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.
-
+
+
+
+
kubeconfig
+
+
+ any
+
+
+
+
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.
+
-
-
label_selectors
-
list / elements=string
-
-
List of label selectors to use to filter results
-
Default:[]
-
+
+
+
+
label_selectors
+
+
+ list
+ / elements=string
+
+
+
+
List of label selectors to use to filter results
+
Default:[]
+
-
-
name
-
string
-
-
Specify the name of the VirtualMachine.
-
+
+
+
+
name
+
+
+ string
+
+
+
+
Specify the name of the VirtualMachine.
+
-
-
namespace
-
string
-
-
Specify the namespace of VirtualMachines.
-
+
+
+
+
namespace
+
+
+ string
+
+
+
+
Specify the namespace of VirtualMachines.
+
-
-
no_proxy
-
string
-
added in kubernetes.core 2.3.0
-
-
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”
-
+
+
+
+
no_proxy
+
+
+ string
+
+
added in kubernetes.core 2.3.0
+
+
+
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"
+
-
-
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.
-
+
+
+
+
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.
+
-
-
persist_config
-
boolean
-
-
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.
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
+
Choices:
+
+
false
+
true
+
+
+
-
-
proxy
-
string
-
-
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).
-
+
+
+
+
proxy
+
+
+ string
+
+
+
+
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).
Colon-separated username:password for basic authentication header.
-
Can also be specified via K8S_AUTH_PROXY_HEADERS_BASIC_AUTH environment.
-
+
+
+
+
basic_auth
+
+
+ string
+
+
+
+
Colon-separated username:password for basic authentication header.
+
Can also be specified via K8S_AUTH_PROXY_HEADERS_BASIC_AUTH environment.
+
-
-
proxy_basic_auth
-
string
-
-
Colon-separated username:password for proxy basic authentication header.
-
Can also be specified via K8S_AUTH_PROXY_HEADERS_PROXY_BASIC_AUTH environment.
-
+
+
+
+
proxy_basic_auth
+
+
+ string
+
+
+
+
Colon-separated username:password for proxy basic authentication header.
+
Can also be specified via K8S_AUTH_PROXY_HEADERS_PROXY_BASIC_AUTH environment.
+
-
-
user_agent
-
string
-
-
String representing the user-agent you want, such as foo/1.0.
-
Can also be specified via K8S_AUTH_PROXY_HEADERS_USER_AGENT environment.
-
+
+
+
+
user_agent
+
+
+ string
+
+
+
+
String representing the user-agent you want, such as foo/1.0.
+
Can also be specified via K8S_AUTH_PROXY_HEADERS_USER_AGENT environment.
+
-
-
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 community.okd.k8s_auth module, as that might do what you need.
-
+
+
+
+
+
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 community.okd.k8s_auth module, as that might do what you need.
+
-
-
-
validate_certs
-
aliases: verify_ssl
-
boolean
-
-
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
-
-
+
+
+
+
+
validate_certs
+
+
aliases: verify_ssl
+
+ boolean
+
+
+
+
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
+
+
+
-
-
wait
-
boolean
-
-
Whether to wait for the VirtualMachine to end up in the ready state.
-
Choices:
-
-
false← (default)
-
true
-
-
+
+
+
+
wait
+
+
+ boolean
+
+
+
+
Whether to wait for the VirtualMachine to end up in the ready state.
+
Choices:
+
+
false← (default)
+
true
+
+
+
-
-
wait_sleep
-
integer
-
-
Number of seconds to sleep between checks.
-
Ignored if wait is not set.
-
Default:5
-
+
+
+
+
wait_sleep
+
+
+ integer
+
+
+
+
Number of seconds to sleep between checks.
+
Ignored if wait is not set.
+
Default:5
+
-
-
wait_timeout
-
integer
-
-
How long in seconds to wait for the resource to end up in the desired state.
-
Ignored if wait is not set.
-
Default:120
-
+
+
+
+
wait_timeout
+
+
+ integer
+
+
+
+
How long in seconds to wait for the resource to end up in the desired state.