A sample template for eksctl and terraform is available from the Release Information page and you can use these 'as is' or modify them to create a system according to your own requirements.

You can use this as a reference or modify according to your infrastructure standards, see Pre-installation (4.0) page for the AWS service list required for MZ installation in AWS.

Working With the Infrastructure Template

Get the latest infrastructure templates from Release Information.

Download the template file and unzip it to a new folder.
```
$ cd <your work folder>
$ tar xzvf mz10-aws.tgz
```

For EKS Cluster

Set up the VPC and EKS Cluster

Note!

If you are using Openshift cluster refer to the section for Setup - OpenShift (4.0).

The default value for the cluster name is mz-eks and region is eu-west-1

Go to the eksctl folder in the unzipped contents.
Update the following fields in the mz-eks.yaml file:

See https://github.com/weaveworks/eksctl for information about more parameters that can be used in the eksctl template

Metadata         
    name (cluster name, default to mz-eks)
    aws region (default to eu-west-1)

Worker Nodes
    instanceType (change the instant type to match your application load)
    minSize, maxSize and desiredSize (if you wish to have more nodes running)

Execute the following commands to start the creation of the EKS cluster

$ eksctl create cluster -f mz-eks.yaml --kubeconfig=./kubeconfig
$ export KUBECONFIG=`pwd`/kubeconfig

You should be able to run any kubectl commands from now on

Note!

The eksctl create command can take a considerable amount of time to be completed.

Create Resources Required for with EKS

Go to the terraform folder and copy the terraform.tfvars.example to terraform.tfvars.
```
$ cp terraform.tfvars.example terraform.tfvars
```

Retrieve the following values from AWS Console and fill in the parameters in terraform.tfvars.

terraform.tfvars	Where to get the values
aws_account_id	From AWS Console Go to My Account page and you will see the Account Id under Account Settings
aws_region	Follow as per the value configured in mz-eks.yaml Default is eu-west-1
cluster_name	Follow as per the value configured in mz-eks.yaml Default is mz-eks
db_password	Use a secure password for the platform database. Minimum 10 characters.
domain domain_zone_id	From AWS Console On the Route 53 page, find your existing Hosted Zone and copy the Hosted Zone ID and Domain Name.
vpc_id	From AWS Console On the VPC Service page, find the vpc name eksctl-mz-eks-cluster/VPC and copy the VPC ID.

#  ____  _____ _____   _____ _   _ _____ ____  _____
# / ___|| ____|_   _| |_   _| | | | ____/ ___|| ____|_
# \___ \|  _|   | |     | | | |_| |  _| \___ \|  _| (_)
#  ___) | |___  | |     | | |  _  | |___ ___) | |___ _
# |____/|_____| |_|     |_| |_| |_|_____|____/|_____(_)

# The below values must be set explicitly in order for the setup to work correctly.

vpc_id = "vpc-xxxxxxxxxxxxxxxxx"
aws_region = "eu-west-1"
aws_account_id = ""

# cluster_name.domain will be the final domain name
cluster_name = "mz-eks"
domain = "example.com"

# Route 53 Hosted Zone ID
# This should be the Zone ID of the Domain above. Ie. that domain must already exist in Route 53.
# We'll insert the nameservers of the new domain name "cluster-name.domain" as a NS record in domain's hosted zone.
domain_zone_id = ""

# Password to the database.
db_password = ""

Run the following commands:

$ terraform init
$ terraform plan
$ terraform apply

Save the output from terraform for the next step.

Installing AWS Helpers

Run the following commands by replacing the placeholders with values from the terraform output.

Placeholder	Value from terraform output
<region>	Follow as per the value configured in cluster.yaml Default is eu-west-1
<eks_domain_zone_name>	eks_domain_zone_name
<eks_domain_zone_id>	eks_domain_zone_id
<efs id>	efs_id
<cluster_name>	Follow as per the value configured in cluster.yaml Default is mz-eks

See https://github.com/kubernetes-sigs/aws-efs-csi-driver for information on how to install Amazon EFS CSI Driver as follows:

$ helm repo add aws-efs-csi-driver https://kubernetes-sigs.github.io/aws-efs-csi-driver/
$ helm repo update
$ helm upgrade --install aws-efs-csi-driver --namespace <namespace> aws-efs-csi-driver/aws-efs-csi-driver

If you need to dynamically provision persistent volume claim (PVC) through Amazon EFS access points, see https://github.com/kubernetes-sigs/aws-efs-csi-driver/tree/master/examples/kubernetes/dynamic_provisioning for information on how to install the storage class.
Below is an example of a storage class yaml setup:
```
kind: StorageClass
apiVersion: storage.k8s.io/v1
metadata:
  name: aws-efs
provisioner: efs.csi.aws.com
parameters:
  provisioningMode: efs-ap
  fileSystemId: <efs id>
  directoryPerms: "700"
```

See https://github.com/bitnami/charts/tree/master/bitnami/external-dns for information on how to install External DNS as follows:

$ helm repo add bitnami https://charts.bitnami.com/bitnami
$ helm repo update
$ helm upgrade --install external-dns bitnami/external-dns \
-n <namespace> \
--set provider=aws \
--set aws.zoneType=public \
--set txtOwnerId=<eks_domain_zone_id> \
--set "domainFilters[0]=<eks_domain_zone_name>" \
--set policy=sync

See https://github.com/aws/eks-charts/tree/master/stable/aws-load-balancer-controller for information on how to install AWS Load Balancer Controller as follows:

$ helm repo add eks https://aws.github.io/eks-charts
$ helm repo update
$ helm install aws-load-balancer-controller eks/aws-load-balancer-controller \
-n <namespace> \
--set clusterName=<cluster_name>

Create a custom values yaml and populate it with the following information, which will be used in NGINX ingress controller installation:

ingress-nginx-values.yaml

controller:
  scope:
    enabled: true
  admissionWebhooks:
    enabled: false
  metrics:
    enabled: false
    serviceMonitor:
      enabled: false
  ingressClassResource:
    name: nginx
    enabled: true
    default: false
    controllerValue: "k8s.io/ingress-nginx"
    watchIngressWithoutClass: false
  service:
    targetPorts:
      http: 80
      https: 443
    type: NodePort
  extraArgs:
    v: 1
  containerSecurityContext:
    runAsUser: 101
    allowPrivilegeEscalation: true
serviceAccount:
  create: false

Install NGINX chart with custom values yaml:

See https://github.com/kubernetes/ingress-nginx/releases for the released NGINX helm chart version.

If you are running multiple installations on the cluster, in case the Nginx IngressClass resource is already installed, then you should add the following to your helm command to avoid hitting a resource already exists error.

--set controller.ingressClassResource.enabled=false

$ helm repo add ingress-nginx https://kubernetes.github.io/ingress-nginx
$ helm repo update
$ helm install <release name> ingress-nginx/ingress-nginx --version <NGINX helm chart version> -f ingress-nginx-values.yaml -n <namespace>

For Openshift Cluster

These installation steps are only applicable if you are using an Openshift cluster on your AWS. The following procedures and steps are specific to Openshift clusters.

Set up Openshift Cluster

To set up the Openshift cluster on your AWS, see https://docs.openshift.com/container-platform/4.7/installing/installing_aws/installing-aws-default.html.

Note!

It is important that you explicitly set up the SCC with the following strategies:

RunAsAny for RUNASUSER
RunAsAny for FSGROUP

You should also bind your SCC to a Service Account for Openshift. To point into using your defined Service Account, you can modify the serviceAccountName properties in values.yaml file to your own.

Warning!

You are required to give your Service Account Name the nonroot access to allow for the installation of . You may use the following command to grant the nonroot access to your Service Account Name.

oc adm policy add-scc-to-user nonroot -z <service account name> -n <namespace>

Create Resources Required for with Openshift

Once you have successfully set up the cluster, proceed with the following steps:

Go to the terraform folder and copy the terraform.tfvars.example to terraform.tfvars.
```
$ cp terraform.tfvars.example terraform.tfvars
```

Retrieve the following values from AWS Console and fill in the parameters in terraform.tfvars.

terraform.tfvars	Where to get the values
aws_account_id	From AWS Console Go to My Account page and you will see the Account Id under Account Settings
aws_region	Follow as per the value configured in mz-eks.yaml Default is eu-west-1
cluster_name	Follow as per the value configured in mz-eks.yaml Default is mz-eks
db_password	Use a secure password for the platform database. Minimum 10 characters.
domain domain_zone_id	From AWS Console On the Route 53 page, find your existing Hosted Zone and copy the Hosted Zone ID and Domain Name.
vpc_id	From AWS Console On the VPC Service page, find the vpc name where your Openshift cluster is located and copy the VPC ID.

Comment out the following line from kms.tf file. The role will not exist in this instance.

   principals {
      type  = "AWS"
      identifiers = ["arn:aws:iam::${var.aws_account_id}:role/aws-service-role/autoscaling.amazonaws.com/AWSServiceRoleForAutoScaling"]

    }

Run the following commands:

$ terraform init
$ terraform plan
$ terraform apply

Save the output from terraform for the next step.

Installing AWS Helpers

Run the following commands by replacing the placeholders with values from the terraform output.

Placeholder	Value from terraform output
<region>	Follow as per the value configured in cluster.yaml Default is eu-west-1
<eks_domain_zone_name>	eks_domain_zone_name
<eks_domain_zone_id>	eks_domain_zone_id
<efs id>	efs_id
<cluster_name>	Follow as per the value configured in cluster.yaml Default is mz-eks

See https://github.com/kubernetes-sigs/aws-efs-csi-driver for information on how to install Amazon EFS CSI Driver as follows:
```
$ helm repo add aws-efs-csi-driver https://kubernetes-sigs.github.io/aws-efs-csi-driver/
$ helm repo update
$ helm upgrade --install aws-efs-csi-driver --namespace <namespace> aws-efs-csi-driver/aws-efs-csi-driver
```
The efs-csi-controller-sa and efs-csi-node-sa service accounts require the privileged SCC access permission to be granted.

The driver requires IAM permission to talk to Amazon EFS to manage the volume on your behalf, hence you must set up driver permission that is mentioned in the installation steps.

See https://github.com/bitnami/charts/tree/master/bitnami/external-dns for information on how to install External DNS as follows:

$ helm repo add bitnami https://charts.bitnami.com/bitnami
$ helm repo update
$ helm upgrade --install external-dns bitnami/external-dns \
-n <namespace> \
--set provider=aws \
--set aws.zoneType=public \
--set txtOwnerId=<eks_domain_zone_id> \
--set "domainFilters[0]=<eks_domain_zone_name>" \
--set policy=sync \
--set aws.region=<region> \
--set aws.credentials.accessKey=<AWS_Access_Key> \
--set aws.credentials.secretKey=<AWS_Secret_Access_Key>

The external-dns service account requires the nonroot SCC access permission to be granted.

See https://github.com/aws/eks-charts/tree/master/stable/aws-load-balancer-controller for information on how to install AWS Load Balancer Controller as follows:

$ helm repo add eks https://aws.github.io/eks-charts
$ helm repo update
$ helm install aws-load-balancer-controller eks/aws-load-balancer-controller \
-n <namespace> \
--set clusterName=<cluster_name> \
--set region=<region> \
--set vpcId=<vpc_id> \
--set env.AWS_ACCESS_KEY_ID=<AWS_Access_Key> \
--set env.AWS_SECRET_ACCESS_KEY=<AWS_Secret_Access_Key>

The aws-load-balancer-controller service account requires the nonroot SCC access permission to be granted.

Create a custom values yaml and populate it with the following information, which will be used in NGINX ingress controller installation.

ingress-nginx-values.yaml

controller:
  scope:
    enabled: true
  admissionWebhooks:
    enabled: false
  metrics:
    enabled: false
    serviceMonitor:
      enabled: false
  ingressClassResource:
    name: nginx
    enabled: true
    default: false
    controllerValue: "k8s.io/ingress-nginx"
    watchIngressWithoutClass: false
  service:
    targetPorts:
      http: 80
      https: 443
    type: NodePort
  extraArgs:
    v: 1
  containerSecurityContext:
    runAsUser: 101
    allowPrivilegeEscalation: true
serviceAccount:
  create: false

Install NGINX chart with custom values yaml:

See https://github.com/kubernetes/ingress-nginx/releases for the released NGINX helm chart version.

If you are running multiple installations on the cluster, in case the Nginx IngressClass resource is already installed, then you should add the following to your helm command to avoid hitting a resource already exists error.

--set controller.ingressClassResource.enabled=false

$ helm repo add ingress-nginx https://kubernetes.github.io/ingress-nginx
$ helm repo update
$ helm install <release name> ingress-nginx/ingress-nginx --version <NGINX helm chart version> -f ingress-nginx-values.yaml -n <namespace>

Setup (4.0)

Working With the Infrastructure Template

For EKS Cluster

Set up the VPC and EKS Cluster

Note!

Create Resources Required for with EKS

Installing AWS Helpers

For Openshift Cluster

Set up Openshift Cluster

Note!

Warning!

Create Resources Required for with Openshift

Installing AWS Helpers