Tarball package#
Users of any recent Linux distribution on the x86_64 or AArch64 instruction set
architecture can use the tar.gz
archive, the “tarball”, to install
Starburst Enterprise platform (SEP).
The tarball includes the application and all plugins. However, unlike the RPM installation method, this archive does not include or create any default configuration settings, and the server is not configured to start as a service. You must add all configuration options as desired.
Extracting tarball contents#
Download the tarball as described on the download page. Look for a file named with the following pattern:
starburst-enterprise-<version>.tar.gz
where <version> is the version identifier for SEP such as 355-e.
In a terminal session, navigate to a temporary extraction location.
Use the
tar
command to extract the package:tar xvfz ~/Downloads/starburst-enterprise-*.tar.gz
Prefix this command with
sudo
if your extraction directory is a system location for which your current username does not have write rights.
Extracted directory structure#
The tarball package extracts the files used by SEP into a single directory, using the basename of the archive as the directory name, organized as follows:
bin
— contains thelauncher
script to start and stop the server and its support fileslib
— contains various libraries needed to run the productplugin
— contains libraries used by individual connectorsstarburst-insights
— contains files needed by Starburst Insights
Installation after extraction#
The tar
command in Extracting tarball contents extracts the contents into a
single directory with the release number in its name. Continue after extraction
to install the extracted files into a more generalized runtime location that is
not tied to the extracted release number.
Follow your site’s standards and Linux standard practice to determine a runtime location for SEP. Consider the following suggested locations:
/opt/starburst
/usr/local/starburst
/usr/local/lib/starburst
Note
If you have or expect to have the RPM installation of SEP on the same machine, then do not install the tarball files into the locations used by the RPM installer, described in RPM package.
The instructions below use /opt/starburst
only as an example target
installation location.
After extracting the tarball’s files, follow these steps to create an SEP installation.
Move the extracted directory to the target location. For example:
sudo mv starburst-enterprise-* /opt/starburst
Determine a location for SEP’s configuration files, such as
/etc/sep
. Keeping the configuration directory separate from the target directory allows you to upgrade SEP versions without changing configuration.Create a symbolic link named
etc
in the target directory pointing to the actual configuration directory. For example:cd /opt/starburst sudo ln -s /etc/sep etc
The SEP server by default looks for a configuration directory named
etc
parallel to itsbin
andlib
directories. To specify a different location, use the--etc-dir
option described in Specifying non-default locations. Alternatively, you can use anetc
directory in the target directory, and copy that to each new installation location for upgrades.Populate the configuration directory with configuration files that describe how the server is to run. For a starting point set of configuration files you can copy, see Configuring Trino.
Start the server with
/opt/starburst/bin/launcher start
.
Using the launcher
command#
The installation provides a bin/launcher
utility, which requires Python in
the PATH
. The utility can be used manually or as a daemon startup script. It
accepts six commands:
Command |
Action |
---|---|
|
Starts the server in the foreground and leaves it running. To shut down
the server, use Ctrl+C in this terminal or the |
|
Starts the server as a daemon and returns its process ID. |
|
Shuts down a server started with either |
|
Stops then restarts a running server, or starts a stopped server, assigning a new process ID. |
|
Shuts down a possibly hung server by sending the SIGKILL signal. |
|
Prints a status line, either Stopped pid or Running as pid. |
The -v
or --verbose
option for each command prepends the server’s
current settings before the command’s usual output, much like the following
example:
config_path = /etc/sep/config.properties
data_dir = /opt/starburst
etc_dir = /etc/sep
install_path = /opt/starburst
jvm_config = /etc/sep/jvm.config
jvm_options = []
launcher_config = /opt/starburst/bin/launcher.properties
launcher_log = /opt/starburst/var/log/launcher.log
log_levels = /etc/sep/log.properties
log_levels_set = False
node_config = /etc/sep/node.properties
pid_file = /opt/starburst/var/run/launcher.pid
properties = {'node.environment': 'demo', 'node.id': 'ffffffff-ffff-ffff-ffff-ffffffffffff'}
server_log = /opt/starburst/var/log/server.log
verbose = True
Specifying non-default locations#
A number of additional options allow you to specify non-default configuration file and directory locations, as well as Java options.
--etc-dir=DIR Defaults to INSTALL_PATH/etc
--launcher-config=FILE Defaults to INSTALL_PATH/bin/launcher.properties
--node-config=FILE Defaults to ETC_DIR/node.properties
--jvm-config=FILE Defaults to ETC_DIR/jvm.config
--config=FILE Defaults to ETC_DIR/config.properties
--log-levels-file=FILE Defaults to ETC_DIR/log.properties
--data-dir=DIR Defaults to INSTALL_PATH
--pid-file=FILE Defaults to DATA_DIR/var/run/launcher.pid
--launcher-log-file=FILE Defaults to DATA_DIR/var/log/launcher.log (only in
daemon mode)
--server-log-file=FILE Defaults to DATA_DIR/var/log/server.log (only in
daemon mode)
-J OPT Set a JVM option
-D NAME=VALUE Set a Java system property