Use this command to install MKE on a node. Running this command will initialize a new swarm, turn a node into a manager, and install MKE.
When installing MKE, you can customize:
The MKE web server certificates. Create a volume named
ucp-controller-server-certs
and copy the ca.pem
, cert.pem
, and
key.pem
files to the root directory. Next, run the install command with
the --external-server-cert
flag.
The license used by MKE, which you can accomplish by bind-mounting the
file at /config/docker_subscription.lic
in the tool or by specifying
the --license $(cat license.lic)
option.
For example, to bind-mount the file:
-v /path/to/my/config/docker_subscription.lic:/config/docker_subscription.lic
If you’re joining more nodes to this swarm, open the following ports in your firewall:
--controller-port
--swarm-port
If you are installing MKE on a manager node with SELinunx enabled at the daemon
and OS level, you will need to pass --security-opt label=disable
in to your
install command. This flag will disable SELinux policies on the installation
container. The MKE installation container mounts and configures the Docker
Socket as part of the MKE installation container, therefore the MKE
installation will fail with the following permission denied error if you fail
to pass in this flag.
FATA[0000] unable to get valid Docker client: unable to ping Docker daemon: Got
permission denied while trying to connect to the Docker daemon socket at
unix:///var/run/docker.sock: Get http://%2Fvar%2Frun%2Fdocker.sock/_ping: dial
unix /var/run/docker.sock: connect: permission denied - If SELinux is enabled
on the Docker daemon, make sure you run MKE with "docker run --security-opt
label=disable -v /var/run/docker.sock:/var/run/docker.sock ..."
An installation command for a system with SELinux enabled at the daemon level would be:
docker container run \
--rm \
--interactive \
--tty \
--name ucp \
--security-opt label=disable \
--volume /var/run/docker.sock:/var/run/docker.sock \
docker/ucp \
install [command options]
If you are installing on a public cloud platform, there is cloud specific MKE installation documentation:
Option | Description |
---|---|
--debug, -D |
Enable debug mode |
--jsonlog |
Produce json formatted output for easier parsing. |
--interactive, -i |
Run in interactive mode and prompt for configuration values. |
--admin-password value |
The MKE administrator password [$UCP_ADMIN_PASSWORD]. |
--admin-username value |
The MKE administrator username [$UCP_ADMIN_USER]. |
--azure-ip-count value |
Configure the Number of IP Address to be provisioned for each Azure Virtual Machine (default: “128”). |
binpack |
Set the Docker Swarm scheduler to binpack mode. Used for backwards compatibility. |
--cloud-provider value |
The cloud provider for the cluster. |
--cni-installer-url value |
A URL pointing to a kubernetes YAML file to be used as an installer for the CNI plugin of the cluster. If specified, the default CNI plugin will not be installed. If the URL is using the HTTPS scheme, no certificate verification will be performed |
--controller-port value |
Port for the web UI and API (default: 443). |
--data-path-addr value |
Address or interface to use for data path traffic. Format: IP address or network interface name [$UCP_DATA_PATH_ADDR]. |
--disable-tracking |
Disable anonymous tracking and analytics. |
--disable-usage |
Disable anonymous usage reporting. |
--dns-opt value |
Set DNS options for the MKE containers [$DNS_OPT]. |
--dns-search value |
Set custom DNS search domains for the MKE containers [$DNS_SEARCH]. |
--dns value |
Set custom DNS servers for the MKE containers [$DNS]. |
--enable-profiling |
Enable performance profiling. |
--existing-config |
Use the latest existing MKE config during this installation. The install will fail if a config is not found. |
--external-server-cert |
Customize the certificates used by the MKE web server. |
--external-service-lb value |
Set the IP address of the load balancer that published services are expected to be reachable on. |
--force-insecure-tcp |
Force install to continue even with unauthenticated MCR ports. |
--force-minimums |
Force the install/upgrade even if the system does not meet the minimum requirements. |
--host-address value |
The network address to advertise to other nodes. Format: IP address or network interface name [$UCP_HOST_ADDRESS]. |
--iscsiadm-pathvalue value |
Path to the host iscsiadm binary. This option is applicable only when –storage-iscsi is specified. |
--kube-apiserver-port value |
Port for the Kubernetes API server (default: 6443). |
--kv-snapshot-count value |
Number of changes between key-value store snapshots (default: 20000) [$KV_SNAPSHOT_COUNT]. |
--kv-timeout value |
Timeout in milliseconds for the key-value store (default: 5000) [$KV_TIMEOUT]. |
--license value |
Add a license: e.g. –license “$(cat license.lic)” [$UCP_LICENSE]. |
--nodeport-range value |
Allowed port range for Kubernetes services of type NodePort (Default: 32768-35535) (default: “32768-35535”). |
--pod-cidr value |
Kubernetes cluster IP pool for the pods to allocated IP from (Default: 192.168.0.0/16) (default: “192.168.0.0/16”). |
--preserve-certs |
Don’t generate certificates if they already exist. |
--pull value |
Pull MKE images: ‘always’, when ‘missing’, or ‘never’ (default: “missing”). |
--random |
Set the Docker Swarm scheduler to random mode. Used for backwards compatibility. |
--registry-password value |
Password to use when pulling images [$REGISTRY_PASSWORD]. |
--registry-username value |
Username to use when pulling images [$REGISTRY_USERNAME]. |
--san value |
Add subject alternative names to certificates (e.g. –san www1.acme.com –san www2.acme.com) [$UCP_HOSTNAMES]. |
--service-cluster-ip-range value |
Kubernetes Cluster IP Range for Services (default: “10.96.0.0/16”). |
--skip-cloud-provider-check |
Disables checks which rely on detecting which (if any) cloud provider the cluster is currently running on. |
--storage-expt-enabled |
Flag to enable experimental features in Kubernetes storage. |
--storage-iscsi |
Enable ISCSI based Persistent Volumes in Kubernetes. |
--swarm-experimental |
Enable Docker Swarm experimental features. Used for backwards compatibility. |
--swarm-grpc-port value |
Port for communication between nodes (default: 2377). |
--swarm-port value |
Port for the Docker Swarm manager. Used for backwards compatibility (default: 2376). |
--unlock-key value |
The unlock key for this swarm-mode cluster, if one exists. [$UNLOCK_KEY]. |
--unmanaged-cni |
Flag to indicate if cni provider is calico and managed by MKE (calico is the default CNI provider). |