Bootstrap a management cluster

Bootstrap a management cluster

Caution

This feature is available as Technology Preview. Use such configuration for testing and evaluation purposes only. For details about the Mirantis Technology Preview support scope, see the Preface section of this guide.

Caution

This feature is available starting from the Container Cloud release 2.2.0.

Note

In scope of Technology Preview support for the VMWare vSphere cloud provider, StackLight deployed on a management cluster has limitations related to alerts and Grafana dashboards. For details, see StackLight support for VMWare vSphere.

After you complete the prerequisite steps described in Prerequisites, proceed with bootstrapping your VMWare vSphere-based Mirantis Container Cloud management cluster.

To bootstrap a vSphere-based management cluster:

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

  2. Download and run the Container Cloud bootstrap script:

    wget https://binary.mirantis.com/releases/get_container_cloud.sh
    chmod 0755 get_container_cloud.sh
    ./get_container_cloud.sh
    
  3. Change the directory to the kaas-bootstrap folder created by the get_container_cloud.sh script.

  4. Obtain your license file that will be required during the bootstrap. See step 3 in Getting Started with Mirantis Container Cloud.

  5. Save the license file as mirantis.lic under the kaas-bootstrap directory.

  6. In templates/vsphere/rhellicenses.yaml.template, set the user name and password of your RedHat Customer Portal account associated with your RHEL license for Virtual Datacenters. Optionally, specify the subscription allocation pools to use for the RHEL subscriptions activation. If you leave the pool field empty, subscription-manager will automatically select the licenses for machines.

  7. Modify templates/vsphere/vsphere-config.yaml.template:

    vSphere configuration data

    Parameter

    Description

    SET_VSPHERE_SERVER

    IP address or FQDN of the vCenter Server.

    SET_VSPHERE_SERVER_PORT

    Port of the vCenter Server. Leave empty to use 443 by default.

    SET_VSPHERE_DATACENTER

    vSphere data center name.

    SET_VSPHERE_SERVER_INSECURE

    Flag that controls validation of the vSphere Server certificate.

    SET_VSPHERE_CAPI_PROVIDER_USERNAME

    vSphere Cluster API provider user name. For details, see Prepare the VMWare deployment user setup and permissions.

    SET_VSPHERE_CAPI_PROVIDER_PASSWORD

    vSphere Cluster API provider user password.

    SET_VSPHERE_CLOUD_PROVIDER_USERNAME

    vSphere Cloud Provider deployment user name. For details, see Prepare the VMWare deployment user setup and permissions.

    SET_VSPHERE_CLOUD_PROVIDER_PASSWORD

    vSphere Cloud Provider deployment user password.

  8. Prepare the OVF template as described in Prepare the OVF template.

  9. In templates/vsphere/machines.yaml.template:

    • Define SSH_USER_NAME. The default SSH user name is cloud-user.

    • Define SET_VSPHERE_TEMPLATE_PATH prepared in the previous step.

    • Modify other parameters as required.

    spec:
      providerSpec:
        value:
          apiVersion: vsphere.cluster.k8s.io/v1alpha1
          kind: VsphereMachineProviderSpec
          sshUserName: SSH_USER_NAME
          rhelLicense: kaas-mgmt-rhel-license
          network:
            devices:
            - dhcp4: true
              dhcp6: false
          template: SET_VSPHERE_TEMPLATE_PATH
    
  10. Modify the templates/vsphere/cluster.yaml.template parameters to fit your deployment. For example, add the corresponding values for cidrBlocks in the spec::clusterNetwork::services section.

    Required parameters:

    vSphere configuration data

    Parameter

    Description

    SET_VSPHERE_DATASTORE

    Name of the vSphere datastore. You can use different datastores for vSphere Cluster API and vSphere Cloud Provider.

    SET_VSPHERE_MACHINES_FOLDER

    Path to a folder where the cluster machines metadata will be stored.

    SET_VSPHERE_NETWORK_PATH

    Path to a network for cluster machines.

    SET_VSPHERE_RESOURCE_POOL_PATH

    Path to a resource pool in which VMs will be created.

    Note

    The passwordSalt and passwordHash values for the IAM roles are automatically re-generated during the IAM configuration described in the next step.

  11. Optional. Skip this step to use the default password password in the Container Cloud web UI.

    Configure the IAM parameters:

    1. Create hashed passwords for every IAM role: reader, writer, and operator for bare metal deployments:

      ./bin/hash-generate -i 27500
      

      The hash-generate utility requests you to enter a password and outputs the parameters required for the next step. Save the password that you enter in a secure location. This password will be used to access the Container Cloud web UI with a specific IAM role.

      Example of system response:

      passwordSalt: 6ibPZdUfQK8PsOpSmyVJnA==
      passwordHash: 23W1l65FBdI3NL7LMiUQG9Cu62bWLTqIsOgdW8xNsqw=
      passwordHashAlgorithm: pbkdf2-sha256
      passwordHashIterations: 27500
      

      Run the tool several times to generate hashed passwords for every IAM role.

    2. Open templates/cluster.yaml.template for editing.

    3. In the initUsers section, add the following parameters for each IAM role that you generated in the previous step:

      • passwordSalt - base64-encoded randomly generated sequence of bytes.

      • passwordHash - base64-encoded password hash generated using passwordHashAlgorithm with passwordHashIterations. Supported algorithms include pbkdf2-sha256 and pbkdf-sha512.

  12. Optional. Configure external identity provider for IAM.

  13. Run the bootstrap script:

    ./bootstrap.sh all
    
  14. 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 openstack_tmp located in ~/.ssh/ for access to the management cluster nodes.

      Note

      The SSH key name openstack_tmp is the same for all cloud providers. This name will be changed in one of the following Container Cloud releases to avoid confusion with a cloud provider name and its related SSH key name.

    • The URL and credentials for the Container Cloud web UI. The system outputs these details when the bootstrap completes.

    • The StackLight endpoints. For details, see Operations Guide: 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.

    Note

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

Now, you can proceed with operating your management cluster using the Container Cloud web UI and deploying managed clusters as described in Create a VMWare vSphere-based managed cluster.