KumoScale Agent

Both KumoScale for Appliance mode and KumoScale for Managed mode support installation of the KumoScale agent on bare-metal. The agent, ks-agent, can be installed on initiators using RHEL 7.x or Ubuntu 18.x.

Before installing the agent, ensure mdadm, dmidecode, nvme-cli, and util-linux are installed on the initiator.

Installing the KumoScale Agent

To install the agent using

  • RPM, enter
    • yum install ks-agent-<major>.<minor>.<release>.x86_64.rpm -y
  • DEB, enter
    • dpkg -i ks-agent_<major>.<minor>.<release>_amd64.deb

       

The ks-agent service will start automatically after the installation. To verify status, enter:
  • systemctl status ks-agent.service

     

Using the KumoScale Agent

Configuring the Agent

To configure external arguments for the application, edit /usr/lib/systemd/system/ks-agent.conf as shown in the table below:

Argument

Description

PROV_URL

Provisioner full URL                                                    

PROV_TOKEN

Provisioner token                                                            

NODE_NAME

Node name - should be unique (within provisioner), start with a letter, no more than 32 chars, and only small letters, numbers and '-'.

PROV_TOKEN

A provisioner token (set if using 'LOCAL' authentication mode)

PROV_CLIENT_ID

The client ID of a client which has ADMIN role in provisioner resource server (set if using 'OPEN_IDC' authentication mode)

PROV_CLIENT_SECRET

The client secret of a client which has ADMIN role in provisioner resource server

AUTH_SERVER_TOKEN_URL

The URL to generate the token on the configured authorization server

 

Stopping and starting ks-agent

To stop the ks-agent service, enter:

systemctl stop ks-agent.service

 

To start the ks-agent service, enter:

systemctl start ks-agent.service

 

Configuring the Provisioner

The Provisioner can be configured by editing provisioner.conf as shown in the table below:

Argument

Description

prov_ip

Provisioner full URL                                                    

prov_port

 

token

Provisioner token                                                            

cert_file

Certificate file.

client_id

(optional)

client_secret

(optional)

token_url

(optional)

 

prov_ip='172.##.##.#'

prov_port=30100

token=’#########’

cert_file='/etc/kioxia/ssdtoolbox.pem'

client_id=None

client_secret=None

token_url=None

 

Upgrading the KumoScale Agent

To upgrade the agent using:

  • RPM, enter
    • rpm -Uvh ks-agent-<major>.<minor>.<release>.x86_64
  • DEB, enter
    • dpkg -i ks-agent_<major>.<minor>.<release>_amd64.deb

       

Uninstalling the KumoScale Agent

To upgrade the agent using:

  • RPM, enter
    • rpm -ev ks-agent-<major>.<minor>.<release>.x86_64
  • DEB, enter:
    • dpkg --purge ks-agent

 

Next: CSI Storage Provisioning