1. RED TV Deployment Guide¶
This document describes how to install, upgrade, and patch the Technical Version (TV) of the RED framework on a target host. The TV comprises the RED framework itself: its executables, management tools, system service configuration, and database schemas.
A TV is delivered as a self-extracting executable:
Full installer
red_install_<version>: used for fresh installations and for upgrades from any older version.Patch installer
red_patch_<from_version>_to_<to_version>(e.g.red_patch_2.0.0_to_2.0.1): a compact package that upgrades a host running exactly<from_version>to<to_version>.
1.1. Overview of TV Deployment¶
A TV deployment consists of three sequential phases:
Host Installation (as
root): run the full or patch installer on the target host.Environment Instance Setup (as
redsys): create a new environment instance withredenv_createor upgrade an existing one withredenv_upgrade.Database Schema Installation (inside the environment context): install or upgrade the database schemas with
redtvctl install.
Phase |
Fresh Installation |
Upgrade or Patch |
|---|---|---|
Host Installation |
|
|
Environment Instance |
|
|
Database Schema |
|
|
Note
A patch only differs from a full installer in the host installation phase. Environment instances and the database are upgraded in exactly the same way for both.
1.2. Prerequisites¶
1.2.1. Target Host¶
Requirement |
Value |
|---|---|
Operating system |
Red Hat Enterprise Linux (RHEL) 8 or 9, Oracle Linux 8 or 9 (tested versions) |
CPU |
at least 8 cores |
Memory |
at least 16 GB RAM |
Application filesystem |
|
Firewall |
firewalld stopped and disabled |
SELinux |
disabled (runtime mode and configuration) |
The installers abort on operating systems that are not based on RHEL or older than version 8.
Important
For sFTP file delivery the SSH daemon must be configured manually once per server; the installer does not modify /etc/ssh/sshd_config. See SSH Daemon Configuration in the RED-PSS Guide.
1.2.2. Database¶
Exasol database (tested with Exasol 2025 LTS).
The database
SYSpassword is required for the database schema installation.The database name must match the parameter exa_dbname in the environment configuration.
1.2.3. Operational¶
Create a backup of the database before upgrading an existing installation.
Plan a maintenance window: the installers stop all running environment instances on the host.
1.2.4. Pre-installation Check¶
The full installer provides a check mode (-c) that verifies the host requirements. It requires no root privileges and changes nothing on the host. Run it before the actual installation:
Example: Verify Host Readiness
/tmp/red_install_<version> -c
All failed checks are listed. The exit code is 0 if all checks have passed and 1 otherwise. A non-LVM device for /app is only reported as a warning.
The default thresholds can be overridden via environment variables, e.g. for test systems:
Example: Check with Reduced Thresholds
PRE_MIN_CPUS=4 PRE_MIN_RAM_GB=8 /tmp/red_install_<version> -c
Variable |
Default |
Description |
|---|---|---|
PRE_MOUNT |
/app |
application filesystem to check |
PRE_MIN_CPUS |
8 |
minimum number of CPU cores |
PRE_MIN_RAM_GB |
16 |
minimum RAM in GB |
PRE_MIN_DISK_GB |
64 |
minimum size of the application filesystem in GB |
1.2.5. Current Version¶
To determine the currently installed versions before an upgrade or patch:
Component |
How to check |
|---|---|
Host |
|
Environment instance |
|
Database |
columns |
1.3. Phase 1: Host Installation¶
The host installation is performed by the system administrator as root (e.g. via sudo -i). Transfer the installer to the target host, e.g. into /tmp.
1.3.1. Full Installer¶
Example: Run the Full Installer
sudo -i
/tmp/red_install_<version>
The full installer automatically runs the pre-installation checks first (see Prerequisites). If a check fails, the installation is aborted before anything on the host is changed. Use option -f to install anyway; failed checks are then reported as warnings only.
The installer compares the installed host version (/etc/red) with its own version:
equal: nothing to do, the installer exits without changes.
host is newer: the installation is aborted.
host is older or no RED installation exists: the host is upgraded or installed.
1.3.2. Patch Installer¶
Example: Run a Patch Installer
sudo -i
/tmp/red_patch_2.0.0_to_2.0.1
A patch installer only runs on a host that has exactly <from_version> installed (as recorded in /etc/red). Otherwise it aborts without changing any files. The patch installer does not run the pre-installation checks.
1.3.3. What the Installer Does¶
Both installers perform the following steps:
Stop services: all running environment instances on the host are stopped.
Users and groups: the system users and groups (see below) are created if they are missing.
Upgrade: version-specific host upgrade steps are applied for all versions between the installed and the new version.
Framework files: the framework, management tools, and the
.seedtemplate for environment instances are installed or updated under/app. Personal shell settings (.bashrc,.bash_profile) are not overwritten.Host configuration: sudo rules, SSH daemon settings, and the systemd service
redsys.serviceare installed and enabled, so that all environment instances with autostart enabled start on boot.Version:
/etc/redis updated to the new version.Language containers: the Exasol script language containers are updated if they are part of the package. If more than one Exasol client configuration exists on the host, the installer prints the
clconfigcommands to be run manually instead.
Note
After the host installation the environment instances are still at the old version and stopped. Continue with Phase 2 and Phase 3 for every instance before starting them again.
1.3.4. System Users and Groups¶
The installer creates the following users and groups with fixed IDs to ensure consistent file ownership across all hosts:
Name |
Type |
ID |
Description |
|---|---|---|---|
exasol |
user and group |
1050 |
owns the Exasol client environment and tools in |
redsys |
user and group |
1070 |
owns the RED framework and all environment instances in |
redapp |
group |
1080 |
supplementary group for the RED application space |
redftp |
group |
1200 |
shared group for file exchange via sFTP |
Individual sFTP users are bound to the UID range 1200 – 1299 and share the group redftp.
For the directory structure under /app refer to the RED-PSS Guide.
1.4. Phase 2: Environment Instance Setup¶
After the host installation, environment instances have to be created or upgraded.
Important
Run the environment management commands as user redsys (e.g. sudo -iu redsys) from the host shell, not from within an environment context.
1.4.1. Creating a New Environment Instance¶
Example: Create an Environment Instance
redenv_create <new_env_name>
redenv_create copies the .seed template to /app/redsys/env/<new_env_name> and assigns port numbers that do not overlap with the existing instances on the host: service_base_port, mail2cmd_port, gu_port, and vis_port.
Place the licence file of the new instance in its directory etc (see Licence File in the RED-PSS Guide); without a valid licence, the DB jobs of the instance are suspended.
To start the new instance automatically on boot, create the (empty) file .autostart in the instance directory:
Example: Enable Autostart
touch /app/redsys/env/<new_env_name>/.autostart
Note
The shell alias for the new environment is not available in the current session. Reload the profile (source ~/.bashrc) or log in as redsys again.
1.4.2. Upgrading an Existing Environment Instance¶
Use redenv_upgrade after a full installer or a patch installer has been applied:
Example: Upgrade an Environment Instance
redenv_upgrade <env_name>
redenv_upgrade:
stops the instance if it is still running,
applies the version-specific upgrade steps (e.g. new sections and parameters in the instance configuration),
replaces the framework executables and libraries with the version from the
.seedtemplate,updates the instance version in
log/TVERSION.
The instance configuration files etc/red_params.conf and etc/profile are never replaced. Developer environments are rejected.
1.4.3. Switching to the Environment Context¶
Enter the context of an instance with redenv <env_name> or simply with the environment name, which the redsys profile provides as an alias:
<env_name>
The shell prompt shows the active environment. All RED commands now operate on this instance; leave the context with exit.
1.4.4. Verifying the Configuration¶
Check the instance configuration, especially after creating a new instance or after an upgrade that introduced new parameters:
<env_name>
vi etc/red_params.conf
Make sure that all environment-specific values, such as the database connection (exa_dbname and related parameters), are set correctly.
1.5. Phase 3: Database Schema Installation¶
The final step installs or upgrades the database schemas of the environment instance.
1.5.1. Running the Database Installer¶
Example: Install the Database Schemas
<env_name>
redtvctl install
The SYS password is prompted interactively, or it can be passed with -p <password>.
redtvctl install determines the mode automatically:
Full installation: the database contains no schemas yet. All RED schemas, users, roles, and parameters are created. In addition, the password of the Exasol
adminuser is prompted at the beginning (or passed with-a <password>), and the following connections are created:XMLRPC_API: access to the Exasol XML-RPC interface as useradmin.EXASOL_CLUSTER_EXECUTION: connection to the database as userEXASYS, which receives a randomly generated password.
Incremental upgrade: RED schemas exist. All database upgrades between the current database version and the new version are applied in sequence. If the database is already at the new version (or newer), nothing is done.
The installer aborts if
processes of the instance are still running,
the database name does not match exa_dbname,
the current database version is not in status
CLOSED,a script language container cannot be verified.
All output is written to the log file log/tv.install.<mode>.<version>.<timestamp>.log, where <mode> is full or incr. After a successful installation the database is at the new version with status CLOSED.
1.6. Starting and Verifying the Instance¶
Leave the environment context and start the instance:
Example: Start the Instance
exit
redsysctl start <env_name>
redsysctl status <env_name>
Verify that host (/etc/red), instance (log/TVERSION), and database (REDSYS.ADM_CURRENT_TVERSION) show the new version (see Prerequisites).
1.7. Troubleshooting¶
Symptom |
Cause and Action |
|---|---|
Full installer aborts with failed pre-installation checks |
Fix the reported issues (see |
Installer aborts: unsupported OS |
The host is not based on RHEL 8 or later. Only RHEL and Oracle Linux 8 and 9 are tested. |
Full installer aborts: host version is newer |
The host already runs a newer TV. Use the matching installer. |
Patch installer aborts: version mismatch |
The host is not at |
|
Stop the instance with |
|
A previous database installation did not complete. Check the latest |
|
The Exasol script language containers are missing or outdated. Run |