Requirements for the agent management versioned app retrieval add-on

System requirements and prerequisites for the agent management versioned app retrieval add-on in Splunk® Enterprise for agent management. Requires agent management 10.0 or higher, supported external repositories (GitHub, GitLab, JFrog Artifactory, Sonatype Nexus Repository), and properly structured artifact archives.

Before you install and configure the agent management versioned app retrieval add-on, ensure your environment meets these requirements.

Agent management requirements

A Splunk instance configured as agent management, version 10.0 or higher.

External repository requirements

Artifacts must be stored in one of the following external repository:

  • GitHub
  • GitLab
  • JFrog Artifactory
  • Sonatype Nexus Repository

Authentication requirements

You must have valid credentials to access the external repository:

  • For GitHub and GitLab: Personal access token or OAuth token with read access to repositories
  • For JFrog Artifactory and Sonatype Nexus Repository: Username and password or API token with download permissions
  • Credentials must be stored in Splunk secrets storage before configuring inputs

Network requirements

  • HTTPS connectivity from the agent management instance to the external repositories
  • Outbound firewall rules allowing HTTPS (port 443) to the external repository servers
  • For on-premises external repositories: Network access to the external repository server
  • TLS 1.2 or higher support

Resource requirements

  • Disk space: Minimum 1 MB free for add-on storage
  • Additional disk space equal to 3x the largest artifact size (for download, extraction, and retention of two versions)
  • Default maximum artifact size: 500 MB (configurable via the max_file_size parameter)

Artifact format requirements

The agent management versioned app retrieval add-on requires a specific archive structure to properly extract apps and ensure agent management can recognize them as valid Splunk apps. If the structure does not match this format, extraction will fail or apps will not be recognized.

Artifact archives must adhere to the following structure:

CODE 
archive.tar.gz/
├── archive_folder/
    ├── app1_folder/
    │   ├── default/
    │   ├── metadata/
    │   └── (other Splunk app files)
    ├── app2_folder/
    │   ├── default/
    │   ├── metadata/
    │   └── (other Splunk app files)
    └── app3_folder/
        ├── default/
        ├── metadata/
        └── (other Splunk app files)

Where app1_folder, app2_folder, app3_folder are folders corresponding to Splunk apps. Each app folder must contain standard Splunk app structure with at minimum the following items:

  • default/ directory with the app.conf file
  • metadata/ directory with the default.meta file
  • (Optional) local/, bin/, static/, and other standard Splunk app directories

For GitHub and GitLab repositories, app folders should be located directly in the repository. In this case, archive_folder will be the repository name.