On the computer that will be used for the installation, you need to install:
wk can load a valid entitlements file.
Please ensure the nodes fulfill the requirements described in cluster node requirements.
If your cluster has multiple control plane nodes, to ensure high availability it is recommended to setup a control plane load balancer.
First, create a directory which will contain the cluster management scripts and binaries.
The main configuration file will be unpacked at
The required values are your git provider organization or user, your Docker Hub user, and an absolute path to a file containing your Docker Hub password:
dockerIOPasswordFile in your
setup/config.yaml. (See Git Config Repository for details about git parameters)
track field to
wks-ssh, and optionally, set the
wksConfig section you can specify the version and other configuration for your cluster
depending on your infrastructure.
wksConfig.sshConfig section, please provide a
sshUser that has passwordless sudo access to your nodes, and
the path to the matching private
machines array, specify the
role of each node, and its private and public IP address. At least 1
worker node is required.
If you have a load balancer configured to route api-server (
:6443) traffic to all of the
master nodes specified in
machines, you can provide its public IP Address in
wksConfig.controlPlaneLbAddress. (See Control plane load balancers for details.)
WKP uses a personal access token to create the cluster repository on GitHub. The token needs to have permissions in
repo scope. The github documentation on how to create one can be found on this page. Once you have created one,
set the environment variable for it:
If you would like to run EKS-D in your cluster using the experimental support for EKS-D in WKP, please follow the instructions at: Using the EKS-D Kubernetes distribution
Now we are ready to install the cluster:
To expose the WKP UI via wk ui command, run:
You should now be able to view it at http://localhost:8090
To expose the WKP UI to a different port other than the default, run:
To access the WKP UI via its assigned ingress, get the allocated address:
and navigate to it from your browser.
In this example the address is
You can use the