The Ansible Variable File

The Variable File

The example playbooks receive their input from the variable file vars.yml located in the examples directory. Users should modify the relevant variables before executing the playbook. The following sections describe the parameters. Here the parameters are divided into categories.

Several parameters may be used for more than one category (though not repeated).

KumoScale Software Initialization and Network Parameters

The following parameters describe the parameters used for KumoScale software initial configuration and network configurations.

Table 4. KumoScale Configuration Parameters

Variable Name

Description

Expected Input

system_name

KumoScale storage node name.

Up to sixteen characters: Alphanumeric, ‘_’ and ‘-‘

time_mode

KumoScale storage node time mode.

String: NTP or Manual

timezone

The time zone for KumoScale software (if automatic is selected).

String (or ‘None’)

ntp_server

The KumoScale storage node NET server IP.

IP address

group_name

The default group name to create over all SSDs in KumoScale software.

Up to sixteen characters: Alphanumeric, ‘_’ and ‘-‘

portal_ip

The NVMe Portal IP for the KumoScale storage node.

IP address

portal_subnet

The NVMe Portal subnet for the KumoScale storage node.

Subnet

portal_interface

The NVMe Portal interface for the KumoScale node.

String

ks_url

The management URL of the KumoScale storage node.

URL

username

The username for KumoScale software authentication (RBAC).

16 alphanumeric characters

admin_password

Password for RBAC authentication.

String

expiration

Duration (in minutes) until the token expires.

Integer

backend_ip

The KumoScale storage node management IP.

IP address

backend_uuid

The UUID of the KumoScale storage node.

MAC address

backend_rack

List of racks that the volume(s) may reside on (optional).

List<string>

backend_region

List of regions from which the volumes should be accessible (optional).

List<string>

Backend_zone

List of zones from which the volume(s) should be accessible (optional).

List<string>

 

Volume Management Parameters

The following parameters are used for creating and deleting volumes.

Table 5. File Parameters

Variable Name

Description

Expected Input

vol_name

The volume’s name (Alias).

16 alphanumeric characters, ‘_’, ‘-‘

vol_uuid

The UUID of the volume.

UUID

replica_uuid

The replica (physical volume) UUID.

UUID

replicas

Number of volume replicas

Integer

capacity

Volume size in GB.

Integer (with no suffix)

racks

A list of racks the volume may be created on.

List <string>

regions

A list of regions the volume may be created on.

List <string>

zones

A list of zones the volume may be created on.

List <string>

provisioningType

Should the volume be fully pre-allocated (thick) or thin-provisioned (thin)?

String

reservedSpacePercentage

The reserved space for a thin-provisioned volume or for a snapshot’s log, in percentage of volume capacity.

Integer

blockSize

The block size for formatting the new volume, in bytes. The default is 4096.

Integer

maxIOPSPerGB

The maximum limit for a new volume’s IOPS (per each volume’s GB).

Integer

desiredIOPSPerGB

Desired value for a new volume’s IOPS (per each volume’s GB).

Integer

maxBWPerGB

Maximum limit for a new volume’s bandwidth (BW) (per each volume’s GB).

Integer

desiredBWPerGB

Desired limit for a new volume’s BW (per each volume GB).

Integer

sameRackAllowed

May two volume replicas be located on the same rack (default = False).

Boolean

maxReplicaDowntime

The number of minutes to wait when a replica was detected ‘missing’ until autonomous self-healing initiation. The default = 0 is forever.

Integer:
minimum: 5

maximum: 1440 (1 day)

snap_name

The alias for the snapshot.

String

snap_uuid

The snapshot UUID.

String

writable

Is the snapshot volume writable (default = false).

Boolean

spanAllowed

The volume is allowed to span over multiple SSDs (default: true)

Boolean

storageClassName

The name of the storage class

String

tenant_id

The tenant ID in a multi-tenant environment (default = “0”).

String


Syslog Server Parameters

The following table describes parameters used to configure the Syslog server for the KumoScale storage node and host forwarding.

Table 6. Syslog Server Parameters

Variable Name

Description

Expected Input

syslog_name

The Syslog configuration name for KumoScale software.

16 alphanumeric characters, ‘_’, ‘-‘

syslog_url

The Syslog server URL for KumoScale software, includes the Syslog server IP address, port and transport type.

<tcp/udp>:<ip_address>.port

Initiator (Host) Parameters

The following table describes the parameters used to configure the initiator, also referred to as the host.

Table 7. Initiator (Host) Configuration Parameters

Variable Name

Description

Expected Input

hosts_group

Sets which initiators will execute the playbook tasks. The host group is defined in /etc/ansible/hosts.

List <string>

host

The initiator’s name.

String

agent_rpm_path

Full path of the initiator’s installation file.

String

agent_deb_path

Full path of the initiator's installation file for clients running Ubuntu operating system or Debian OS.

String

Provisioner and General Ansible Parameters

The following table describes parameters for configuring the KumoScale Provisioner service and general Ansible module settings.

Table 8. KumoScale Provisioner Service and General Parameters

Variable Name

Description

Expected Input

provisioner_url

IP or FQDN address of the KumoScale Provisioner service.

IPv4 address format

 

Next: Ansible Failure Recovery & Monitoring