install

Download and install Refinery

refinery install [options]
Options:
--all                       --install-config            --nexus-password
--check-install-config      --install-type              --nexus-username
--check-server              --instances                 --overwrite
--download                  --license                   --package-source
--download-target           --list-available            --start-post-install
--extract-target            --maintain-old-version      --warnings-as-errors
--install

If kdb+ is not already installed, run the CLI with the --kdb-no-validate global option.

--list-available

List all available Refinery versions that can be downloaded from FD Nexus.

Requires the Nexus Authentication options.

Supports use of the additional Available Versions options.

--download refinery-version

Download and extract the specified version of Refinery.

Requires the Nexus Authentication options.

Supports use of the additional Download options.

--check-server

Run tests of the server’s suitability for a Refinery installation.

There are three test types:

  • INFO: Server information printed to stdout
  • WARN: Not recommended configuration, but allowed
  • ERROR: Disallowed configuration. The --install option will not permit a Refinery installation

Supports use of the Server Check options.

--check-install-config

Run tests of the Refinery installation configuration for suitability for a Refinery installation.

Fails on the delta-install-type configuration option as this is set dynamically by the --install option.

Supports the additional Install Check option.

--install refinery-version

Install Refinery 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

Requires the Required install options.

Supports the Optional install options.

Nexus authentication options

--nexus-username username

Username to login to FD Nexus.

--nexus-password password

Password to login to FD Nexus. If not specified, you will be prompted for it interactively before the download.

Available versions options

--all

Show all Refinery versions including the non-recent patches in case a specific patch is required

Download options

--download-target path

Override the target folder to temporarily download the Refinery bundle.

By default, downloads to the temporary folder returned by mktemp.

--extract-target path

Override the target folder to store the extracted Refinery bundle.

By default, the bundle is extracted to $HOME/refinery-install.

Server check options

--warnings-as-errors

Report as errors any warnings from the server-level checks and cause the command to fail.

Install check options

--install-config file

Refinery installation configuration file to check

Required install options

--install-config file

Refinery installation configuration file to drive the installation

--license path

Folder containing the licenses required for a Refinery installation, generally k4.lic and .delta.lic

--install-type type

Type of installation to perform on the current server: Delta Control, Delta Control daemon or both: control, daemon, or control+daemon.

Optional install options

--instances csv-file

CSV containing static host and port assignments for specific processes.

--overwrite

If an existing installation is present, back it up and perform a clean installation.

--maintain-old-version

Maintain the previous installation. (By default, on a successful installation, any previous installation is deleted.)

--start-post-install

Start Delta Control and/or the Delta Control daemon, according to the specified installation type (--install-type). (By default, no processes are started after an installation.)

--package-source path

Root folder containing the downloaded Refinery packages, if not the default.

The folder specified here must match the structure created by the --download option above: 

KxRefinery-version/
    packages/
    scripts/