⚠️ 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
⚠️ Make sure to add an Ondat licence after installing.
⚠️ Make sure you have a running Google Anthos 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 Google Anthos cluster use
ubuntu_containerdas the default node operating system. This node operating system image has the required kernel modules available for Ondat to run successfully.
Step 1 - Conducting Preflight Checks
- Run the following command to conduct preflight checks against the Google Anthos cluster to validate that Ondat prerequisites have been met before attempting an installation.
kubectl storageos preflight
Step 2 - Installing Ondat
- Define and export the
STORAGEOS_PASSWORDenvironment variables that will be used to manage your Ondat instance.
export STORAGEOS_USERNAME="storageos" export STORAGEOS_PASSWORD="storageos"
- Run the following
kubectl-storageosplugin command to install Ondat.
⚠️ If you are installing Ondat and connecting to an existing etcd cluster, then you must include the
--skip-etcd-endpoints-validationflag in the bash script below.
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
kubectlcommands to inspect Ondat’s resources (the core components should all be in a
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.