KubeVirt Collection for Ansible Release Notes
+KubeVirt Collection for Ansible Release Notes
This changelog describes changes after version 1.0.0.
v1.3.0
-Release Summary
-Internal release, documentation or test changes only.
-v1.3.0
Minor Changes
+Minor Changes
Bugfixes
+Bugfixes
v1.2.3
-Release Summary
+v1.2.3
+Release Summary
No functional changes, hotfix release to retrigger the downstream build and to keep in sync with Ansible Automation Hub.
v1.2.2
-Release Summary
+v1.2.2
+Release Summary
No functional changes, only cleanup of files included in the release tarball and vendoring of documentation fragments.
v1.2.1
-Release Summary
+v1.2.1
+Release Summary
Mostly code cleanups and dependency updates to ensure compatibility with KubeVirt >= 1.1.0
v1.2.0
-Release Summary
+v1.2.0
+Release Summary
Not released due to issues in the release process
v1.1.0
-Minor Changes
+v1.1.0
+Minor Changes
Add kubevirt_vm_info module to describe existing VirtualMachines
inventory: Allow to control creation of additional groups
@@ -229,9 +224,9 @@
v1.0.0
-Release Summary
+v1.0.0
+Release Summary
Initial release
General
diff --git a/main/README.html b/main/README.html index 56e226f..b4c7e7e 100644 --- a/main/README.html +++ b/main/README.html @@ -18,7 +18,7 @@ - + @@ -79,6 +79,7 @@General
diff --git a/main/_sources/CHANGELOG.rst.txt b/main/_sources/CHANGELOG.rst.txt index 29af724..8b56c4b 100644 --- a/main/_sources/CHANGELOG.rst.txt +++ b/main/_sources/CHANGELOG.rst.txt @@ -9,11 +9,6 @@ This changelog describes changes after version 1.0.0. v1.3.0 ====== -Release Summary ---------------- - -Internal release, documentation or test changes only. - Minor Changes ------------- diff --git a/main/_sources/developing.md.txt b/main/_sources/developing.md.txt index ca04283..0434ed6 100644 --- a/main/_sources/developing.md.txt +++ b/main/_sources/developing.md.txt @@ -11,3 +11,24 @@ - `vars/` vs `defaults/` - internal or interpolated variables that don't need to change or be overridden by user go in `vars/`, those that a user would likely override, go under `defaults/` directory - All arguments have a specification in `meta/argument_specs.yml` - All playbooks/roles should be focused on compatibility with Ansible Automation Platform + +## Development environment + +To develop and to run tests you need to install `tox` and `tox-ansible` on +your machine. + +``` +pip install --user tox tox-ansible +``` + +### Virtualenv for development + +To build a virtualenv for development purposes run the following command: + +``` +make build-venv +``` + +The resulting virtualenv will be symlinked to `.venv`, which for example can +be selected as virtualenv in VSCode (`Shift+Ctrl+P` and then +`Python: Select Interpreter`). diff --git a/main/_sources/testing.md.txt b/main/_sources/testing.md.txt index 6ed0b3d..c71a1b6 100644 --- a/main/_sources/testing.md.txt +++ b/main/_sources/testing.md.txt @@ -1,9 +1,88 @@ # Testing -## Continuous integration +## Sanity and unit tests -The `hack/e2e-setup.sh` script contains the steps necessary to reproduce the CI test environment, which relies on `kubectl` and `kind`. +Sanity and unit tests can be run in two ways: +- with `tox` and the `tox-ansible` plugin (both need to be installed on the dev machine) +- with `ansible-test` + +For development purposes `tox` and `tox-ansible` are better suited, as they allow +debugging of issues in the collection on the developer's machine. + +For verification purposes of the collection the compatibility with `ansible-test` +is ensured. + +### Running tests with tox-ansible + +Run sanity tests with `tox-ansible` like so: + +``` +make test-sanity +``` + +Run unit tests with `tox-ansible` like so: + +``` +make test-unit +``` + +### Running tests with ansible-test + +In order to test changes with `ansible-test`, it is recommended to bind mount +the repository to `~/.ansible/collections/ansible_collections/kubevirt/core` +if you did not check it out into this location. + +This can be done with: + +``` +mkdir -p ~/.ansible/collections/ansible_collections/kubevirt/core +sudo mount --bindGeneral
@@ -102,6 +106,24 @@All arguments have a specification in meta/argument_specs.yml
All playbooks/roles should be focused on compatibility with Ansible Automation Platform
Development environment
+To develop and to run tests you need to install tox and tox-ansible on
+your machine.
pip install --user tox tox-ansible
+Virtualenv for development
+To build a virtualenv for development purposes run the following command:
+make build-venv
+The resulting virtualenv will be symlinked to .venv, which for example can
+be selected as virtualenv in VSCode (Shift+Ctrl+P and then
+Python: Select Interpreter).
General
diff --git a/main/index.html b/main/index.html index d5691dc..e8fdeaf 100644 --- a/main/index.html +++ b/main/index.html @@ -18,7 +18,7 @@ - + @@ -55,6 +55,7 @@General
@@ -118,11 +119,16 @@Developer documentation
- Testing
- Contributor’s Guidelines +
- Development environment +
- Collection Versioning Strategy
- New content is added to an existing collection
- New feature to existing plugin or role within a collection (backwards compatible) diff --git a/main/plugins/index.html b/main/plugins/index.html index 526c428..6d5efec 100644 --- a/main/plugins/index.html +++ b/main/plugins/index.html @@ -18,7 +18,7 @@ - + @@ -61,6 +61,7 @@
- Testing
- Contributor’s Guidelines +
- Development environment
- Collection Versioning Strategy
- New content is added to an existing collection
- New feature to existing plugin or role within a collection (backwards compatible) diff --git a/main/roles/index.html b/main/roles/index.html index 3ad418a..b671133 100644 --- a/main/roles/index.html +++ b/main/roles/index.html @@ -18,7 +18,7 @@ - + @@ -58,6 +58,7 @@
with
toxand thetox-ansibleplugin (both need to be installed on the dev machine)
+with
ansible-test
+
General
diff --git a/main/search.html b/main/search.html index 5f50557..1f5438e 100644 --- a/main/search.html +++ b/main/search.html @@ -18,7 +18,7 @@ - + @@ -56,6 +56,7 @@General
diff --git a/main/searchindex.js b/main/searchindex.js index 42c2f70..d2e27b9 100644 --- a/main/searchindex.js +++ b/main/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["CHANGELOG", "CONTRIBUTING", "README", "developing", "index", "plugins/index", "plugins/kubevirt", "plugins/kubevirt_vm", "plugins/kubevirt_vm_info", "releasing", "roles/index", "testing"], "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"], "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", "kubevirt_vm \u2013 Create or delete KubeVirt VirtualMachines", "kubevirt_vm_info \u2013 Describe KubeVirt VirtualMachines", "Collection Versioning Strategy", "Role Index", "Testing"], "terms": {"thi": [0, 4, 6, 7, 8, 9], "changelog": [0, 4], "describ": [0, 2, 4, 5], "after": [0, 6, 9], "version": [0, 4, 6, 7, 8], "intern": [0, 3], "document": [0, 6, 7, 8], "test": [0, 2, 4, 6, 7, 8, 9], "onli": [0, 6, 7, 8, 9], "feat": 0, "add": [0, 6], "append_base_domain": [0, 6], "option": [0, 6, 7, 8], "connect": [0, 6, 7, 8, 9], "72": 0, "give": 0, "secondari": [0, 6], "interfac": [0, 6, 7], "higher": [0, 6], "prioriti": [0, 6], "over": [0, 3], "servic": [0, 6], "76": 0, "set": [0, 6, 7, 8], "ansible_connect": 0, "winrm": 0, "window": [0, 7, 8], "host": [0, 2, 6, 7, 8], "75": 0, "fix": [0, 4, 7, 8], "explic": 0, "ansible_port": 0, "70": 0, "return": [0, 5, 6, 9], "earli": 0, "avoid": [0, 3, 7, 8], "ad": [0, 4, 6, 7, 8], "empti": [0, 6, 7], "group": [0, 6, 7, 8], "73": 0, "No": 0, "function": [0, 9], "hotfix": 0, "retrigg": 0, "downstream": 0, "build": [0, 6, 9, 11], "keep": [0, 3], "sync": 0, "autom": [0, 2, 3, 4], "hub": [0, 9], "cleanup": [0, 11], "file": [0, 2, 3, 6, 7, 8], "includ": [0, 3, 4, 6, 7, 8, 9], "tarbal": 0, "vendor": 0, "fragment": 0, "mostli": 0, "code": [0, 4], "depend": [0, 7, 11], "updat": [0, 9], "ensur": [0, 6], "compat": [0, 3, 4], "Not": 0, "due": 0, "issu": [0, 2], "process": [0, 2], "kubevirt_vm_info": [0, 2, 4, 5], "modul": [0, 7, 8, 9], "exist": [0, 4, 6, 7, 8], "virtualmachin": [0, 2, 4, 5], "inventori": [0, 2, 4, 9, 11], "allow": [0, 9], "control": [0, 6, 7], "creation": [0, 6], "addit": [0, 9], "drop": 0, "namespace_vmis_group": 0, "i": [0, 2, 4, 6, 7, 8, 11], "redund": 0, "initi": 0, "refer": [1, 2, 7, 8], "kubevirt": [1, 5, 11], "guidelin": [1, 2, 4], "repositori": [2, 11], "core": [2, 6, 7, 8, 11], "which": [2, 6, 11], "provid": [2, 6, 7, 8, 11], "virtual": [2, 11], "machin": [2, 11], "oper": [2, 7, 8], "an": [2, 4, 6, 7, 8], "sourc": [2, 4, 5, 7, 11], "ha": [2, 7, 8], "been": 2, "against": 2, "2": [2, 3, 4, 6, 7, 8, 9], "14": 2, "16": [2, 7, 8], "3": [2, 4, 6, 7, 8], "9": [2, 6, 7, 8], "12": [2, 6, 7, 8], "see": [2, 6, 7, 8, 9], "support": [2, 7, 8, 9], "matrix": [2, 9], "combin": 2, "kubevirt_vm": [2, 4, 5], "creat": [2, 4, 5, 6, 9, 11], "delet": [2, 4, 5, 9, 11], "befor": [2, 7], "you": [2, 6, 7, 8], "need": [2, 3, 6, 7, 8, 9], "command": 2, "line": 2, "tool": 2, "clone": [2, 11], "checkout": 2, "tag": [2, 9], "want": [2, 7, 8], "pick": [2, 7, 8], "main": [2, 7], "branch": 2, "develop": [2, 6, 9], "tar": 2, "gz": 2, "kubernet": [2, 6, 7, 8], "0": [2, 4, 6, 7, 8, 9], "1": [2, 4, 6, 7, 8, 9], "To": [2, 6, 7, 8], "all": [2, 3, 6, 8, 9], "r": [2, 11], "requir": [2, 3, 5, 9, 11], "yml": [2, 3, 6, 11], "jinja2": [2, 6, 7], "jsonpatch": [2, 7], "28": [2, 6, 7, 8], "pyyaml": [2, 6, 7, 8], "11": [2, 6, 7, 8], "pip": [2, 11], "txt": [2, 11], "more": [2, 3, 6], "detail": [2, 6, 7, 8], "we": [2, 6, 9], "follow": [2, 3, 7, 8, 9, 11], "The": [2, 6, 7, 8, 9, 11], "made": [2, 9], "peopl": 2, "like": [2, 3, 7, 8], "commun": [2, 7, 8], "individu": 2, "collabor": 2, "make": [2, 6, 9], "world": 2, "better": 2, "through": [2, 7, 8], "softwar": 2, "ar": [2, 3, 6, 7, 8, 9, 11], "activ": [2, 6], "accept": 2, "new": [2, 4, 7, 8], "contributor": [2, 4], "ani": [2, 4, 7, 8], "kind": [2, 8, 11], "veri": 2, "welcom": 2, "don": [2, 3], "t": [2, 3, 7, 8], "know": 2, "how": [2, 7, 8, 9], "start": [2, 3, 6], "our": 2, "guid": 2, "md": 2, "review_checklist": 2, "current": [2, 7, 8, 9], "maintain": [2, 9], "list": [2, 3, 6, 7, 8], "owner": 2, "If": [2, 6, 7, 8], "have": [2, 3, 6], "question": 2, "help": 2, "feel": 2, "free": 2, "mention": 2, "them": 2, "propos": 2, "learn": 2, "becom": 2, "can": [2, 6, 7, 8], "found": [2, 6, 7, 8], "doc": 2, "decis": 2, "base": [2, 6, 7, 8], "discuss": [2, 7, 8], "find": [2, 8], "consensu": 2, "among": 2, "particip": 2, "everi": 2, "voic": 2, "import": 2, "someth": 2, "your": [2, 7, 8], "mind": 2, "dedic": [2, 9], "let": 2, "": [2, 4, 6, 7, 8], "gnu": 2, "gener": [2, 6, 7, 9], "public": 2, "v3": 2, "later": 2, "full": [2, 7, 8], "text": 2, "yaml": [3, 6], "name": [3, 6, 7, 8, 9], "extens": [3, 9], "us": [3, 4, 6, 7, 8], "space": 3, "around": 3, "jinja": 3, "variabl": [3, 6, 7, 8], "var": [3, 6], "role": [3, 4], "should": [3, 6, 7, 8, 9], "lowercas": 3, "self": 3, "contain": [3, 9, 11], "task": [3, 7], "from": [3, 4, 6, 7, 8], "other": [3, 6, 7, 8], "when": [3, 6, 7, 8, 9], "possibl": [3, 6], "plai": [3, 11], "do": [3, 7, 8], "noth": 3, "than": [3, 7, 8], "except": 3, "where": 3, "pre_task": 3, "post_task": 3, "separ": [3, 6, 7, 8], "valid": [3, 7, 8], "ie": 3, "underscor": [3, 6], "e": [3, 7, 8], "g": [3, 7, 8], "my_rol": 3, "my_playbook": 3, "dash": 3, "my": 3, "path": [3, 6, 7, 8], "defin": [3, 6], "trail": 3, "slash": 3, "my_path": 3, "foo": [3, 7, 8], "concaten": [3, 6], "same": 3, "convent": 3, "bar": 3, "indent": 3, "each": [3, 6, 9], "v": 3, "default": [3, 6, 7, 8, 9], "interpol": 3, "chang": [3, 4, 7], "overridden": 3, "user": [3, 6, 7, 8, 9], "go": [3, 7, 8], "those": [3, 6, 7], "would": [3, 9], "overrid": [3, 6], "under": 3, "directori": [3, 11], "argument": [3, 7, 8], "specif": [3, 6, 8], "meta": 3, "argument_spec": 3, "playbook": [3, 4, 6, 7, 8, 9], "focus": 3, "ansibl": [3, 4, 6, 7, 8, 9, 11], "platform": [3, 7, 8], "lean": 4, "bind": 4, "python": [4, 6, 7, 8, 11], "content": 4, "conduct": 4, "contribut": 4, "mainten": 4, "releas": 4, "polici": [4, 7], "govern": 4, "licens": 4, "plugin": [4, 6], "index": 4, "continu": [4, 6], "integr": 4, "exampl": [4, 5, 9], "config": [4, 6, 7, 8], "strategi": 4, "featur": [4, 7, 8], "within": 4, "backward": 4, "bug": 4, "secur": 4, "break": 4, "remov": 4, "A": [4, 6], "typograph": 4, "error": [4, 6, 7, 8], "wa": [4, 6, 7], "modifi": 4, "v1": [4, 6, 7, 8], "synopsi": 5, "paramet": [5, 9], "author": 5, "note": [5, 9], "valu": [5, 6], "part": [6, 7, 8], "collect": [6, 7, 8, 11], "It": [6, 7, 8], "check": [6, 7, 8], "whether": [6, 7, 8], "instal": [6, 7, 8, 11], "run": [6, 7, 8, 11], "galaxi": [6, 7, 8, 9, 11], "further": [6, 7, 8], "abl": [6, 7, 8], "specifi": [6, 7, 8], "fetch": 6, "virtualmachineinst": 6, "one": 6, "namespac": [6, 7, 8], "label": [6, 7, 8, 9], "selector": [6, 8], "namespace_vmi": 6, "kubectl": [6, 11], "access": [6, 7, 8], "cluster": [6, 7, 8], "configur": [6, 7, 8, 11], "below": [6, 7, 8, 9], "local": [6, 7, 8, 11], "node": 6, "execut": [6, 7, 8], "comment": [6, 7, 8], "cach": 6, "boolean": [6, 7, 8], "toggl": 6, "enabl": 6, "disabl": 6, "x27": [6, 7, 8], "data": 6, "setup": [6, 11], "work": [6, 7, 8], "choic": [6, 7, 8], "fals": [6, 7, 8], "true": [6, 7, 8], "ini": 6, "entri": [6, 9], "environ": [6, 7, 8, 11], "ansible_inventory_cach": 6, "cache_connect": 6, "string": [6, 7, 8], "read": [6, 7, 8], "fact_caching_connect": 6, "ansible_cache_plugin_connect": 6, "ansible_inventory_cache_connect": 6, "cache_plugin": 6, "34": [6, 7, 8], "memori": 6, "fact_cach": 6, "ansible_cache_plugin": 6, "ansible_inventory_cache_plugin": 6, "cache_prefix": 6, "prefix": 6, "tabl": 6, "ansible_inventory_": 6, "fact_caching_prefix": 6, "ansible_cache_plugin_prefix": 6, "ansible_inventory_cache_plugin_prefix": 6, "cache_timeout": 6, "integ": [6, 7, 8], "durat": [6, 7], "second": [6, 7, 8], "3600": 6, "fact_caching_timeout": 6, "ansible_cache_plugin_timeout": 6, "ansible_inventory_cache_timeout": 6, "compos": 6, "dictionari": [6, 7, 8], "express": 6, "kube": [6, 7, 8], "context": [6, 7, 8], "object": [6, 7, 8], "api_kei": [6, 7, 8], "token": [6, 7, 8], "authent": [6, 7, 8], "api": [6, 7, 8, 9], "also": [6, 7, 8], "via": [6, 7, 8], "k8s_auth_api_kei": [6, 7, 8], "api_vers": [6, 7, 8], "io": [6, 7, 8], "append": 6, "domain": [6, 7, 8], "construct": 6, "ssh": [6, 7], "type": [6, 7], "nodeport": 6, "base_domain": 6, "case": [6, 7], "kubesecondarydn": 6, "ca_cert": [6, 7, 8], "alias": [6, 7, 8], "ssl_ca_cert": [6, 7, 8], "ca": [6, 7, 8], "certif": [6, 7, 8], "k8s_auth_ssl_ca_cert": [6, 7, 8], "client_cert": [6, 7, 8], "cert_fil": [6, 7, 8], "k8s_auth_cert_fil": [6, 7, 8], "client_kei": [6, 7, 8], "key_fil": [6, 7, 8], "kei": [6, 7, 8], "k8s_auth_key_fil": [6, 7, 8], "k8s_auth_context": [6, 7, 8], "create_group": 6, "url": [6, 7, 8], "k8s_auth_host": [6, 7, 8], "kube_secondary_dn": 6, "deriv": 6, "network": [6, 7], "kubeconfig": [6, 7, 8], "client": [6, 7, 8], "attempt": [6, 7, 8], "load": [6, 7, 8], "k8s_auth_kubeconfig": [6, 7, 8], "label_selector": [6, 8], "select": 6, "subset": 6, "assign": 6, "server": [6, 7, 8], "port": 6, "network_nam": 6, "interface_nam": 6, "In": 6, "multipl": [6, 7, 8], "attach": 6, "primari": 6, "ip": [6, 7, 8], "address": 6, "password": [6, 7, 8], "k8s_auth_password": [6, 7, 8], "use_servic": 6, "establish": 6, "usernam": [6, 7, 8], "k8s_auth_usernam": [6, 7, 8], "validate_cert": [6, 7, 8], "verify_ssl": [6, 7, 8], "verifi": [6, 7, 8], "ssl": [6, 7, 8], "k8s_auth_verify_ssl": [6, 7, 8], "condit": [6, 7], "host_format": 6, "format": [6, 9], "avail": [6, 9], "uid": [6, 7], "keyed_group": 6, "element": [6, 7, 8], "default_valu": 6, "mutual": [6, 7], "exclus": [6, 7], "trailing_separ": 6, "input": 6, "parent_group": 6, "parent": 6, "_": 6, "omit": 6, "leading_separ": 6, "conjunct": 6, "By": [6, 9], "doe": [6, 7, 8, 9], "becaus": 6, "lead": 6, "given": [6, 9], "map": [6, 8], "still": 6, "item": 6, "instead": 6, "strict": [6, 9], "ye": [6, 7], "invalid": 6, "fatal": 6, "otherwis": 6, "skip": 6, "sinc": 6, "fact": 6, "thei": 6, "might": [6, 7, 8], "alwai": [6, 8], "ignor": [6, 7, 8], "use_extra_var": 6, "merg": 6, "extra": 6, "composit": 6, "highest": 6, "preced": 6, "inventory_plugin": 6, "ansible_inventory_use_extra_var": 6, "filenam": 6, "must": [6, 7, 8], "end": [6, 7, 8], "http": [6, 7, 8, 9, 11], "192": [6, 7, 8], "168": [6, 7, 8], "64": 6, "4": 6, "8443": 6, "xxxxxxxxxxxxxxxx": 6, "bridg": [6, 7], "app": [6, 7, 8], "custom": 6, "awx": 6, "project": [6, 7, 8], "low": 6, "high": 6, "order": 6, "For": 6, "lower": 6, "up": [6, 7, 8], "perform": [7, 8], "pass": [7, 8], "either": [7, 8, 9], "mode": [7, 8], "annot": [7, 8, 9], "state": [7, 8, 9], "present": 7, "chain": [7, 8], "data_volume_templ": 7, "datavolum": 7, "templat": 7, "definit": 7, "html": [7, 8], "_v1_datavolumetemplatespec": 7, "delete_opt": 7, "behavior": 7, "absent": 7, "graceperiodsecond": 7, "mani": 7, "wait": [7, 8], "forcefulli": 7, "termin": [7, 11], "implement": 7, "pod": 7, "resourc": [7, 8], "grace": 7, "period": 7, "precondit": 7, "met": 7, "proce": 7, "resourcevers": 7, "target": [7, 8], "propagationpolici": 7, "mai": [7, 9], "vari": [7, 8], "across": 7, "foreground": 7, "background": 7, "orphan": 7, "forc": 7, "replac": 7, "generate_nam": 7, "basi": 7, "random": 7, "charact": 7, "automat": 7, "uniqu": [7, 8], "impersonate_group": [7, 8], "imperson": [7, 8], "k8s_auth_impersonate_group": [7, 8], "group1": [7, 8], "group2": [7, 8], "impersonate_us": [7, 8], "k8s_auth_impersonate_us": [7, 8], "instancetyp": 7, "matcher": 7, "gt": [7, 8], "17": [7, 8], "no_proxi": [7, 8], "comma": [7, 8], "cidr": [7, 8], "shouldn": [7, 8], "proxi": [7, 8], "k8s_auth_no_proxi": [7, 8], "pleas": [7, 8, 9], "typic": [7, 8], "19": [7, 8], "15": [7, 8], "librari": [7, 8], "less": [7, 8], "fail": [7, 8], "even": [7, 8], "correct": [7, 8, 9], "localhost": [7, 8], "com": [7, 8, 11], "127": [7, 8], "8": [7, 8], "10": [7, 8], "172": [7, 8], "descript": [7, 8], "applic": [7, 8], "persist_config": [7, 8], "save": [7, 8], "refresh": [7, 8], "k8s_auth_persist_config": [7, 8], "k8": [7, 8], "credenti": [7, 8], "oidc": [7, 8], "gke": [7, 8], "gcloud": [7, 8], "auth": [7, 8], "so": [7, 8], "old": [7, 8], "expir": [7, 8], "next": [7, 8, 9], "flag": [7, 8], "tell": [7, 8], "yet": [7, 8], "here": [7, 8], "github": [7, 8, 9, 11], "pull": [7, 8], "169": [7, 8], "prefer": 7, "k8s_auth_proxi": [7, 8], "http_proxi": [7, 8], "proxy_head": [7, 8], "header": [7, 8], "urllib3": [7, 8], "readthedoc": [7, 8], "en": [7, 8], "latest": [7, 8], "util": [7, 8], "highlight": [7, 8], "make_head": [7, 8], "basic_auth": [7, 8], "colon": [7, 8], "basic": [7, 8], "k8s_auth_proxy_headers_basic_auth": [7, 8], "proxy_basic_auth": [7, 8], "k8s_auth_proxy_headers_proxy_basic_auth": [7, 8], "user_ag": [7, 8], "repres": [7, 8], "agent": [7, 8], "k8s_auth_proxy_headers_user_ag": [7, 8], "spec": [7, 8], "_v1_virtualmachineinstancespec": 7, "determin": 7, "patch": [7, 9], "alreadi": 7, "its": 7, "attribut": [7, 8], "differ": [7, 8], "resource_definit": 7, "src": 7, "form": [7, 8], "oauth2": [7, 8], "openshift": [7, 8], "expect": [7, 8], "look": [7, 8], "okd": [7, 8], "k8s_auth": [7, 8], "what": [7, 8], "readi": [7, 8, 9], "wait_sleep": [7, 8], "number": [7, 8, 9], "sleep": [7, 8], "between": [7, 8], "5": [7, 8], "wait_timeout": [7, 8], "long": [7, 8], "desir": [7, 8], "120": [7, 8], "testvm": [7, 8], "u1": 7, "medium": 7, "fedora": 7, "devic": 7, "masquerad": 7, "multu": 7, "networknam": 7, "kindexgw": 7, "volum": 7, "containerdisk": 7, "imag": 7, "quai": 7, "cloudinitnocloud": 7, "userdata": 7, "cloud": 7, "ssh_authorized_kei": 7, "ed25519": 7, "aaaa": 7, "cloudinit": 7, "dv": 7, "metadata": [7, 8, 9], "testdv": 7, "registri": 7, "docker": 7, "storag": 7, "accessmod": 7, "readwriteonc": 7, "request": 7, "5gi": 7, "common": [7, 8], "field": [7, 8], "result": [7, 8], "complex": [7, 8], "Will": 7, "success": [7, 8], "sampl": [7, 11], "elaps": 7, "time": [7, 9], "48": 7, "method": 7, "field_selector": 8, "filter": [8, 9], "get": 8, "regist": 8, "default_testvm": 8, "vm_list": 8, "search": 8, "until": 8, "api_found": 8, "were": 8, "successfulli": 8, "schema": 8, "represent": 8, "rest": 8, "standard": 8, "etc": 8, "statu": 8, "semant": 9, "semver": 9, "org": 9, "major": 9, "minor": 9, "increment": 9, "incompat": 9, "scenario": 9, "manner": 9, "deprec": 9, "pre": 9, "first": 9, "shall": 9, "newli": 9, "begin": 9, "smaller": 9, "therefor": 9, "explicitli": 9, "assum": 9, "indic": 9, "while": 9, "prior": 9, "nor": 9, "elimin": 9, "introduc": 9, "limit": 9, "argspec": 9, "structur": 9, "shape": 9, "inbound": 9, "payload": 9, "cfg": 9, "outcom": 9, "previou": 9, "section": 9, "readm": 9, "consid": 9, "abov": [9, 11], "increas": 9, "revis": 9, "trigger": 9, "git": [9, 11], "publish": 9, "built": 9, "artifact": 9, "page": 9, "hack": 11, "e2": 11, "sh": 11, "script": 11, "step": 11, "necessari": 11, "reproduc": 11, "ci": 11, "reli": 11, "cd": 11, "dep": 11, "min": 11}, "objects": {}, "objtypes": {}, "objnames": {}, "titleterms": {"kubevirt": [0, 2, 4, 6, 7, 8], "collect": [0, 2, 4, 9], "ansibl": [0, 2], "releas": [0, 2, 9], "note": [0, 7, 8], "topic": 0, "v1": 0, "3": 0, "0": 0, "summari": 0, "minor": 0, "chang": [0, 9], "bugfix": 0, "2": 0, "1": 0, "contribut": [1, 2], "lean": 2, "bind": 2, "python": 2, "version": [2, 9], "compat": [2, 9], "includ": 2, "content": [2, 9], "plugin": [2, 5, 9], "us": 2, "thi": 2, "instal": 2, "from": [2, 9], "galaxi": 2, "build": 2, "local": 2, "depend": 2, "librari": 2, "code": 2, "conduct": 2, "mainten": 2, "polici": 2, "govern": 2, "licens": 2, "contributor": 3, "": 3, "guidelin": 3, "welcom": 4, "core": 4, "document": [4, 9], "user": 4, "develop": 4, "gener": 4, "index": [5, 10], "inventori": [5, 6], "modul": 5, "sourc": 6, "virtualmachin": [6, 7, 8], "synopsi": [6, 7, 8], "requir": [6, 7, 8], "paramet": [6, 7, 8], "exampl": [6, 7, 8, 11], "author": [6, 7, 8], "kubevirt_vm": 7, "creat": 7, "delet": 7, "return": [7, 8], "valu": [7, 8], "kubevirt_vm_info": 8, "describ": 8, "strategi": 9, "new": 9, "i": 9, "ad": 9, "an": 9, "exist": 9, "featur": 9, "role": [9, 10], "within": 9, "backward": 9, "bug": 9, "fix": 9, "secur": 9, "break": 9, "ani": 9, "remov": 9, "A": 9, "typograph": 9, "error": 9, "wa": 9, "modifi": 9, "autom": 9, "test": 11, "continu": 11, "integr": 11, "config": 11, "playbook": 11}, "envversion": {"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, "sphinx": 60}, "alltitles": {"KubeVirt Collection for Ansible Release Notes": [[0, "kubevirt-collection-for-ansible-release-notes"]], "Topics": [[0, "topics"]], "v1.3.0": [[0, "v1-3-0"]], "Release Summary": [[0, "release-summary"], [0, "id6"], [0, "id7"], [0, "id8"], [0, "id9"], [0, "id11"]], "Minor Changes": [[0, "minor-changes"], [0, "id10"]], "Bugfixes": [[0, "bugfixes"]], "v1.2.3": [[0, "v1-2-3"]], "v1.2.2": [[0, "v1-2-2"]], "v1.2.1": [[0, "v1-2-1"]], "v1.2.0": [[0, "v1-2-0"]], "v1.1.0": [[0, "v1-1-0"]], "v1.0.0": [[0, "v1-0-0"]], "Contributing": [[1, "contributing"]], "Lean Ansible bindings for KubeVirt": [[2, "lean-ansible-bindings-for-kubevirt"]], "Ansible and Python version compatibility": [[2, "ansible-and-python-version-compatibility"]], "Included content": [[2, "included-content"]], "Plugins": [[2, "plugins"]], "Using this collection": [[2, "using-this-collection"]], "Installing the Collection from Ansible Galaxy": [[2, "installing-the-collection-from-ansible-galaxy"]], "Build and install locally": [[2, "build-and-install-locally"]], "Dependencies": [[2, "dependencies"]], "Ansible collections": [[2, "ansible-collections"]], "Python libraries": [[2, "python-libraries"]], "Code of Conduct": [[2, "code-of-conduct"]], "Contributing to this collection": [[2, "contributing-to-this-collection"]], "Collection maintenance": [[2, "collection-maintenance"]], "Release policy": [[2, "release-policy"]], "Governance": [[2, "governance"]], "Licensing": [[2, "licensing"]], "Contributor\u2019s Guidelines": [[3, "contributor-s-guidelines"]], "Welcome to kubevirt.core Collection documentation": [[4, "welcome-to-kubevirt-core-collection-documentation"]], "User documentation": [[4, null]], "Developer documentation": [[4, null]], "General": [[4, null]], "Plugin Index": [[5, "plugin-index"]], "inventory plugins": [[5, null]], "modules plugins": [[5, null]], "kubevirt \u2013 Inventory source for KubeVirt VirtualMachines": [[6, "kubevirt-inventory-source-for-kubevirt-virtualmachines"]], "Synopsis": [[6, "synopsis"], [7, "synopsis"], [8, "synopsis"]], "Requirements": [[6, "requirements"], [7, "requirements"], [8, "requirements"]], "Parameters": [[6, "parameters"], [7, "parameters"], [8, "parameters"]], "Examples": [[6, "examples"], [7, "examples"], [8, "examples"]], "Authors": [[6, "authors"], [7, "authors"], [8, "authors"]], "kubevirt_vm \u2013 Create or delete KubeVirt VirtualMachines": [[7, "kubevirt-vm-create-or-delete-kubevirt-virtualmachines"]], "Notes": [[7, "notes"], [8, "notes"]], "Return Values": [[7, "return-values"], [8, "return-values"]], "kubevirt_vm_info \u2013 Describe KubeVirt VirtualMachines": [[8, "kubevirt-vm-info-describe-kubevirt-virtualmachines"]], "Collection Versioning Strategy": [[9, "collection-versioning-strategy"]], "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"]], "Bug fix or security fix to existing content within a collection": [[9, "bug-fix-or-security-fix-to-existing-content-within-a-collection"]], "Breaking change to any content within a collection": [[9, "breaking-change-to-any-content-within-a-collection"]], "Content removed from a collection": [[9, "content-removed-from-a-collection"]], "A typographical error was fixed in the documentation for a collection": [[9, "a-typographical-error-was-fixed-in-the-documentation-for-a-collection"]], "Documentation added/removed/modified within a collection": [[9, "documentation-added-removed-modified-within-a-collection"]], "Release automation": [[9, "release-automation"]], "Role Index": [[10, "role-index"]], "Testing": [[11, "testing"]], "Continuous integration": [[11, "continuous-integration"]], "Example config and playbooks": [[11, "example-config-and-playbooks"]]}, "indexentries": {}}) \ 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 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"]], "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"]], "Minor Changes": [[0, "minor-changes"], [0, "id9"]], "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, "id6"], [0, "id7"], [0, "id8"], [0, "id10"]], "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 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": [[6, "kubevirt-inventory-source-for-kubevirt-virtualmachines"]], "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"]]}, "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": [7, 8], "11": [2, 6, 7, 8], "12": [2, 6, 7, 8], "120": [7, 8], "127": [7, 8], "14": 2, "15": [7, 8], "16": [2, 7, 8], "168": [6, 7, 8], "169": [7, 8], "17": [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": 6, "48": 7, "5": [7, 8], "5gi": 7, "64": 6, "70": 0, "72": 0, "73": 0, "75": 0, "76": 0, "8": [7, 8], "8443": 6, "9": [2, 6, 7, 8], "A": [4, 6], "By": [6, 9], "For": [6, 11], "If": [2, 6, 7, 8], "In": [6, 11], "It": [6, 7, 8], "No": 0, "Not": 0, "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], "abov": [9, 11], "absent": 7, "accept": 2, "access": [6, 7, 8], "accessmod": 7, "across": 7, "activ": [2, 6], "ad": [0, 4, 6, 7, 8], "add": [0, 6], "addit": [0, 9], "address": 6, "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, "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, "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": [2, 6, 7, 8], "base_domain": 6, "basi": 7, "basic": [7, 8], "basic_auth": [7, 8], "becaus": 6, "becom": 2, "been": 2, "befor": [2, 7], "begin": 9, "behavior": 7, "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, "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], "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], "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, 7, 8], "compat": [0, 3, 4, 11], "complex": [7, 8], "compos": 6, "composit": 6, "concaten": [3, 6], "condit": [6, 7], "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": [2, 6, 7, 8, 11], "correct": [7, 8, 9], "creat": [2, 4, 5, 6, 9, 11], "create_group": 6, "creation": [0, 6], "credenti": [7, 8], "ctrl": 3, "current": [2, 7, 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": 9, "deriv": 6, "describ": [0, 2, 4, 5], "descript": [7, 8], "desir": [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, 8], "directori": [3, 11], "disabl": 6, "discuss": [2, 7, 8], "do": [3, 7, 8], "doc": 2, "docker": [7, 11], "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": 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], "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], "expect": [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], "first": 9, "fix": [0, 4, 7, 8], "flag": [7, 8], "focus": 3, "follow": [2, 3, 7, 8, 9, 11], "foo": [3, 7, 8], "forc": 7, "forcefulli": 7, "foreground": 7, "form": [7, 8], "format": [6, 9], "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": [2, 6, 7, 9], "generate_nam": 7, "get": 8, "git": [9, 11], "github": [7, 8, 9, 11], "give": 0, "given": [6, 9], "gke": [7, 8], "gnu": 2, "go": [3, 7, 8], "govern": 4, "grace": 7, "graceperiodsecond": 7, "group": [0, 6, 7, 8], "group1": [7, 8], "group2": [7, 8], "gt": [7, 8], "guid": 2, "guidelin": [1, 2, 4], "gz": 2, "ha": [2, 7, 8], "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], "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], "implement": 7, "import": 2, "inbound": 9, "includ": [0, 3, 4, 6, 7, 8, 9], "incompat": 9, "increas": 9, "increment": 9, "indent": 3, "index": 4, "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": 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": [2, 6, 7], "jsonpatch": [2, 7], "k8": [7, 8], "k8s_auth": [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": [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": [2, 6, 7, 8], "kubesecondarydn": 6, "kubevirt": [1, 5, 11], "kubevirt_vm": [2, 4, 5], "kubevirt_vm_info": [0, 2, 4, 5], "label": [6, 7, 8, 9], "label_selector": [6, 8], "later": 2, "latest": [7, 8], "lead": 6, "leading_separ": 6, "lean": 4, "learn": 2, "less": [7, 8], "let": 2, "librari": [7, 8], "licens": 4, "like": [2, 3, 7, 8, 11], "limit": 9, "line": 2, "list": [2, 3, 6, 7, 8], "load": [6, 7, 8], "local": [6, 7, 8, 11], "localhost": [7, 8], "locat": 11, "long": [7, 8], "look": [7, 8], "low": 6, "lower": 6, "lowercas": 3, "machin": [2, 3, 11], "made": [2, 9], "mai": [7, 9], "main": [2, 7], "maintain": [2, 9], "mainten": 4, "major": 9, "make": [2, 3, 6, 9, 11], "make_head": [7, 8], "mani": 7, "manner": 9, "map": [6, 8], "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": [7, 8], "modifi": 4, "modul": [0, 7, 8, 9], "more": [2, 3, 6], "mostli": 0, "mount": 11, "multipl": [6, 7, 8], "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_vmi": 6, "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], "oauth2": [7, 8], "object": [6, 7, 8], "oidc": [7, 8], "okd": [7, 8], "old": [7, 8], "omit": 6, "one": 6, "onli": [0, 6, 7, 8, 9], "openshift": [7, 8], "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, "over": [0, 3], "overrid": [3, 6], "overridden": 3, "owner": 2, "p": [3, 11], "page": 9, "paramet": [5, 9], "parent": 6, "parent_group": 6, "part": [6, 7, 8], "particip": 2, "pass": [7, 8], "password": [6, 7, 8], "patch": [7, 9], "path": [3, 6, 7, 8], "payload": 9, "peopl": 2, "perform": [7, 8], "period": 7, "persist_config": [7, 8], "pick": [2, 7, 8], "pip": [2, 3, 11], "plai": [3, 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], "project": [6, 7, 8], "project_dir": 11, "propagationpolici": 7, "propos": 2, "provid": [2, 6, 7, 8, 11], "proxi": [7, 8], "proxy_basic_auth": [7, 8], "proxy_head": [7, 8], "public": 2, "publish": 9, "pull": [7, 8], "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, 11], "replac": 7, "repositori": [2, 11], "repres": [7, 8], "represent": 8, "reproduc": 11, "request": 7, "requir": [2, 3, 5, 9, 11], "resourc": [7, 8], "resource_definit": 7, "resourcevers": 7, "rest": 8, "result": [3, 7, 8], "retrigg": 0, "return": [0, 5, 6, 9], "review_checklist": 2, "revis": 9, "role": [3, 4], "run": [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, "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], "sh": 11, "shall": 9, "shape": 9, "shift": 3, "should": [3, 6, 7, 8, 9], "shouldn": [7, 8], "sinc": 6, "skip": 6, "slash": 3, "sleep": [7, 8], "smaller": 9, "so": [7, 8, 11], "softwar": 2, "someth": 2, "sourc": [2, 4, 5, 7, 11], "space": 3, "spec": [7, 8], "specif": [3, 6, 8], "specifi": [6, 7, 8], "src": 7, "ssh": [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, "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": [2, 7, 8, 9], "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": [7, 11], "test": [2, 3, 4, 6, 7, 8, 9], "testdv": 7, "testvm": [7, 8], "text": 2, "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, "tox": 3, "trail": 3, "trailing_separ": 6, "trigger": 9, "true": [6, 7, 8], "two": 11, "txt": [2, 11], "type": [6, 7], "typic": [7, 8], "typograph": 4, "u1": 7, "uid": [6, 7], "under": 3, "underscor": [3, 6], "uniqu": [7, 8], "unit": 4, "until": 8, "up": [6, 7, 8, 11], "updat": [0, 9], "url": [6, 7, 8], "urllib3": [7, 8], "us": [3, 4, 6, 7, 8], "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], "v3": 2, "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": [6, 7, 8], "verify_ssl": [6, 7, 8], "version": [0, 4, 6, 7, 8], "via": [6, 7, 8], "virtual": [2, 11], "virtualenv": 4, "virtualmachin": [0, 2, 4, 5], "virtualmachineinst": 6, "vm_list": 8, "voic": 2, "volum": 7, "vscode": 3, "wa": [4, 6, 7], "wai": 11, "wait": [7, 8], "wait_sleep": [7, 8], "wait_timeout": [7, 8], "want": [2, 7, 8], "we": [2, 6, 9], "welcom": 2, "were": 8, "what": [7, 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, 7, 8, 11], "world": 2, "would": [3, 9], "x27": [6, 7, 8], "xxxxxxxxxxxxxxxx": 6, "yaml": [3, 6], "ye": [6, 7], "yet": [7, 8], "yml": [2, 3, 6, 11], "you": [2, 3, 6, 7, 8, 11], "your": [2, 3, 7, 8, 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", "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, "A": 9, "ad": 9, "an": 9, "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, "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, "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], "wa": 9, "welcom": 4, "within": 9}}) \ No newline at end of file diff --git a/main/testing.html b/main/testing.html index ea55fa8..32c2fbc 100644 --- a/main/testing.html +++ b/main/testing.html @@ -18,7 +18,7 @@ - + @@ -55,11 +55,21 @@Developer documentation
General
@@ -93,9 +103,74 @@Testing
++ +Sanity and unit tests
+Sanity and unit tests can be run in two ways:
+-
+
For development purposes
+toxandtox-ansibleare better suited, as they allow +debugging of issues in the collection on the developer’s machine.For verification purposes of the collection the compatibility with
+ansible-test+is ensured.+ +Running tests with tox-ansible
+Run sanity tests with
+tox-ansiblelike so:++make test-sanity +Run unit tests with
+tox-ansiblelike so:++make test-unit ++ +Running tests with ansible-test
+In order to test changes with
+ansible-test, it is recommended to bind mount +the repository to~/.ansible/collections/ansible_collections/kubevirt/core+if you did not check it out into this location.This can be done with:
+++mkdir -p ~/.ansible/collections/ansible_collections/kubevirt/core +sudo mount --bind <project_dir>/kubevirt.core ~/.ansible/collections/ansible_collections/kubevirt/core +cd ~/.ansible/collections/ansible_collections/kubevirt/core +
Run sanity tests with
+ansible-testlike so:++ANSIBLE_TEST_PREFER_PODMAN=1 ansible-test sanity --docker +Run unit tests with
+ansible-testlike so:++ANSIBLE_TEST_PREFER_PODMAN=1 ansible-test units --docker ++ Integration tests
+Integration tests require a working cluster and can be run with +
ansible-test.- +Continuous integration
-The
+hack/e2e-setup.shscript contains the steps necessary to reproduce the CI test environment, which relies onkubectlandkind.Continuous integration
+The
+hack/e2e-setup.shscript contains the steps necessary to reproduce the +CI integration test environment, which relies ondockerorpodman, +kubectlandkind.To create the CI integration test environment on your machine run:
+++make cluster-up +To remove the test CI integration test environment run:
+++make cluster-down ++ Running integration tests with ansible test
+Run integration tests with ansible-test like so:
+++ansible-test integration +Example config and playbooks
General
diff --git a/main/plugins/kubevirt.html b/main/plugins/kubevirt.html index f2bcdf5..34ee2f7 100644 --- a/main/plugins/kubevirt.html +++ b/main/plugins/kubevirt.html @@ -19,7 +19,7 @@ - + @@ -71,6 +71,7 @@General
diff --git a/main/plugins/kubevirt_vm.html b/main/plugins/kubevirt_vm.html index 516d790..e3e1da5 100644 --- a/main/plugins/kubevirt_vm.html +++ b/main/plugins/kubevirt_vm.html @@ -19,7 +19,7 @@ - + @@ -73,6 +73,7 @@General
diff --git a/main/plugins/kubevirt_vm_info.html b/main/plugins/kubevirt_vm_info.html index 85f3c79..25d5032 100644 --- a/main/plugins/kubevirt_vm_info.html +++ b/main/plugins/kubevirt_vm_info.html @@ -19,7 +19,7 @@ - + @@ -73,6 +73,7 @@General
diff --git a/main/releasing.html b/main/releasing.html index a2f81a2..4da0524 100644 --- a/main/releasing.html +++ b/main/releasing.html @@ -18,7 +18,7 @@ - + @@ -56,6 +56,7 @@