In This Section
Overview
The Lumino Starter bundle is a fully self-contained, standalone instance containing all required Lumino components in a ready-to-launch package. This page contains instructions for installing and upgrading the Lumino Starter package.
Prerequisites
Install
Once the prerequisites are installed, getting the starter bundle up and running is quite simple.
First, download the starter tarball on the host on which you want to install the starter bundle. Be sure to substitute a real username in place of service-user – we suggest creating a lumino user and running Lumino services as that user.
Once the download is complete, you can unpack the tarball:
(Optional) If you like, you can get a better idea of the installed directory structure using the 'find' command:
Next we create a symlink to the new release. Strictly speaking, this is optional, but it can make upgrades easier should you have other scripts that need to reference the installation:
Customizing the Configuration
Configuring The Server
Optionally, you may want to configure ports used by the Lumino server. The default port values used by the server are:
Setting | Default | Description |
|---|---|---|
| Lumino Server Port | 8001 | The port on which Lumino will listen for traffic. The Lumino server proxies to its back end Grafana server on the Grafana Port as well as to the Lumino agents that it is configured to proxy to. To change:
|
| Lumino Public Host Address | ... | Thepublichostnameusedin links created by the Lumino Server will use thehostnamespecifedbythe domain property in thelumino.ini To change:
|
| Lumino Agent Connection | ... | You can add additional agents that the server will add to the set of available agents on startup. By default, the Local Agent is configured with "url": "http://localhost:7778/lumino-agent". If you plan on changing the agent's HTTP port below, it should be updated here. To change, update "url": "http://localhost:7778/lumino-agent" to the desired host port combination. |
| Grafana Port | 3000 | The Grafana back-end port. By default, Grafana is bound to 127.0.0.1 (localhost) only so as not to be made accessible externally.
To change this port you must also update http_port in current/app/vendor/grafana/conf/lumino.ini |
When the Lumino server is first launched this file is copied to <install-root>data/grafana/conf/lumino.ini to preserve config changes across upgrades.Configuring the Lumino Agent
Optionally, the agent's properties can be configured in the current/lumino-agent/robin.conf. When the agent first starts up the robin.conf file is copied to data/robin/robin.conf so that in future upgrades the configuration is preserved. So if you have already attempted to start the agent, then the values below should be edited in data/robin/robin.conf.
Port | Property | Default | Description |
|---|---|---|---|
| Lumino Agent Port | lumino.agent.http.port | 7778 | The port exposed by the agent to Lumino Server. Changing this port is only recommended if you anticipate a port conflict.
|
| Lumino Discovery | nv.discovery.descriptor | mcast://224.0.1.200:4090 | Sets the discovery descriptor to be used to discover running XVMS.
Update nv.discovery.descriptor=mcast://224.0.1.200:4090 |
| Admin Transports | nv.server.admin.transports | direct | The default behavior of a Lumino agent is to directly connect to discovered XVMs over direct tcp connections. If you'd prefer to use messaging as the monitoring transport this may be changed to 'sma' and the bus.descriptor must be specified (see below). Example: nv.server.admin.transports=sma SINCE 1.4 |
| nv.server.admin.sma.bus.descriptor | - | If configuring to use Admin over SMA, this property sets the bus connection descriptor that is used to monitor and control discovered XVMs. Example (admin over solace): SINCE 1.4 | |
| Influx Url | lumino.agent.influx.url | http://localhost:8086 | The connection url to influx. By default, this is set to the bundled influx instance. It should be changed if you change influx connection information below or plan to point the agent at a difference influx instance.
|
| Influx Username | lumino.agent.influx.username | root | The username used to connect to influx to write agent collected data. |
| Influx Password | lumino.agent.influx.password | root | The password used to connect to influx to write agent collected data. |
Note that changing this value requires that the agent's connection information be updated in the Lumino Server's Lumino Agents UI Configuring Influx DB
Optionally, the bundled influx instance configuration properties can be configured in the current/conf/influxdb.conf file. When the agent first starts up the influxdb.conf file is copied to data/influxdb/influx.conf so that in future upgrades the configuration is preserved. So if you have already attempted to start the agent, then the values below should be edited in data/influxdb/influx.conf .
Setting | Default | Description |
|---|---|---|
| Influx Bind Address | 8086 | The port on which Lumino will listen for traffic. The lumino server proxies to its back end Grafana server on the Grafana Port as well as to the Lumino agents that is configured to proxy to. To change uncomment the bind-address = ":8086" and be sure to make the corresponding change to the agent configuration. |
Launching Lumino
Finally, we're ready to start all the components in the starter bundle. JAVA_HOME must be set to point to the home directory of java 8 JVM, and don't forget to ensure that the X License is installed on the target host (for example in the user home folder of the user used to launch Lumino).
You should now be able to log in to the Lumino Server instance running on port 8001 (unless you changed it above) using the credentials admin:admin. Be sure to change your admin account password after you log in.
Upgrade
Upgrades of the starter bundle can be done in-place using a process very similar to the initial installation.
First, we start by downloading the latest release on the target host:
Next, we unpack the tarball passing --no-overwrite-dir to the tar command to avoid some quirks related to the way tar handles directories:
Now we're ready to stop the previous instance. Use the stop.sh script in the old Lumino installation directory to shut everything down:
Now that everything has stopped, update the "current" symlink to point to the latest release:
Now we're ready to start everything up again:
Again, the new release should be up and running on port 8001.