Docker Installation
You can use Docker to install Litmus Edge.
Note: You can't upgrade the Litmus Edge Docker version using a software update file (UPD). You can follow the Docker recommended approach for Docker image upgrade and volume management.
- On the Intel 64-bit machine, have administrative permissions to execute Docker commands.
- Ensure the Docker Engine is configured to run a Docker image with a root user.
- Contact your Litmus account representative to get access to the service account .json file.
To use Docker to install Litmus Edge, you will need to do the following:
- Step 1: Launch a Litmus Edge Docker Image
- Step 2: Log in to Litmus Edge
To launch a Litmus Edge Docker image:
1. Download the service account .json file, which you can get from your Litmus account representative. 2. Open a Command Prompt Terminal (CTRL+R) on the Intel 64-bit machine. 3. Use one of the commands below to launch the Docker image: Linux or Windows.
The <file_name>.json parameter is the service account file requested from step 1.
Example: If the .json file is named abc123.json, execute: cat abc123.json | docker login -u _json_key --password-stdin https://us-docker.pkg.dev
Refer to Google's Setting Up Authentication: Service Account Key for more information.
Note: If the Docker container (that will be initialized from the Docker image from Step 3) will be configured with CPU/RAM limits, allocate at least 2-4 CPUs and 4-8 GB RAM. Scale up as needed.
4. Execute the following command to initialize the Litmus Edge Docker container from the downloaded Docker image from Step 3.
Refer to the command parameters:
- --name LE parameter can be changed with a different name than LE.
- --cap-add=NET_ADMIN parameter should not be changed as NET_ADMIN is required.
- -p 8443:443 parameter can be changed with a different port than 8443. Internal port 443 can be mapped to any other external port other than 8443 as desired.
- The command -v vol1:/var will mount all container data to a volume called vol1. You can name the volume to your preference.
Note: The --sysctl net.ipv4.ping_group_range="0 2147483647" parameter is not always required. However, if you are using Utilities and ping encounters errors due to host system limitations, add this parameter before initiating the container.
5. From the Docker terminal window, it will display the IP address to access the Litmus Edge device through the Web UI. Enter the IP address into an internet browser URL bar to access the Litmus Edge device.
See Access the Litmus Edge Web UI for details on logging in.