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 18.04 that is configured as described in Prerequisites.
Prepare the bootstrap script:
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
Change the directory to the kaas-bootstrap folder created by the script.
Obtain your license file that will be required during the bootstrap:
Create a user account at www.mirantis.com.
Log in to your account and download the mirantis.lic license file.
Save the license file as mirantis.lic under the kaas-bootstrap
directory on the bootstrap node.
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 18.04 from the required AWS region. For example:
spec:
providerSpec:
value:
apiVersion: aws.kaas.mirantis.com/v1alpha1
kind: AWSMachineProviderSpec
instanceType: c5d.2xlarge
ami:
id: ami-033a0960d9d83ead0
Also, modify other parameters as required.
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
# in MiB
minMemory: 16384
# in GB
minStorage: 120
supportedArchitectures:
- "x86_64"
filters:
- name: instance-storage-info.disk.type
values:
- "ssd"
allowedAMIs:
-
- name: name
values:
- "ubuntu/images/hvm-ssd/ubuntu-bionic-18.04-amd64-server-20200729"
- name: owner-id
values:
- "099720109477"
Also, modify other parameters as required.
Optional. 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 servers names:
spec:
...
providerSpec:
value:
kaas:
...
regional:
- helmReleases:
- name: aws-provider
values:
config:
lcm:
...
ntp:
servers:
- 0.pool.ntp.org
...
provider: aws
...
Generate the AWS Access Key ID with Secret Access Key for the admin
user 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 admin 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.
./kaas bootstrap aws policy
If you do not have access to create the CloudFormation stack, users, or policies:
Log in to your AWS Management Console.
On the home page, expand the upper right menu with your user name and capture your Account ID.
Create the CloudFormation template:
./kaas bootstrap aws policy --account-id <accountId> --dump > cf.yaml
Substitute the parameter enclosed in angle brackets with the corresponding value.
Send the cf.yaml template to your AWS account admin to create
the CloudFormation stack from this template.
Configure the bootstrapper.cluster-api-provider-aws.kaas.mirantis.com
user created in the previous steps:
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.
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
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
The following variables formats are accepted:
Variable |
Format |
|---|---|
|
|
|
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 AWS-based cluster.
Optional. Configure external identity provider for IAM.
Optional. If you are going to use your own TLS certificates for Keycloak,
set DISABLE_OIDC=true in bootstrap.env.
Run the bootstrap script:
./bootstrap.sh all
In case of deployment issues, refer to Troubleshooting. If the script fails for an unknown reason:
Run the cleanup script:
./bootstrap.sh cleanup
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 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.
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 Create and operate an AWS-based managed cluster.
Using the same management cluster, you can also deploy managed clusters that are based on the Equinix Metal cloud provider. For details, see Create and operate an Equinix Metal based managed cluster.