Bootstrap a management cluster

After you complete the prerequisite steps described in Prerequisites, proceed with bootstrapping your Mirantis Container Cloud management cluster based on the Equinix Metal provider.

To bootstrap an Equinix Metal based management cluster:

  1. Log in to the bootstrap node running Ubuntu 18.04 that is configured as described in Prerequisites.

  2. Prepare the bootstrap script:

    1. Download and run the Container Cloud bootstrap script:

      chmod 0755
    2. Change the directory to the kaas-bootstrap folder created by the script.

  3. Obtain your license file that will be required during the bootstrap:

    1. Create a user account at

    2. Log in to your account and download the mirantis.lic license file.

    3. Save the license file as mirantis.lic under the kaas-bootstrap directory on the bootstrap node.

  4. Prepare the Equinix Metal configuration:

    1. Log in to the Equinix Metal console.

    2. Select the project that you want to use for the Container Cloud deployment.

    3. In Project Settings > General, capture your Project ID.

    4. In Profile Settings > Personal API Keys, capture the existing user-level API Key or create a new one:

      1. In Profile Settings > Personal API Keys, click Add New Key.

      2. Fill in the Description and select the Read/Write permissions.

      3. Click Add Key.

    5. Change the directory to kaas-bootstrap.

    6. In templates/equinix/equinix-config.yaml.template, modify spec:projectID and spec:apiToken:value using the values obtained in the previous steps. For example:

        projectID: g98sd6f8-dc7s-8273-v8s7-d9v7395nd91
          value: Bi3m9c7qjYBD3UgsnSCSsqs2bYkbK
    7. In templates/equinix/cluster.yaml.template, modify the default configuration of the Equinix Metal facility depending on the previously prepared capacity settings:

          facility: am6

      Also, modify other parameters as required.

    8. Optional. In templates/equinix/machines.yaml.template, modify the default configuration of the Equinix Metal machine type. The minimal required type is c3.small.x86.

          machineType: c3.small.x86

      Also, modify other parameters as required.

  5. Optional. Configure the regional NTP server parameters to be applied to all machines of regional and managed clusters in the specified region.

    In templates/equinix/cluster.yaml.template, add the ntp:servers section with the list of required servers names:

              - helmReleases:
                - name: equinix-provider
                provider: equinixmetal
  6. Export the following parameter:

    export KAAS_EQUINIX_ENABLED=true
  7. If you require all Internet access to go through a proxy server, in bootstrap.env, add the following environment variables to bootstrap the management and regional cluster using proxy:



    • NO_PROXY

    Example snippet:

    export HTTP_PROXY=
    export HTTPS_PROXY=
    export NO_PROXY=,registry.internal.lan

    The following variables formats are accepted:

    Proxy configuration data





    • - for anonymous access

    • - for restricted access

    • NO_PROXY

    Comma-separated list of IP addresses or domain names

    For the list of Mirantis resources and IP addresses to be accessible from the Container Cloud clusters, see Requirements for an Equinix Metal based cluster.

  8. Optional. Configure external identity provider for IAM.

  9. Optional. If you are going to use your own TLS certificates for Keycloak, set DISABLE_OIDC=true in bootstrap.env.

  10. Re-verify that the selected Equinix Metal facility for the management cluster bootstrap is still available and has enough capacity:

    packet-cli capacity check --facility $EQUINIX_FACILITY --plan $EQUINIX_MACHINE_TYPE --quantity $MACHINES_AMOUNT

    In the system response, if the value in the AVAILABILITY section has changed from true to false, find an available facility and update the previously configured facility field in cluster.yaml.template.

    For details about the verification procedure, see Verify the capacity of the Equinix Metal facility.

  11. Run the bootstrap script:

    ./ all

    In case of deployment issues, refer to Troubleshooting. If the script fails for an unknown reason:

    1. Run the cleanup script:

      ./ cleanup
    2. Rerun the bootstrap script.


    If the bootstrap fails on the Connecting to bootstrap cluster step with the unable to initialize Tiller in bootstrap cluster: failed to establish connection with tiller error, refer to the known issue 16873 to identify possible root cause of the issue and apply the workaround, if applicable.

  12. When the bootstrap is complete, collect and save the following management cluster details in a secure location:

    • The kubeconfig file located in the same directory as the bootstrap script. This file contains the admin credentials for the management cluster.

    • The private ssh_key for access to the management cluster nodes that is located in the same directory as the bootstrap script.


      If the initial version of your Container Cloud management cluster was earlier than 2.6.0, ssh_key is named openstack_tmp and is located at ~/.ssh/.

    • The URL for the Container Cloud web UI. Before the first login, create users with required permissions as described in Create initial users after a management cluster bootstrap.

    • The StackLight endpoints. For details, see Access StackLight web UIs.

    • The Keycloak URL that the system outputs when the bootstrap completes. The admin password for Keycloak is located in kaas-bootstrap/passwords.yml along with other IAM passwords.


    The Container Cloud web UI communicates with Keycloak to authenticate users. Keycloak is exposed using HTTPS and self-signed TLS certificates that are not trusted by web browsers.

    To use your own TLS certificates for Keycloak, refer to Configure TLS certificates for management cluster applications.


    When the bootstrap is complete, the bootstrap cluster resources are freed up.

  13. Optional. Deploy an additional regional cluster of a different provider type or configuration as described in Deploy an additional regional cluster (optional).

Now, you can proceed with operating your management cluster using the Container Cloud web UI and deploying managed clusters as described in Create and operate an Equinix Metal based managed cluster.