Supported Linux Versions:
– Ubuntu 22.x or higher
– Red Hat Enterprise Linux (RHEL) 8.x or higher
1. Downloading repositories and installer.
Download the installer to the installation directory. For example, from [server]/home/saltworks
$ curl –header “X-JFrog-Art-Api: AKCp8jQnGCX2fzgVgc1vKY66YBNetgPPTdddbRQJoxanqq5LNqDDmuoczLYVGrc7PHBW6f9Vs” https://saltminer.jfrog.io/artifactory/test-saltminer-local/deploy/SaltMinerDeploymentArtifacts-2308031917.zip –output sm.zip
Ensure that there is a license.txt in the same directory as the installer. We typically use SCP to upload this, for example if the license file is on your local machine you could use the following command from the command prompt in a folder that contains the license file:
$ scp license.txt saltworks@10.9.2.13:/home/saltworks/
Unzip the installer files:
$ unzip sm.zip
Note: If necessary, install unzip:
$ sudo apt install -y unzip
2. Installing prerequisites and Saltminer.
WARNING: At several points during the installation the script will ask if components installed ok which is confirming that no errors were encountered. The script can be suspended in order to make changes to the system and then resumed. Also, at key points in the installation the script can be exited and when restarted and will resume after the last completion point. The installation script should only be run ONCE to completion on a system for any give section, e.g. Elasticsearch, Kibana, or Saltminer components. There are no checks for pre-existing installation.
Change permissions of the install script:
$ chmod +x sm-install.sh
Run the install script:
$ ./sm-install.sh
Notes on Install Script:
- You will be required to accept to license agreements during this phase of the installation by clicking “OK” and “Yes”.
- After installing prereqs (you will receive the following messages:
Package installation complete.- Prereqs (dotnet, unzip, nginx, pip) installed ok (y/n)? [y]
- Test installation of nginx by using a browser to go to the server. If nginx is running correctly you should get a
- 502 Bad Gateway message.
- For single server installation, no edits required for elasticsearch.yml
- Passwords can be generated only once. Be sure to copy them to a place where they can be accessed later in the installation.
- After editing kibana.yml including setting the kibana_system password test again with browser. You should be able to login using the elastic user and password.
- For demo systems, skip the firewall configuration and answer yes (y) to Firewall configuration good…?
- Once the script completes you can confirm that the API is up by going to http://server/smapi/swagger
3. Configuring and installing source adapters.
All source adapters have values which can be set or overridden in a configuration file for that source adapter. Details on these common core settings and instructions for configuring them and running them can be found here Source Adapters along with the documentation for that specific adapter.
Configure the Source Adapter(s) according to the instructions for that source before proceeding to Step 4.
4. Run the Source Adapters and the SaltMiner Manager:
Saltminer is set up to automatically run the Source Adapter agents at regular intervals to pull updates from the source systems into a queue. Saltminer also processes the queues at regular intervals to normalize and enrich the data to make it available in Saltminer visualizations.
After configuration of a new Source Adapter the operator may manually run the scripts to ingest data from Source Adpaters.