Skip to content

Installation

Upon being admitted to the platform, you'll receive an email with a license key and a link to download the app in a .tgz format.

Please refer to your relevant Splunk deployment type below to deploy the app.

Splunk Cloud Platform

Install the private app through Splunk Cloud Platform (SCP) Apps:

  1. Log in to Splunk Web as an administrator and open Apps > Manage Apps.
  2. Click Uploaded Apps and then Upload App. Enter your splunk.com credentials.
  3. Drag the packaged lynx_ai_agent.tgz app to the upload window, or use the file picker to select the package.
  4. Click Upload. Splunk AppInspect vets the app in Splunk Cloud Platform, which is indicated by a status value of "Vetting".
  5. Once the app passes vetting, click the Install link that appears next to the app name.
  6. Installing the app should be followed with a restart of your Splunk Cloud Platform components. Click Continue.
  7. When the app finishes deploying, click Close.

Info

Learn more about SCP private apps here.

Splunk Enterprise

Installing Lynx AI Agent on Splunk Enterprise can be done either via the Web UI or from configuration. Here's how you do it:

Single Instance & Single Search Head

Install from Splunk Web

  1. Log in to Splunk Web as an administrator and open Apps > Manage Apps.
  2. Click Install app from file, upload lynx_ai_agent.tgz, and click Upload.
  3. Restart Splunk by navigating Settings > Server Controls > Restart Splunk to fully load the app.

Note

If Lynx AI Agent is already installed, choose Upgrade app when prompted. This replaces the previous version safely and preserves any local changes you made to the app.

Install from configuration

  1. Extract the app and copy it to the apps directory: 
    tar -xvzf lynx_ai_agent.tgz -C $SPLUNK_HOME/etc/apps
  2. Ensure the ownership is splunk:splunk and permissions are readable.
  3. Restart Splunk with $SPLUNK_HOME/bin/splunk restart.

Search Head Cluster

Deploy through the cluster Deployer:

  1. Extract the app and copy it to the apps directory: 
    tar -xvzf lynx_ai_agent.tgz -C $SPLUNK_HOME/etc/shcluster/apps
  2. Ensure the ownership is splunk:splunk and permissions are readable.
  3. Run $SPLUNK_HOME/bin/splunk apply shcluster-bundle -target https://<captain>:8089 -auth admin:<password>.
  4. Monitor the rolling restart; once complete, confirm the app is enabled on every search head.

Upgrading

Upgrading Lynx AI Agent follows the same process as upgrading any other Splunk app. Deploy the new .tgz package the same way you installed it, whether through Splunk Web or configuration files, and follow the steps in the sections above that match your environment.

From Splunk Web: Upload the updated package and select Upgrade app when prompted. This safely replaces the previous version while preserving any local changes.

From configuration: Replace the app files under $SPLUNK_HOME/etc/apps (or on your Search Head Cluster deployer) with the contents of the new package, then restart Splunk or deploy a rolling restart to the cluster.

After Splunk finishes restarting, hard-refresh your browser to clear cached app assets and load the latest version. Press Ctrl+F5 on Windows or Linux, or Cmd+Shift+R on macOS.