Manager commands
This is a quick reference guide for all the manager commands in Unravel.
Quick reference - manager commands
You can refer to this section for the manager tool commands. Any commands from this list can be run from the Manager tool as follows:
<Unravel installation directory>/manager <manager command> For example: /opt/unravel/manager start
Main actions
The table shows the main actions displayed when you run the manager tool. You can run any of these actions for setting up services and configurations.
Action
Description
start
Start Unravel
stop
Stop Unravel
restart
Restart Unravel
report
Report Unravel services
watch
Report Unravel services. Refreshes every two seconds
service
Additional service management commands
config
Configure Unravel
refresh
Refresh scripts and configurations
activate
Activate an Unravel version
version
Unravel version information
precheck
Verify that the system configuration supports the currently running Unravel
healthcheck
Verify the health of an Unravel installation
run
Run Unravel scripts
api
Unravel API tools
Configuration
Commands
Description
config auto
Starts autoconfig, which is the automatic mode.
URL, username, and password will be prompted unless --URL, --username , and --password are passed.
config notebook
Configures and enables Jupyter notebook service.
config archive
Archives the content of
data/confandservicesinto a tar file and stored indata/conf_archives.refresh <entity>
Refreshes the specified entity. An entity can be any of the following:
all
files
kafka
db
es
Note
Stop Unravel before you run refresh <entity>.
Custom ports
Commands
Description
help config ports
Open the config ports menu.
config ports show
Display currently defined port values.
config ports unset
Returns a custom port value to its default value.
manager config ports remap
begin<specify start range>end<specify end range>Set range for Unravel ports.
email
Commands
Description
config email
Configure email.
Install and upgrade
Commands
Description
version
Shows the Unravel version and components information.
verify <sensor|properties|files>
Sensor: Checks the cluster configuration and ensures that the sensor parameters are correct.
properties: Validates
unravel.properties, checking for invalid, unknown, and duplicate properties.files: Verifies and reports on any unexpected changes to unravel components, scripts, and configuration.
activate
Displays a list of available versions of Unravel for activation. This applies to upgrades, downgrades, and patches. The manager tool verifies the compatibility before making any changes.
activate <version>
Activates a specific version of Unravel.
uninstall
Uninstalls Unravel.
Log Receiver (LR) endpoint (Databricks) with TLS
The following commands are used to update the Log Receiver (LR) endpoint if the Unravel LR is not accessible with the default hostname and port from Databricks, based on various TLS scenarios.
Commands
Description
config databricks set-lr-endpoint <hostname> 4043
Set LR hostname and LR port number to default, when TLS is NOT enabled.
config databricks set-lr-endpoint <hostname> 4443
Set LR hostname and LR port number to default, when TLS is enabled.
config databricks set-lr-endpoint <hostname> 4043 --no-tls
Set LR hostname and LR port number to default, when TLS is enabled but you want to keep using HTTP.
Monitoring
Commands
Description
report
Shows the status of all unravel services.
report <service>
Shows the status of the specified service.
watch
Shows the status of all unravel services.
watch <service>
Shows the status of the specified service.
service list
Display detailed status information about the service.
service is-enabled <service>
Shows whether the service is enabled.
service is-running <service>
Shows whether the service is running.
service is-alive <service>
Shows whether the service is alive.
healthcheck
To run healthcheck.
License
Commands
Description
license set <filename>
Takes a filename as input.
license show
Displays the content of the current license and its validity.
Service Management
Commands
Description
start
Starts unravel and all the enabled services.
start <service>
Only starts the specified service.
stop
Stops unravel and all the running services.
stop <service>
Stops only the specified service.
restart
Restart all services.
restart <service>
Restart only a specific service.
service enable <service>
This enables a service that was temporarily disabled.
Run the service enable <service> --permanent command to update unravel.yaml
service disable <service>
Temporarily disables a service. Run the service disable <service> --permanent, which updates the
unravel.yamlfile and permanently disables a service.TLS
Command
Description
config tls trust enable|disable
Enable or disable Unravel using a truststore to use when connecting to services secured with TLS. This requires regenerating files.
config tls trust add
<path>config tls trust --jks
<path>config tls trust --pem
<path>config tls trust --pkcs12
<path>Imports certificates to trust. For example, autodetect format is based on the extension.
Supported <format> are:
PEM
PKCS12
JKS
<path>is the path to the file to import.config tls enable|disable
Enable/disable using a TLS for Unravel. This requires regenerating files.
config tls set
<path>config tls set --jks
<path>config tls set --pem
<path>config tls set --pkcs12
<path>Set the certificate and key to use for TLS. First example autodetect format based on the extension.
Supported <format> are:
PEM
PKCS12
JKS
For PKCS12 and JKS, the user will be prompted for the password.
<path>is the path to the file to import.Tagging
Commands
Description
config tagging enable|disable
Enable/disable tagging support for UnravelThis requires regenerating files.
config tagging set
Allows setting the script and the method for tagging.