Input parameters for agent management versioned app retrieval

Configuration parameters for external repository inputs in the agent management versioned app retrieval add-on for agent management. Includes common parameters and repository-specific settings for GitHub, GitLab, JFrog Artifactory, Sonatype Nexus Repository.

The agent management versioned app retrieval add-on handles artifact downloads from several types of external repositories. Configure these parameters in $SPLUNK_HOME/etc/apps/agent_management_versioned_app_retrieval/local/inputs.conf. Some parameters are common and required across all types, while others are specific to a particular type of external repository.

Common parameters

The following parameters are required for all types of external repositories:

name
Name of the input stanza, for example, gitlab_apps.
repository_type
Type of repository. Supported values:
  • github
  • gitlab
  • jfrog
  • nexus
extract_path
Path where the archive should be extracted. For deployment to agents, use $SPLUNK_HOME/etc/deployment-apps. For specific serverclass configurations, use the path specified in the serverclass.conf file in the repositoryLocation parameter.
extension
File extension for the artifact archive. Supported values:
  • .tar.gz
  • .zip
auth_header_type
Authentication header type. Supported values:
  • Basic
  • Bearer
secrets_storage_username
Username created to store the secret under in Splunk secrets storage. For more details, see Install the agent management versioned app retrieval add-on .
max_file_size
Maximum size in megabytes (MB) of one file (archive) that will be downloaded from the external source. Default: 500.
timeout
Timeout in seconds for HTTP requests to the external repository. Default: 60.
max_retries
Maximum number of retries for sending HTTP requests to the external repository if the response was not successful. Default: 3.

JFrog Artifactory parameters

These parameters are specific to JFrog Artifactory repositories.

address
Base address of the JFrog Artifactory repository, for example, https://myjfrog.com.
repository_name
JFrog Artifactory repository name.
artifact_name
JFrog Artifactory artifact (archive) name (without extension).
path
Path to the JFrog Artifactory artifact.

Sonatype Nexus Repository parameters

These parameters are specific to Sonatype Nexus Repository.

address
Base address of the Sonatype Nexus Repository, for example, https://mynexus.com.
repository_name
The name of Sonatype Nexus Repository.
artifact_name
Sonatype Nexus Repository artifact (archive) name (without extension).
path
Path to the Sonatype Nexus Repository artifact.

GitHub parameters

These parameters are specific to GitHub repositories.

address
Base address of GitHub. Can be either a public or private instance. For a publicly hosted GitHub instance, the value should be https://api.github.com.
owner
Owner of the repository.
repository_name
Name of the repository.
branch
(Optional) Branch or tag specifying the revision. Default: main.

GitLab parameters

These parameters are specific to GitLab instances.

address
Base address of the GitLab instance, for example, https://my.gitlab.com.
project_id
ID of the project, for example, 1234.
branch
(Optional) Branch or tag specifying the revision. Default: main.