Creating the manifest

The dux CLI tool supports deploying and managing multiple containers, including Tunnel, PAC Reader, SEG, and Content Gateway.

The following steps apply to all containerized gateway services. Refer to the specific gateway service guide for additional details and service‑specific commands.

The manifest YAML file defines all configuration parameters necessary for deploying the containerized service. Every containerized service has its own unique manifest YAML file.

The dux init command prompts the user to select the container type they want to initialize. Based on the selection, dux generates a manifest file template for the selected container type.

To use a different path where the manifest file needs to be created, use the dux init <path> command. Ensure that you specify the path of the manifest with -m option in the other commands.

Examples

Deploying Content Gateway

Run the command dux init.

Result: This command creates a sample manifest (cg_manifest.yml) and stores it in the default directory based on the platform.

Select a container type to initialize:

1. Tunnel
2. EIC
3. PAC Reader
4. SEG
5. Content Gateway

Enter the number of the container type: 5

Content Gateway manifest file successfully created at: /opt/omnissa/dux/cg_manifest.yml

Deploying EIC

Run the command dux init.

Result: This command creates a sample manifest (eic_manifest.yml) and eic-config directory under the default directory dux (based on the platform).

Select a container type to initialize:
1. Tunnel
2. EIC
3. PAC Reader
4. SEG
5. Content Gateway
Enter the number of the container type: 2
EIC manifest file successfully created at: /opt/omnissa/dux/eic_manifest.yml
Please upload the config files for EIC under: /opt/omnissa/dux/eic-config
Directory: /opt/omnissa/dux/scripts already exists
Directory: /opt/omnissa/dux/certs already exists
$cd /opt/omnissa/dux
abc@abc dux $ ls -ltr
total 16
[root@centos81 dux]# ls -ltr
total 28
drwxr-xr-x. 2 abc abc    6 Jun 17 04:12 images
drwxr-xr-x. 2 abc abc   42 Jun 17 06:10 logs
drwxr-xr-x. 2 abc abc    6  Jun 18 15:05 eic-config
drwxr-xr-x  3 abc abc    96 Jun 17 13:05 certs
drwxr-xr-x  3 abc abc    96 Jun 17 13:05 scripts
-rw-r--r--. 1 abc abc 3720  Jun 18 15:05 eic_manifest.yml

(Optional) Upgrade the manifest

If you have an older version of dux installed with a manifest file (for example, SEG/Tunnel/EIC/PAC Reader manifest), use the command to upgrade.

dux init -u

The upgrade command prompts you to select the container type and confirms the upgrade.

1. Tunnel
2. EIC
3. PAC Reader
4. SEG
Enter the number of the container type: 4

Warning: Manifest version 3.0.0.641 is outdated. 
Do you want to upgrade the manifest to the latest dux version? (y/n): y

Upgrading manifest from version 3.0.0.641 to version 3.1.0.852
Manifest file backed up to: /opt/omnissa/dux/seg_manifest.yml.bak_2025-12-11_18-09-08
Manifest file updated successfully at /opt/omnissa/dux/seg_manifest.yml

Automatic Backup

The upgrade process automatically creates a backup (with timestamps) of your original manifest file. The changes between versions can be verified or reverted if needed.