refinery-install(8) -- Refinery package download and installation¶

Synopsis¶

refinery install [option]

Description¶

Provides the ability to download and install Refinery.

NOTE: If you are downloading and installing on a new server and kdb+ is not already installed, you must run the CLI with the --kdb-no-validate global option.

Options¶

--list-available¶

Lists all available Refinery versions that can be downloaded from FD Nexus. This option requires the use of the additional [NEXUS AUTHENTICATION OPTIONS] described below and supports the use of the additional [AVAILABLE VERSIONS OPTIONS] also described below.

--download refinery-version¶

Download and extract the specified version of Refinery from

This option requires the use of the additional [NEXUS AUTHENTICATION OPTIONS] described below and supports the use of the additional [DOWNLOAD OPTIONS] also described below.

--check-server¶

Runs a set of checks against the server to check its suitability for a Refinery installation. There are 3 check types:

INFO: Server information printed to standard out
WARN: Not recommended configuration, but not explictly disallowed by the Refinery core team
ERROR: Disallowed configuration. The --install option will not allow a Refinery installation

This option supports the use of the additional [SERVER CHECK OPTIONS] described below.

--check-install-config¶

Runs a set of checks against the Refinery installation configuration for suitability for a Refinery installation.

NOTE: This command will fail on the delta-install-type configuration item as this is dynamically set by the --install option

This option supports the use of the additional [INSTALL CHECK OPTION] described below.

--install refinery-version¶

Perform a Refinery installation on the current server. Prior to an installation, the command will:

Modify the installation configuration file (--install-config) with the specified installation type (--install-type)
Run the server checks
Run the installation configuration checks
Check if a backup of the target installation directory is required
If present, --overwrite is required to allow the installation to proceed
If not, check that the current user has the correct permissions to create the installation folder
Print installation summary
Prompt for installation to begin
Backup existing installation if present
Run Platform installation
- If successful, delete the backup if present
- If successful and --maintain-old-version specified, keep the backup
- If failed, delete new install and restore old install

This option requires the use of the additional [REQUIRED INSTALL OPTIONS] described below and supports the use of the additional [OPTIONAL INSTALL OPTIONS] also described below.

Nexus authentication options¶

--nexus-username *username¶

The username to login to FD Nexus

--nexus-password password¶

The password to login to FD Nexus. If this is not specified as a command line argument, it will be prompted for interactively before the download

Available versions options¶

--all¶

If specified, show all Refinery versions including the non-recent patches in case a specific patch is required

Download options¶

--download-target path¶

If specified, override the target folder to temporarily download the Refinery bundle. By default, it will download to the temporary folder returned by mktemp.

--extract-target path¶

If specified, override the target folder to store the extracted Refinery bundle. By default, the bundle will be extracted to $HOME/refinery-install.

Server check options¶

--warnings-as-errors¶

If set, any warnings that occur as part of the server-level checks will be reported as errors and cause the command to fail.

Install check options¶

--install-config file¶

The Refinery installation configuration file to check

Required install options¶

--install-config file¶

The Refinery installation configuration file to drive the installation

--license path¶

The folder containing the required licenses for a Refinery installation. Generally k4.lic and .delta.lic

--install-type type¶

The type of installation to perform on the current server. Must be one of:

control: Install Delta Control only
daemon: Install Delta Control daemon only
control+daemon: Install Delta Control and Delta Control daemon

Optional install options¶

--instances csv-file¶

A CSV file containing static host and port assignments for specific processes

--overwrite¶

If an existing installation is present, allow the command to backup and perform a clean installation

--maintain-old-version¶

By default on a successful installation, the previous installation is deleted. This option ensures that the previous installation is maintained.

--start-post-install¶

By default, no processes are started after an installation. This option will start Delta Control and/or Delta Control daemon based on the specified installation type (--install-type)

--package-source path¶

The root folder containing the downloaded Refinery packages if not the default.

NOTE: The structure of the folder specified here must match the structure created by the --download option above. This is:

KxRefinery-version/
- packages/
- scripts/

Copyright¶

Version¶

RELEASE_NAME