QuickStart Guide
Installation and Deployments
Docker Installation
7 min
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 before you begin install docker engine 19 03+ https //docs docker com/get docker/ on an intel 64 bit machine that you have administrative permissions required for executing 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 step 1 launch a litmus edge docker image to launch a litmus edge docker image 1\ download the service account json file, which you obtained from your litmus account representative 2\ open a command prompt terminal (ctrl+r) on the intel 64 bit machine 3\ use the following linux or windows command to launch the docker image cat \<file name> json | docker login u json key password stdin https //us docker pkg devtype \<file name> json | docker login u json key password stdin https //us docker pkg dev the \<file name> json parameter is the service account file 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 https //cloud google com/artifact registry/docs/docker/authentication#json key for more information note if you specify cpu/ram limits for the docker container that's initialized from the docker image, allocate at least 2 4 cpus and 4 8 gb ram then scale up as needed 4\ execute the following command to initialize the litmus edge docker container from the docker image that you downloaded docker run name le d cap add=net admin p 8443 443 v vol1 /var us docker pkg dev/litmus sales enablement/litmusedge/litmusedge std docker\ latest where \ name le defines the container name you can change this from a different name than le cap add=net admin should not be changed as net admin is required p 8443 443 defines the port mapping you can change the value to a port other than 8443 the internal 443 port can be mapped to any other external port other than 8443 as desired v vol1 /var command mounts all container data to a volume called vol1 you can name the volume to your preference optionally, use the following command to mount external storage to the volume and enable efficient file transfer between the host system and litmus edge v /path/to/folder/in/host /var/lib/customer/ftp data where /path/to/folder/in/host specifies the path to the folder on your host machine /var/lib/customer/ftp data defines the mirrored folder location in litmus edge 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 step 2 log in to litmus edge see access the litmus edge web ui docid\ y hkza2pmc4iruk ebouk for details on logging in