Google Kubernetes Engine (GKE)

Overview

This guide will demonstrate how to install Ondat onto a Google Kubernetes Engine (GKE) cluster using the Ondat kubectl plugin.

💡 For users who are looking to deploy Ondat onto a Google Anthos cluster, a recommendation would be to review Google Anthos installation guide for more information.

Prerequisites

⚠️ Make sure you have met the minimum resource requirements for Ondat to successfully run. Review the main Ondat prerequisites page for more information.

⚠️ Make sure the following CLI utilities are installed on your local machine and are available in your $PATH:

⚠️ Make sure to add an Ondat licence after installing.

⚠️ Make sure you have a running GKE cluster with a minimum of 3 worker nodes and the sufficient Role-Based Access Control (RBAC) permissions to deploy and manage applications in the cluster.

⚠️ Make sure your GKE cluster uses ubuntu_containerd as the default node operating system. This node operating system image has the required kernel modules available for Ondat to run successfully.

Procedure

Step 1 - Conducting Preflight Checks

  • Run the following command to conduct preflight checks against the GKE cluster to validate that Ondat prerequisites have been met before attempting an installation.
kubectl storageos preflight

Step 2 - Installing Ondat

  1. Define and export the STORAGEOS_USERNAME and STORAGEOS_PASSWORD environment variables that will be used to manage your Ondat instance.
export STORAGEOS_USERNAME="storageos"
export STORAGEOS_PASSWORD="storageos"
  1. Run the following kubectl-storageos plugin command to install Ondat.
kubectl storageos install \
  --include-etcd \
  --etcd-tls-enabled \
  --admin-username="$STORAGEOS_USERNAME" \
  --admin-password="$STORAGEOS_PASSWORD"
  • The installation process may take a few minutes.

Step 3 - Verifying Ondat Installation

  • Run the following kubectl commands to inspect Ondat’s resources (the core components should all be in a RUNNING status)
kubectl get all --namespace=storageos
kubectl get all --namespace=storageos-etcd
kubectl get storageclasses | grep "storageos"

Step 4 - Applying a Licence to the Cluster

⚠️ Newly installed Ondat clusters must be licensed within 24 hours. Our Free Forever tier supports up to 1 TiB of provisioned storage.

To obtain a licence, follow the instructions on our licensing operations page.