Installing zassist

Install zassist, a command-line tool used for content ingestion.

Before you begin

Attention: The following prerequisites are applicable for Linux OS only.

Before you install zassist, you must install GNOME Keyring. Use the following commands for installing GNOME Keyring on Linux:

The following steps are applicable for Ubuntu:

Install GNOME Keyring:

sudo apt-get update
sudo apt-get install dbus-x11
sudo apt-get install gnome-keyring

Create a folder to store the keyring:
```
mkdir -p ~/.local/share/keyrings 
```
(Optional) if the preceding step fails, use the following command:
```
/usr/bin/gnome-keyring-daemon --start --components=secrets
```
Unlock the Keyring manually:
```
export $(dbus-launch) echo "password" | gnome-keyring-daemon --unlock
```
Note: You must unlock the keyring manually whenever you start a new terminal or session.

The following steps are applicable for Red Hat OpenShift:

Install dbus-x11:
```
sudo dnf install dbus-x11
```
Install gnome-keyring:
```
sudo dnf install gnome-keyring
```
Create a folder to store keyring:
```
mkdir -p ~/.local/share/keyrings
```

Unlock the Keyring manually:

export $(dbus-launch)
echo "password" | gnome-keyring-daemon --unlock

Note: Unlock the keyring manually whenever you start a new terminal or session.

The following are the PersistentVolumeClaim (PVC) requirements for installing zAssist.

PVC	Minimum requirement
Write speed	50 MB
Size	Total File Sizes * 2.5

The preceding PVC requirements are also applicable for OpenSearch PVC.

About this task

The zassist CLI is available for the following platforms:

Platform	Binary path	Architecture
Linux (x86_64)	linux/zassist	x86_64 (Intel/AMD 64-bit)
macOS (Intel)	mac/zassist	x86_64 (Intel-based Macs)
macOS (Apple Silicon)	mac-arm/zassist	ARM64 (M1/M2/M3 Macs)
Linux (s390x)	s390x/zassist	IBM Z mainframe (s390x)
Windows	windows/zassist.exe	x86_64 (64-bit Windows)

Procedure

Download zAssist from IBM Passport Advantage.
Complete the following tasks based on the OS that you are using:
Linux and Mac OS:
1. Copy the executable file to a folder.
2. Add the folder to the path export PATH="$PATH:/path/to/folder" and save it to your preferred configuration file
  
  Note: Based on your OS configuration, you can save the configuration file in any of the following home directories : .Zsh, .bashrc, .profile, and so on.
3. Either close all your open terminals and restart your computer or re-source your modified configuration file.
Windows OS:
1. Copy the executable file to a folder.
2. Add the folder to the path:
  1. Click Windows + R or click Start, type run, and click Open.
  2. In the Run window, type "SystemPropertiesAdvanced" and click OK to launch the Advanced tab of the System Properties window.
  3. Click Environment Variables.
  4. Click Path under User variables or System variables.
  5. Click Edit.
  6. In the Environment Variables window, click New, and enter the absolute path of the folder.
  7. Click OK.
  8. Either restart all the open terminals or restart your computer.