diff --git a/main/CHANGELOG.html b/main/CHANGELOG.html index 47f9683..9998407 100644 --- a/main/CHANGELOG.html +++ b/main/CHANGELOG.html @@ -65,50 +65,51 @@
  • Release Summary
  • Major Changes
  • Minor Changes
  • +
  • Breaking Changes / Porting Guide
  • Bugfixes
  • v1.4.0
  • v1.3.2 -
  • -
  • v1.3.1
  • +
  • v1.3.1 +
  • v1.3.0
  • v1.2.3 -
  • -
  • v1.2.2
  • -
  • v1.2.1 - +

    cache_connection

    @@ -157,7 +238,7 @@ Parameters
    - +

    cache_plugin

    @@ -192,7 +273,7 @@ Parameters
    - +

    cache_prefix

    @@ -227,7 +308,7 @@ Parameters
    - +

    cache_timeout

    @@ -262,7 +343,41 @@ Parameters
    + +
    +
    +
    +

    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.

    +
    + +

    compose

    @@ -277,159 +392,48 @@ Parameters

    Default: {}

    - +

    connections

    - list - / elements=dictionary + 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.

    +

    Optional list of cluster connection settings.

    This parameter is deprecated. Split your connections into multiple configuration files and move parameters of each connection to the configuration top level.

    Deprecated in version 1.5.0, will be removed in version 3.0.0.

    - -
    -
    -

    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"

    -
    - - -
    -
    -

    append_base_domain

    - -

    - boolean -

    - -
    -
    -

    Append the base domain of the cluster to host names constructed from SSH Services of type NodePort.

    -

    Choices:

    - - -
    - - -
    -
    -

    base_domain

    - -

    - string -

    - -
    -
    -

    Override the base domain used to construct host names. Used in case of kubesecondarydns or Services of type NodePort if connections.append_base_domain is set.

    -
    - - -
    -
    -
    -

    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.

    +
    +

    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 and VirtualMachineInstances.

    Choices:

      @@ -440,184 +444,6 @@ Parameters
    -
    -
    -

    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 virtual machines.

    -
    - - -
    -
    -

    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 virtual machines from all namespaces the user is authorized to access.

    -
    - - -
    -
    -
    -

    network_name

    - -

    aliases: interface_name

    -

    - string -

    - -
    -
    -

    In case multiple networks are attached to a virtual machine, 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 a virtual machine.

    -

    Services are only used if no connections.network_name was provided.

    -

    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

    @@ -632,6 +458,21 @@ Parameters

    Default: {}

    + +
    +
    +

    host

    + +

    + string +

    + +
    +
    +

    Provide a URL for accessing the API.

    +

    Can also be specified via K8S_AUTH_HOST environment variable.

    +
    +
    @@ -647,6 +488,37 @@ Parameters

    Default: "{namespace}-{name}"

    + +
    +
    +

    impersonate_groups

    + +

    + list + / elements=string +

    + +
    +
    +

    Group(s) to impersonate for the operation.

    +

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

    +
    + + +
    +
    +

    impersonate_user

    + +

    + string +

    + +
    +
    +

    Username to impersonate for the operation.

    +

    Can also be specified via K8S_AUTH_IMPERSONATE_USER environment variable.

    +
    +
    @@ -761,6 +633,57 @@ Parameters +
    +
    +

    kube_secondary_dns

    + +

    + boolean +

    + +
    +
    +

    Enable kubesecondarydns derived host names when using a secondary network interface.

    +

    Choices:

    +
      +
    • false ← (default)

    • +
    • true

    • +
    + +
    + + +
    +
    +

    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.

    +
    + + +
    +
    +

    label_selector

    + +

    + string +

    + +
    +
    +

    Define a label selector to select a subset of the fetched virtual machines.

    +
    + +

    leading_separator

    @@ -786,7 +709,108 @@ Parameters
    + +
    +
    +

    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 virtual machines from all namespaces the user is authorized to access.

    +
    + + +
    +
    +
    +

    network_name

    + +

    aliases: interface_name

    +

    + string +

    + +
    +
    +

    In case multiple networks are attached to a virtual machine, define which interface should be returned as primary IP address.

    +
    + + +
    +
    +

    no_proxy

    + +

    + string +

    + +
    +
    +

    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.

    +

    Disabled by default.

    +

    Choices:

    +
      +
    • false

    • +
    • true

    • +
    + +
    + +

    plugin

    @@ -807,6 +831,83 @@ Parameters
    + +
    +
    +

    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_headers

    + +

    + dictionary +

    + +
    + + + +
    +
    +

    basic_auth

    + +

    + string +

    + +
    +
    +

    Colon-separated username:password for basic authentication header.

    +

    Can also be specified via K8S_AUTH_PROXY_HEADERS_BASIC_AUTH environment variable.

    +
    + + +
    +
    +

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

    +
    + + +
    +
    +

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

    +
    + +
    @@ -862,6 +963,65 @@ Parameters
    + +
    +
    +

    use_service

    + +

    + boolean +

    + +
    +
    +

    Enable the use of Services to establish an SSH connection to a virtual machine.

    +

    Services are only used if no network_name was provided.

    +

    Choices:

    +
      +
    • false

    • +
    • true ← (default)

    • +
    + +
    + + +
    +
    +

    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

    • +
    + +
    + @@ -872,6 +1032,11 @@ Parameters .. Notes +Notes +----- + +.. note:: + - To avoid SSL certificate validation errors when \ :ansopt:`kubevirt.core.kubevirt#inventory:validate\_certs=yes`\ , the full certificate chain for the API server must be provided via \ :ansopt:`kubevirt.core.kubevirt#inventory:ca\_cert`\ or in the \ :ansopt:`kubevirt.core.kubevirt#inventory:kubeconfig`\ file. .. Seealso @@ -886,32 +1051,28 @@ Examples # Filename must end with kubevirt.[yml|yaml] - - name: Authenticate with token and return all virtual machines from all accessible namespaces - plugin: kubevirt.core.kubevirt - connections: - - host: https://192.168.64.4:8443 - api_key: xxxxxxxxxxxxxxxx - validate_certs: false + # Authenticate with token and return all virtual machines from all accessible namespaces + - plugin: kubevirt.core.kubevirt + host: https://192.168.64.4:8443 + api_key: xxxxxxxxxxxxxxxx + validate_certs: false - - name: Use default ~/.kube/config and return virtual machines from namespace testing connected to network bridge-network - plugin: kubevirt.core.kubevirt - connections: - - namespaces: - - testing - network_name: bridge-network + # Use default ~/.kube/config and return virtual machines from namespace testing connected to network bridge-network + - plugin: kubevirt.core.kubevirt + namespaces: + - testing + network_name: bridge-network - - name: Use default ~/.kube/config and return virtual machines from namespace testing with label app=test - plugin: kubevirt.core.kubevirt - connections: - - namespaces: - - testing - label_selector: app=test + # Use default ~/.kube/config and return virtual machines from namespace testing with label app=test + - plugin: kubevirt.core.kubevirt + namespaces: + - testing + label_selector: app=test - - name: 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' + # Use a custom config file and a specific context + - plugin: kubevirt.core.kubevirt + 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 c7300ea..7316d7e 100644 --- a/main/_sources/plugins/kubevirt_vm.rst.txt +++ b/main/_sources/plugins/kubevirt_vm.rst.txt @@ -390,7 +390,7 @@ 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.

    -

    The kubernetes configuration can be provided as dictionary. This feature requires a python kubernetes client version >= 17.17.0. Added in version 2.2.0.

    +

    The kubernetes configuration can be provided as dictionary. This feature requires a python kubernetes client version >= 17.17.0.

    diff --git a/main/_sources/plugins/kubevirt_vm_info.rst.txt b/main/_sources/plugins/kubevirt_vm_info.rst.txt index d35160d..fe555c3 100644 --- a/main/_sources/plugins/kubevirt_vm_info.rst.txt +++ b/main/_sources/plugins/kubevirt_vm_info.rst.txt @@ -251,7 +251,7 @@ 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.

    -

    The kubernetes configuration can be provided as dictionary. This feature requires a python kubernetes client version >= 17.17.0. Added in version 2.2.0.

    +

    The kubernetes configuration can be provided as dictionary. This feature requires a python kubernetes client version >= 17.17.0.

    diff --git a/main/plugins/index.html b/main/plugins/index.html index 93cd335..2b86947 100644 --- a/main/plugins/index.html +++ b/main/plugins/index.html @@ -102,6 +102,7 @@
  • Synopsis
  • Requirements
  • Parameters
  • +
  • Notes
  • Examples diff --git a/main/plugins/kubevirt.html b/main/plugins/kubevirt.html index 5ae54b7..3720207 100644 --- a/main/plugins/kubevirt.html +++ b/main/plugins/kubevirt.html @@ -55,6 +55,7 @@
  • Synopsis
  • Requirements
  • Parameters
  • +
  • Notes
  • Examples @@ -121,16 +122,17 @@ see Synopsis

  • Requirements

  • Parameters

  • -
  • Examples

  • +
  • Notes

  • +
  • Examples

  • Synopsis

    @@ -153,6 +155,87 @@ see +
    +
    +

    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"

    +
    + + +
    +
    +

    append_base_domain

    + +

    + boolean +

    + +
    +
    +

    Append the base domain of the cluster to host names constructed from SSH Services of type NodePort.

    +

    Choices:

    + + +
    + + +
    +
    +

    base_domain

    + +

    + string +

    + +
    +
    +

    Override the base domain used to construct host names. Used in case of kubesecondarydns or Services of type NodePort if append_base_domain is set.

    +
    + + +
    +
    +
    +

    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.

    +
    + +

    cache

    @@ -185,7 +268,7 @@ see +

    cache_connection

    @@ -219,7 +302,7 @@ see
    +

    cache_plugin

    @@ -254,7 +337,7 @@ see
    +

    cache_prefix

    @@ -289,7 +372,7 @@ see
    +

    cache_timeout

    @@ -324,7 +407,41 @@ see
    +
    +
    +
    +

    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.

    +
    + +

    compose

    @@ -339,159 +456,48 @@ see Default: {}

    - +

    connections

    - list - / elements=dictionary + 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.

    +

    Optional list of cluster connection settings.

    This parameter is deprecated. Split your connections into multiple configuration files and move parameters of each connection to the configuration top level.

    Deprecated in version 1.5.0, will be removed in version 3.0.0.

    - -
    -
    -

    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"

    -
    - - -
    -
    -

    append_base_domain

    - -

    - boolean -

    - -
    -
    -

    Append the base domain of the cluster to host names constructed from SSH Services of type NodePort.

    -

    Choices:

    -
      -
    • false ← (default)

    • -
    • true

    • -
    - -
    - - -
    -
    -

    base_domain

    - -

    - string -

    - -
    -
    -

    Override the base domain used to construct host names. Used in case of kubesecondarydns or Services of type NodePort if connections.append_base_domain is set.

    -
    - - -
    -
    -
    -

    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.

    +
    +

    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 and VirtualMachineInstances.

    Choices:

      @@ -502,184 +508,6 @@ see -
      -
      -

      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 virtual machines.

      -
      - - -
      -
      -

      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 virtual machines from all namespaces the user is authorized to access.

      -
      - - -
      -
      -
      -

      network_name

      - -

      aliases: interface_name

      -

      - string -

      - -
      -
      -

      In case multiple networks are attached to a virtual machine, 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 a virtual machine.

      -

      Services are only used if no connections.network_name was provided.

      -

      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

      @@ -694,6 +522,21 @@ see Default: {}

      + +
      +
      +

      host

      +
      +

      + string +

      + +
      +
      +

      Provide a URL for accessing the API.

      +

      Can also be specified via K8S_AUTH_HOST environment variable.

      +
      +
      @@ -709,6 +552,37 @@ see Default: "{namespace}-{name}"

      + +
      +
      +

      impersonate_groups

      +
      +

      + list + / elements=string +

      + +
      +
      +

      Group(s) to impersonate for the operation.

      +

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

      +
      + + +
      +
      +

      impersonate_user

      + +

      + string +

      + +
      +
      +

      Username to impersonate for the operation.

      +

      Can also be specified via K8S_AUTH_IMPERSONATE_USER environment variable.

      +
      +
      @@ -823,6 +697,57 @@ see +
      +
      +

      kube_secondary_dns

      +
      +

      + boolean +

      + +
      +
      +

      Enable kubesecondarydns derived host names when using a secondary network interface.

      +

      Choices:

      +
        +
      • false ← (default)

      • +
      • true

      • +
      + +
      + + +
      +
      +

      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.

      +
      + + +
      +
      +

      label_selector

      + +

      + string +

      + +
      +
      +

      Define a label selector to select a subset of the fetched virtual machines.

      +
      + +

      leading_separator

      @@ -848,7 +773,108 @@ see +
      +
      +

      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 virtual machines from all namespaces the user is authorized to access.

      +
      + + +
      +
      +
      +

      network_name

      + +

      aliases: interface_name

      +

      + string +

      + +
      +
      +

      In case multiple networks are attached to a virtual machine, define which interface should be returned as primary IP address.

      +
      + + +
      +
      +

      no_proxy

      + +

      + string +

      + +
      +
      +

      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.

      +

      Disabled by default.

      +

      Choices:

      +
        +
      • false

      • +
      • true

      • +
      + +
      + +

      plugin

      @@ -869,6 +895,83 @@ see +
      +
      +

      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_headers

      + +

      + dictionary +

      + +
      + + + +
      +
      +

      basic_auth

      + +

      + string +

      + +
      +
      +

      Colon-separated username:password for basic authentication header.

      +

      Can also be specified via K8S_AUTH_PROXY_HEADERS_BASIC_AUTH environment variable.

      +
      + + +
      +
      +

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

      +
      + + +
      +
      +

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

      +
      + +
      @@ -924,38 +1027,102 @@ see +
      +
      +

      use_service

      +
      +

      + boolean +

      + +
      +
      +

      Enable the use of Services to establish an SSH connection to a virtual machine.

      +

      Services are only used if no network_name was provided.

      +

      Choices:

      +
        +
      • false

      • +
      • true ← (default)

      • +
      + +
      + + +
      +
      +

      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

      • +
      + +
      +
    +
    +

    Notes

    +
    +

    Note

    + +
    +
    -

    Examples

    +

    Examples

    # Filename must end with kubevirt.[yml|yaml]
     
    -- name: Authenticate with token and return all virtual machines from all accessible namespaces
    -  plugin: kubevirt.core.kubevirt
    -  connections:
    -    - host: https://192.168.64.4:8443
    -      api_key: xxxxxxxxxxxxxxxx
    -      validate_certs: false
    +# Authenticate with token and return all virtual machines from all accessible namespaces
    +- plugin: kubevirt.core.kubevirt
    +  host: https://192.168.64.4:8443
    +  api_key: xxxxxxxxxxxxxxxx
    +  validate_certs: false
     
    -- name: Use default ~/.kube/config and return virtual machines from namespace testing connected to network bridge-network
    -  plugin: kubevirt.core.kubevirt
    -  connections:
    -    - namespaces:
    -        - testing
    -      network_name: bridge-network
    +# Use default ~/.kube/config and return virtual machines from namespace testing connected to network bridge-network
    +- plugin: kubevirt.core.kubevirt
    +  namespaces:
    +    - testing
    +  network_name: bridge-network
     
    -- name: Use default ~/.kube/config and return virtual machines from namespace testing with label app=test
    -  plugin: kubevirt.core.kubevirt
    -  connections:
    -    - namespaces:
    -        - testing
    -      label_selector: app=test
    +# Use default ~/.kube/config and return virtual machines from namespace testing with label app=test
    +- plugin: kubevirt.core.kubevirt
    +  namespaces:
    +    - testing
    +  label_selector: app=test
     
    -- name: 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'
    +# Use a custom config file and a specific context
    +- plugin: kubevirt.core.kubevirt
    +  kubeconfig: /path/to/config
    +  context: 'awx/192-168-64-4:8443/developer'
     
    diff --git a/main/plugins/kubevirt_vm.html b/main/plugins/kubevirt_vm.html index 6ecc0f9..4da56e9 100644 --- a/main/plugins/kubevirt_vm.html +++ b/main/plugins/kubevirt_vm.html @@ -456,7 +456,7 @@ see K8S_AUTH_KUBECONFIG environment variable.

    Multiple Kubernetes config file can be provided using separator ; for Windows platform or : for others platforms.

    -

    The kubernetes configuration can be provided as dictionary. This feature requires a python kubernetes client version >= 17.17.0. Added in version 2.2.0.

    +

    The kubernetes configuration can be provided as dictionary. This feature requires a python kubernetes client version >= 17.17.0.

    diff --git a/main/plugins/kubevirt_vm_info.html b/main/plugins/kubevirt_vm_info.html index 9b33b14..32e3d7a 100644 --- a/main/plugins/kubevirt_vm_info.html +++ b/main/plugins/kubevirt_vm_info.html @@ -317,7 +317,7 @@ see
    K8S_AUTH_KUBECONFIG environment variable.

    Multiple Kubernetes config file can be provided using separator ; for Windows platform or : for others platforms.

    -

    The kubernetes configuration can be provided as dictionary. This feature requires a python kubernetes client version >= 17.17.0. Added in version 2.2.0.

    +

    The kubernetes configuration can be provided as dictionary. This feature requires a python kubernetes client version >= 17.17.0.

    diff --git a/main/searchindex.js b/main/searchindex.js index 26322fc..1f5f15e 100644 --- a/main/searchindex.js +++ b/main/searchindex.js @@ -1 +1 @@ -Search.setIndex({"alltitles": {"A typographical error was fixed in the documentation for a collection": [[9, "a-typographical-error-was-fixed-in-the-documentation-for-a-collection"]], "Ansible and Python version compatibility": [[2, "ansible-and-python-version-compatibility"]], "Ansible collections": [[2, "ansible-collections"]], "Authors": [[6, "authors"], [7, "authors"], [8, "authors"]], "Breaking change to any content within a collection": [[9, "breaking-change-to-any-content-within-a-collection"]], "Bug fix or security fix to existing content within a collection": [[9, "bug-fix-or-security-fix-to-existing-content-within-a-collection"]], "Bugfixes": [[0, "bugfixes"], [0, "id15"], [0, "id23"]], "Build and install locally": [[2, "build-and-install-locally"]], "Code of Conduct": [[2, "code-of-conduct"]], "Collection Versioning Strategy": [[9, "collection-versioning-strategy"]], "Collection maintenance": [[2, "collection-maintenance"]], "Content removed from a collection": [[9, "content-removed-from-a-collection"]], "Continuous integration": [[11, "continuous-integration"]], "Contributing": [[1, "contributing"]], "Contributing to this collection": [[2, "contributing-to-this-collection"]], "Contributor\u2019s Guidelines": [[3, "contributor-s-guidelines"]], "Dependencies": [[2, "dependencies"]], "Developer documentation": [[4, null]], "Development environment": [[3, "development-environment"]], "Documentation added/removed/modified within a collection": [[9, "documentation-added-removed-modified-within-a-collection"]], "Example config and playbooks": [[11, "example-config-and-playbooks"]], "Examples": [[6, "examples"], [7, "examples"], [8, "examples"]], "General": [[4, null]], "Governance": [[2, "governance"]], "Included content": [[2, "included-content"]], "Installing the Collection from Ansible Galaxy": [[2, "installing-the-collection-from-ansible-galaxy"]], "Integration tests": [[11, "integration-tests"]], "KubeVirt Collection for Ansible Release Notes": [[0, "kubevirt-collection-for-ansible-release-notes"]], "Lean Ansible bindings for KubeVirt": [[2, "lean-ansible-bindings-for-kubevirt"]], "Licensing": [[2, "licensing"]], "Major Changes": [[0, "major-changes"]], "Minor Changes": [[0, "minor-changes"], [0, "id10"], [0, "id20"], [0, "id31"]], "New content is added to an existing collection": [[9, "new-content-is-added-to-an-existing-collection"]], "New feature to existing plugin or role within a collection (backwards compatible)": [[9, "new-feature-to-existing-plugin-or-role-within-a-collection-backwards-compatible"]], "Notes": [[7, "notes"], [8, "notes"]], "Parameters": [[6, "parameters"], [7, "parameters"], [8, "parameters"]], "Plugin Index": [[5, "plugin-index"]], "Plugins": [[2, "plugins"]], "Python libraries": [[2, "python-libraries"]], "Release Summary": [[0, "release-summary"], [0, "id9"], [0, "id18"], [0, "id19"], [0, "id27"], [0, "id28"], [0, "id29"], [0, "id30"], [0, "id32"]], "Release automation": [[9, "release-automation"]], "Release policy": [[2, "release-policy"]], "Requirements": [[6, "requirements"], [7, "requirements"], [8, "requirements"]], "Return Values": [[7, "return-values"], [8, "return-values"]], "Role Index": [[10, "role-index"]], "Running integration tests with ansible test": [[11, "running-integration-tests-with-ansible-test"]], "Running tests with ansible-test": [[11, "running-tests-with-ansible-test"]], "Running tests with coverage analysis": [[11, "running-tests-with-coverage-analysis"]], "Running tests with tox-ansible": [[11, "running-tests-with-tox-ansible"]], "Sanity and unit tests": [[11, "sanity-and-unit-tests"]], "Synopsis": [[6, "synopsis"], [7, "synopsis"], [8, "synopsis"]], "Testing": [[11, "testing"]], "Topics": [[0, "topics"]], "User documentation": [[4, null]], "Using this collection": [[2, "using-this-collection"]], "Virtualenv for development": [[3, "virtualenv-for-development"]], "Welcome to kubevirt.core Collection documentation": [[4, "welcome-to-kubevirt-core-collection-documentation"]], "inventory plugins": [[5, null]], "kubevirt \u2013 Inventory source for KubeVirt VirtualMachines and VirtualMachineInstances": [[6, "kubevirt-inventory-source-for-kubevirt-virtualmachines-and-virtualmachineinstances"]], "kubevirt_vm \u2013 Create or delete KubeVirt VirtualMachines": [[7, "kubevirt-vm-create-or-delete-kubevirt-virtualmachines"]], "kubevirt_vm_info \u2013 Describe KubeVirt VirtualMachines": [[8, "kubevirt-vm-info-describe-kubevirt-virtualmachines"]], "modules plugins": [[5, null]], "v1.0.0": [[0, "v1-0-0"]], "v1.1.0": [[0, "v1-1-0"]], "v1.2.0": [[0, "v1-2-0"]], "v1.2.1": [[0, "v1-2-1"]], "v1.2.2": [[0, "v1-2-2"]], "v1.2.3": [[0, "v1-2-3"]], "v1.3.0": [[0, "v1-3-0"]], "v1.3.1": [[0, "v1-3-1"]], "v1.3.2": [[0, "v1-3-2"]], "v1.4.0": [[0, "v1-4-0"]], "v1.5.0": [[0, "v1-5-0"]]}, "docnames": ["CHANGELOG", "CONTRIBUTING", "README", "developing", "index", "plugins/index", "plugins/kubevirt", "plugins/kubevirt_vm", "plugins/kubevirt_vm_info", "releasing", "roles/index", "testing"], "envversion": {"sphinx": 61, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1}, "filenames": ["CHANGELOG.rst", "CONTRIBUTING.md", "README.md", "developing.md", "index.rst", "plugins/index.rst", "plugins/kubevirt.rst", "plugins/kubevirt_vm.rst", "plugins/kubevirt_vm_info.rst", "releasing.md", "roles/index.rst", "testing.md"], "indexentries": {}, "objects": {}, "objnames": {}, "objtypes": {}, "terms": {"": [2, 4, 6, 7, 8, 11], "0": [2, 4, 6, 7, 8, 9], "1": [2, 4, 6, 7, 8, 9, 11], "10": [0, 7, 8], "100": 0, "103": 0, "105": 0, "106": 0, "108": 0, "109": 0, "11": [2, 6, 7, 8], "111": 0, "114": 0, "115": 0, "12": [2, 6, 7, 8], "120": [7, 8], "127": [7, 8], "15": [0, 2, 7, 8], "16": [7, 8], "168": [6, 7, 8], "17": [2, 7, 8], "172": [7, 8], "19": [7, 8], "192": [6, 7, 8], "2": [2, 3, 4, 6, 7, 8, 9], "28": [2, 6, 7, 8], "3": [2, 4, 6, 7, 8], "34": [6, 7, 8], "3600": 6, "4": [2, 4, 6, 8], "48": 7, "5": [4, 6, 7, 8], "5gi": 7, "6": 0, "64": 6, "70": 0, "72": 0, "73": 0, "75": 0, "76": 0, "8": [7, 8], "8443": 6, "88": 0, "89": 0, "9": [2, 6, 7, 8], "90": 0, "91": 0, "95": 0, "A": [4, 6], "By": [6, 8, 9], "For": [6, 11], "If": [2, 6, 7, 8, 11], "In": [6, 11], "It": [6, 7, 8, 11], "No": 0, "Not": 0, "Or": 11, "The": [2, 3, 6, 7, 8, 9, 11], "To": [2, 3, 6, 7, 8, 11], "Will": 7, "_": 6, "_v1_datavolumetemplatespec": 7, "_v1_virtualmachineinstancespec": 7, "aaaa": 7, "abl": [6, 7, 8], "about": 11, "abov": [9, 11], "absent": 7, "accept": 2, "access": [6, 7, 8, 11], "accessmod": 7, "across": 7, "activ": [2, 6], "ad": [0, 4, 6, 7, 8], "add": [0, 6], "addit": [0, 9], "address": 6, "affect": 8, "after": [0, 6, 9], "against": 2, "agent": [7, 8], "alias": [6, 7, 8], "all": [2, 3, 6, 8, 9], "allow": [0, 9, 11], "alreadi": 7, "also": [6, 7, 8], "alwai": [6, 8], "among": 2, "an": [2, 4, 6, 7, 8], "ani": [2, 4, 7, 8], "annot": [7, 8, 9], "ansibl": [3, 4, 6, 7, 8, 9], "ansible_cache_plugin": 6, "ansible_cache_plugin_connect": 6, "ansible_cache_plugin_prefix": 6, "ansible_cache_plugin_timeout": 6, "ansible_collect": 11, "ansible_connect": 0, "ansible_inventory_": 6, "ansible_inventory_cach": 6, "ansible_inventory_cache_connect": 6, "ansible_inventory_cache_plugin": 6, "ansible_inventory_cache_plugin_prefix": 6, "ansible_inventory_cache_timeout": 6, "ansible_inventory_use_extra_var": 6, "ansible_port": 0, "ansible_test_prefer_podman": 11, "apach": 2, "api": [6, 7, 8, 9], "api_found": 8, "api_kei": [6, 7, 8], "api_vers": [6, 7, 8], "app": [6, 7, 8], "append": 6, "append_base_domain": [0, 6], "applic": [7, 8], "ar": [2, 3, 6, 7, 8, 9, 11], "argspec": 9, "argument": [3, 7, 8], "argument_spec": 3, "around": 3, "artifact": 9, "assert": 0, "assign": 6, "assum": 9, "attach": 6, "attempt": [6, 7, 8], "attribut": [7, 8], "auth": [7, 8], "authent": [6, 7, 8], "author": 5, "autom": [0, 2, 3, 4], "automat": 7, "avail": [6, 9], "avoid": [0, 3, 7, 8], "awx": 6, "background": 7, "backward": 4, "bar": 3, "base": [0, 2, 6, 8], "base_domain": 6, "basi": 7, "basic": [7, 8], "basic_auth": [7, 8], "becaus": 6, "becom": 2, "been": 2, "befor": 2, "begin": 9, "behavior": [7, 8], "below": [6, 7, 8, 9], "better": [2, 11], "between": [7, 8], "bind": [4, 11], "boolean": [6, 7, 8], "both": 11, "branch": 2, "break": 4, "bridg": [6, 7], "bug": 4, "build": [0, 3, 6, 9, 11], "built": 9, "bump": 0, "ca": [6, 7, 8], "ca_cert": [6, 7, 8], "cach": 6, "cache_connect": 6, "cache_plugin": 6, "cache_prefix": 6, "cache_timeout": 6, "can": [2, 3, 6, 7, 8, 11], "case": [6, 7], "cd": 11, "cert_fil": [6, 7, 8], "certif": [6, 7, 8], "cfg": 9, "chain": [7, 8], "chang": [3, 4, 7, 11], "changelog": [0, 4], "charact": 7, "check": [6, 7, 8, 11], "checkout": 2, "choic": [6, 7, 8], "choosen": 11, "chore": 0, "ci": 11, "cidr": [7, 8], "cleanup": [0, 11], "client": [6, 7, 8], "client_cert": [6, 7, 8], "client_kei": [6, 7, 8], "clone": [2, 11], "cloud": 7, "cloudinit": 7, "cloudinitnocloud": 7, "cluster": [6, 7, 8, 11], "code": [0, 4, 11], "collabor": 2, "collect": [6, 7, 8, 11], "colon": [7, 8], "com": [7, 8, 11], "combin": 2, "comma": [7, 8], "command": [2, 3], "comment": [6, 7, 8], "common": [7, 8], "commun": 2, "compat": [0, 3, 4, 11], "complex": [7, 8], "compos": 6, "composit": 6, "concaten": [3, 6], "condit": [6, 7, 8], "conduct": 4, "config": [4, 6, 7, 8], "configur": [6, 7, 8, 11], "conjunct": 6, "connect": [0, 6, 7, 8, 9], "consensu": 2, "consid": 9, "construct": 6, "contain": [3, 9, 11], "containerdisk": 7, "content": 4, "context": [6, 7, 8], "continu": 6, "contribut": 4, "contributor": [2, 4], "control": [0, 6, 7], "convent": 3, "core": [0, 2, 6, 7, 8, 11], "correct": [7, 8, 9], "cover": 11, "creat": [2, 4, 5, 6, 9, 11], "create_group": 6, "creation": [0, 6], "credenti": [7, 8], "ctrl": 3, "current": [2, 8, 9], "custom": 6, "dash": 3, "data": 6, "data_volume_templ": 7, "datavolum": 7, "debug": 11, "decis": 2, "dedic": [2, 9], "default": [3, 6, 7, 8, 9], "default_testvm": 8, "default_valu": 6, "defin": [3, 6], "definit": 7, "delet": [2, 4, 5, 9, 11], "delete_opt": 7, "dep": 11, "depend": [0, 7, 11], "deprec": [0, 6, 9], "deriv": 6, "describ": [0, 2, 4, 5], "descript": [7, 8], "detail": [2, 6, 7, 8], "determin": 7, "dev": 11, "develop": [2, 6, 9, 11], "devic": 7, "dictionari": [6, 7, 8], "did": 11, "differ": 7, "directori": [3, 11], "disabl": [6, 7, 8], "discuss": [2, 7, 8], "do": 3, "doc": [0, 2], "docker": [7, 11], "docsit": 0, "document": [0, 6, 7, 8], "doe": [6, 7, 8, 9], "domain": [6, 7, 8], "don": [2, 3], "done": 11, "down": 11, "downstream": 0, "drop": 0, "due": 0, "durat": [6, 7], "dv": 7, "e": [3, 7, 8], "e2": [0, 11], "each": [3, 6, 9], "earli": 0, "ed25519": 7, "either": [7, 8, 9], "elaps": 7, "element": [6, 7, 8], "elimin": 9, "empti": [0, 6, 7], "en": [7, 8], "enabl": 6, "end": [6, 7, 8], "enhanc": 0, "ensur": [0, 6, 11], "entri": [6, 9], "environ": [4, 6, 7, 8, 11], "error": [4, 6, 7, 8], "establish": 6, "etc": 8, "even": [7, 8], "everi": 2, "exampl": [3, 4, 5, 9], "except": 3, "exclus": [6, 7], "execut": [6, 7, 8], "exist": [0, 4, 6, 7, 8], "expir": [7, 8], "explic": 0, "explicitli": 9, "express": 6, "extens": [3, 9], "extra": 6, "fact": 6, "fact_cach": 6, "fact_caching_connect": 6, "fact_caching_prefix": 6, "fact_caching_timeout": 6, "fail": [7, 8], "fals": [6, 7, 8], "fatal": 6, "feat": 0, "featur": [4, 7, 8], "fedora": 7, "feel": 2, "fetch": 6, "field": [7, 8], "field_selector": 8, "file": [0, 2, 3, 6, 7, 8], "filenam": 6, "filter": [8, 9], "find": [2, 8], "fip": 0, "first": 9, "fix": [0, 4], "flag": [7, 8], "focus": 3, "follow": [2, 3, 7, 8, 9, 11], "foo": [3, 7, 8], "forc": 7, "foreground": 7, "format": [6, 9, 11], "found": [2, 6, 7, 8], "fragment": 0, "free": 2, "from": [3, 4, 6, 7, 8], "full": [2, 7, 8], "function": [0, 9], "further": [6, 7, 8], "g": [3, 7, 8], "galaxi": [6, 7, 8, 9, 11], "gcloud": [7, 8], "gener": [6, 7, 9], "generate_nam": 7, "get": 8, "git": [9, 11], "github": [9, 11], "give": 0, "given": [6, 9], "gke": [7, 8], "go": [3, 7, 8], "govern": 4, "group": [0, 6, 7, 8], "group1": [7, 8], "group2": [7, 8], "gt": [7, 8], "guid": 2, "guidelin": [1, 2, 4], "gz": 2, "ha": 2, "hack": 11, "have": [2, 3, 6], "header": [7, 8], "help": 2, "here": [7, 8], "high": 6, "higher": [0, 6], "highest": 6, "highlight": [7, 8], "host": [0, 2, 6, 7, 8], "host_format": 6, "hotfix": 0, "how": [2, 7, 8, 9], "html": [7, 8, 11], "http": [6, 7, 8, 9, 11], "http_proxi": [7, 8], "hub": [0, 9], "i": [0, 2, 4, 6, 7, 8, 11], "ie": 3, "ignor": [6, 7, 8], "imag": 7, "imperson": [7, 8], "impersonate_group": [7, 8], "impersonate_us": [7, 8], "import": 2, "improv": 0, "inbound": 9, "includ": [0, 3, 4, 6, 7, 8, 9], "incompat": 9, "increas": 9, "increment": 9, "indent": 3, "index": [4, 11], "indic": 9, "individu": 2, "ini": 6, "initi": 0, "input": 6, "instal": [3, 6, 7, 8, 11], "instancetyp": 7, "instead": 6, "integ": [6, 7, 8], "integr": [0, 4], "interfac": [0, 6, 7], "interface_nam": 6, "intern": 3, "interpol": 3, "interpret": 3, "introduc": 9, "invalid": 6, "inventori": [0, 2, 4, 9, 11], "inventory_plugin": 6, "io": [6, 7, 8], "ip": [6, 7, 8], "issu": [0, 2, 11], "item": 6, "its": 7, "jinja": 3, "jinja2": 6, "jsonpatch": [2, 7], "k8": [0, 7, 8], "k8s_auth_api_kei": [6, 7, 8], "k8s_auth_cert_fil": [6, 7, 8], "k8s_auth_context": [6, 7, 8], "k8s_auth_host": [6, 7, 8], "k8s_auth_impersonate_group": [7, 8], "k8s_auth_impersonate_us": [7, 8], "k8s_auth_key_fil": [6, 7, 8], "k8s_auth_kubeconfig": [6, 7, 8], "k8s_auth_no_proxi": [7, 8], "k8s_auth_password": [6, 7, 8], "k8s_auth_persist_config": [7, 8], "k8s_auth_proxi": [7, 8], "k8s_auth_proxy_headers_basic_auth": [7, 8], "k8s_auth_proxy_headers_proxy_basic_auth": [7, 8], "k8s_auth_proxy_headers_user_ag": [7, 8], "k8s_auth_ssl_ca_cert": [6, 7, 8], "k8s_auth_usernam": [6, 7, 8], "k8s_auth_verify_ssl": [6, 7, 8], "keep": [0, 3], "kei": [0, 6, 7, 8], "key_fil": [6, 7, 8], "keyed_group": 6, "kind": [2, 8, 11], "kindexgw": 7, "know": 2, "kube": [6, 7, 8], "kube_secondary_dn": 6, "kubeconfig": [6, 7, 8], "kubectl": [6, 11], "kubernet": [0, 2, 6, 7, 8], "kubesecondarydn": 6, "kubevirt": [1, 5, 11], "kubevirt_vm": [0, 2, 4, 5], "kubevirt_vm_info": [0, 2, 4, 5], "label": [6, 7, 8, 9], "label_selector": [6, 8], "latest": [7, 8], "lead": 6, "leading_separ": 6, "lean": 4, "learn": 2, "less": [7, 8], "let": 2, "level": 6, "librari": [7, 8], "licens": 4, "like": [2, 3, 7, 8, 11], "limit": 9, "line": 2, "link": 0, "list": [0, 2, 3, 6, 7, 8], "load": [6, 7, 8], "local": [6, 7, 8, 11], "localhost": [7, 8], "locat": 11, "long": [7, 8], "low": 6, "lower": 6, "lowercas": 3, "machin": [2, 3, 6, 11], "made": [2, 9], "mai": [7, 9], "main": [2, 7], "maintain": [2, 9], "mainten": 4, "major": 9, "make": [0, 2, 3, 6, 9, 11], "make_head": [7, 8], "mani": 0, "manner": 9, "map": [6, 8], "markup": 0, "masquerad": 7, "matcher": 7, "matrix": [2, 9], "md": 2, "medium": 7, "memori": 6, "mention": 2, "merg": 6, "met": 7, "meta": 3, "metadata": [7, 8, 9], "method": 7, "might": [6, 7, 8], "min": 11, "mind": 2, "minor": 9, "mkdir": 11, "mode": [0, 7, 8], "modifi": [4, 8], "modul": [0, 7, 8, 9], "more": [0, 2, 3, 6], "mostli": 0, "mount": 11, "move": 6, "multipl": [6, 7, 8, 11], "multu": 7, "must": [6, 7, 8], "mutual": [6, 7], "my": 3, "my_path": 3, "my_playbook": 3, "my_rol": 3, "name": [3, 6, 7, 8, 9], "namespac": [6, 7, 8], "namespace_vmis_group": 0, "necessari": 11, "need": [2, 3, 6, 7, 8, 9, 11], "network": [6, 7], "network_nam": 6, "networknam": 7, "new": [2, 4, 7, 8], "newli": 9, "next": [7, 8, 9], "no_proxi": [7, 8], "node": 6, "nodeport": 6, "nor": 9, "note": [5, 9], "noth": 3, "number": [7, 8, 9], "object": [6, 7, 8], "oidc": [7, 8], "old": [7, 8], "omit": 6, "one": 6, "onli": [0, 6, 7, 9], "oper": [2, 7, 8], "option": [0, 6, 7, 8], "order": [6, 11], "org": 9, "orphan": 7, "other": [3, 6, 7, 8], "otherwis": 6, "our": 2, "out": 11, "outcom": 9, "output": 11, "over": [0, 3], "overrid": [3, 6], "overridden": 3, "owner": 2, "p": [3, 11], "page": 9, "paramet": [0, 5, 9], "parent": 6, "parent_group": 6, "part": [6, 7, 8], "particip": 2, "pass": [0, 7, 8], "password": [6, 7, 8], "patch": [7, 9], "path": [3, 6, 7, 8, 11], "payload": 9, "peopl": 2, "perform": [7, 8], "persist_config": [7, 8], "pick": [2, 7, 8], "pip": [2, 3, 11], "plai": [3, 11], "plain": 11, "platform": [3, 7, 8], "playbook": [3, 4, 6, 7, 8, 9], "pleas": [7, 8, 9], "plugin": [4, 6, 11], "pod": 7, "podman": 11, "polici": [4, 7], "port": 6, "possibl": [3, 6], "post_task": 3, "pre": 9, "pre_task": 3, "preced": 6, "precondit": 7, "prefer": 7, "prefix": 6, "present": 7, "previou": 9, "primari": 6, "prior": 9, "prioriti": [0, 6], "proce": 7, "process": [0, 2], "produc": 11, "project": [6, 7, 8, 11], "project_dir": 11, "propagationpolici": 7, "proper": 0, "propos": 2, "provid": [0, 2, 6, 7, 8, 11], "proxi": [7, 8], "proxy_basic_auth": [7, 8], "proxy_head": [7, 8], "publish": 9, "purpos": [3, 11], "python": [3, 4, 6, 7, 8, 11], "pyyaml": [2, 6, 7, 8], "quai": 7, "question": 2, "r": [2, 11], "random": 7, "read": [6, 7, 8], "readi": [7, 8, 9], "readm": 9, "readthedoc": [7, 8], "readwriteonc": 7, "recommend": 11, "redund": 0, "refer": [1, 2, 7, 8], "refresh": [7, 8], "regist": 8, "registri": 7, "releas": 4, "reli": 11, "remov": [4, 6, 11], "replac": 7, "report": 11, "repositori": [2, 11], "repres": [7, 8], "represent": 8, "reproduc": 11, "request": 7, "requir": [2, 3, 5, 9, 11], "resourc": [7, 8], "resourcevers": 7, "rest": 8, "result": [3, 7, 8], "retrigg": 0, "return": [0, 5, 6, 9], "review_checklist": 2, "revis": 9, "rework": 0, "robust": 0, "role": [3, 4], "rsa": 0, "run": [0, 3, 6, 7, 8], "same": 3, "sampl": [7, 11], "saniti": 4, "save": [7, 8], "scenario": 9, "schema": 8, "script": 11, "search": 8, "second": [6, 7, 8], "secondari": [0, 6], "section": [9, 11], "secur": 4, "see": [2, 6, 7, 8, 9], "select": [3, 6], "selector": [6, 8], "self": 3, "semant": 9, "semver": 9, "separ": [3, 6, 7, 8], "server": [6, 7, 8], "servic": [0, 6], "set": [0, 6, 7, 8], "setup": [6, 11], "sever": 0, "sh": 11, "shall": 9, "shape": 9, "shift": 3, "ship": 0, "should": [3, 6, 7, 8, 9], "shouldn": [7, 8], "shown": 11, "sinc": 6, "skip": 6, "slash": 3, "sleep": [7, 8], "smaller": 9, "so": [7, 8, 11], "softwar": [0, 2], "some": 0, "someth": 2, "sourc": [2, 4, 5, 7, 11], "space": 3, "spec": [7, 8], "specif": [3, 6, 8], "specifi": [6, 7, 8], "split": 6, "ssh": [0, 6, 7], "ssh_authorized_kei": 7, "ssl": [6, 7, 8], "ssl_ca_cert": [6, 7, 8], "standard": 8, "start": [2, 3, 6], "state": [7, 8, 9], "statu": 8, "step": 11, "still": 6, "stop": [0, 8], "storag": 7, "strategi": 4, "strict": [6, 9], "string": [6, 7, 8], "structur": 9, "subset": 6, "success": [7, 8], "successfulli": 8, "sudo": 11, "suit": 11, "support": [0, 2, 7, 8, 9, 11], "symlink": 3, "sync": 0, "synopsi": 5, "t": [2, 3, 7, 8], "tabl": 6, "tag": [2, 9], "tar": 2, "tarbal": 0, "target": [7, 8], "task": [3, 7], "tell": [7, 8], "templat": 7, "termin": 11, "test": [0, 2, 3, 4, 6, 7, 8, 9], "testdv": 7, "testvm": [7, 8], "text": [2, 11], "than": [3, 7, 8], "thei": [6, 11], "them": 2, "therefor": 9, "thi": [0, 4, 6, 7, 8, 9, 11], "those": [3, 6, 7], "through": [2, 7, 8], "time": [7, 9], "toggl": 6, "token": [6, 7, 8], "tool": 2, "top": 6, "tox": 3, "trail": 3, "trailing_separ": 6, "trigger": 9, "true": [6, 7, 8], "two": 11, "txt": [2, 11], "type": [0, 6, 7], "typic": [7, 8], "typograph": 4, "u1": 7, "uid": [6, 7], "under": 3, "underscor": [3, 6], "uniqu": [7, 8], "unit": [0, 4], "until": 8, "up": [6, 7, 8, 11], "updat": [0, 9], "url": [6, 7, 8], "urllib3": [7, 8], "us": [0, 3, 4, 6, 7, 8, 11], "use_extra_var": 6, "use_servic": 6, "user": [3, 6, 7, 8, 9], "user_ag": [7, 8], "userdata": 7, "usernam": [6, 7, 8], "util": [7, 8], "v": 3, "v1": [4, 6, 7, 8], "valid": [3, 7, 8], "validate_cert": [6, 7, 8], "valu": [5, 6], "var": [3, 6], "vari": [7, 8], "variabl": [3, 6, 7, 8], "vendor": 0, "venv": 3, "veri": 2, "verif": 11, "verifi": [0, 6, 7, 8], "verify_ssl": [6, 7, 8], "version": [0, 4, 6, 7, 8], "via": [6, 7, 8], "virtual": [2, 6, 11], "virtualenv": 4, "virtualmachin": [0, 2, 4, 5], "virtualmachineinst": [4, 5], "vm": 0, "vm_list": 8, "voic": 2, "volum": 7, "vscode": 3, "wa": [4, 6, 7], "wai": 11, "wait": [7, 8], "wait_condit": 0, "wait_sleep": [7, 8], "wait_timeout": [7, 8], "want": [2, 7, 8], "we": [2, 6, 9], "welcom": 2, "were": 8, "when": [3, 6, 7, 8, 9], "where": 3, "whether": [6, 7, 8], "which": [2, 3, 6, 11], "while": 9, "window": [0, 7, 8], "winrm": 0, "within": 4, "work": [6, 11], "world": 2, "would": [3, 9], "x27": [6, 7, 8], "xml": 11, "xxxxxxxxxxxxxxxx": 6, "yaml": [0, 3, 6], "ye": [6, 7, 8], "yml": [0, 2, 3, 6, 11], "you": [2, 3, 6, 7, 8, 11], "your": [2, 3, 6, 11]}, "titles": ["KubeVirt Collection for Ansible Release Notes", "Contributing", "Lean Ansible bindings for KubeVirt", "Contributor\u2019s Guidelines", "Welcome to kubevirt.core Collection documentation", "Plugin Index", "kubevirt \u2013 Inventory source for KubeVirt VirtualMachines and VirtualMachineInstances", "kubevirt_vm \u2013 Create or delete KubeVirt VirtualMachines", "kubevirt_vm_info \u2013 Describe KubeVirt VirtualMachines", "Collection Versioning Strategy", "Role Index", "Testing"], "titleterms": {"": 3, "0": 0, "1": 0, "2": 0, "3": 0, "4": 0, "5": 0, "A": 9, "ad": 9, "an": 9, "analysi": 11, "ani": 9, "ansibl": [0, 2, 11], "author": [6, 7, 8], "autom": 9, "backward": 9, "bind": 2, "break": 9, "bug": 9, "bugfix": 0, "build": 2, "chang": [0, 9], "code": 2, "collect": [0, 2, 4, 9], "compat": [2, 9], "conduct": 2, "config": 11, "content": [2, 9], "continu": 11, "contribut": [1, 2], "contributor": 3, "core": 4, "coverag": 11, "creat": 7, "delet": 7, "depend": 2, "describ": 8, "develop": [3, 4], "document": [4, 9], "environ": 3, "error": 9, "exampl": [6, 7, 8, 11], "exist": 9, "featur": 9, "fix": 9, "from": [2, 9], "galaxi": 2, "gener": 4, "govern": 2, "guidelin": 3, "i": 9, "includ": 2, "index": [5, 10], "instal": 2, "integr": 11, "inventori": [5, 6], "kubevirt": [0, 2, 4, 6, 7, 8], "kubevirt_vm": 7, "kubevirt_vm_info": 8, "lean": 2, "librari": 2, "licens": 2, "local": 2, "mainten": 2, "major": 0, "minor": 0, "modifi": 9, "modul": 5, "new": 9, "note": [0, 7, 8], "paramet": [6, 7, 8], "playbook": 11, "plugin": [2, 5, 9], "polici": 2, "python": 2, "releas": [0, 2, 9], "remov": 9, "requir": [6, 7, 8], "return": [7, 8], "role": [9, 10], "run": 11, "saniti": 11, "secur": 9, "sourc": 6, "strategi": 9, "summari": 0, "synopsi": [6, 7, 8], "test": 11, "thi": 2, "topic": 0, "tox": 11, "typograph": 9, "unit": 11, "us": 2, "user": 4, "v1": 0, "valu": [7, 8], "version": [2, 9], "virtualenv": 3, "virtualmachin": [6, 7, 8], "virtualmachineinst": 6, "wa": 9, "welcom": 4, "within": 9}}) \ No newline at end of file +Search.setIndex({"alltitles": {"A typographical error was fixed in the documentation for a collection": [[9, "a-typographical-error-was-fixed-in-the-documentation-for-a-collection"]], "Ansible and Python version compatibility": [[2, "ansible-and-python-version-compatibility"]], "Ansible collections": [[2, "ansible-collections"]], "Authors": [[6, "authors"], [7, "authors"], [8, "authors"]], "Breaking Changes / Porting Guide": [[0, "breaking-changes-porting-guide"]], "Breaking change to any content within a collection": [[9, "breaking-change-to-any-content-within-a-collection"]], "Bug fix or security fix to existing content within a collection": [[9, "bug-fix-or-security-fix-to-existing-content-within-a-collection"]], "Bugfixes": [[0, "bugfixes"], [0, "id16"], [0, "id24"]], "Build and install locally": [[2, "build-and-install-locally"]], "Code of Conduct": [[2, "code-of-conduct"]], "Collection Versioning Strategy": [[9, "collection-versioning-strategy"]], "Collection maintenance": [[2, "collection-maintenance"]], "Content removed from a collection": [[9, "content-removed-from-a-collection"]], "Continuous integration": [[11, "continuous-integration"]], "Contributing": [[1, "contributing"]], "Contributing to this collection": [[2, "contributing-to-this-collection"]], "Contributor\u2019s Guidelines": [[3, "contributor-s-guidelines"]], "Dependencies": [[2, "dependencies"]], "Developer documentation": [[4, null]], "Development environment": [[3, "development-environment"]], "Documentation added/removed/modified within a collection": [[9, "documentation-added-removed-modified-within-a-collection"]], "Example config and playbooks": [[11, "example-config-and-playbooks"]], "Examples": [[6, "examples"], [7, "examples"], [8, "examples"]], "General": [[4, null]], "Governance": [[2, "governance"]], "Included content": [[2, "included-content"]], "Installing the Collection from Ansible Galaxy": [[2, "installing-the-collection-from-ansible-galaxy"]], "Integration tests": [[11, "integration-tests"]], "KubeVirt Collection for Ansible Release Notes": [[0, "kubevirt-collection-for-ansible-release-notes"]], "Lean Ansible bindings for KubeVirt": [[2, "lean-ansible-bindings-for-kubevirt"]], "Licensing": [[2, "licensing"]], "Major Changes": [[0, "major-changes"]], "Minor Changes": [[0, "minor-changes"], [0, "id11"], [0, "id21"], [0, "id32"]], "New content is added to an existing collection": [[9, "new-content-is-added-to-an-existing-collection"]], "New feature to existing plugin or role within a collection (backwards compatible)": [[9, "new-feature-to-existing-plugin-or-role-within-a-collection-backwards-compatible"]], "Notes": [[6, "notes"], [7, "notes"], [8, "notes"]], "Parameters": [[6, "parameters"], [7, "parameters"], [8, "parameters"]], "Plugin Index": [[5, "plugin-index"]], "Plugins": [[2, "plugins"]], "Python libraries": [[2, "python-libraries"]], "Release Summary": [[0, "release-summary"], [0, "id10"], [0, "id19"], [0, "id20"], [0, "id28"], [0, "id29"], [0, "id30"], [0, "id31"], [0, "id33"]], "Release automation": [[9, "release-automation"]], "Release policy": [[2, "release-policy"]], "Requirements": [[6, "requirements"], [7, "requirements"], [8, "requirements"]], "Return Values": [[7, "return-values"], [8, "return-values"]], "Role Index": [[10, "role-index"]], "Running integration tests with ansible test": [[11, "running-integration-tests-with-ansible-test"]], "Running tests with ansible-test": [[11, "running-tests-with-ansible-test"]], "Running tests with coverage analysis": [[11, "running-tests-with-coverage-analysis"]], "Running tests with tox-ansible": [[11, "running-tests-with-tox-ansible"]], "Sanity and unit tests": [[11, "sanity-and-unit-tests"]], "Synopsis": [[6, "synopsis"], [7, "synopsis"], [8, "synopsis"]], "Testing": [[11, "testing"]], "Topics": [[0, "topics"]], "User documentation": [[4, null]], "Using this collection": [[2, "using-this-collection"]], "Virtualenv for development": [[3, "virtualenv-for-development"]], "Welcome to kubevirt.core Collection documentation": [[4, "welcome-to-kubevirt-core-collection-documentation"]], "inventory plugins": [[5, null]], "kubevirt \u2013 Inventory source for KubeVirt VirtualMachines and VirtualMachineInstances": [[6, "kubevirt-inventory-source-for-kubevirt-virtualmachines-and-virtualmachineinstances"]], "kubevirt_vm \u2013 Create or delete KubeVirt VirtualMachines": [[7, "kubevirt-vm-create-or-delete-kubevirt-virtualmachines"]], "kubevirt_vm_info \u2013 Describe KubeVirt VirtualMachines": [[8, "kubevirt-vm-info-describe-kubevirt-virtualmachines"]], "modules plugins": [[5, null]], "v1.0.0": [[0, "v1-0-0"]], "v1.1.0": [[0, "v1-1-0"]], "v1.2.0": [[0, "v1-2-0"]], "v1.2.1": [[0, "v1-2-1"]], "v1.2.2": [[0, "v1-2-2"]], "v1.2.3": [[0, "v1-2-3"]], "v1.3.0": [[0, "v1-3-0"]], "v1.3.1": [[0, "v1-3-1"]], "v1.3.2": [[0, "v1-3-2"]], "v1.4.0": [[0, "v1-4-0"]], "v1.5.0": [[0, "v1-5-0"]]}, "docnames": ["CHANGELOG", "CONTRIBUTING", "README", "developing", "index", "plugins/index", "plugins/kubevirt", "plugins/kubevirt_vm", "plugins/kubevirt_vm_info", "releasing", "roles/index", "testing"], "envversion": {"sphinx": 61, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1}, "filenames": ["CHANGELOG.rst", "CONTRIBUTING.md", "README.md", "developing.md", "index.rst", "plugins/index.rst", "plugins/kubevirt.rst", "plugins/kubevirt_vm.rst", "plugins/kubevirt_vm_info.rst", "releasing.md", "roles/index.rst", "testing.md"], "indexentries": {}, "objects": {}, "objnames": {}, "objtypes": {}, "terms": {"": [2, 4, 6, 7, 8, 11], "0": [2, 4, 6, 7, 8, 9], "1": [2, 4, 6, 7, 8, 9, 11], "10": [0, 6, 7, 8], "100": 0, "103": 0, "105": 0, "106": 0, "108": 0, "109": 0, "11": [2, 6, 7, 8], "111": 0, "114": 0, "115": 0, "117": 0, "12": [2, 6, 7, 8], "120": [7, 8], "127": [6, 7, 8], "15": [0, 2, 6, 7, 8], "16": [6, 7, 8], "168": [6, 7, 8], "17": [2, 6, 7, 8], "172": [6, 7, 8], "19": [6, 7, 8], "192": [6, 7, 8], "2": [2, 3, 4, 6, 9], "28": [2, 6, 7, 8], "3": [2, 4, 6, 7, 8], "34": [6, 7, 8], "3600": 6, "4": [2, 4, 6, 8], "48": 7, "5": [4, 6, 7, 8], "5gi": 7, "6": 0, "64": 6, "70": 0, "72": 0, "73": 0, "75": 0, "76": 0, "8": [6, 7, 8], "8443": 6, "88": 0, "89": 0, "9": [2, 6, 7, 8], "90": 0, "91": 0, "95": 0, "A": [4, 6], "By": [6, 8, 9], "For": [6, 11], "If": [2, 6, 7, 8, 11], "In": [6, 11], "It": [6, 7, 8, 11], "No": 0, "Not": 0, "Or": 11, "The": [2, 3, 6, 7, 8, 9, 11], "To": [2, 3, 6, 7, 8, 11], "Will": 7, "_": 6, "_v1_datavolumetemplatespec": 7, "_v1_virtualmachineinstancespec": 7, "aaaa": 7, "abl": [6, 7, 8], "about": 11, "abov": [9, 11], "absent": 7, "accept": 2, "access": [6, 7, 8, 11], "accessmod": 7, "across": 7, "activ": [2, 6], "ad": [0, 4, 6, 7, 8], "add": [0, 6], "addit": [0, 9], "address": 6, "affect": 8, "after": [0, 6, 9], "against": 2, "agent": [6, 7, 8], "alias": [6, 7, 8], "all": [2, 3, 6, 8, 9], "allow": [0, 9, 11], "alreadi": 7, "also": [6, 7, 8], "alwai": [6, 8], "among": 2, "an": [2, 4, 6, 7, 8], "ani": [2, 4, 6, 7, 8], "annot": [7, 8, 9], "ansibl": [3, 4, 6, 7, 8, 9], "ansible_cache_plugin": 6, "ansible_cache_plugin_connect": 6, "ansible_cache_plugin_prefix": 6, "ansible_cache_plugin_timeout": 6, "ansible_collect": 11, "ansible_connect": 0, "ansible_inventory_": 6, "ansible_inventory_cach": 6, "ansible_inventory_cache_connect": 6, "ansible_inventory_cache_plugin": 6, "ansible_inventory_cache_plugin_prefix": 6, "ansible_inventory_cache_timeout": 6, "ansible_inventory_use_extra_var": 6, "ansible_port": 0, "ansible_test_prefer_podman": 11, "apach": 2, "api": [6, 7, 8, 9], "api_found": 8, "api_kei": [6, 7, 8], "api_vers": [6, 7, 8], "app": [6, 7, 8], "append": 6, "append_base_domain": [0, 6], "applic": [6, 7, 8], "ar": [2, 3, 6, 7, 8, 9, 11], "argspec": 9, "argument": [3, 7, 8], "argument_spec": 3, "around": 3, "artifact": 9, "assert": 0, "assign": 6, "assum": 9, "attach": 6, "attempt": [6, 7, 8], "attribut": [7, 8], "auth": [6, 7, 8], "authent": [6, 7, 8], "author": 5, "autom": [0, 2, 3, 4], "automat": 7, "avail": [6, 9], "avoid": [0, 3, 6, 7, 8], "awx": 6, "background": 7, "backward": 4, "bar": 3, "base": [0, 2, 6, 8], "base_domain": 6, "basi": 7, "basic": [6, 7, 8], "basic_auth": [6, 7, 8], "becaus": 6, "becom": 2, "been": 2, "befor": 2, "begin": 9, "behavior": [7, 8], "below": [6, 7, 8, 9], "better": [2, 11], "between": [7, 8], "bind": [4, 11], "boolean": [6, 7, 8], "both": 11, "branch": 2, "break": 4, "bridg": [6, 7], "bug": 4, "build": [0, 3, 6, 9, 11], "built": 9, "bump": 0, "ca": [6, 7, 8], "ca_cert": [6, 7, 8], "cach": 6, "cache_connect": 6, "cache_plugin": 6, "cache_prefix": 6, "cache_timeout": 6, "can": [2, 3, 6, 7, 8, 11], "case": [6, 7], "cd": 11, "cert_fil": [6, 7, 8], "certif": [6, 7, 8], "cfg": 9, "chain": [6, 7, 8], "chang": [3, 4, 7, 11], "changelog": [0, 4], "charact": 7, "check": [6, 7, 8, 11], "checkout": 2, "choic": [6, 7, 8], "choosen": 11, "chore": 0, "ci": 11, "cidr": [6, 7, 8], "cleanup": [0, 11], "client": [6, 7, 8], "client_cert": [6, 7, 8], "client_kei": [6, 7, 8], "clone": [2, 11], "cloud": 7, "cloudinit": 7, "cloudinitnocloud": 7, "cluster": [6, 7, 8, 11], "code": [0, 4, 11], "collabor": 2, "collect": [6, 7, 8, 11], "colon": [6, 7, 8], "com": [6, 7, 8, 11], "combin": 2, "comma": [6, 7, 8], "command": [2, 3], "comment": [6, 7, 8], "common": [7, 8], "commun": 2, "compat": [0, 3, 4, 11], "complex": [7, 8], "compos": 6, "composit": 6, "concaten": [3, 6], "condit": [6, 7, 8], "conduct": 4, "config": [4, 6, 7, 8], "configur": [6, 7, 8, 11], "conjunct": 6, "connect": [0, 6, 7, 8, 9], "consensu": 2, "consid": 9, "construct": 6, "contain": [3, 9, 11], "containerdisk": 7, "content": 4, "context": [6, 7, 8], "continu": 6, "contribut": 4, "contributor": [2, 4], "control": [0, 6, 7], "convent": 3, "core": [0, 2, 6, 7, 8, 11], "correct": [6, 7, 8, 9], "cover": 11, "creat": [2, 4, 5, 6, 9, 11], "create_group": 6, "creation": [0, 6], "credenti": [6, 7, 8], "ctrl": 3, "current": [2, 8, 9], "custom": 6, "dash": 3, "data": 6, "data_volume_templ": 7, "datavolum": 7, "debug": 11, "decis": 2, "dedic": [2, 9], "default": [3, 6, 7, 8, 9], "default_testvm": 8, "default_valu": 6, "defin": [3, 6], "definit": 7, "delet": [2, 4, 5, 9, 11], "delete_opt": 7, "dep": 11, "depend": [0, 7, 11], "deprec": [0, 6, 9], "deriv": 6, "describ": [0, 2, 4, 5], "descript": [6, 7, 8], "detail": [2, 6, 7, 8], "determin": 7, "dev": 11, "develop": [2, 6, 9, 11], "devic": 7, "dictionari": [6, 7, 8], "did": 11, "differ": 7, "directori": [3, 11], "disabl": [6, 7, 8], "discuss": [2, 6, 7, 8], "do": 3, "doc": [0, 2], "docker": [7, 11], "docsit": 0, "document": [0, 6, 7, 8], "doe": [6, 7, 8, 9], "domain": [6, 7, 8], "don": [2, 3], "done": 11, "down": 11, "downstream": 0, "drop": 0, "due": 0, "durat": [6, 7], "dv": 7, "e": [3, 6, 7, 8], "e2": [0, 11], "each": [3, 6, 9], "earli": 0, "ed25519": 7, "either": [7, 8, 9], "elaps": 7, "element": [6, 7, 8], "elimin": 9, "empti": [0, 6, 7], "en": [6, 7, 8], "enabl": 6, "end": [6, 7, 8], "enhanc": 0, "ensur": [0, 6, 11], "entri": [6, 9], "environ": [4, 6, 7, 8, 11], "error": [4, 6, 7, 8], "establish": 6, "etc": 8, "even": [6, 7, 8], "everi": 2, "exampl": [3, 4, 5, 9], "except": 3, "exclus": [6, 7], "execut": [6, 7, 8], "exist": [0, 4, 6, 7, 8], "expir": [6, 7, 8], "explic": 0, "explicitli": 9, "express": 6, "extens": [3, 9], "extra": 6, "fact": 6, "fact_cach": 6, "fact_caching_connect": 6, "fact_caching_prefix": 6, "fact_caching_timeout": 6, "fail": [6, 7, 8], "fals": [6, 7, 8], "fatal": 6, "feat": 0, "featur": [4, 6, 7, 8], "fedora": 7, "feel": 2, "fetch": 6, "field": [7, 8], "field_selector": 8, "file": [0, 2, 3, 6, 7, 8], "filenam": 6, "filter": [8, 9], "find": [2, 8], "fip": 0, "first": 9, "fix": [0, 4], "flag": [6, 7, 8], "focus": 3, "follow": [2, 3, 7, 8, 9, 11], "foo": [3, 6, 7, 8], "forc": 7, "foreground": 7, "format": [6, 9, 11], "found": [2, 6, 7, 8], "fragment": 0, "free": 2, "from": [3, 4, 6, 7, 8], "full": [2, 6, 7, 8], "function": [0, 9], "further": [6, 7, 8], "g": [3, 6, 7, 8], "galaxi": [6, 7, 8, 9, 11], "gcloud": [6, 7, 8], "gener": [6, 7, 9], "generate_nam": 7, "get": 8, "git": [9, 11], "github": [9, 11], "give": 0, "given": [6, 9], "gke": [6, 7, 8], "go": [3, 6, 7, 8], "govern": 4, "group": [0, 6, 7, 8], "group1": [6, 7, 8], "group2": [6, 7, 8], "gt": [6, 7, 8], "guid": 2, "guidelin": [1, 2, 4], "gz": 2, "ha": 2, "hack": 11, "have": [2, 3, 6], "header": [6, 7, 8], "help": 2, "here": [6, 7, 8], "high": 6, "higher": [0, 6], "highest": 6, "highlight": [6, 7, 8], "host": [0, 2, 6, 7, 8], "host_format": 6, "hotfix": 0, "how": [2, 7, 8, 9], "html": [6, 7, 8, 11], "http": [6, 7, 8, 9, 11], "http_proxi": [6, 7, 8], "hub": [0, 9], "i": [0, 2, 4, 6, 7, 8, 11], "ie": 3, "ignor": [6, 7, 8], "imag": 7, "imperson": [6, 7, 8], "impersonate_group": [6, 7, 8], "impersonate_us": [6, 7, 8], "import": 2, "improv": 0, "inbound": 9, "includ": [0, 3, 4, 6, 7, 8, 9], "incompat": 9, "increas": 9, "increment": 9, "indent": 3, "index": [4, 11], "indic": 9, "individu": 2, "ini": 6, "initi": 0, "input": 6, "instal": [3, 6, 7, 8, 11], "instancetyp": 7, "instead": 6, "integ": [6, 7, 8], "integr": [0, 4], "interfac": [0, 6, 7], "interface_nam": 6, "intern": 3, "interpol": 3, "interpret": 3, "introduc": 9, "invalid": 6, "inventori": [0, 2, 4, 9, 11], "inventory_plugin": 6, "io": [6, 7, 8], "ip": [6, 7, 8], "issu": [0, 2, 11], "item": 6, "its": 7, "jinja": 3, "jinja2": 6, "jsonpatch": [2, 7], "k8": [0, 6, 7, 8], "k8s_auth_api_kei": [6, 7, 8], "k8s_auth_cert_fil": [6, 7, 8], "k8s_auth_context": [6, 7, 8], "k8s_auth_host": [6, 7, 8], "k8s_auth_impersonate_group": [6, 7, 8], "k8s_auth_impersonate_us": [6, 7, 8], "k8s_auth_key_fil": [6, 7, 8], "k8s_auth_kubeconfig": [6, 7, 8], "k8s_auth_no_proxi": [6, 7, 8], "k8s_auth_password": [6, 7, 8], "k8s_auth_persist_config": [6, 7, 8], "k8s_auth_proxi": [6, 7, 8], "k8s_auth_proxy_headers_basic_auth": [6, 7, 8], "k8s_auth_proxy_headers_proxy_basic_auth": [6, 7, 8], "k8s_auth_proxy_headers_user_ag": [6, 7, 8], "k8s_auth_ssl_ca_cert": [6, 7, 8], "k8s_auth_usernam": [6, 7, 8], "k8s_auth_verify_ssl": [6, 7, 8], "keep": [0, 3], "kei": [0, 6, 7, 8], "key_fil": [6, 7, 8], "keyed_group": 6, "kind": [2, 8, 11], "kindexgw": 7, "know": 2, "kube": [6, 7, 8], "kube_secondary_dn": 6, "kubeconfig": [6, 7, 8], "kubectl": 11, "kubernet": [0, 2, 6, 7, 8], "kubesecondarydn": 6, "kubevirt": [1, 5, 11], "kubevirt_vm": [0, 2, 4, 5], "kubevirt_vm_info": [0, 2, 4, 5], "label": [6, 7, 8, 9], "label_selector": [6, 8], "latest": [6, 7, 8], "lead": 6, "leading_separ": 6, "lean": 4, "learn": 2, "less": [6, 7, 8], "let": 2, "level": 6, "librari": [6, 7, 8], "licens": 4, "like": [2, 3, 6, 7, 8, 11], "limit": 9, "line": 2, "link": 0, "list": [0, 2, 3, 6, 7, 8], "load": [6, 7, 8], "local": [6, 7, 8, 11], "localhost": [6, 7, 8], "locat": 11, "long": [7, 8], "low": 6, "lower": 6, "lowercas": 3, "machin": [2, 3, 6, 11], "made": [2, 9], "mai": [7, 9], "main": [2, 7], "maintain": [2, 9], "mainten": 4, "major": 9, "make": [0, 2, 3, 6, 9, 11], "make_head": [6, 7, 8], "mani": 0, "manner": 9, "map": [6, 8], "markup": 0, "masquerad": 7, "matcher": 7, "matrix": [2, 9], "md": 2, "medium": 7, "memori": 6, "mention": 2, "merg": 6, "met": 7, "meta": 3, "metadata": [7, 8, 9], "method": 7, "might": [6, 7, 8], "min": 11, "mind": 2, "minor": 9, "mkdir": 11, "mode": [0, 7, 8], "modifi": [4, 8], "modul": [0, 6, 7, 8, 9], "more": [0, 2, 3, 6], "mostli": 0, "mount": 11, "move": 6, "multipl": [0, 6, 7, 8, 11], "multu": 7, "must": [6, 7, 8], "mutual": [6, 7], "my": 3, "my_path": 3, "my_playbook": 3, "my_rol": 3, "name": [3, 6, 7, 8, 9], "namespac": [6, 7, 8], "namespace_vmis_group": 0, "necessari": 11, "need": [2, 3, 6, 7, 8, 9, 11], "network": [6, 7], "network_nam": 6, "networknam": 7, "new": [2, 4, 6, 7, 8], "newli": 9, "next": [6, 7, 8, 9], "no_proxi": [6, 7, 8], "node": 6, "nodeport": 6, "nor": 9, "note": [5, 9], "noth": 3, "number": [7, 8, 9], "object": [7, 8], "oidc": [6, 7, 8], "old": [6, 7, 8], "omit": 6, "one": 6, "onli": [0, 6, 7, 9], "oper": [2, 6, 7, 8], "option": [0, 6, 7, 8], "order": [6, 11], "org": 9, "orphan": 7, "other": [3, 6, 7, 8], "otherwis": 6, "our": 2, "out": 11, "outcom": 9, "output": 11, "over": [0, 3], "overrid": [3, 6], "overridden": 3, "owner": 2, "p": [3, 11], "page": 9, "paramet": [0, 5, 9], "parent": 6, "parent_group": 6, "part": [6, 7, 8], "particip": 2, "pass": [0, 7, 8], "password": [6, 7, 8], "patch": [7, 9], "path": [3, 6, 7, 8, 11], "payload": 9, "peopl": 2, "perform": [7, 8], "persist_config": [6, 7, 8], "pick": [2, 6, 7, 8], "pip": [2, 3, 11], "plai": [3, 11], "plain": 11, "platform": [3, 6, 7, 8], "playbook": [3, 4, 6, 7, 8, 9], "pleas": [6, 7, 8, 9], "plugin": [4, 6, 11], "pod": 7, "podman": 11, "polici": [4, 7], "port": 6, "possibl": [3, 6], "post_task": 3, "pre": 9, "pre_task": 3, "preced": 6, "precondit": 7, "prefer": 7, "prefix": 6, "present": 7, "previou": 9, "primari": 6, "prior": 9, "prioriti": [0, 6], "proce": 7, "process": [0, 2], "produc": 11, "project": [6, 7, 8, 11], "project_dir": 11, "propagationpolici": 7, "proper": 0, "propos": 2, "provid": [0, 2, 6, 7, 8, 11], "proxi": [6, 7, 8], "proxy_basic_auth": [6, 7, 8], "proxy_head": [6, 7, 8], "publish": 9, "purpos": [3, 11], "python": [3, 4, 6, 7, 8, 11], "pyyaml": [2, 6, 7, 8], "quai": 7, "question": 2, "r": [2, 11], "random": 7, "read": [6, 7, 8], "readi": [7, 8, 9], "readm": 9, "readthedoc": [6, 7, 8], "readwriteonc": 7, "recommend": 11, "redund": 0, "refer": [1, 2, 6, 7, 8], "refresh": [6, 7, 8], "regist": 8, "registri": 7, "releas": 4, "reli": 11, "remov": [4, 6, 11], "replac": 7, "report": 11, "repositori": [2, 11], "repres": [6, 7, 8], "represent": 8, "reproduc": 11, "request": 7, "requir": [2, 3, 5, 9, 11], "resourc": [7, 8], "resourcevers": 7, "rest": 8, "result": [3, 7, 8], "retrigg": 0, "return": [0, 5, 6, 9], "review_checklist": 2, "revis": 9, "rework": 0, "robust": 0, "role": [3, 4], "rsa": 0, "run": [0, 3, 6, 7, 8], "same": 3, "sampl": [7, 11], "saniti": 4, "save": [6, 7, 8], "scenario": 9, "schema": 8, "script": 11, "search": 8, "second": [6, 7, 8], "secondari": [0, 6], "section": [9, 11], "secur": 4, "see": [2, 6, 7, 8, 9], "select": [3, 6], "selector": [6, 8], "self": 3, "semant": 9, "semver": 9, "separ": [3, 6, 7, 8], "server": [6, 7, 8], "servic": [0, 6], "set": [0, 6, 7, 8], "setup": [6, 11], "sever": 0, "sh": 11, "shall": 9, "shape": 9, "shift": 3, "ship": 0, "should": [3, 6, 7, 8, 9], "shouldn": [6, 7, 8], "shown": 11, "sinc": 6, "skip": 6, "slash": 3, "sleep": [7, 8], "smaller": 9, "so": [6, 7, 8, 11], "softwar": [0, 2], "some": 0, "someth": 2, "sourc": [2, 4, 5, 7, 11], "space": 3, "spec": [7, 8], "specif": [3, 6, 8], "specifi": [6, 7, 8], "split": 6, "ssh": [0, 6, 7], "ssh_authorized_kei": 7, "ssl": [6, 7, 8], "ssl_ca_cert": [6, 7, 8], "standard": 8, "start": [2, 3, 6], "state": [7, 8, 9], "statu": 8, "step": 11, "still": 6, "stop": [0, 8], "storag": 7, "strategi": 4, "strict": [6, 9], "string": [6, 7, 8], "structur": 9, "subset": 6, "success": [7, 8], "successfulli": 8, "sudo": 11, "suit": 11, "support": [0, 2, 7, 8, 9, 11], "symlink": 3, "sync": 0, "synopsi": 5, "t": [2, 3, 6, 7, 8], "tabl": 6, "tag": [2, 9], "tar": 2, "tarbal": 0, "target": [7, 8], "task": [3, 7], "tell": [6, 7, 8], "templat": 7, "termin": 11, "test": [0, 2, 3, 4, 6, 7, 8, 9], "testdv": 7, "testvm": [7, 8], "text": [2, 11], "than": [3, 6, 7, 8], "thei": [6, 11], "them": 2, "therefor": 9, "thi": [0, 4, 6, 7, 8, 9, 11], "those": [3, 6, 7], "through": [2, 6, 7, 8], "time": [7, 9], "toggl": 6, "token": [6, 7, 8], "tool": 2, "top": 6, "tox": 3, "trail": 3, "trailing_separ": 6, "trigger": 9, "true": [6, 7, 8], "two": 11, "txt": [2, 11], "type": [0, 6, 7], "typic": [6, 7, 8], "typograph": 4, "u1": 7, "uid": [6, 7], "under": 3, "underscor": [3, 6], "uniqu": [7, 8], "unit": [0, 4], "until": 8, "up": [6, 7, 8, 11], "updat": [0, 9], "url": [6, 7, 8], "urllib3": [6, 7, 8], "us": [0, 3, 4, 6, 7, 8, 11], "use_extra_var": 6, "use_servic": 6, "user": [3, 6, 7, 8, 9], "user_ag": [6, 7, 8], "userdata": 7, "usernam": [6, 7, 8], "util": [6, 7, 8], "v": 3, "v1": [4, 6, 7, 8], "valid": [3, 6, 7, 8], "validate_cert": [6, 7, 8], "valu": [5, 6], "var": [3, 6], "vari": [7, 8], "variabl": [3, 6, 7, 8], "vendor": 0, "venv": 3, "veri": 2, "verif": 11, "verifi": [0, 6, 7, 8], "verify_ssl": [6, 7, 8], "version": [0, 4, 6, 7, 8], "via": [6, 7, 8], "virtual": [2, 6, 11], "virtualenv": 4, "virtualmachin": [0, 2, 4, 5], "virtualmachineinst": [4, 5], "vm": 0, "vm_list": 8, "voic": 2, "volum": 7, "vscode": 3, "wa": [4, 6, 7], "wai": 11, "wait": [7, 8], "wait_condit": 0, "wait_sleep": [7, 8], "wait_timeout": [7, 8], "want": [2, 6, 7, 8], "we": [2, 6, 9], "welcom": 2, "were": 8, "when": [3, 6, 7, 8, 9], "where": 3, "whether": [6, 7, 8], "which": [2, 3, 6, 11], "while": 9, "window": [0, 6, 7, 8], "winrm": 0, "within": 4, "work": [6, 11], "world": 2, "would": [3, 9], "x27": [6, 7, 8], "xml": 11, "xxxxxxxxxxxxxxxx": 6, "yaml": [0, 3, 6], "ye": [6, 7, 8], "yml": [0, 2, 3, 6, 11], "you": [2, 3, 6, 7, 8, 11], "your": [2, 3, 6, 11]}, "titles": ["KubeVirt Collection for Ansible Release Notes", "Contributing", "Lean Ansible bindings for KubeVirt", "Contributor\u2019s Guidelines", "Welcome to kubevirt.core Collection documentation", "Plugin Index", "kubevirt \u2013 Inventory source for KubeVirt VirtualMachines and VirtualMachineInstances", "kubevirt_vm \u2013 Create or delete KubeVirt VirtualMachines", "kubevirt_vm_info \u2013 Describe KubeVirt VirtualMachines", "Collection Versioning Strategy", "Role Index", "Testing"], "titleterms": {"": 3, "0": 0, "1": 0, "2": 0, "3": 0, "4": 0, "5": 0, "A": 9, "ad": 9, "an": 9, "analysi": 11, "ani": 9, "ansibl": [0, 2, 11], "author": [6, 7, 8], "autom": 9, "backward": 9, "bind": 2, "break": [0, 9], "bug": 9, "bugfix": 0, "build": 2, "chang": [0, 9], "code": 2, "collect": [0, 2, 4, 9], "compat": [2, 9], "conduct": 2, "config": 11, "content": [2, 9], "continu": 11, "contribut": [1, 2], "contributor": 3, "core": 4, "coverag": 11, "creat": 7, "delet": 7, "depend": 2, "describ": 8, "develop": [3, 4], "document": [4, 9], "environ": 3, "error": 9, "exampl": [6, 7, 8, 11], "exist": 9, "featur": 9, "fix": 9, "from": [2, 9], "galaxi": 2, "gener": 4, "govern": 2, "guid": 0, "guidelin": 3, "i": 9, "includ": 2, "index": [5, 10], "instal": 2, "integr": 11, "inventori": [5, 6], "kubevirt": [0, 2, 4, 6, 7, 8], "kubevirt_vm": 7, "kubevirt_vm_info": 8, "lean": 2, "librari": 2, "licens": 2, "local": 2, "mainten": 2, "major": 0, "minor": 0, "modifi": 9, "modul": 5, "new": 9, "note": [0, 6, 7, 8], "paramet": [6, 7, 8], "playbook": 11, "plugin": [2, 5, 9], "polici": 2, "port": 0, "python": 2, "releas": [0, 2, 9], "remov": 9, "requir": [6, 7, 8], "return": [7, 8], "role": [9, 10], "run": 11, "saniti": 11, "secur": 9, "sourc": 6, "strategi": 9, "summari": 0, "synopsi": [6, 7, 8], "test": 11, "thi": 2, "topic": 0, "tox": 11, "typograph": 9, "unit": 11, "us": 2, "user": 4, "v1": 0, "valu": [7, 8], "version": [2, 9], "virtualenv": 3, "virtualmachin": [6, 7, 8], "virtualmachineinst": 6, "wa": 9, "welcom": 4, "within": 9}}) \ No newline at end of file