Configuration¶
For the complete list of Jetstream configuration options, please see jetstream server and jetstream relay_server command reference.
Editing Configuration¶
Jetstream services use response files for configuration, which contain all arguments that would normally be given on the command line. The arguments can be specified on a single line or argument per line for better readability. For example /etc/jetstream-server.rsp
:
--api-allow-remote-control
--trigger-dir=/var/lib/jetstream/triggers
--persistent-state-dir=/var/lib/jetstream/state
--license-location=5053@jetstream-license.cumul8.com
After editing configuration response files for one of the services, you will need to restart the service in order for the changes to take effect.
See also
- jetstream server command options
- jetstream relay_server command options
- Managing System Services
Linux (CentOS, Ubuntu)¶
The jetstream-server
startup arguments can be specified in the /etc/jetstream-server.rsp
file, and jetstream-relay
startup arguments in the /etc/jetstream-relay.rsp
file.
Any environment variables that Jetstream may require (for eg. RLM_LICENSE_PASSWORD
) can be added to the /etc/jetstream-server.env
file on new lines.
macOS¶
The jetstream-server
startup arguments can be specified in the /usr/local/jetstream/etc/jetstream-server.rsp
file, and jetstream-relay
startup arguments in the /usr/local/jetstream/etc/jetstream-relay.rsp
file.
Any environment variables that Jetstream may require can be added to the /usr/local/jetstream/etc/jetstream-server.env
file on new lines, or uncommented if they already exist.
Windows¶
On Windows, all Jetstream Server service startup arguments can be specified in the C:\Program Files\Cumul8\Jetstream Server\etc\jetstream-server.rsp
file, and Jetstream Relay service startup arguments in the C:\Program Files\Cumul8\Jetstream Server\etc\jetstream-relay.rsp
file.
Any other environment variables that Jetstream requires (such as RLM_LICENSE_PASSWORD
) can be specified in Advanced System Properties:
Open the System Control Panel
Choose Advanced system settings from the left menu bar
On the bottom of the window click on Environment Variables
On the bottom of the window, under System Variables, click New…
For Variable name:, enter:
RLM_LICENSE_PASSWORD
. For Variable value:, enter the password that was provided to you.Click OK and close all the windows.
License Configuration¶
Jetstream server requires a license to run. If you do not have a license, service logs will print the following:
Jetstream command error: Error checking out license: No license for product (-1)
For a demo license, you need to add a --license-password
argument (preferred) or set the RLM_LICENSE_PASSWORD
environment variable with the password that was provided to you as its contents. Please contact sales@cumul8.com if you wish to customize your demo license.
For a paid license, customize the --license-location
argument to point it to your own license server, or an offline/node-locked license file. By default it points to a license server hosted by Eight Solutions Inc.
See also
- Editing Configuration
- jetstream server command options
Startup Configuration¶
In order for the Jetstream server to know where to send the data, it needs to be configured with another Jetstream server. This configuration is not persistent and needs to be done each time the jetstream-server
service restarts or the machine reboots. To avoid manual configuration each time, a launch trigger can be used to set this automatically.
Create a new or edit the existing launch trigger and add the following contents (Linux example):
#!/bin/sh
export JETSTREAM_API_PASSWORD=secret
/usr/local/bin/jetstream api --user <username> createDestination --destinationAddress <destination_address> --sendRateMax=100000
Here, we use JETSTREAM_API_PASSWORD
environment variable, to avoid using it in command line parameters, where it’s visible to users who have shell access to the server. <destination_address>
is the IP address of the remote Jetstream server, and <username>
is a username used to authenticate against the local Jetstream server. The --user
parameter is only required if Jetstream is running as a privileged process. A password can be specified as an environment variable in the trigger file (see example above, or API documentation).
As this is a launch trigger, Jetstream will only execute it at startup. If the Jetstream server is already running, you’ll need to restart the jetstream-server
service, or execute the launch
script manually.