OpenShift via Marketplace

Walkthrough guide to install Ondat onto an OpenShift Cluster via the Red Hat marketplace

Overview

This guide will demonstrate how to install Ondat onto an Openshift cluster using the Ondat kubectl plugin.

Prerequisites

⚠️ Make sure the prerequisites for Ondat are satisfied before proceeding. Including the deployment of an etcd cluster and configuration of CRI-O PID limits.

⚠️ If you have installed OpenShift in AWS ensure that the requisite ports are opened for the worker nodes' security group.

⚠️ Make sure to add an Ondat licence after installing. You can request a licence via the Ondat SaaS Platform.

💡 For OpenShift upgrades, refer to the OpenShift platform page.

Ondat v2 supports OpenShift v4. For more information, see the OpenShift platform page.

installation of Ondat via Red Hat Marketplace

Step 1: Red Hat Markerplace

⚠️ The installation of Ondat using the Red Hat Marketplace requires the Openshift cluster to be registered to the Marketplace Portal, including the roll out of the PullSecret in your cluster. Failure to do so will result in a image pull authentication failure with the Red Hat registry.

  1. Select the OperatorHub from the Catalog sub menu and search for StorageOS.

    💡 Choose the RedHat Marketplace option.

  2. Select StorageOS and click Purchase. Note that Openshift needs to be registered with the Red Hat Marketplace portal.

  3. Select the relevant install option.

    💡 Project Edition is suitable for production workloads, Developer Edition for personal experimentation and evaluation.

  4. Specify the product configuration to fit your needs.

  5. Navigate to your software within Red Hat Marketplace and install the StorageOS software as specified in the image.

  6. Install the Operator. Set the update approval strategy to Automatic to ensure that you always have the latest version of StorageOS installed.

The Ondat Cluster Operator is installed into your specified cluster.

Step 2: Authentication

  1. Create a Secret in the openshift-operators project and select the YAML option to create a secret containing the username and an password key. The username and password defined in the secret will be used to authenticate when using the Ondat CLI and GUI. Take note of which project you created the secret in.

    Input the secret as YAML for simplicity.

    apiVersion: v1
    kind: Secret
    metadata:
      name: storageos-api
      namespace: openshift-operators
    type: "kubernetes.io/storageos"
    data:
      # echo -n '<secret>' | base64
      username: c3RvcmFnZW9z
      password: c3RvcmFnZW9z
    
  2. Navigate to StorageOS on your Installed Operators tab.

    💡 Verify that the StorageOS Cluster Operator is installed.

  3. Open to the StorageOS Cluster tab and click Create StorageOSCluster.

    💡 A StorageOSCluster is defined using a Custom Resource(CR) Definition.

  4. Create the CR Definition:

    The Ondat cluster resource describes the Ondat cluster that will be created. Parameters such as the secretRefName, the secretRefNamespace and the kvBackend.address are mandatory.

    💡 Additional spec parameters are available on the Cluster Operator configuration page.

    apiVersion: "storageos.com/v1"
    kind: StorageOSCluster
    metadata:
      name: storageos
      namespace: openshift-operators
    spec:
      # Ondat Pods are in kube-system by default
      secretRefName: "storageos-api" # Reference the Secret created in the previous step
      secretRefNamespace: "openshift-operators"  # Namespace of the Secret created in the previous step
      k8sDistro: "openshift"
      kvBackend:
        address: 'storageos-etcd-client.etcd:2379' # Example address, change for your etcd endpoint
      # address: '10.42.15.23:2379,10.42.12.22:2379,10.42.13.16:2379' # You can set ETCD server ips
      resources:
        requests:
          memory: "512Mi"
          cpu: 1
      # nodeSelectorTerms:
      #   - matchExpressions:
      #     - key: "node-role.kubernetes.io/worker" # Compute node label will vary according to your installation
      #       operator: In
      #       values:
      #       - "true"
    
  5. Verify that the StorageOS Cluster status is Running.

    💡 It can take up to a minute to report the Ondat Pods ready.

  6. Check the StorageOS Pods in the kube-system project.

    💡 A Status of 3/3 in the Ready column for the Daemonset Pods indicates that Ondat is bootstrapped successfully.

License cluster

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

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

First Ondat volume

If this is your first installation you may wish to follow the Ondat volume guide for an example of how to mount an Ondat volume in a Pod.