Install MSR online

The procedure provided herein will guide you in your installation of MSR onto a Swarm cluster that has one manager and one worker node, with the MSR installation occurring on one worker. Be aware, though, that you can adjust the number of nodes to fit your specific needs.


  • You must install MSR on an odd number of nodes.

  • Mirantis recommends that you install MSR on worker nodes only.

  1. If you have not done so, create the swarm where MSR will run.

  2. SSH into the manager node.

  3. Generate the values.yml file that you will use to configure and deploy MSR:

    docker run -it --rm \
    --entrypoint cat<msr-version> \
    /config/values.yml > values.yml
  4. Edit the values.yml file to customize your MSR deployment. Be sure to place your license in the license section.

    license: '<license-string>'
  5. Obtain a list of non-manager nodes along with their node IDs:

    docker node ls --format "{{ .ID }}" --filter "role=worker"
  6. In the swarm.nodeList section of the values.yml file, add the node IDs of the worker nodes on which you plan to install MSR:

        - <node-id-1>
        - <node-id-2>
        - <node-id-3>
  7. Execute the following command to install MSR:

    docker run \
      --rm \
      -it \
      -v /var/run/docker.sock:/var/run/docker.sock \
      -v <path-to-values.yml>:/config/values.yml \<msr-version> \
      install \
      --https_port 8443 \
      --http_port 8888


    • If you do not specify any worker nodes on which to install MSR, the software will exclusively be installed on the manager node where the msr-installer is executed.

    • You must specify the destination file in the destination container as :/config/values.yml \. Any other name will cause the container deployment to fail, which will result in the cluster becoming inoperable.

    • To switch the log-level from the default info to debug, you need to insert the --log-level debug flag between the msr-installer image and the install subcommand.

    • Port 8443 is indicated in the provided example, demonstrating a scenario in which MKE and MSR are both in use and have a conflict with port 443. Port 443 should be used exclusively for all other installation configurations.

  8. Review the status of the deployed services:

    docker stack services msr
  9. Access the MSR web UI at https://<node-ip>:443. The default user name and password are admin:password.