Installing a cluster on AWS with network customizations

If you do not have an existing SSH key pair on your local machine to use for authentication onto your cluster nodes, create one. For example, on a computer that uses a Linux operating system, run the following command:

$ ssh-keygen -t ed25519 -N '' -f <path>/<file_name> (1)

View the public SSH key:

$ cat <path>/<file_name>.pub

$ cat ~/.ssh/id_ed25519.pub

Add the SSH private key identity to the SSH agent for your local user, if it has not already been added. SSH agent management of the key is required for password-less SSH authentication onto your cluster nodes, or if you want to use the ./openshift-install gather command.

Add your SSH private key to the ssh-agent:

$ ssh-add <path>/<file_name> (1)

Identity added: /home/<you>/<path>/<file_name> (<computer_name>)

Go to the Cluster Type page on the Red Hat Hybrid Cloud Console. If you have a Red Hat account, log in with your credentials. If you do not, create an account.

Select your infrastructure provider from the Run it yourself section of the page.

Select your host operating system and architecture from the dropdown menus under OpenShift Installer and click Download Installer.

Place the downloaded file in the directory where you want to store the installation configuration files.

Extract the installation program. For example, on a computer that uses a Linux operating system, run the following command:

$ tar -xvf openshift-install-linux.tar.gz

Download your installation pull secret from Red Hat OpenShift Cluster Manager. This pull secret allows you to authenticate with the services that are provided by the included authorities, including Quay.io, which serves the container images for OpenShift Container Platform components.

Create the install-config.yaml file.

Modify the install-config.yaml file. You can find more information about the available parameters in the "Installation configuration parameters" section.

Back up the install-config.yaml file so that you can use it to install multiple clusters.

Navigate to the OpenShift Container Platform downloads page on the Red Hat Customer Portal.

Select the architecture from the Product Variant drop-down list.

Select the appropriate version from the Version drop-down list.

Click Download Now next to the OpenShift v4.15 Linux Client entry and save the file.

Unpack the archive:

$ tar xvf <file>

Place the oc binary in a directory that is on your PATH.

$ echo $PATH

Navigate to the OpenShift Container Platform downloads page on the Red Hat Customer Portal.

Select the appropriate version from the Version drop-down list.

Click Download Now next to the OpenShift v4.15 Windows Client entry and save the file.

Unzip the archive with a ZIP program.

Move the oc binary to a directory that is on your PATH.

C:\> path

Navigate to the OpenShift Container Platform downloads page on the Red Hat Customer Portal.

Select the appropriate version from the Version drop-down list.

Click Download Now next to the OpenShift v4.15 macOS Client entry and save the file.

Unpack and unzip the archive.

Move the oc binary to a directory on your PATH.

$ echo $PATH

Change to the directory that contains the installation program and create the manifests:

$ ./openshift-install create manifests --dir <installation_directory> (1)

Create a stub manifest file for the advanced network configuration that is named cluster-network-03-config.yml in the <installation_directory>/manifests/ directory:

apiVersion: operator.openshift.io/v1
kind: Network
metadata:
  name: cluster
spec:

Specify the advanced network configuration for your cluster in the cluster-network-03-config.yml file, such as in the following example:

apiVersion: operator.openshift.io/v1
kind: Network
metadata:
  name: cluster
spec:
  defaultNetwork:
    ovnKubernetesConfig:
      ipsecConfig:
        mode: Full

Optional: Back up the manifests/cluster-network-03-config.yml file. The installation program consumes the manifests/ directory when you create the Ignition config files.

Change to the directory that contains the installation program and create the manifests:

$ ./openshift-install create manifests --dir <installation_directory> (1)

Create a file that is named cluster-ingress-default-ingresscontroller.yaml in the <installation_directory>/manifests/ directory:

$ touch <installation_directory>/manifests/cluster-ingress-default-ingresscontroller.yaml (1)

$ ls <installation_directory>/manifests/cluster-ingress-default-ingresscontroller.yaml

cluster-ingress-default-ingresscontroller.yaml

Open the cluster-ingress-default-ingresscontroller.yaml file in an editor and enter a custom resource (CR) that describes the Operator configuration you want:

apiVersion: operator.openshift.io/v1
kind: IngressController
metadata:
  creationTimestamp: null
  name: default
  namespace: openshift-ingress-operator
spec:
  endpointPublishingStrategy:
    loadBalancer:
      scope: External
      providerParameters:
        type: AWS
        aws:
          type: NLB
    type: LoadBalancerService

Save the cluster-ingress-default-ingresscontroller.yaml file and quit the text editor.

Optional: Back up the manifests/cluster-ingress-default-ingresscontroller.yaml file. The installation program deletes the manifests/ directory when creating the cluster.

Change to the directory that contains the installation program and create the manifests:

$ ./openshift-install create manifests --dir <installation_directory>

Create a stub manifest file for the advanced network configuration that is named cluster-network-03-config.yml in the <installation_directory>/manifests/ directory:

$ cat <<EOF > <installation_directory>/manifests/cluster-network-03-config.yml
apiVersion: operator.openshift.io/v1
kind: Network
metadata:
  name: cluster
spec:
EOF

Open the cluster-network-03-config.yml file in an editor and configure OVN-Kubernetes with hybrid networking, as in the following example:

apiVersion: operator.openshift.io/v1
kind: Network
metadata:
  name: cluster
spec:
  defaultNetwork:
    ovnKubernetesConfig:
      hybridOverlayConfig:
        hybridClusterNetwork: (1)
        - cidr: 10.132.0.0/14
          hostPrefix: 23
        hybridOverlayVXLANPort: 9898 (2)

Save the cluster-network-03-config.yml file and quit the text editor.

Optional: Back up the manifests/cluster-network-03-config.yml file. The installation program deletes the manifests/ directory when creating the cluster.

Change to the directory that contains the installation program and initialize the cluster deployment:

$ ./openshift-install create cluster --dir <installation_directory> \ (1)
    --log-level=info (2)

Optional: Remove or disable the AdministratorAccess policy from the IAM account that you used to install the cluster.

Export the kubeadmin credentials:

$ export KUBECONFIG=<installation_directory>/auth/kubeconfig (1)

Verify you can run oc commands successfully using the exported configuration:

$ oc whoami

system:admin

Obtain the password for the kubeadmin user from the kubeadmin-password file on the installation host:

$ cat <installation_directory>/auth/kubeadmin-password

List the OpenShift Container Platform web console route:

$ oc get routes -n openshift-console | grep 'console-openshift'

console     console-openshift-console.apps.<cluster_name>.<base_domain>            console     https   reencrypt/Redirect   None

Navigate to the route detailed in the output of the preceding command in a web browser and log in as the kubeadmin user.