Catalog Install

StorageOS is a Certified application in the Rancher Catalog. You can install StorageOS using the Rancher application install.

Before completing the steps below, you will need an etcd cluster. For evaluations it is sufficient to use our simple test recipe. For production installations, please follow our production recipe. Make a note of the etcd endpoint URL in either case.

1. Select the System project of your cluster

   

2. Select the Apps tab and click Launch

   

3. Search for StorageOS and click on the App

   

   This will install the StorageOS operator, which manages the StorageOS DaemonSet.

4. Check and ammend installation options

   A generic configuration for StorageOS is preset using the default values in the form. Be sure to check the etcd address and ensure it matches the value you noted at the beginning of this guide.

   The catalog form exposes several useful parameters - documented below.

   For further customization, you can opt to set the option to ‘Install StorageOS Cluster’ to false and install a custom CR. See below for this.

   

5. Launch the StorageOS cluster

   

6. Verify the cluster bootstrap has successfully completed

   

7. License the newly installed cluster

   Newly installed StorageOS clusters must be licensed within 24 hours. Our personal license is free, and supports up to 1TiB of provisioned storage.

   You will need access to the StorageOS API on port 5705 of any of your nodes. For convenience, it is often easiest to port forward the service using the following kubectl incantation (this will block, so a second terminal window may be advisable):

   $ kubectl port-forward -n kube-system svc/storageos 5705
   

   Now follow the instructions on our licensing operations page to obtain and apply a license.

   Installation of StorageOS is now complete.

Simple Customization - Modify Catalog Form

The following options are exposed by the catalog form to allow some simple customization of the StorageOS installation.

• Cluster Operator namespace : The Kubernetes namespace where the StorageOS Cluster Operator and other resources will be created.
• Container Images : By default images are pulled from DockerHub, you can
• specify the image URLs when using private registries.
• Install StorageOS cluster : Controls the automatic deployment of StorageOS after installing the Cluster Operator. If set to false, the Operator will be created, but a Custom Resource will not be applied to the cluster. Launch the operator and proceed to the section Advanced Customization below.
• Namespace : The Kubernetes namespace where StorageOS will be installed. By default, StorageOS installs into the kube-system namespace, which will add a priority class to ensure high priority resource allocation. Installing StorageOS with the priority class prevents StorageOS from being evicted during periods of resource contention. It is inadvisable to modify this under normal circumstances.
• Username/Password : Default Username and Password for the admin account to be created at StorageOS bootstrap. A random password will be generated by leaving the field empty or clicking the Generate button.
• External etcd address(es) : Connection and configuration details for an external Etcd cluster.See our documentation here.
• Node Selectors and Tolerations : Control placement of StorageOS DaemonSet Pods. StorageOS will only be installed on the selected nodes.
• Tolerations : Define any tolerations you wish the DaemonSet to observe.

Advanced Customization - Apply Custom CR

If Install StorageOS Cluster was set to false, StorageOS will not be bootstrapped automatically. After the StorageOS Operator is installed, you can now create a Custom Resource that describes the StorageOS cluster.

1. Select the System Workloads and Import YAML

2. Create the Secret and CustomResource

   This is an example.

   ---
   apiVersion: v1
   kind: Secret
   metadata:
     name: "storageos-api"
     namespace: "storageos-operator"
     labels:
       app: "storageos"
   type: "kubernetes.io/storageos"
   data:
     # echo -n '<secret>' | base64
     apiUsername: c3RvcmFnZW9z
     apiPassword: c3RvcmFnZW9z
     # CSI Credentials
     csiProvisionUsername: c3RvcmFnZW9z
     csiProvisionPassword: c3RvcmFnZW9z
     csiControllerPublishUsername: c3RvcmFnZW9z
     csiControllerPublishPassword: c3RvcmFnZW9z
     csiNodePublishUsername: c3RvcmFnZW9z
     csiNodePublishPassword: c3RvcmFnZW9z
     csiControllerExpandUsername: c3RvcmFnZW9z
     csiControllerExpandPassword: c3RvcmFnZW9z
   ---
   apiVersion: "storageos.com/v1"
   kind: StorageOSCluster
   metadata:
     name: "storageos"
     namespace: "storageos-operator"
   spec:
     # StorageOS Pods are in kube-system by default
     secretRefName: "storageos-api" # Reference from the Secret created in the previous step
     secretRefNamespace: "storageos-operator"  # Namespace of the Secret
     k8sDistro: "rancher"
     images:
       nodeContainer: "storageos/node:v2.4.4" # StorageOS version
     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
     sharedDir: '/var/lib/kubelet/plugins/kubernetes.io~storageos' # Needed when Kubelet as a container
     resources:
       requests:
         memory: "512Mi"
     nodeSelectorTerms:
       - matchExpressions:
         - key: "node-role.kubernetes.io/worker" # Compute node label will vary according to your installation
           operator: In
           values:
           - "true"
   

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

   You can find more examples such as deployments referencing a external etcd kv store for StorageOS in the Cluster Operator examples page.