Bootstrap a management cluster¶

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

To bootstrap an AWS-based management cluster:

Log in to the bootstrap node running Ubuntu 20.04 that is configured as described in Prerequisites.
Prepare the bootstrap script:
1. Download and run the Container Cloud bootstrap script:
```
apt install wget
wget https://binary.mirantis.com/releases/get_container_cloud.sh
chmod 0755 get_container_cloud.sh
./get_container_cloud.sh
```
2. Change the directory to the kaas-bootstrap folder created by the script.
Obtain your license file that will be required during the bootstrap:
1. Create a user account at www.mirantis.com.
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. Verify that mirantis.lic contains the exact Container Cloud license previously downloaded from www.mirantis.com by decoding the license JWT token, for example, using jwt.io.
  
  Example of a valid decoded Container Cloud license data with the mandatory license field:
```
{
    "exp": 1652304773,
    "iat": 1636669973,
    "sub": "demo",
    "license": {
        "dev": false,
        "limits": {
            "clusters": 10,
            "workers_per_cluster": 10
        },
        "openstack": null
    }
}
```
  Warning
  
  The MKE license does not apply to mirantis.lic. For details about MKE license, see MKE documentation.

Prepare the AWS deployment templates:

Verify access to the target cloud endpoint from Docker. For example:
```
docker run --rm alpine sh -c "apk add --no-cache curl; \
curl https://ec2.amazonaws.com"
```
The system output must contain no error records. In case of issues, follow the steps provided in Troubleshooting.
Change the directory to the kaas-bootstrap folder.
In templates/aws/machines.yaml.template, modify the spec:providerSpec:value section by substituting the ami:id parameter with the corresponding value for Ubuntu 20.04 from the required AWS region. For example:
```
spec:
  providerSpec:
    value:
      apiVersion: aws.kaas.mirantis.com/v1alpha1
      kind: AWSMachineProviderSpec
      instanceType: c5.4xlarge
      ami:
        id: ami-033a0960d9d83ead0
```
Also, modify other parameters as required.

Warning

Do not stop the AWS instances dedicated to the Container Cloud clusters to prevent data failure and cluster disaster.
Optional. In templates/aws/cluster.yaml.template, modify the values of the spec:providerSpec:value:bastion:amiId and spec:providerSpec:value:bastion:instanceType sections by setting the necessary Ubuntu AMI ID and instance type in the required AWS region respectively. For example:
```
spec:
  providerSpec:
    value:
      apiVersion: aws.kaas.mirantis.com/v1alpha1
      kind: AWSClusterProviderSpec
      bastion:
        amiId: ami-0fb653ca2d3203ac1
        instanceType: t3.micro
```

Optional. In templates/aws/cluster.yaml.template, modify the default configuration of the AWS instance types and AMI IDs for further creation of managed clusters:

providerSpec:
  value:
    ...
    kaas:
      ...
      regional:
      - provider: aws
        helmReleases:
          - name: aws-credentials-controller
            values:
              config:
                allowedInstanceTypes:
                  minVCPUs: 8
                  minMemory: 16384 # in MiB
                  minStorage: 120 # in GB
                  supportedArchitectures:
                  - "x86_64"
                  filters:
                  - name: instance-storage-info.disk.type
                    values:
                      - "ssd"
                allowedAMIs:
                -
                  - name: name
                    values:
                    - "ubuntu/images/hvm-ssd/ubuntu-focal-20.04-amd64-server-20210325"
                  - name: owner-id
                    values:
                    - "099720109477"

Also, modify other parameters as required.

Optional. Configure backups for the MariaDB database as described in Configure periodic backups of MariaDB for the OpenStack provider.
Configure NTP server.

Before Container Cloud 2.23.0, optional if servers from the Ubuntu NTP pool (*.ubuntu.pool.ntp.org) are accessible from the node where the management cluster is being provisioned. Otherwise, configure the regional NTP server parameters as described below.

Since Container Cloud 2.23.0, optionally disable NTP that is enabled by default. This option disables the management of chrony configuration by Container Cloud to use your own system for chrony management. Otherwise, configure the regional NTP server parameters as described below.
NTP configuration
Configure the regional NTP server parameters to be applied to all machines of regional and managed clusters in the specified region.

In templates/aws/cluster.yaml.template, add the ntp:servers section with the list of required server names:
spec: ... providerSpec: value: kaas: ... ntpEnabled: true regional: - helmReleases: - name: <providerName>-provider values: config: lcm: ... ntp: servers: - 0.pool.ntp.org ... provider: <providerName> ...
To disable NTP:
spec: ... providerSpec: value: ... ntpEnabled: false ...
Generate the AWS Access Key ID with Secret Access Key for the user with the IAMFullAccess permissions and select the AWS default region name. For details, see AWS General Reference: Programmatic access.

Export the following parameters by adding the corresponding values for the AWS IAMFullAccess user credentials created in the previous step:

export KAAS_AWS_ENABLED=true
export AWS_SECRET_ACCESS_KEY=XXXXXXX
export AWS_ACCESS_KEY_ID=XXXXXXX
export AWS_DEFAULT_REGION=us-east-2

For Container Cloud to communicate with the AWS APIs, create the AWS CloudFormation stack that contains properly configured IAM users and policies.

Note

If the AWS CloudFormation stack already exists in your AWS account, skip this step.
```
./container-cloud bootstrap aws policy
```
If you do not have access to create the CloudFormation stack, users, or policies:
1. Log in to your AWS Management Console.
2. On the home page, expand the upper right menu with your user name and capture your Account ID.
3. Create the CloudFormation template:
```
./container-cloud bootstrap aws policy --account-id <accountId> --dump > cf.yaml
```
  Substitute the parameter enclosed in angle brackets with the corresponding value.
4. Send the cf.yaml template to your AWS account admin to create the CloudFormation stack from this template.
  
  The generated template includes the following lists of IAM permissions:
  Node policies
  - ec2:DescribeInstances
  - ec2:DescribeRegions
  - ecr:GetAuthorizationToken
  - ecr:BatchCheckLayerAvailability
  - ecr:GetDownloadUrlForLayer
  - ecr:GetRepositoryPolicy
  - ecr:DescribeRepositories
  - ecr:ListImages
  - ecr:BatchGetImage
  Controller node policies
  - ec2:AllocateAddress
  - ec2:AssociateRouteTable
  - ec2:AttachInternetGateway
  - ec2:AuthorizeSecurityGroupIngress
  - ec2:CreateInternetGateway
  - ec2:CreateNatGateway
  - ec2:CreateRoute
  - ec2:CreateRouteTable
  - ec2:CreateSecurityGroup
  - ec2:CreateSubnet
  - ec2:CreateTags
  - ec2:CreateVpc
  - ec2:ModifyVpcAttribute
  - ec2:DeleteInternetGateway
  - ec2:DeleteNatGateway
  - ec2:DeleteRouteTable
  - ec2:DeleteSecurityGroup
  - ec2:DeleteSubnet
  - ec2:DeleteTags
  - ec2:DeleteVpc
  - ec2:DescribeAccountAttributes
  - ec2:DescribeAddresses
  - ec2:DescribeAvailabilityZones
  - ec2:DescribeInstances
  - ec2:DescribeInstanceTypes
  - ec2:DescribeInternetGateways
  - ec2:DescribeImages
  - ec2:DescribeNatGateways
  - ec2:DescribeNetworkInterfaces
  - ec2:DescribeNetworkInterfaceAttribute
  - ec2:DescribeRegions
  - ec2:DescribeRouteTables
  - ec2:DescribeSecurityGroups
  - ec2:DescribeSubnets
  - ec2:DescribeVpcs
  - ec2:DescribeVpcAttribute
  - ec2:DescribeVolumes
  - ec2:DetachInternetGateway
  - ec2:DisassociateRouteTable
  - ec2:DisassociateAddress
  - ec2:ModifyInstanceAttribute
  - ec2:ModifyNetworkInterfaceAttribute
  - ec2:ModifySubnetAttribute
  - ec2:ReleaseAddress
  - ec2:RevokeSecurityGroupIngress
  - ec2:RunInstances
  - ec2:TerminateInstances
  - tag:GetResources
  - elasticloadbalancing:CreateLoadBalancer
  - elasticloadbalancing:ConfigureHealthCheck
  - elasticloadbalancing:DeleteLoadBalancer
  - elasticloadbalancing:DescribeLoadBalancers
  - elasticloadbalancing:DescribeLoadBalancerAttributes
  - elasticloadbalancing:ModifyLoadBalancerAttributes
  - elasticloadbalancing:RegisterInstancesWithLoadBalancer
  - elasticloadbalancing:DescribeTargetGroups
  - elasticloadbalancing:CreateTargetGroup
  - elasticloadbalancing:DeleteTargetGroup
  - elasticloadbalancing:DescribeListeners
  - elasticloadbalancing:CreateListener
  - elasticloadbalancing:DeleteListener
  - elasticloadbalancing:RegisterTargets
  - elasticloadbalancing:DeregisterTargets
  Control plane policies
  - autoscaling:DescribeAutoScalingGroups
  - autoscaling:DescribeLaunchConfigurations
  - autoscaling:DescribeTags
  - ec2:DescribeInstances
  - ec2:DescribeImages
  - ec2:DescribeRegions
  - ec2:DescribeRouteTables
  - ec2:DescribeSecurityGroups
  - ec2:DescribeSubnets
  - ec2:DescribeVolumes
  - ec2:CreateSecurityGroup
  - ec2:CreateTags
  - ec2:CreateVolume
  - ec2:ModifyInstanceAttribute
  - ec2:ModifyVolume
  - ec2:AttachVolume
  - ec2:AuthorizeSecurityGroupIngress
  - ec2:CreateRoute
  - ec2:DeleteRoute
  - ec2:DeleteSecurityGroup
  - ec2:DeleteVolume
  - ec2:DetachVolume
  - ec2:RevokeSecurityGroupIngress
  - ec2:DescribeVpcs
  - elasticloadbalancing:AddTags
  - elasticloadbalancing:AttachLoadBalancerToSubnets
  - elasticloadbalancing:ApplySecurityGroupsToLoadBalancer
  - elasticloadbalancing:CreateLoadBalancer
  - elasticloadbalancing:CreateLoadBalancerPolicy
  - elasticloadbalancing:CreateLoadBalancerListeners
  - elasticloadbalancing:ConfigureHealthCheck
  - elasticloadbalancing:DeleteLoadBalancer
  - elasticloadbalancing:DeleteLoadBalancerListeners
  - elasticloadbalancing:DescribeLoadBalancers
  - elasticloadbalancing:DescribeLoadBalancerAttributes
  - elasticloadbalancing:DetachLoadBalancerFromSubnets
  - elasticloadbalancing:DeregisterInstancesFromLoadBalancer
  - elasticloadbalancing:ModifyLoadBalancerAttributes
  - elasticloadbalancing:RegisterInstancesWithLoadBalancer
  - elasticloadbalancing:SetLoadBalancerPoliciesForBackendServer
  - elasticloadbalancing:AddTags
  - elasticloadbalancing:CreateListener
  - elasticloadbalancing:CreateTargetGroup
  - elasticloadbalancing:DeleteListener
  - elasticloadbalancing:DeleteTargetGroup
  - elasticloadbalancing:DescribeListeners
  - elasticloadbalancing:DescribeLoadBalancerPolicies
  - elasticloadbalancing:DescribeTargetGroups
  - elasticloadbalancing:DescribeTargetHealth
  - elasticloadbalancing:ModifyListener
  - elasticloadbalancing:ModifyTargetGroup
  - elasticloadbalancing:RegisterTargets
  - elasticloadbalancing:SetLoadBalancerPoliciesOfListener
  - iam:CreateServiceLinkedRole
  - kms:DescribeKey
Configure the bootstrapper.cluster-api-provider-aws.kaas.mirantis.com user created in the previous steps:
1. Using your AWS Management Console, generate the AWS Access Key ID with Secret Access Key for bootstrapper.cluster-api-provider-aws.kaas.mirantis.com and select the AWS default region name.
  
  Note
  
  Other authorization methods, such as usage of AWS_SESSION_TOKEN, are not supported.
2. Export the AWS bootstrapper.cluster-api-provider-aws.kaas.mirantis.com user credentials that were created in the previous step:
```
export KAAS_AWS_ENABLED=true
export AWS_SECRET_ACCESS_KEY=XXXXXXX
export AWS_ACCESS_KEY_ID=XXXXXXX
export AWS_DEFAULT_REGION=us-east-2
```

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:

HTTP_PROXY
HTTPS_PROXY
NO_PROXY
PROXY_CA_CERTIFICATE_PATH

Example snippet:

export HTTP_PROXY=http://proxy.example.com:3128
export HTTPS_PROXY=http://user:pass@proxy.example.com:3128
export NO_PROXY=172.18.10.0,registry.internal.lan
export PROXY_CA_CERTIFICATE_PATH="/home/ubuntu/.mitmproxy/mitmproxy-ca-cert.cer"

The following formats of variables are accepted:

Proxy configuration data¶
Variable	Format
`HTTP_PROXY` `HTTPS_PROXY`	`http://proxy.example.com:port` - for anonymous access. `http://user:password@proxy.example.com:port` - for restricted access.
`NO_PROXY`	Comma-separated list of IP addresses or domain names.
`PROXY_CA_CERTIFICATE_PATH`	Optional. Absolute path to the proxy CA certificate for man-in-the-middle (MITM) proxies. Must be placed on the bootstrap node to be trusted. For details, see Install a CA certificate for a MITM proxy on a bootstrap node. Warning If you require Internet access to go through a MITM proxy, ensure that the proxy has streaming enabled as described in Enable streaming for MITM. Note For MOSK-based deployments, the parameter is generally available since MOSK 22.4.

For implementation details, see Proxy and cache support.

For the NO_PROXY variable, also explicitly add the following addresses:

Since Container Cloud 2.21.0:

NO_PROXY=169.254.169.254,ec2.<REGION>.amazonaws.com,elb.<REGION>.amazonaws.com,elasticloadbalancing.<REGION>.amazonaws.com

Replace <REGION> with the required region name. For example, us-east-2.

Since Container Cloud 2.20.0:

NO_PROXY=10.96.0.1,169.254.169.254,ec2.<REGION>.amazonaws.com,elb.<REGION>.amazonaws.com,elasticloadbalancing.<REGION>.amazonaws.com

Replace <REGION> with the required region name. For example, us-east-2.

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

Optional. Configure external identity provider for IAM.
Optional. Enable infinite timeout for all bootstrap stages by exporting the following environment variable or adding it to bootstrap.env:
```
export KAAS_BOOTSTRAP_INFINITE_TIMEOUT=true
```
Infinite timeout prevents the bootstrap failure due to timeout. This option is useful in the following cases:
- The network speed is slow for artifacts downloading
- An infrastructure configuration does not allow booting fast
- A bare-metal node inspecting presupposes more than two HDDSATA disks to attach to a machine
Optional. Available since Container Cloud 2.23.0. Customize the cluster and region name by exporting the following environment variables or adding them to bootstrap.env:
```
export REGION=<customRegionName>
export CLUSTER_NAME=<customClusterName>
```
By default, the system uses region-one for the region name and kaas-mgmt for the management cluster name.
Run the bootstrap script:
```
./bootstrap.sh all
```
- In case of deployment issues, refer to Troubleshooting and inspect logs.
- If the script fails for an unknown reason:
  1. Run the cleanup script:
    ./bootstrap.sh cleanup
  2. Rerun the bootstrap script.
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.
  
  Note
  
  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.
  
  To create users with permissions required for accessing the Container Cloud web UI, see 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.
Note

The Container Cloud web UI and StackLight endpoints are available through Transport Layer Security (TLS) and communicate 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 cluster applications.

Note

When the bootstrap is complete, the bootstrap cluster resources are freed up.
Optional. Deploy an additional regional cluster of a different provider type 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 operate-managed-aws.