You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
94 lines
2.8 KiB
94 lines
2.8 KiB
.\" generated with Ronn/v0.7.3
|
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
|
.
|
|
.TH "SLIM\-PACKAGE" "1" "May 2020" "Splunk, Inc." "Splunk Packaging Toolkit"
|
|
.
|
|
.SH "NAME"
|
|
\fBslim\-package\fR \- make an app source package for distribution
|
|
.
|
|
.SH "SYNOPSIS"
|
|
\fBslim\fR \fBpackage\fR [(\fB\-h\fR|\fB\-\-help\fR)] [(\fB\-r\fR|\fB\-\-repository=\fR)<repository>] [(\fB\-u\fR|\fB\-\-unreferenced\-input\-groups=)\fR<level>] [(\fB\-o\fR|\fB\-\-output\-dir=\fR)<output\-dir>] <app\-source>
|
|
.
|
|
.SH "DESCRIPTION"
|
|
Makes a Splunk app source package for distribution\. It asssumes the \fBapp\.manifest\fR file is located at the root of the app source directory\. The manifest file must exist for the package command to run\. The source package filename is derived from the app id as follows:
|
|
.
|
|
.P
|
|
\~\~\~\~\fI<info\.id\.group>\fR\fB\-\fR\fI<info\.id\.name>\fR\fB\-\fR\fI<info\.id\.version>\fR\fB\.tar\.gz\fR
|
|
.
|
|
.P
|
|
The file is placed on the \fBoutput\fR directory, which defaults to the current directory\.
|
|
.
|
|
.P
|
|
Since you\'re likely to link your app directories to \fB${SPLUNK_HOME}/etc/apps\fR to debug locally, the following standard set of ignore files has been generated, and you have the option to specify your own list in a \fB\.slimignore\fR file at the root of the app source directory\. The standard ignore list includes these files:
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
\&\.DS_STORE
|
|
Thumbs\.db
|
|
*\.py[co]
|
|
default/indexes\.conf
|
|
local/
|
|
metadata/local\.meta
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.SH "OPTIONS"
|
|
<app\-source>
|
|
.
|
|
.br
|
|
Location of the app source directory\.
|
|
.
|
|
.P
|
|
\fB\-h\fR, \fB\-\-help\fR
|
|
.
|
|
.br
|
|
Print help message and exit\.
|
|
.
|
|
.P
|
|
\fB\-o\fR <output\-dir>, \fB\-\-output\-dir=\fR<output\-dir>
|
|
.
|
|
.br
|
|
Save the app source package to the directory at this location\. (default: current directory)
|
|
.
|
|
.P
|
|
\fB\-r\fR <repository>, \fB\-\-repository=\fR<repository>
|
|
.
|
|
.br
|
|
Look for dependent source packages in the directory at this location\. (default: \fB${SLIM_REPOSITORY:=~/\.slim/repository}\fR)
|
|
.
|
|
.P
|
|
\fB\-u\fR <level>, \fB\-\-unreferenced\-input\-groups=\fR<level>
|
|
.
|
|
.br
|
|
Report unreferenced input groups at \fBlevel\fR: \fBnote\fR or \fBwarn\fR or \fBerror\fR (default: \fBnote\fR)
|
|
.
|
|
.SH "EXAMPLES"
|
|
The following example demonstrates using the \fBpackage\fR command to package an app called "fictional\."
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
$ slim \-\-debug package \-\-unreferenced\-input\-groups=note \-\-repository ~/\.slim/repository fictional
|
|
package: Packaging app "fictional" to "~/slim"\.\.\.
|
|
package: [INFO] fictional: unreferenced input groups: dependency com\.splunk\.addon:microsoft_windows:4\.7\.5:
|
|
Active Directory Domain Services
|
|
DHCP Server
|
|
Windows Event Log
|
|
Windows Host Monitor
|
|
Windows Network Monitor
|
|
Windows Performance Monitor
|
|
Windows Print Monitor
|
|
Windows Registry
|
|
Windows Update Monitor
|
|
package: Source package exported to "~/slim/com\.splunk\.addons\-fictional\-1\.0\.0\.tar\.gz"
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
|