MKE CLI reference

MKE CLI reference

Note

UCP is now MKE.

The product formerly known as Universal Control Plane (UCP) is now Mirantis Kubernetes Engine (MKE).

This image has commands to install and manage MKE on a Mirantis Container Runtime.

You can configure the commands using flags or environment variables.

When using environment variables, use the docker container run -e VARIABLE_NAME syntax to pass the value from your shell, or docker container run -e VARIABLE_NAME=value to specify the value explicitly on the command line.

The container running this image needs to be named ucp and bind-mount the Docker daemon socket. Below you can find an example of how to run this image.

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

Usage

docker container run -it --rm \
--name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
mirantis/ucp:3.X.Y \
command [command arguments]

Note

Depending on the version of MKE 3.X.Y in use, it may be necessary to substitute docker/ucp:3.X.Y for mirantis/ucp:3.X.Y to get the appropriate image (look in https://hub.docker.com/r/mirantis/ucp/tags?page=1&ordering=name and https://hub.docker.com/r/docker/ucp/tags?page=1&ordering=name to confirm correct usage).