Skip to content

Install MKE 4 CLI (mkectl)#

Before you can proceed with the MKE 4 installation, you must download and install the MKE 4 CLI, mkectl. You can do this automatically using an install.sh script, or you can do it manually.

Important

  • Each mkectl version is tethered to a particular MKE 4 release and should only be used with that release. Thus, for example, you must use mkectl x.y.1 with MKE 4 release x.y.1 and not with MKE 4 release x.y.2. An exception to when you upgrade MKE 4 to a later release, wherein you should use the mkectl version that aligns with the target MKE 4 release.

  • You can run mkectl from within the cluster or from an external host. If you run it from an in-cluster node and an operation requires that node to restart, the restart will be deferred until the operation completes — at which point you will be informed to reboot manually.

Install automatically with a script#

  1. Install mkectl by downloading and executing the following shell script:

    sudo /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/MirantisContainers/mke-release/refs/heads/main/install.sh)"

    If you want to override default dependency versions, pass the MKECTL_VERSION as required. For example:

    sudo MKECTL_VERSION=v4.1.2 /bin/sh -c "$(curl -fsSL https://raw.githubusercontent.com/MirantisContainers/mke-release/refs/heads/main/install.sh)"

    If you prefer to run the script in the debug mode for more detailed output and logging, set DEBUG=true:

    sudo DEBUG=true /bin/sh -c "$(curl -fsSL https://raw.githubusercontent.com/MirantisContainers/mke-release/refs/heads/main/install.sh)"

  2. Confirm the installation:

    mkectl version

    Expected output:

    Version: v4.1.2

    Info

    By default, the script installs mkectl v4.1.2.

The install.sh script detects the operating system and the underlying architecture, based on which it will install the mkectl binary in /usr/local/bin. Thus, you must ensure that /usr/local/bin is in your PATH environment variable.

You can now proceed with MKE 4 cluster creation.

Install using Homebrew#

  1. Add the mirantis repository to your local taps:

    brew tap mirantis/tap

    Info

    If the mirantis tap is already present and you want to update it, run:

    brew update

  2. Install mkectl:

    • To install the latest mkectl version:

      brew install mkectl

    • To install a specific mkectl version:

      brew install mkectl@<version-number>

Install manually#

  1. Download the mkectl binary from the S3 bucket:

    Distribution Architecture Download
    Linux x86_64 download
    Linux arm64 download
    MacOS x86_64 download
    MacOS arm64 download
    Windows x86_64 download
    Windows arm64 download

  2. Ensure that the mkectl binary is executable:

    chmod +x mkectl

  3. Copy the mkectl binary to /usr/local/bin/:

    mv mkectl /usr/local/bin/