Installer Preferences File Reference
This document follows the conventions of JSON Schema. Some URLs may be used as identifiers rather than actual web resources.
Installer Preferences File Schema
http://128technology.com/installerPreferencesFile
Schema for the preferences file used by the SSR Installer.
Installer Preferences File Type
object (Installer Preferences File)
Installer Preferences File Properties
install
Cleanly install SSR with the given options after wiping away any traces of previous installations.
install
- is optional
- cannot be null
install Type
object (Install)
upgrade
Upgrade SSR to a newer version.
upgrade
- is optional
- cannot be null
upgrade Type
object (Upgrade)
rollback
Roll back to the previous installation of SSR. This is only possible if SSR was installed or upgraded with the Installer.
Before performing a rollback, please refer to Rolling Back Software for important details about the rollback operation.
rollback
- is optional
- cannot be null
rollback Type
object (Rollback)
download
Download the SSR software and dependencies without installing.
download
- is optional
- cannot be null
download Type
object (Download)
import
Import an SSR ISO or packages directory into the local repository.
import
- is optional
- cannot be null
import Type
object (Import)
repository
Manage SSR software repositories.
repository
- is optional
- cannot be null
repository Type
object (Repository)
authentication
Authentication for downloading and installing SSR software.
authentication
- is optional
- cannot be null
authentication Type
object (Authentication)
authentication Constraints
minimum number of properties: the minimum number of properties for this object is: 1
enable-128T
Enable the SSR service if the operation is successful.
enable-128T
- is optional
- cannot be null
enable-128T Type
boolean
enable-128T Default Value
The default value is:
false
start-128T
Start the SSR service if the operation is successful.
start-128T
- is optional
- cannot be null
start-128T Type
boolean
start-128T Default Value
The default value is:
false
reboot-if-required
Reboot the system when the Installer exits if the operation is successful and a reboot is required.
reboot-if-required
- is optional
- cannot be null
reboot-if-required Type
boolean
reboot-if-required Default Value
The default value is:
false
retry-max-attempts
The maximum number of times to try an operation.
retry-max-attempts
- is optional
- cannot be null
retry-max-attempts Type
integer
retry-max-attempts Constraints
minimum: the value of this number must greater than or equal to: 1
retry-max-attempts Default Value
The default value is:
5
retry-delay
The initial number of seconds to wait before retrying. This can be increased for each successive try by using 'backoff'.
retry-delay
- is optional
- cannot be null
retry-delay Type
integer
retry-delay Constraints
minimum: the value of this number must greater than or equal to: 0
retry-delay Default Value
The default value is:
10
retry-backoff
The factor by which 'delay' should be multiplied for each successive retry.
retry-backoff
- is optional
- cannot be null
retry-backoff Type
integer
retry-backoff Constraints
minimum: the value of this number must greater than or equal to: 1
retry-backoff Default Value
The default value is:
1
set-default-kernel
Whether or not to set the system's default kernel after an Installer operation. If set to 'false', the correct kernel will need to be enabled manually for SSR to function normally.
set-default-kernel
- is optional
- cannot be null
set-default-kernel Type
boolean
set-default-kernel Default Value
The default value is:
true
keep-deprecated
Whether or not to keep deprecated packages during installation or upgrade.
keep-deprecated
- is optional
- cannot be null
keep-deprecated Type
boolean
keep-deprecated Default Value
The default value is:
false
Install Schema
http://128technology.com/installerPreferencesFile#/properties/install
Cleanly install SSR with the given options after wiping away any traces of previous installations.
install Type
object (Install)
Install Properties
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| yum-certificate | string | Optional | cannot be null | Installer Preferences File |
| initialize | object | Required | cannot be null | Installer Preferences File |
| ssr-version | string | Optional | cannot be null | Installer Preferences File |
| no-nuke-on-start | boolean | Optional | cannot be null | Installer Preferences File |
| no-nuke-on-failure | boolean | Optional | cannot be null | Installer Preferences File |
yum-certificate
Deprecated; use 'authentication.certificate' instead
yum-certificate
- is optional
- cannot be null
yum-certificate Type
string
initialize
Preferences to pass to the Initializer. These must conform to the Initializer preferences schema for the version of SSR being installed.
initialize
- is required
- cannot be null
initialize Type
object (Initializer Preferences File)
SSR-version
An RPM version requirement string of the form '[comparison ][epoch:]version[-release]', where 'comparison' is one of '>=', '<', '>', '<=', or '='. If omitted, '=' will be used for 'comparison'.
128T-version
- is optional
- cannot be null
SSR-version Type
string
SSR-version Constraints
pattern: the string must match the following regular expression:
^((=|[><]=?)\s+)?([^\s:]+)?([^\s\-]+)(-(\S+))?$
SSR-version Examples
"3.0.3"
"3.0.3-release.201705302342.1.el7"
"0:3.1.4"
"0:3.1.4-release.1"
"= 3.1.4"
"< 3.2.0"
"<= 3.1.5-release.201710132231.1.el7"
"> 3.1.5-release.201710132231.1.el7"
">= 3.1.3"
no-nuke-on-start
Do not erase previous installations of SSR when the Installer starts.
no-nuke-on-start
- is optional
- cannot be null
no-nuke-on-start Type
boolean
no-nuke-on-start Default Value
The default value is:
false
no-nuke-on-failure
Do not uninstall SSR and clean up if the Installer fails.
no-nuke-on-failure
- is optional
- cannot be null
no-nuke-on-failure Type
boolean
no-nuke-on-failure Default Value
The default value is:
false
Upgrade Schema
http://128technology.com/installerPreferencesFile#/properties/upgrade
Upgrade SSR to a newer version.
upgrade Type
object (Upgrade)
Upgrade Properties
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| yum-certificate | string | Optional | cannot be null | Installer Preferences File |
| ssr-version | string | Optional | cannot be null | Installer Preferences File |
yum-certificate
Deprecated; use 'authentication.certificate' instead.
yum-certificate
- is optional
- cannot be null
yum-certificate Type
string
SSR-version
An RPM version requirement string of the form '[comparison ][epoch:]version[-release]', where 'comparison' is one of '>=', '<', '>', '<=', or '='. If omitted, '=' will be used for 'comparison'.
128T-version
- is optional
- cannot be null
SSR-version Type
string
SSR-version Constraints
pattern: the string must match the following regular expression:
^((=|[><]=?)\s+)?([^\s:]+)?([^\s\-]+)(-(\S+))?$
SSR-version Examples
"3.0.3"
"3.0.3-release.201705302342.1.el7"
"0:3.1.4"
"0:3.1.4-release.1"
"= 3.1.4"
"< 3.2.0"
"<= 3.1.5-release.201710132231.1.el7"
"> 3.1.5-release.201710132231.1.el7"
">= 3.1.3"
Rollback Schema
http://128technology.com/installerPreferencesFile#/properties/rollback
Roll back to the previous installation of SSR. This is only possible if SSR was installed or upgraded with the Installer.
rollback Type
object (Rollback)
Download Schema
http://128technology.com/installerPreferencesFile#/properties/download
Download the SSR software and dependencies without installing.
download Type
object (Download)
Download Properties
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| ssr-version | string | Optional | cannot be null | Installer Preferences File |
| yum-certificate | string | Optional | cannot be null | Installer Preferences File |
SSR-version
An RPM version requirement string of the form '[comparison ][epoch:]version[-release]', where 'comparison' is one of '>=', '<', '>', '<=', or '='. If omitted, '=' will be used for 'comparison'.
128T-version
- is optional
- cannot be null
SSR-version Type
string
SSR-version Constraints
pattern: the string must match the following regular expression:
^((=|[><]=?)\s+)?([^\s:]+)?([^\s\-]+)(-(\S+))?$
SSR-version Examples
"3.0.3"
"3.0.3-release.201705302342.1.el7"
"0:3.1.4"
"0:3.1.4-release.1"
"= 3.1.4"
"< 3.2.0"
"<= 3.1.5-release.201710132231.1.el7"
"> 3.1.5-release.201710132231.1.el7"
">= 3.1.3"
yum-certificate
Deprecated; use 'authentication.yum-certificate' instead.
yum-certificate
- is optional
- cannot be null
yum-certificate Type
string
Import Schema
http://128technology.com/installerPreferencesFile#/properties/import
Import an SSR ISO or packages directory into the local repository.
import Type
object (Import)
Import Properties
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| iso-hunt | boolean | Optional | cannot be null | Installer Preferences File |
| iso-path | string | Optional | cannot be null | Installer Preferences File |
| packages-path | string | Optional | cannot be null | Installer Preferences File |
iso-hunt
Search the filesystem for ISOs and attempt to import them all.
iso-hunt
- is optional
- cannot be null
iso-hunt Type
boolean
iso-hunt Default Value
The default value is:
false
iso-path
The path to the SSR ISO to be imported.
iso-path
- is optional
- cannot be null
iso-path Type
string
packages-path
The path to package directory to be imported.
packages-path
- is optional
- cannot be null
packages-path Type
string
Repository Schema
http://128technology.com/installerPreferencesFile#/properties/repository
Manage SSR software repositories.
repository Type
object (Repository)
Repository Properties
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| enable | object | Optional | cannot be null | Installer Preferences File |
| disable | object | Optional | cannot be null | Installer Preferences File |
enable
Enable SSR software repositories. If a new authentication token is specified, an existing repository configuration will be updated to use the new token.
enable
- is optional
- cannot be null
enable Type
object (Enable)
disable
Disable SSR software repositories.
disable
- is optional
- cannot be null
disable Type
object (Disable)
Enable Schema
http://128technology.com/installerPreferencesFile#/properties/repository/properties/enable
Enable SSR software repositories. If a new authentication token is specified, an existing repository configuration will be updated to use the new token.
enable Type
object (Enable)
Enable Properties
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| repos | array | Optional | cannot be null | Installer Preferences File |
| persistent | boolean | Optional | cannot be null | Installer Preferences File |
repos
A list of SSR repositories to enable.
repos
- is optional
- cannot be null
repos Type
an array of merged types (Enabled Repo)
persistent
If false, enables the repo for this operation only. Does not apply to 'system' or 'legacy' repos (it will always be treated as false).
persistent
- is optional
- cannot be null
persistent Type
boolean
persistent Default Value
The default value is:
false
Enabled Repo Schema
http://128technology.com/installerPreferencesFile#/properties/repository/properties/enable/properties/repos/items
A repository to enable.
items Type
merged type (Enabled Repo)
one (and only one) of
System Schema
http://128technology.com/installerPreferencesFile#/properties/repository/properties/enable/properties/repos/items/oneOf/1
Allow the use of all configured and enabled RPM repositories.
System Type
string (System)
System Constraints
constant: the value of this property must be equal to:
"system"
Disable Schema
http://128technology.com/installerPreferencesFile#/properties/repository/properties/disable
Disable SSR software repositories.
disable Type
object (Disable)
Disable Properties
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| repos | array | Optional | cannot be null | Installer Preferences File |
| persistent | boolean | Optional | cannot be null | Installer Preferences File |
repos
A list of SSR repositories to disable.
repos
- is optional
- cannot be null
repos Type
string[] (Repository Type)
persistent
If false, disables the repo for this operation only. Does not apply to 'legacy' repo type (it will always be treated as false).
persistent
- is optional
- cannot be null
persistent Type
boolean
persistent Default Value
The default value is:
false
Authentication Schema
http://128technology.com/installerPreferencesFile#/definitions/authentication
Authentication for downloading and installing SSR software.
authentication Type
object (Authentication)
authentication Constraints
minimum number of properties: the minimum number of properties for this object is: 1
Authentication Properties
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| username | string | Optional | cannot be null | Installer Preferences File |
| token | string | Optional | cannot be null | Installer Preferences File |
| certificate | string | Optional | cannot be null | Installer Preferences File |
username
Username for authentication.
username
- is optional
- cannot be null
username Type
string
username Constraints
minimum length: the minimum number of characters for this string is: 1
token
API key to be used for authentication.
token
- is optional
- cannot be null
token Type
string
token Constraints
minimum length: the minimum number of characters for this string is: 1
certificate
The contents of a certificate file to use for authenticating with the SSR RPM repository. If present, this will overwrite an existing certificate.
certificate
- is optional
- cannot be null
certificate Type
string
certificate Constraints
minimum length: the minimum number of characters for this string is: 1
Repository Type Schema
http://128technology.com/installerPreferencesFile#/definitions/repository-type
An SSR software repository.
repository-type Type
string (Repository Type)
repository-type Constraints
enum: the value of this property must be equal to one of the following values:
| Value | Explanation |
|---|---|
"alpha" | SSR alpha software repository |
"beta" | SSR beta software repository |
"legacy" | SSR software repository for older releases |
"prealpha" | SSR pre-alpha software repository |
"release" | SSR release software repository |
"plugins-alpha" | SSR alpha plugin repository |
"plugins-beta" | SSR beta plugin repository |
"plugins-release" | SSR release plugin repository |