Pre-requisites to install dux

Before installing and running dux, ensure your environment meets the following requirements.

Host system requirements

SSH

• Verify that SSH is installed and running on your local Mac/Linux/Windows machine.

• Configure the SSH keys
  Ensure that the SSH keys are set up for users to log in to the remote VMs (where the container is to be deployed) securely without passwords.
  
  To generate SSH keys:

  1. Run the command ssh-keygen -t rsa.
  2. Follow the prompts to create the SSH keys.
     Linux/macOS (default):
     - Private key: ~/.ssh/id_rsa
     - Public key: ~/.ssh/id_rsa.pub
     Windows (default): C:\Users\<user_name>\.ssh\
  3. Copy the contents of the public key (id_rsa.pub) to the remote VM's ~/.ssh/authorized_keys file.
     ssh-copy-id username@remote_host
     Note: Windows do not include ssh-copy-id. Manually copy the public key using scp, sftp, or paste to authorized_keys.

• If you want to enable ssh_host_key_check in the manifest (example, ts_manifest.yml), ensure that the known_hosts file exists on your local machine.
  This file is used to store information about host keys for SSH connections.
  If it does not exist, it is created automatically when you connect to a remote host for the first time/when running dux commands.

Host key verification

If you want to enable ssh_host_key_check in the manifest (example, ts_manifest.yml), ensure that the known_hosts file exists on your local machine. This file is used to store information about host keys for SSH connections. If it does not exist, it is created automatically when you connect to a remote host for the first time on running dux commands.

Container Image

Download the container Docker image bundle (tar.gz) from Customer Connect. After dux is installed and the folder structure is created, copy the image to the default path.
Note: To use a custom folder, provide the full directory path in the manifest file.

Configuration files for EIC Container

Based on the platform, the following files must be uploaded to the eic-config directory under the default dux directory. If these directories do not exist already, they are created by the dux init command.

• policies.json
• logback.xml
• application.yaml

Remote virtual machines/hosts requirements

The Linux VMs or hosts where you deploy the container must meet the following requirements.

SSH Server

• Ensure SSH is enabled on the remote VM.
• Verify the SSH daemon (sshd) is running. For example, check on AlmaLinux if sshd is running: systemctl status sshd

Docker or Podman

• Install Docker CE (Snap Docker for Ubuntu is not supported) or Podman or Podman-docker.
• If using Podman, create a symbolic link to ensure compatibility using dux commands.
  dux deploy -d
• Alternatively, manually create the link using the command:
  sudo ln -sf $(which podman) /usr/bin/docker

To configure passwordless sudo:

1. SSH to the remote VM with administrative privileges.
2. Edit the sudoers file using the command sudo visudo.
3. Add the following line (replace username with the actual username):
   username ALL=(ALL) NOPASSWD: ALL
4. Save and exit the sudoers file.

To add user to docker group:

1. Run the command: sudo usermod -aG docker <username>.
2. Log out and login again for the changes to take effect.
3. Verify the user's access to Docker: docker ps

If the command runs without any errors, the user has sufficient permissions.

Network connectivity

Ensure the remote VM has connectivity.

Deploying container on dux VM

To deploy a container on the same Linux VM as dux, and to use dux commands locally without the need to use ssh:

In the 'address' field under the 'hosts' group, use any of the following for localhost deployment:

127.0.0.1, localhost, the host's interface IP, or the hostname