Initializer Preferences File Reference
This document follows the conventions of JSON Schema. Some URLs may be used as identifiers rather than actual web resources.
Initializer Preferences File Schema
http://128technology.com/initializerPreferencesFile
Schema for the preferences file used by the SSR Initializer.
Initializer Preferences File Type
object (Initializer Preferences File)
Initializer Preferences File Properties
node-name
The name of the Node being initialized.
node-name
- is required
- cannot be null
node-name Type
string
node-name Constraints
pattern: the string must match the following regular expression:
^([a-zA-Z0-9]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]$
node-ip
An IPv4 or IPv6 address.
node-ip
- is optional
- cannot be null
node-ip Type
string (IP Address)
one (and only one) of
node-ip Examples
"1.1.1.1"
"2001:0db8:85a3:0000:0000:8a2e:0370:7334"
node-role
The role of the Node being initialized.
node-role
- is required
- cannot be null
node-role Type
string
node-role Constraints
enum: the value of this property must be equal to one of the following values:
| Value | Explanation |
|---|---|
"conductor" | An SSR Conductor node |
"control" | Unsupported. Use 'combo' instead |
"combo" | An SSR Router node |
"slice" | Unsupported. Use 'combo' instead |
router-name
The name of the Router to which the Node belongs. Ignored if 'learn-from-ha-peer' is true and required if 'learn-from-ha-peer' is false.
router-name
- is optional
- cannot be null
router-name Type
string
router-name Constraints
pattern: the string must match the following regular expression:
^([a-zA-Z0-9]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]$
conductor
Configuration of a Conductor that will manage this Node. Ignored if 'learn-from-ha-peer' is true.
conductor
- is optional
- cannot be null
conductor Type
object (Conductor)
ha-peer-ip
An IPv4 or IPv6 address.
ha-peer-ip
- is optional
- cannot be null
ha-peer-ip Type
string (IP Address)
one (and only one) of
ha-peer-ip Examples
"1.1.1.1"
"2001:0db8:85a3:0000:0000:8a2e:0370:7334"
ha-peer-name
The name of the Node to be used as an HA peer. Required if 'learn-from-ha-peer' is false and 'ha-peer-ip' is true.
ha-peer-name
- is optional
- cannot be null
ha-peer-name Type
string
ha-peer-name Constraints
pattern: the string must match the following regular expression:
^([a-zA-Z0-9]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]$
learn-from-ha-peer
If true, the Initializer will use the HA peer to obtain setup information.
learn-from-ha-peer
- is optional
- cannot be null
learn-from-ha-peer Type
boolean
learn-from-ha-peer Default Value
The default value is:
false
local-init
Preferences to be passed to the SSR local environment configuration. These must conform to the Environment Config schema for the version of SSR being initialized.
local-init
- is optional
- cannot be null
local-init Type
object (local.init)
timezone
The time zone to set for the system, in 'timedatectl' format.
timezone
- is optional
- cannot be null
timezone Type
string
timezone Examples
"America/New_York"
"Asia/Tokyo"
"Europe/Brussels"
admin-password
A salted SHA-512 hash of the password to set for the 'admin' user.
admin-password
- is optional
- cannot be null
admin-password Type
string
admin-password Constraints
pattern: the string must match the following regular expression:
^\$6\$[A-Za-z0-9.\/]{1,16}\$[A-Za-z0-9.\/]{86}$
admin-password Examples
"$6$wM4C/pYWP6aVjchX$GNFrgAZW.P8CBk2.Oq1x4kQhAqlm.tBN3DCipgLN2.RAZ.2tdKnvix8t.8Hm/uWHzbxUt6WnQYzCpAH9ojTEk1"
root-password
A salted SHA-512 hash of the password to set for the 'root' user.
root-password
- is optional
- cannot be null
root-password Type
string
root-password Constraints
pattern: the string must match the following regular expression:
^\$6\$[A-Za-z0-9.\/]{1,16}\$[A-Za-z0-9.\/]{86}$
root-password Examples
"$6$wM4C/pYWP6aVjchX$GNFrgAZW.P8CBk2.Oq1x4kQhAqlm.tBN3DCipgLN2.RAZ.2tdKnvix8t.8Hm/uWHzbxUt6WnQYzCpAH9ojTEk1"
pdc-key-comment
An optional comment to include with the PDC SSH key.
pdc-key-comment
- is optional
- cannot be null
pdc-key-comment Type
string
bypass-compliance
If true, the Initializer will proceed even if compliance validation fails.
bypass-compliance
- is optional
- cannot be null
bypass-compliance Type
boolean
bypass-compliance Default Value
The default value is:
false
disable-sizing
If true, the Initializer will not configure system memory/CPU settings in the environment.
disable-sizing
- is optional
- cannot be null
disable-sizing Type
boolean
disable-sizing Default Value
The default value is:
false
disable-tuning
If true, the Initializer will skip steps that modify operating system settings.
disable-tuning
- is optional
- cannot be null
disable-tuning Type
boolean
disable-tuning Default Value
The default value is:
false
is-virtual
This must be true when initializing an SSR node that is managed by a Virtual Conductor.
is-virtual
- is optional
- cannot be null
is-virtual Type
boolean
is-virtual Default Value
The default value is:
false
Conductor Schema
http://128technology.com/initializerPreferencesFile#/properties/conductor
Configuration of a Conductor that will manage this Node. Ignored if 'learn-from-ha-peer' is true.
conductor Type
object (Conductor)
Conductor Properties
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| primary | object | Required | cannot be null | Initializer Preferences File |
| secondary | object | Optional | cannot be null | Initializer Preferences File |
primary
Configuration of the primary Node in an HA Conductor, or the only Node in a standalone.
primary
- is required
- cannot be null
primary Type
object (Conductor Node)
secondary
Configuration of the secondary Node in an HA Conductor.
secondary
- is optional
- cannot be null
secondary Type
object (Conductor Node)
local.init Schema
http://128technology.com/initializerPreferencesFile#/properties/local-init
Preferences to be passed to SSR local environment configuration. These must conform to the Environment Config schema for the version of SSR being initialized.
local-init Type
object (local.init)
IP Address Schema
http://128technology.com/initializerPreferencesFile#/definitions/host/anyOf/0
An IPv4 or IPv6 address.
IP Address Type
string (IP Address)
one (and only one) of
IP Address Examples
"1.1.1.1"
"2001:0db8:85a3:0000:0000:8a2e:0370:7334"
IPv4 Address Schema
http://128technology.com/initializerPreferencesFile#/definitions/ip-address/oneOf/0
IPv4 Address Type
string (IPv4 Address)
IPv4 Address Constraints
IPv4: the string must be an IPv4 address (dotted quad), according to RFC 2673, section 3.2
IPv6 Address Schema
http://128technology.com/initializerPreferencesFile#/definitions/ip-address/oneOf/1
IPv6 Address Type
string (IPv6 Address)
IPv6 Address Constraints
IPv6: the string must be an IPv6 address, according to RFC 4291, section 2.2
Conductor Node Schema
http://128technology.com/initializerPreferencesFile#/definitions/conductor-node
conductor-node Type
object (Conductor Node)
Conductor Node Properties
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| name | string | Optional | cannot be null | Initializer Preferences File |
| ip | Merged | Required | cannot be null | Initializer Preferences File |
name
Deprecated. This field is ignored.
name
- is optional
- cannot be null
name Type
string
name Constraints
pattern: the string must match the following regular expression:
^([a-zA-Z0-9]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]$
ip
An IP address or hostname.
ip
- is required
- cannot be null
ip Type
string (Host)
any of
-
one (and only one) of
ip Examples
"1.1.1.1"
"2001:0db8:85a3:0000:0000:8a2e:0370:7334"
"128technology.com"
"localhost"
Hostname Schema
http://128technology.com/initializerPreferencesFile#/definitions/host/anyOf/1
Hostname Type
string (Hostname)
Hostname Constraints
hostname: the string must be a hostname, according to RFC 1123, section 2.1