From cebcb891f8287836bb05ce96c0888f3439dc73cf Mon Sep 17 00:00:00 2001 From: kubevirt-bot Date: Thu, 13 Jun 2024 08:28:08 +0000 Subject: [PATCH] Update docs for main Signed-off-by: kubevirt-bot --- main/README.html | 2 +- main/_sources/README.md.txt | 2 +- main/_sources/plugins/kubevirt_vm.rst.txt | 159 +++++++++--------- .../_sources/plugins/kubevirt_vm_info.rst.txt | 72 ++++---- main/plugins/kubevirt_vm.html | 159 +++++++++--------- main/plugins/kubevirt_vm_info.html | 72 ++++---- main/searchindex.js | 2 +- 7 files changed, 233 insertions(+), 235 deletions(-) diff --git a/main/README.html b/main/README.html index 21e8d25..8df454f 100644 --- a/main/README.html +++ b/main/README.html @@ -223,7 +223,7 @@ ansible-galaxy collection install<

Licensing

-

GNU General Public License v3.0 or later.

+

Apache License 2.0

See LICENSE to see the full text.

diff --git a/main/_sources/README.md.txt b/main/_sources/README.md.txt index a46c4f8..df82141 100644 --- a/main/_sources/README.md.txt +++ b/main/_sources/README.md.txt @@ -112,6 +112,6 @@ Every voice is important. If you have something on your mind, create an issue or ## Licensing -GNU General Public License v3.0 or later. +Apache License 2.0 See [LICENSE](./LICENSE) to see the full text. diff --git a/main/_sources/plugins/kubevirt_vm.rst.txt b/main/_sources/plugins/kubevirt_vm.rst.txt index 5024d2a..a263674 100644 --- a/main/_sources/plugins/kubevirt_vm.rst.txt +++ b/main/_sources/plugins/kubevirt_vm.rst.txt @@ -116,7 +116,8 @@ Parameters

-

Token used to authenticate with the API. Can also be specified via K8S_AUTH_API_KEY environment variable.

+

Token used to authenticate with the API.

+

Can also be specified via K8S_AUTH_API_KEY environment variable.

@@ -145,7 +146,8 @@ Parameters

-

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.

+

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.

@@ -160,7 +162,8 @@ Parameters

-

Path to a certificate used to authenticate with the API. Can also be specified via K8S_AUTH_CERT_FILE environment variable.

+

Path to a certificate used to authenticate with the API.

+

Can also be specified via K8S_AUTH_CERT_FILE environment variable.

@@ -175,7 +178,8 @@ Parameters

-

Path to a key file used to authenticate with the API. Can also be specified via K8S_AUTH_KEY_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.

@@ -188,7 +192,8 @@ Parameters

-

The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT environment variable.

+

The name of a context found in the config file.

+

Can also be specified via K8S_AUTH_CONTEXT environment variable.

@@ -214,29 +219,13 @@ Parameters

dictionary

-

added in kubevirt.core 1.2.0

Configure behavior when deleting an object.

-

Only used when state=absent.

+

Only used when state=absent.

-
-
-

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

@@ -249,7 +238,7 @@ Parameters

Specify condition that must be met for delete to proceed.

- +

resourceVersion

@@ -262,7 +251,7 @@ Parameters

Specify the resource version of the target object.

- +

uid

@@ -272,11 +261,11 @@ Parameters

-

Specify the UID of the target object.

+

Specify the UID of the target object.

- +

propagationPolicy

@@ -298,7 +287,7 @@ Parameters
- +

force

@@ -308,7 +297,7 @@ Parameters

-

If set to yes, and state is present, an existing object will be replaced.

+

If set to force=yes, and state=present is set, an existing object will be replaced.

Choices:

  • false ← (default)

    • @@ -317,7 +306,7 @@ Parameters
- +

generate_name

@@ -332,7 +321,7 @@ Parameters

Mutually exclusive with name.

- +

host

@@ -342,10 +331,11 @@ Parameters

-

Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable.

+

Provide a URL for accessing the API.

+

Can also be specified via K8S_AUTH_HOST environment variable.

- +

impersonate_groups

@@ -354,14 +344,13 @@ Parameters list / elements=string

-

added in kubevirt.core 2.3.0

Group(s) to impersonate for the operation.

-

Can also be specified via K8S_AUTH_IMPERSONATE_GROUPS environment. Example: Group1,Group2

+

Can also be specified via K8S_AUTH_IMPERSONATE_GROUPS environment variable, e.g. Group1,Group2.

- +

impersonate_user

@@ -369,14 +358,13 @@ Parameters

string

-

added in kubevirt.core 2.3.0

Username to impersonate for the operation.

-

Can also be specified via K8S_AUTH_IMPERSONATE_USER environment.

+

Can also be specified via K8S_AUTH_IMPERSONATE_USER environment variable.

- +

instancetype

@@ -390,7 +378,7 @@ Parameters

Only used when state=present.

- +

kubeconfig

@@ -400,12 +388,13 @@ Parameters

-

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.

+

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

@@ -418,7 +407,7 @@ Parameters

Specify labels to set on the VirtualMachine.

- +

name

@@ -433,7 +422,7 @@ Parameters

Mutually exclusive with generate_name.

- +

namespace

@@ -447,7 +436,7 @@ Parameters

Specify the namespace of the VirtualMachine.

- +

no_proxy

@@ -455,16 +444,16 @@ Parameters

string

-

added in kubevirt.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"

+

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

@@ -474,11 +463,12 @@ Parameters

-

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.

+

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

@@ -488,11 +478,10 @@ Parameters

-

Whether or not to save the kube config refresh tokens. Can also be specified via K8S_AUTH_PERSIST_CONFIG environment variable.

+

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

+

Disabled by default.

Choices:

  • false

    • @@ -501,7 +490,7 @@ Parameters
- +

preference

@@ -515,7 +504,7 @@ Parameters

Only used when state=present.

- +

proxy

@@ -525,11 +514,12 @@ Parameters

-

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).

+

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_headers

@@ -537,14 +527,13 @@ Parameters

dictionary

-

added in kubevirt.core 2.0.0

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.

- +

basic_auth

@@ -555,10 +544,10 @@ Parameters

Colon-separated username:password for basic authentication header.

-

Can also be specified via K8S_AUTH_PROXY_HEADERS_BASIC_AUTH environment.

+

Can also be specified via K8S_AUTH_PROXY_HEADERS_BASIC_AUTH environment variable.

- +

proxy_basic_auth

@@ -569,10 +558,10 @@ Parameters

Colon-separated username:password for proxy basic authentication header.

-

Can also be specified via K8S_AUTH_PROXY_HEADERS_PROXY_BASIC_AUTH environment.

+

Can also be specified via K8S_AUTH_PROXY_HEADERS_PROXY_BASIC_AUTH environment variable.

- +

user_agent

@@ -583,11 +572,11 @@ Parameters

String representing the user-agent you want, such as foo/1.0.

-

Can also be specified via K8S_AUTH_PROXY_HEADERS_USER_AGENT environment.

+

Can also be specified via K8S_AUTH_PROXY_HEADERS_USER_AGENT environment variable.

- +

running

@@ -606,7 +595,7 @@ Parameters
- +

spec

@@ -620,7 +609,7 @@ Parameters

See https://kubevirt.io/api-reference/main/definitions.html#_v1_virtualmachineinstancespec

- +

state

@@ -630,7 +619,10 @@ Parameters

-

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.

+

Determines if an object should be created, patched, or deleted.

+

When set to state=present, an object will be created, if it does not already exist.

+

If set to state=absent, an existing object will be deleted.

+

If set to state=present, an existing object will be patched, if its attributes differ from those specified.

Choices:

  • "absent"

    • @@ -639,7 +631,7 @@ Parameters
- +

username

@@ -649,11 +641,11 @@ Parameters

-

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.

+

Provide a username for authenticating with the API.

+

Can also be specified via K8S_AUTH_USERNAME environment variable.

- +
@@ -665,7 +657,8 @@ Parameters

-

Whether or not to verify the API server's SSL certificates. Can also be specified via K8S_AUTH_VERIFY_SSL 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

    • @@ -674,7 +667,7 @@ Parameters
- +

wait

@@ -693,7 +686,7 @@ Parameters
- +

wait_sleep

@@ -708,7 +701,7 @@ Parameters

Default: 5

- +

wait_timeout

@@ -737,7 +730,7 @@ Notes ----- .. note:: - - To avoid SSL certificate validation errors when \ :literal:`validate\_certs`\ is \ :emphasis:`True`\ , the full certificate chain for the API server must be provided via \ :literal:`ca\_cert`\ or in the kubeconfig file. + - To avoid SSL certificate validation errors when \ :ansopt:`kubevirt.core.kubevirt\_vm#module:validate\_certs=yes`\ , the full certificate chain for the API server must be provided via \ :ansopt:`kubevirt.core.kubevirt\_vm#module:ca\_cert`\ or in the \ :ansopt:`kubevirt.core.kubevirt\_vm#module:kubeconfig`\ file. .. Seealso diff --git a/main/_sources/plugins/kubevirt_vm_info.rst.txt b/main/_sources/plugins/kubevirt_vm_info.rst.txt index dcf571d..20c8571 100644 --- a/main/_sources/plugins/kubevirt_vm_info.rst.txt +++ b/main/_sources/plugins/kubevirt_vm_info.rst.txt @@ -100,7 +100,8 @@ Parameters

-

Token used to authenticate with the API. Can also be specified via K8S_AUTH_API_KEY environment variable.

+

Token used to authenticate with the API.

+

Can also be specified via K8S_AUTH_API_KEY environment variable.

@@ -129,7 +130,8 @@ Parameters

-

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.

+

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.

@@ -144,7 +146,8 @@ Parameters

-

Path to a certificate used to authenticate with the API. Can also be specified via K8S_AUTH_CERT_FILE environment variable.

+

Path to a certificate used to authenticate with the API.

+

Can also be specified via K8S_AUTH_CERT_FILE environment variable.

@@ -159,7 +162,8 @@ Parameters

-

Path to a key file used to authenticate with the API. Can also be specified via K8S_AUTH_KEY_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.

@@ -172,7 +176,8 @@ Parameters

-

The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT environment variable.

+

The name of a context found in the config file.

+

Can also be specified via K8S_AUTH_CONTEXT environment variable.

@@ -200,7 +205,8 @@ Parameters

-

Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable.

+

Provide a URL for accessing the API.

+

Can also be specified via K8S_AUTH_HOST environment variable.

@@ -212,11 +218,10 @@ Parameters list / elements=string

-

added in kubevirt.core 2.3.0

Group(s) to impersonate for the operation.

-

Can also be specified via K8S_AUTH_IMPERSONATE_GROUPS environment. Example: Group1,Group2

+

Can also be specified via K8S_AUTH_IMPERSONATE_GROUPS environment variable, e.g. Group1,Group2.

@@ -227,11 +232,10 @@ Parameters

string

-

added in kubevirt.core 2.3.0

Username to impersonate for the operation.

-

Can also be specified via K8S_AUTH_IMPERSONATE_USER environment.

+

Can also be specified via K8S_AUTH_IMPERSONATE_USER environment variable.

@@ -244,8 +248,9 @@ Parameters

-

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.

+

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.

@@ -298,13 +303,13 @@ Parameters

string

-

added in kubevirt.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"

+

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.

@@ -317,8 +322,9 @@ Parameters

-

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.

+

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.

@@ -331,11 +337,10 @@ Parameters

-

Whether or not to save the kube config refresh tokens. Can also be specified via K8S_AUTH_PERSIST_CONFIG environment variable.

+

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

+

Disabled by default.

Choices:

  • false

    • @@ -354,8 +359,9 @@ Parameters

-

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).

+

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).

@@ -366,7 +372,6 @@ Parameters

dictionary

-

added in kubevirt.core 2.0.0

The Header used for the HTTP proxy.

@@ -384,7 +389,7 @@ Parameters

Colon-separated username:password for basic authentication header.

-

Can also be specified via K8S_AUTH_PROXY_HEADERS_BASIC_AUTH environment.

+

Can also be specified via K8S_AUTH_PROXY_HEADERS_BASIC_AUTH environment variable.

@@ -398,7 +403,7 @@ Parameters

Colon-separated username:password for proxy basic authentication header.

-

Can also be specified via K8S_AUTH_PROXY_HEADERS_PROXY_BASIC_AUTH environment.

+

Can also be specified via K8S_AUTH_PROXY_HEADERS_PROXY_BASIC_AUTH environment variable.

@@ -412,7 +417,7 @@ Parameters

String representing the user-agent you want, such as foo/1.0.

-

Can also be specified via K8S_AUTH_PROXY_HEADERS_USER_AGENT environment.

+

Can also be specified via K8S_AUTH_PROXY_HEADERS_USER_AGENT environment variable.

@@ -448,8 +453,8 @@ Parameters

-

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.

+

Provide a username for authenticating with the API.

+

Can also be specified via K8S_AUTH_USERNAME environment variable.

@@ -464,7 +469,8 @@ Parameters

-

Whether or not to verify the API server's SSL certificates. Can also be specified via K8S_AUTH_VERIFY_SSL 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:

@@ -211,7 +212,8 @@ see -

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.

+

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.

@@ -226,7 +228,8 @@ see -

Path to a certificate used to authenticate with the API. Can also be specified via K8S_AUTH_CERT_FILE environment variable.

+

Path to a certificate used to authenticate with the API.

+

Can also be specified via K8S_AUTH_CERT_FILE environment variable.

@@ -241,7 +244,8 @@ see -

Path to a key file used to authenticate with the API. Can also be specified via K8S_AUTH_KEY_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.

@@ -254,7 +258,8 @@ see -

The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT environment variable.

+

The name of a context found in the config file.

+

Can also be specified via K8S_AUTH_CONTEXT environment variable.

@@ -280,29 +285,13 @@ see dictionary

-

added in kubevirt.core 1.2.0

Configure behavior when deleting an object.

-

Only used when state=absent.

+

Only used when state=absent.

-
-
-

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

@@ -315,7 +304,7 @@ see +

resourceVersion

@@ -328,7 +317,7 @@ see +

uid

@@ -338,11 +327,11 @@ see
-

Specify the UID of the target object.

+

Specify the UID of the target object.

- +

propagationPolicy

@@ -364,7 +353,7 @@ see +

force

@@ -374,7 +363,7 @@ see -

If set to yes, and state is present, an existing object will be replaced.

+

If set to force=yes, and state=present is set, an existing object will be replaced.

Choices:

@@ -364,13 +369,13 @@ see string

-

added in kubevirt.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"

+

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.

@@ -383,8 +388,9 @@ see -

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.

+

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.

@@ -397,11 +403,10 @@ see -

Whether or not to save the kube config refresh tokens. Can also be specified via K8S_AUTH_PERSIST_CONFIG environment variable.

+

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

+

Disabled by default.

Choices:

@@ -432,7 +438,6 @@ see dictionary

-

added in kubevirt.core 2.0.0

The Header used for the HTTP proxy.

@@ -450,7 +455,7 @@ see

Colon-separated username:password for basic authentication header.

-

Can also be specified via K8S_AUTH_PROXY_HEADERS_BASIC_AUTH environment.

+

Can also be specified via K8S_AUTH_PROXY_HEADERS_BASIC_AUTH environment variable.

@@ -464,7 +469,7 @@ see

Colon-separated username:password for proxy basic authentication header.

-

Can also be specified via K8S_AUTH_PROXY_HEADERS_PROXY_BASIC_AUTH environment.

+

Can also be specified via K8S_AUTH_PROXY_HEADERS_PROXY_BASIC_AUTH environment variable.

@@ -478,7 +483,7 @@ see

String representing the user-agent you want, such as foo/1.0.

-

Can also be specified via K8S_AUTH_PROXY_HEADERS_USER_AGENT environment.

+

Can also be specified via K8S_AUTH_PROXY_HEADERS_USER_AGENT environment variable.

@@ -514,8 +519,8 @@ see -

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.

+

Provide a username for authenticating with the API.

+

Can also be specified via K8S_AUTH_USERNAME environment variable.

@@ -530,7 +535,8 @@ see -

Whether or not to verify the API server's SSL certificates. Can also be specified via K8S_AUTH_VERIFY_SSL 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: