Install - Prerequisites & Preparation

This guide will walk you through all the steps to successfully install and configure the KumoScale™ storage software. After completing the steps documented in this guide you will be ready to provision your storage and create a new storage environment, or integrate it into an existing one.

The installation consists of installing the software and configuring the storage cluster.

KumoScale Storage Cluster: KumoScale management services run on a Kubernetes™ orchestration cluster hosted on the storage nodes themselves. The services that run on this cluster are configured for native Kubernetes environments’ data resiliency and high availability (HA). The installation automatically installs the following essential services:

  • Provisioner, a service for provisioning, analysing, and managing storage nodes. The Provisioner is installed on the master node of the storage cluster and acts as a load balancer, using storage requirements and analytics data to determine the best location for allocating requested volumes.
  • Control Operators to manage KumoScale These control operators run as services on the Kubernetes cluster.
  • The CSI driver for Kubernetes to support implementation of the storage cluster and storage nodes.

Additional components that provide internal logging and analysis can be added to the storage cluster.

KumoScale Storage Nodes: KumoScale software is installed on storage appliances or physical servers equiped with NVMe™ SSDs, and configured as master or worker nodes.

More detailed information, including a system overview describing all components and interfaces, is available in the Overview section of the KumoScale User Guide.

Once you have deployed the KumoScale storage cluster, your environment will be ready for provisioning as shown in Figure 1. Example of a KumoScale Software Deployment.

Screen Shot 2021-11-01 at 19.03.42

Figure 1. Example of a KumoScale Software Deployment

Before you Begin

Before you begin the installation:

  • Confirm that your hardware platform and network environment comply with KumoScale software requirements as specified in the KumoScale Hardware Compatibility List (HCL).
  • Read the Release Notes document for additional information on installation and use of KumoScale software products.
  • Read the Release Notes for changes made in 3.19.
  • Review the installation and configuration requirements documented in this guide in Environmental Requirements.
  • If you are doing a single node installation, please follow the simplified installation process documented in the Single Node Installation Guide.

Intended Audience

This document is written for storage administrators. It is assumed that the reader has a working knowledge of storage, networking and Kubernetes orchestration concepts.

Changes from Previous Release

For changes from the previous release, see the Release Notes.

Environmental Requirements

This section details prerequisites for a successful implementation. You should not proceed with an installation until you have verified that your environment supports these requirements.

Hardware Requirements

KumoScale software may be installed on any of the server and network configurations defined in the Hardware Compatibility List (HCL)

Installation Device

KumoScale software supports deployment on platforms with either SATA drives or NVMe drives. By default, SATA drive(s) is/are used for installation. NVMe drive(s) will be used if no SATA drive is available. The installation devices are formatted as mirrored (RAID-1) devices if at least two drives are available. Otherwise, the installation is done on the single drive. More installation device options can be found under Installation Command Line Parameters.

NOTE    We recommend using two SATA SSDs as installation media.

Network and Environment Requirements

NOTE    KumoScale storage node installation is supported only on platforms that are configured for UEFI.

There are three ways you can boot into the image depending on the device you choose:

Network Installation: This is the preferred installation method when installing a large number of nodes. It works when installing remotely. This installation requires a TFTP/DHCP PXE server that supports DNS, HTTP / HTTPS / FTP services on the installation site.

Virtual CD Installation: This option should be used when a PXE server is not available, and only remote access is available to the setup. It requires a way to transfer files over the network such as a WebDAV server, TFTP server etc. The Virtual CD is a remote server containing the image and must be accessible from either the Baseboard Management Controller (BMC), iLO or iDRAC of the server.

USB Installation: This method installs the image directly on a server using a USB drive. This option is typically chosen when installing on a small number of nodes, or when a PXE server is not available. This method does not assume any special conditions.

Configuration Requirements

In order to configure storage nodes, you will need your license key. Details on how the storage cluster should be configured in your environment, and a remote host with the kubectl tool are provided below.

License Key

You will need a copy of the license key file provided to you by KIOXIA in order to configure the storage nodes.

Number of Masters

A KumoScale storage cluster is optimally configured with an odd number of masters on the same subnet. For single node deployments, one (1) master is sufficient. High Availability (HA) systems should contain at least three (3) masters. Table 1. KumoScale Cluster Configurations shows possible cluster configurations.

Note: The master nodes must all be on the same subnet.

Table 1. KumoScale Cluster Configurations

Cluster size

Number of Master Nodes

Number of Worker Nodes

Deployment Environment




No resiliency








Odd number of masters




Best practice

More than 5



The number of master nodes is specified when you install the first node. If the number of master nodes is specified as, say, three, then the first three nodes installed are master nodes. All nodes added after that are configured as worker nodes.  You may add nodes to your KumoScale cluster at any time. Note that it is possible to prevent a node from joining as a master node.

VIP for the First Master

The KumoScale storage cluster has a Virtual IP Address (VIP). It is defined when you install KumoScale software on the very first node (details in Installation Command Line Parameters). However, as noted earlier, all master nodes must be on the same subnet so a node will join as a master only if it is on the same subnet as the first master.

Custom Requirements for the Masters

KumoScale enables you to specify requirements for when a node can join as a master of the KumoScale storage cluster. These restrictions need to be provided when configuring the Master CR. In particular you will need to select whether you want a node to join only when there is affinity or antiaffinity or neither. You cannot have both. The default setting is neither.

Affinity: the node meets a certain set of requirements such as it is located in a specific rack, or it has a particular name.

Antiaffinity: the node does not meet a certain set of requirements such as it is NOT located in a specific rack.

You will express this in the Master CR. You will need the information gathered in the Configuration Requirements to complete this step. See Configure the First Master. Examples of syntax are provided in that section.

Administrative Host with Support for Kubernetes kubectl

For security reasons, users are not given direct access to the storage cluster or storage nodes. All post-install steps are executed on your Windows™/OS X/Linux™ host that can connect to the KumoScale master node via over the network and supports the Kubernetes command-line tool, kubectl. Ensure that you have access to a host with this tool before starting the installation. This is your administrative host.

To install kubectl on your administrative host, please follow the steps here.


We recommend that you install and configure servers one at a time starting with the storage cluster masters. This chapter explains how to install KumoScale software in your environment. The Configuration chapter explains how to configure the server.

Figure 2 KumoScale Node Installation and Configuration Process

At a high level, the process consists of:

  • Installing KumoScale software on a physical server, steps 1)- 5).
  • Configure the masters for the storage cluster, steps 6)- 10). As explained in the overview, this is a private Kubernetes cluster that supports services and operators for provisioning, monitoring, and support. You will use the remote host set up in Administrative Host with Support for Kubernetes kubectl section to complete the configuration steps. You will use custom resource files to configure the cluster for your deployment environment. The User Guide has complete information on how custom resources are used in KumoScale software and what parameters you will need to specify the master nodes.
  • Configure storage nodes as workers of the storage cluster, step 11). As with the master you will use Custom Resource (CR) files to configure all worker nodes.

Upon completing each step, you will have a KumoScale software environment configured with storage nodes as shown in Figure 1. Example of a KumoScale Software Deployment. Note that you will need all of the information discussed in Configuration Requirements in order to complete these steps successfully.

We recommend that you install and configure servers one at a time starting with the masters. Although you may be able to install KumoScale software on all servers, you must configure all masters, before configuring additional storage.

  • Connect your platform to the network and prepare files for installation as defined in the Prepare the Installation File and Environment
  • Determine values for any command line (CLI) parameter that needs to be set for KumoScale software to install in your environment. Note that you will need to specify the VIP for the masters when installing on the first master. See Installation Command Line Parameters for details.
  • Configure your platform to use the UEFI and to boot from either of the appropriate devices. See Configure the Boot Order.
  • Start the installation process by rebooting or powering up the server and booting according to the preconfigured option specified in Step 3 (network/USB/Virtual CD). The OS, and all required packages and dependencies, along with KumoScale software, are installed using any parameters you choose to provide per Step 2. This process is explained in Start the Installation.
  • Verify that installation was successful as instructed in Verify Installation Success.
  • Access the KumoScale storage cluster from a remote host as explained in Access the KumoScale Storage Cluster from a Remote Administrative Host.
  • Configure the first master for the KumoScale storage cluster. You will need the information gathered in the Configuration Requirements to complete this step. See Configure the First Master.
  • Repeat Steps 1-6 on the servers to be added as masters to the KumoScale storage cluster and configure as instructed in Install and Deploy Remaining Masters.
  • Install the internal components on the KumoScale storage cluster. You will need these tools for internal analytics. See Install Internal Components on Storage Cluster.
  • Verify that the KumoScale storage cluster is running and set up as expected. See Verify KumoScale Storage Cluster Configuration.
  • Install and configure storage nodes as workers as explained in Install and Configure Storage Nodes.

Next: Single Node Install or Multi Node Install