Skip to content

Commit d9888bd

Browse files
authored
Add support for integration deployment mode agentless to include identity fields (#801)
Add new identity fields for agentless, and make them mandatory. This is a breaking change, but there are very few affected integrations.
1 parent 5f2c9ee commit d9888bd

12 files changed

Lines changed: 1045 additions & 648 deletions

File tree

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,4 @@
22
temp/
33
fuzz
44
/build/
5+
.vscode/

code/go/pkg/validator/validator_test.go

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -206,6 +206,14 @@ func TestValidateFile(t *testing.T) {
206206
`field policy_templates.0.inputs.0.vars.0.hide_in_deployment_modes.0: policy_templates.0.inputs.0.vars.0.hide_in_deployment_modes.0 must be one of the following: "agentless"`,
207207
},
208208
},
209+
"bad_deployment_mode_without_identities": {
210+
"manifest.yml",
211+
[]string{
212+
`field policy_templates.0.deployment_modes.agentless: organization is required`,
213+
`field policy_templates.0.deployment_modes.agentless: division is required`,
214+
`field policy_templates.0.deployment_modes.agentless: team is required`,
215+
},
216+
},
209217
"bad_input_dataset_vars": {
210218
"_dev/test/policy/test-vars.yml",
211219
[]string{

spec/changelog.yml

Lines changed: 623 additions & 619 deletions
Large diffs are not rendered by default.

spec/integration/manifest.spec.yml

Lines changed: 61 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -107,13 +107,13 @@ spec:
107107
description: The subscription required for this package.
108108
type: string
109109
enum:
110-
- basic
111-
- gold
112-
- platinum
113-
- enterprise
110+
- basic
111+
- gold
112+
- platinum
113+
- enterprise
114114
default: basic
115115
examples:
116-
- basic
116+
- basic
117117
capabilities:
118118
description: |-
119119
Stack features that are required by the package to work properly.
@@ -147,8 +147,8 @@ spec:
147147
"Collect X from Y with X".
148148
type: string
149149
examples:
150-
- Collect logs and metrics from Apache HTTP Servers with Elastic Agent.
151-
- Collect logs and metrics from Amazon Web Services with Elastic Agent.
150+
- Collect logs and metrics from Apache HTTP Servers with Elastic Agent.
151+
- Collect logs and metrics from Amazon Web Services with Elastic Agent.
152152
deployment_modes:
153153
description: >
154154
Options related to the deployment modes. The deployment mode refers to the mode used to
@@ -174,6 +174,38 @@ spec:
174174
enabled:
175175
type: boolean
176176
default: false
177+
organization:
178+
description: >
179+
The responsible organization of the integration. This is used to tag the agentless agent deployments
180+
for monitoring.
181+
type: string
182+
examples:
183+
- "security"
184+
division:
185+
description: >
186+
The division responsible for the integration. This is used to tag the agentless agent deployments
187+
for monitoring.
188+
type: string
189+
examples:
190+
- "cloud-security"
191+
team:
192+
description: >
193+
The team responsible for the integration. This is used to tag the agentless
194+
agent deployments for monitoring.
195+
type: string
196+
examples:
197+
- "cloud-security-posture-management"
198+
allOf:
199+
- if:
200+
properties:
201+
enabled:
202+
const: true
203+
then:
204+
required:
205+
- organization
206+
- division
207+
- team
208+
177209
icons:
178210
description: List of icons for by this package.
179211
type: array
@@ -258,9 +290,9 @@ spec:
258290
kind of source being managed by this package.
259291
type: string
260292
examples:
261-
- Apache HTTP Server
262-
- MySQL
263-
- AWS
293+
- Apache HTTP Server
294+
- MySQL
295+
- AWS
264296
version:
265297
description: Version of the package, following semantic versioning. It can include pre-release labels.
266298
type: string
@@ -279,9 +311,9 @@ spec:
279311
type: string
280312
pattern: '^(([a-zA-Z0-9-_]+)|([a-zA-Z0-9-_]+\/[a-zA-Z0-9-_]+))$'
281313
examples:
282-
- "elastic"
283-
- "apm-agent-java"
284-
- "ux_infra_team"
314+
- "elastic"
315+
- "apm-agent-java"
316+
- "ux_infra_team"
285317
type:
286318
description: >
287319
Describes who owns the package and the level of support that is
@@ -310,7 +342,7 @@ spec:
310342
type: string
311343
pattern: '^[a-z0-9_]+$'
312344
examples:
313-
- apache
345+
- apache
314346
title:
315347
$ref: "#/definitions/title"
316348
description:
@@ -324,9 +356,9 @@ spec:
324356
description: The type of package.
325357
type: string
326358
enum:
327-
- integration
359+
- integration
328360
examples:
329-
- integration
361+
- integration
330362
categories:
331363
$ref: "#/definitions/categories"
332364
conditions:
@@ -448,13 +480,13 @@ spec:
448480
items:
449481
type: string
450482
required:
451-
- format_version
452-
- name
453-
- title
454-
- description
455-
- version
456-
- type
457-
- owner
483+
- format_version
484+
- name
485+
- title
486+
- description
487+
- version
488+
- type
489+
- owner
458490

459491
# JSON patches for newer versions should be placed on top
460492
versions:
@@ -494,12 +526,12 @@ versions:
494526
deprecated: true # See https://github.com/elastic/package-spec/issues/225
495527
type: string
496528
enum:
497-
- experimental
498-
- beta
499-
- ga
529+
- experimental
530+
- beta
531+
- ga
500532
default: ga
501533
examples:
502-
- experimental
534+
- experimental
503535
- before: 2.0.0
504536
patch:
505537
- op: add
@@ -509,7 +541,7 @@ versions:
509541
deprecated: true # See https://github.com/elastic/package-spec/issues/298.
510542
type: string
511543
enum:
512-
- basic
544+
- basic
513545
default: basic
514546
examples:
515-
- basic
547+
- basic

test/packages/bad_deployment_mode/manifest.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,9 @@ policy_templates:
3535
agentless:
3636
enabled:
3737
true
38+
organization: elastic
39+
division: observability
40+
team: obs-infraobs-integrations
3841
inputs:
3942
- type: logfile
4043
title: Collect sample logs from instances
Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

0 commit comments

Comments
 (0)