Deployment

the topic registry is distributed as a docker image, making it easy to deploy on any system that supports docker follow these steps to deploy the solution and configure it to work with litmus edge prerequisites litmus edge version +3 16 8 litmus edge ip address or hostname the ip address or hostname of the litmus edge instance to connect to litmus edge rest api token a valid rest api token generated from the litmus edge instance refer to the litmus edge documentation for instructions on generating an api token litmus edge access token a valid access token is required to connect to the litmus edge message broker this token authenticates the topic registry to receive real time updates see the litmus edge documentation for details on generating an access token note ensure the nats proxy is enabled and that the account token has permission to subscribe to all topics by including > in the read topics configuration docker docker must be installed on the machine where the topic registry will be deployed for installation instructions, refer to the docker documentation downloading the image the docker image is available on litmus central download the appropriate version and load the image into your docker environment using the following command docker load i le topic registry \<version> tar example docker load i le topic registry 001 tar basic deployment to deploy the solution without configuring environment variables in advance, run the following command this will expose the solution on port 3000 docker run itd p 3000 3000 e x litmus key=super secret key us docker pkg dev/litmus customer facing/litmus solutions/le topic registry \<version> example docker run itd p 3000 3000 e x litmus key=super secret key us docker pkg dev/litmus customer facing/litmus solutions/le topic registry 0 0 1 create a volume to ensure data is persisted if the container is deleted if you are deploying the image in litmus edge, please add the option network host to the above command, or deploy the solution from the marketplace also, a firewall rule should be added to the solution port to allow inbound traffic this requirement only applies when deploying in litmus edge pre configured deployment you can pre configure the solution using environment variables edge hostname the ip address or hostname of the litmus edge instance edge nats token the access token for connecting to the litmus edge message broker edge api token the api token for accessing litmus edge api endpoints x litmus key (solution) a secret key for authenticating rest api requests show logger set to true to enable verbose logging for debugging you can provide these environment variables during deployment or configure them later via the solution's web ui for a pre configured deployment, include the necessary environment variables in the docker run command as follows docker run itd p 3000 3000 e edge hostname=\<edge hostname> e edge nats token=\<edge nats token> e edge api token=\<edge api token> e x litmus key=\<tr solution api key> us docker pkg dev/litmus customer facing/litmus solutions/le topic registry \<version> replace \<edge hostname> , \<edge nats token> , \<edge api token> , and \<tr solution api key> with your appropriate values accessing the solution once the container is running, access the solution in your web browser at http //localhost 3000 or use the ip address of the host machine