Installing Wazi Deploy on a distributed environment and installing the Wazi Deploy Ansible collection

Wazi Deploy is provided as a Python package, which allows for usage on a multitude of operating systems. The package must be installed in Python to become functional. Install the Wazi Deploy core package on a distributed environment in x86 or Linux® on Z.

Note: If you install a Wazi Deploy version earlier than 3.0.3, follow the instructions in Installing Wazi Deploy prior to 3.0.3.

Installing the requisites and Wazi Deploy

If you plan to use Wazi Deploy on a distributed environment (x86 or Linux on Z), install the Wazi Deploy Python modules. It is mandatory to use the Wazi Deploy Ansible modules.

Create a Python virtual environment.
Creating a virtual environment is recommended to isolate the Python package installation. You can then manage separate package installations for different projects and test the installations.
To create a virtual environment named gdp in the /global/opt/pyenv directory, enter the following command:
```
python3 -m venv /global/opt/pyenv/gdp
```
Next, you must activate the virtual environment with the following command:
```
. /global/opt/pyenv/gdp/bin/activate
```
Note: If you use a bash shell, you can use the source command instead of the . command. So for example, you can enter the following command:
```
source /global/opt/pyenv/gdp/bin/activate
```

Get the Wazi Deploy installable files that are present on z/OS®.

These files were created on z/OS when the Wazi Deploy FMID was installed through SMP/E, as described in the Wazi Deploy Program Directory.

By default, the SMP/E installation created the /usr/lpp/IBM/gdp z/OS UNIX directory. This directory contains the installable files for usage on z/OS, and a tar subdirectory that contains the wazideploy.tar file.

The wazideploy.tar file can be sent to a distributed environment (x86 or Linux on Z) for the installation of Wazi Deploy on that system. You can extract the installable files from the file by using the following command:

tar -xvf wazideploy.tar

The installable files are wheel files. A wheel file is a ZIP-format archive with a specially formatted file name followed by the .whl extension. It contains a precompiled Python module ready to install. The current Python versions support this installation method.

The /usr/lpp/IBM/gdp directory contains a .whl file for each of the currently supported versions of IBM® Open Enterprise SDK for Python. The following table lists the Wazi Deploy .whl files, the environments where they can be used, and the corresponding versions of IBM Open Enterprise SDK for Python.

File names	Execution environments	IBM Open Enterprise SDK for Python versions
wazideploy_3.0.6-py3.13-none-any.whl	z/OS and distributed (x86 or Linux on Z) environments	3.13
wazideploy_3.0.6-py3.12-none-any.whl	z/OS and distributed (x86 or Linux on Z) environments	3.12
wazideploy_3.0.6-py3.11-none-any.whl	z/OS and distributed (x86 or Linux on Z) environments	3.11

Warning: The Python wheel installation method performs version matching against the .whl file name. Any modification to the file name can break and corrupt the installation.

Install the requisites.
The /usr/lpp/IBM/gdp directory contains a dependencies directory that contains all the upstream libraries needed for Wazi Deploy.
In the folder where you have unpacked the .tar file, issue the following command:
```
pip3 install --no-deps --no-cache-dir -r dependencies/requirements.txt --no-index --find-links dependencies
```
Install Wazi Deploy.
Now that Python has access to the requisite libraries, you can install Wazi Deploy.

Enter the following installation command, where X represents the Python version in the Wazi Deploy wheel file. For example, the wheel file can be wazideploy-3.0.6-py3.13-none-any.whl.
```
pip3 install --no-deps --no-cache-dir wazideploy-3.0.6-py3.X-none-any.whl
```
Note: If you are not the administrator of the environment where you are installing Wazi Deploy, and if you are not installing Wazi Deploy in a virtual environment, the Wazi Deploy binary files are installed in your home folder ($HOME/.local/bin). In this case, before you validate the Wazi Deploy installation, you must add this folder to the PATH environment variable with the following command:
```
export PATH=$PATH:$HOME/.local/bin
```
Validate the Wazi Deploy installation.
To do so, verify that all the Wazi Deploy command-line interface (CLI) modules are correctly installed by triggering the help options of the various CLI modules with the following commands:
- ```
wazideploy-package -h
```
- ```
wazideploy-generate -h
```
- ```
wazideploy-evidence -h
```
Note: The wazideploy-deploy -h command does not work on Linux.

All these commands must display the command arguments.

If you plan to deploy with Python, which directly targets the z/OS environment, the installation is now complete.

However, if you plan to deploy with Ansible®, you must install the Wazi Deploy Ansible collection.

Installing the Wazi Deploy Ansible collection

You can use the Wazi Deploy Ansible translator on the x86 distributed environment where you installed Ansible .

Get the Wazi Deploy installable files that are present on z/OS, as it is explained in the step 2 of the installation.
Transfer the Wazi Deploy installable files, in binary mode, to the distributed environment (x86 or Linux on Z).

Install the Wazi Deploy Ansible collection with the following command:

ansible-galaxy collection install ibm-ibm_zos_wazi_deploy-3.0.6.tar.gz

Upgrading Wazi Deploy

To upgrade Wazi Deploy, download the installation files that are contained in the new wazideploy.tar file. Then, repeat the installation steps that are explained in Installing the requisites and Wazi Deploy.

Moreover, reinstall the Wazi Deploy Ansible collection by repeating the installation steps that are explained in Installing the Wazi Deploy Ansible collection.