In correlation with the end of life (EOL) for MKE 3.5.x, maintenance of this documentation set was discontinued as of 2023-NOV-22. Click here for the latest MKE 3.x version documentation.

CLI Reference

The mirantis/ucp:3.x.y image includes commands that install and manage MKE on a Mirantis Container Runtime.

You can configure the commands using either flags or environment variables.

Environment variables can use either of the following types of syntax:

  • Pass the value from your shell using the docker container run -e VARIABLE_NAME syntax.

  • Specify the value explicitly from the command line using the docker container run -e VARIABLE_NAME=value syntax.


To use the MKE CLI:

MKE CLI use requires that you name the mirantis/ucp:3.x.y image ucp and bind-mount the Docker daemon socket:

docker container run -it --rm \
  --name ucp \
  -v /var/run/docker.sock:/var/run/docker.sock \
  mirantis/ucp:3.x.y \
  <command> <command-options>

Additional information is available for each command by using the --help flag.

Note

To obtain the appropriate image, it may be necessary to use docker/ucp:3.x.y rather than mirantis/ucp:3.x.y, as older versions are associated with the docker organization. Review the images in the mirantis and docker organizations on Docker Hub to determine the correct organization.