Installation guides

Prerequisites and infrastructure

• GKE on-prem installation guides overview

  Learn about the various ways to install GKE on-prem and create your user clusters.

• vSphere requirements

  Get your vSphere environment ready for GKE on-prem.

• vSphere network

  Learn about the networking requirements for an initial installation of GKE on-prem.

• Proxy and firewall rules

  Add addresses to an allowlist for your proxy and set up firewall rules for GKE on-prem.

• Setting up Seesaw load balancers

  Set up the Seesaw load balancer in your vSphere environment.

Installing GKE on-prem

• Installing Google Cloud CLI

  Install Google Cloud CLI tools that you need to install and use GKE on-prem.

• Configuring your Google Cloud project

  Get your Google Cloud project ready for GKE on-prem.

• Creating an admin workstation

  Create an admin workstation that you can use to install GKE on-prem.

• Creating an admin cluster (basic)

  Create an admin cluster.

• Creating a user cluster (basic)

  Create a user cluster.

Getting started with a user cluster

• Deploying your first application

  Create a Kubernetes Deployment in your user cluster.

• Enabling ingress

  Enable ingress in your GKE on-prem user cluster.

• Creating a Service and an Ingress

  Create a Deployment, Service, and Ingress in your user cluster.

• Connecting to a cluster from the Google Cloud console

  Log in to your cluster to manage it from the Google Cloud console.

Configuration files

• Overview of configuration files

  High level overview of configuration files.

• Admin workstation configuration file

  Learn about the fields in the admin workstation configuration file.

• Admin cluster configuration file

  Learn about the fields in the admin cluster configuration file.

• User cluster configuration file

  Learn about the fields in the user cluster configuration file.

• Host configuration file

  Learn about the fields in a host configuration file.

• Old cluster configuration file

  Learn about the fields in the cluster configuration file that was used in GKE on-prem versions 1.3 and earlier.

Advanced installation guides

• Advanced installation guides overview

  Learn about advanced options for installing a GKE on-prem cluster.

• CPU, RAM, and storage requirements

  Learn how resource requirements depend on the sizes of your clusters.

• Resources available for your workloads

  Learn about CPU and RAM resources available for your Pods.

• Using multiple Google Cloud projects

  Learn about using multiple Google Cloud projects with GKE on-prem.

• Service accounts and keys

  Learn about the Google Cloud service accounts and keys that you need to install GKE on-prem.

• Running preflight checks

  Run preflight checks against your GKE on-prem configuration file before you create your clusters.

• Creating an admin cluster (advanced)

  Create an admin cluster.

• Creating a user cluster (advanced)

  Create a user cluster.

Advanced load balancing installation guides

• Setting up your load balancer for GKE on-prem

  Learn about the different ways you can configure load balancing.

• Bundled load balancing with Seesaw

  Configure GKE on-prem to run in bundled load balancing mode.

• Enabling manual load balancing mode

  Learn how to use manual load balancing mode as an alternative to integrated mode.

• Manual load balancing with Citrix

  Configure the Citrix load balancer for a GKE on-prem cluster using manual mode.

Advanced security installation guides

• Authenticating with OIDC

  Use OpenID Connect to authenticate clients of a user cluster.

• Authenticating with OIDC and AD FS

  Use OpenID Connect and Active Directory Federation Services to authenticate clients of a user cluster.

• Authenticating with OIDC and Google

  Use OpenID Connect and the Google OpenID provider to authenticate clients of a user cluster.

Old installation guides

• Creating an admin workstation with a static IP address

  Create an admin workstation that you can use to install GKE on-prem.

• Installing using static IP addresses

  Install GKE on-prem if you have chosen to use static IP addresses.

• Creating an admin workstation using DHCP

  Create an admin workstation that uses Dynamic Host Configuration Protocol (DHCP) to get its IP address.

• Installing using DHCP

  Install GKE on-prem if you have chosen to use an existing DHCP server to assign IP addresses to cluster nodes.