Update documentations for v3.0 (#506)

Signed-off-by: Qi Zhang <[email protected]>

Author: keirazhang

README.md

@@ -61,7 +61,7 @@ This project supports below scenarios for end-to-end guest operating system vali
   * SSH and Python are installed and enabled.
   * The vm_python variable in vars/test.yml must be set with correct python path. Or user can set PATH in /etc/environment in guest operating system to include the binary directory path to python.
   * The root user should be enabled and permitted to log in through SSH in Linux guest operating system.
-  * Execute [ConfigureRemotingForAnsible.ps1](https://github.com/ansible/ansible/blob/devel/examples/scripts/ConfigureRemotingForAnsible.ps1) script in Windows guest operating system in advance.
+  * Execute [ConfigureRemotingForAnsible.ps1](https://github.com/ansible/ansible-documentation/blob/devel/examples/scripts/ConfigureRemotingForAnsible.ps1) script in Windows guest operating system in advance.
 
 ### Compatible Guest Operating Systems
 
@@ -94,14 +94,13 @@ This project supports below scenarios for end-to-end guest operating system vali
 | Red Hat Enterprise Linux CoreOS (RHCOS) 4.13 and later                    |                                  | :heavy_check_mark:       | :heavy_check_mark:                 |
 
 **Notes**
-1. This compatible guest operating systems list is used for this project only. For guest operating system support status on ESXi, please refer to [VMware Compatibility Guide](https://www.vmware.com/resources/compatibility/search.php?deviceCategory=software&testConfig=16).
-2. Guest OS marked with (*) only supports autoinstall and doesn't support end-to-end tests for now.
+This compatible guest operating systems list is used for this project only. For guest operating system support status on ESXi, please refer to [VMware Compatibility Guide](https://www.vmware.com/resources/compatibility/search.php?deviceCategory=software&testConfig=16).
 
 ### Docker images
-* Latest (Release v2.3):
+* Latest (Release v3.0):
   * projects.registry.vmware.com/gos_cert/ansible-vsphere-gos-validation:latest
-* Release v2.3:
-  * projects.registry.vmware.com/gos_cert/ansible-vsphere-gos-validation:v2.3
+* Release v3.0:
+  * projects.registry.vmware.com/gos_cert/ansible-vsphere-gos-validation:v3.0
 
 Launch testing using Docker image
 1. Execute below commands in your machine

changelogs/changelog.yml

@@ -1,5 +1,62 @@
 ancestor: null
 releases:
+  3.0:
+    changes:
+      major_changes:
+      - Add support for Pardus 21.x test
+      - Add support for RHEL CoreOS OVA image deployment and test
+      - Add support for BCLinux 8.x and BCLinux-for-Euler 21.10 autoinstall and test
+      - Add support for FreeBSD 13.x test
+      - Add support for openSUSE autoinstall and test
+      minor_changes:
+      - Check guest OS full name when short-name is set
+      - Update URL path of VMware Tools 12.3.0 for Windows
+      - Add known issue for PVRDMA hot-remove failure on Oracle Linux 8.8
+      - Use vmware_guest_disk module to add IDE boot disk
+      - Set VM boot order before vHBA testing and test file read/write on new disk
+      - Print error message when reverting VM snapshot failed
+      - Shutdown guest OS after auto install completes instead of rebooting
+      - Update checking guest_os_ansible_distribution is Flatcar
+      - Exit ansible test if VMware Tools installation failed for Windows
+      - Check base snapshot at env_setup
+      - Enable Credential Guard for Windows Server
+      - Skip secureboot and nvdimm testing for guest OS not supporting them
+      - Check VMware Tools version after OVA/OVF deployment without poweron
+      - Add vars and tasks to support VGAuth guest operation testing
+      bugfixes:
+      - Fix package installation failure at deploy_vm on Ubuntu 23.10
+      - Fix undefined variables at rescue or always block when test_setup failed
+      - Fix dict item names in community.vmware.vmware_vm_config_option result
+      - Fix undefined error of WSL
+      - Fix autoinstall issue on FreeBSD 14
+      - Check vmtools_log_dir is defined before using it in check_os_fullname
+      - Fix empty hardware version in collected OVF config info and guest_info.json
+      - Fix command "newfs" issue for Freebsd 13.2 32bit
+      - Fix the offical repo for Pardus 23.0
+      - Fix undefined error for guest_os_with_inbox_drivers in network testcases
+      - Correct ovt_packages for Linux guest OS with desktop
+      - Ignore esxi_hostname at VM creation when vcenter_hostname is not defined
+      - Replace install_linux_esx with linux_flavor for Photon OS autoinstall
+      - Update URL for downloading ConfigureRemotingForAnsible.ps1
+      - Fix cloud-init GOSC failure on Ubuntu and Photon OS
+      - Remove cdrom ISO before running cloud-init GOSC test cases for Ubuntu OVA
+      - Fix Debian 12 auto installation failure
+      - Add parameter esxi_hostname to vm_create
+      - Change the boot disk to be first in boot order for ubuntu 23.04 desktop after deploy_vm
+    docker_image:
+      path: projects.registry.vmware.com/gos_cert/ansible-vsphere-gos-validation:v3.0
+      Ansible: ansible-core 2.15.4
+      Python: 3.10.11
+      Ansible collections:
+      - ansible.netcommon 5.2.0
+      - ansible.posix     1.5.4
+      - ansible.utils     2.11.0
+      - ansible.windows   2.1.0
+      - community.crypto  2.15.1
+      - community.general 7.4.0
+      - community.vmware  3.9.0
+      - community.windows 2.0.0
+    release_date: '2023-09-28'
   2.3:
     changes:
       major_changes:

docker_file/Dockerfile

@@ -1,6 +1,6 @@
 # ansible-vsphere-gos-validation
 # For users launch guest OS validation test on vSphere
-# version: 2.3
+# version: 3.0
 
 # Use latest Photon OS 4.0 docker image as parent image
 FROM photon:4.0
@@ -9,17 +9,17 @@ WORKDIR /root/ansible-vsphere-gos-validation
 # Install the required packages
 RUN tdnf makecache && \
     tdnf install -y python3 zip vim wget python3-pip \
-    sshpass gawk nfs-utils iana-etc python3-lxml \
-    python3-setuptools python3-jmespath python3-netaddr && \
-    pip3 install wheel pycdlib pywinrm pyvmomi pypsrp
+    sshpass gawk nfs-utils iana-etc python3-lxml python3-setuptools \
+    python3-wheel  python3-jmespath python3-netaddr && \
+    pip3 install pycdlib pywinrm pyvmomi pypsrp passlib
 
 # Install ansible-core (starts from Ansible 2.11)
 RUN pip3 install ansible-core
 
 # Install Ansible collections
 # You can set https proxy if collections are failed to install from Galaxy server, e.g.,
 # ENV HTTPS_PROXY="https://proxy.xxxx.com:xxxx"
-# Ansible 2.14.0 requires the locale encoding to be UTF-8
+# Ansible 2.14.0 or later requires the locale encoding to be UTF-8
 ENV LC_ALL=en_US.UTF-8 LANG=en_US.UTF-8
 RUN ansible-galaxy collection install ansible.netcommon ansible.posix community.general community.vmware community.windows community.crypto
 

requirements.txt

@@ -4,9 +4,11 @@ setuptools
 wheel
 jmespath
 PyYAML>=5.1
+lxml
 pycdlib
 netaddr
 pywinrm
 pypsrp
 pyvmomi
+passlib
 ansible-core