-
Notifications
You must be signed in to change notification settings - Fork 71
/
manifest.spec.yml
243 lines (243 loc) · 6.54 KB
/
manifest.spec.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
##
## Describes the specification for the package's main manifest.yml file
##
spec:
# Everything under here follows JSON schema (https://json-schema.org/), written as YAML for readability
type: object
additionalProperties: false
properties:
format_version:
description: The version of the package specification format used by this package.
type: string
pattern: '^([0-9]+)\.([0-9]+)\.([0-9]+)(?:-([0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?(?:\+[0-9A-Za-z-]+)?$'
examples:
- "1.0.0"
name:
description: The name of the package.
type: string
pattern: '^[a-z0-9_]+$'
examples:
- apache
title:
description: The title of the package.
type: string
examples:
- Apache
description:
description: A longer description of the package.
type: string
examples:
- Apache Integration
version:
description: The version of the package.
type: string
pattern: '^([0-9]+)\.([0-9]+)\.([0-9]+)(?:-([0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?(?:\+[0-9A-Za-z-]+)?$'
examples:
- "0.1.0"
license:
description: The license under which the package is being released.
type: string
enum:
- basic
default: basic
examples:
- basic
type:
description: The type of package.
type: string
enum:
- integration
examples:
- integration
release:
description: The stability of the package.
type: string
enum:
- experimental
- beta
- ga
examples:
- experimental
categories:
description: Categories to which this package belongs.
type: array
items:
type: string
enum:
- aws
- azure
- cloud
- config_management
- containers
- crm
- custom
- datastore
- elastic_stack
- google_cloud
- kubernetes
- languages
- message_queue
- monitoring
- network
- notification
- os_system
- productivity
- security
- support
- ticketing
- version_control
- web
examples:
- web
conditions:
description: Conditions under which this package can be installed.
type: object
additionalProperties: false
properties:
kibana:
description: Kibana conditions
type: object
additionalProperties: false
properties:
version:
type: string
description: Kibana versions compatible with this package.
examples:
- ">=7.9.0"
icons:
description: List of icons for by this package.
type: array
items:
type: object
additionalProperties: false
properties:
src:
description: Relative path to the icon's image file.
type: string
format: relative-path
examples:
- "/img/logo_apache.svg"
title:
description: Title of icon.
type: string
examples:
- "Apache Logo"
size:
description: Size of the icon.
type: string
examples:
- "32x32"
type:
description: MIME type of the icon image file.
type: string
examples:
- "image/svg+xml"
required:
- src
screenshots:
description: List of screenshots of Kibana assets created by this package.
type: array
items:
type: object
additionalProperties: false
properties:
src:
description: Relative path to the screenshot's image file.
type: string
format: relative-path
examples:
- "/img/apache_httpd_server_status.png"
title:
description: Title of screenshot.
type: string
examples:
- "Apache HTTPD Server Status"
size:
description: Size of the screenshot.
type: string
examples:
- "1215x1199"
type:
description: MIME type of the screenshot image file.
type: string
examples:
- "image/png"
required:
- src
- title
policy_templates:
description: List of policy templates offered by this package.
type: array
items:
type: object
additionalProperties: false
properties:
name:
description: Name of policy template.
type: string
examples:
- apache
title:
description: Title of policy template.
type: string
examples:
- Apache logs and metrics
description:
description: Longer description of policy template.
type: string
examples:
- Collect logs and metrics from Apache instances
inputs:
description: List of inputs supported by policy template.
type: array
items:
type: object
additionalProperties: false
properties:
type:
description: Type of input.
type: string
title:
description: Title of input.
type: string
examples:
- Collect logs from Apache instances
description:
description: Longer description of input.
type: string
examples:
- Collecting Apache access and error logs
template_path:
description: Path of the config template for the input.
type: string
examples:
- ./agent/input/template.yml.hbs
vars:
$ref: "./data_stream/manifest.spec.yml#/definitions/vars"
required:
- type
- title
- description
multiple:
type: boolean
required:
- name
- title
- description
owner:
type: object
additionalProperties: false
properties:
github:
description: GitHub repository name of package maintainer.
type: string
required:
- github
required:
- format_version
- name
- title
- description
- version
- release
- owner