Skip to content

Commit 002f84c

Browse files
jsorianojsoriano
committed
Merge remote-tracking branch 'origin/main' into fix-ga-content-packages
2 parents 2a9551b + 6cad88c commit 002f84c

24 files changed

Lines changed: 834 additions & 2 deletions

‎code/go/pkg/validator/validator_test.go‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ func TestValidateFile(t *testing.T) {
4444
"custom_ilm_policy": {},
4545
"profiling_symbolizer": {},
4646
"logs_synthetic_mode": {},
47+
"kibana_configuration_links": {},
4748
"bad_additional_content": {
4849
"bad-bad",
4950
[]string{
@@ -239,6 +240,15 @@ func TestValidateFile(t *testing.T) {
239240
"field policy_templates_behavior: policy_templates_behavior must be one of the following: \"all\"",
240241
},
241242
},
243+
"bad_configuration_links": {
244+
"manifest.yml",
245+
[]string{
246+
"field policy_templates.0.configuration_links: Array must have at least 1 items",
247+
"field policy_templates.1.configuration_links.0: url is required",
248+
"field policy_templates.1.configuration_links.1.url: Does not match pattern '^(http(s)?://|kbn:/)'",
249+
"field policy_templates.1.configuration_links.2.url: Does not match pattern '^(http(s)?://|kbn:/)'",
250+
},
251+
},
242252
}
243253

244254
for pkgName, test := range tests {

‎spec/changelog.yml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,12 @@
1818
- description: Added new policy_templates_behavior setting to manage how to show policy templates to the user in Kibana.
1919
type: enhancement
2020
link: https://github.com/elastic/package-spec/pull/825
21+
- description: Add support for configuration links to kibana manifest.
22+
type: enhancement
23+
link: https://github.com/elastic/package-spec/pull/834
24+
- description: Expand support to internal and external configuration_links defined in kibana manifest.
25+
type: enhancement
26+
link: https://github.com/elastic/package-spec/pull/844
2127
- description: Release content packages as GA.
2228
type: enhancement
2329
link: https://github.com/elastic/package-spec/issues/841

‎spec/input/manifest.spec.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,8 @@ spec:
6969
- Collect logs and metrics from Apache instances
7070
deployment_modes:
7171
$ref: "../integration/manifest.spec.yml#/definitions/deployment_modes"
72+
configuration_links:
73+
$ref: "../integration/manifest.spec.yml#/definitions/configuration_links"
7274
icons:
7375
$ref: "../integration/manifest.spec.yml#/definitions/icons"
7476
screenshots:

‎spec/integration/manifest.spec.yml‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -205,6 +205,34 @@ spec:
205205
- organization
206206
- division
207207
- team
208+
configuration_links:
209+
description: List of links related to inputs and policy templates.
210+
type: array
211+
minItems: 1
212+
items:
213+
type: object
214+
additionalProperties: false
215+
properties:
216+
title:
217+
description: Link title
218+
type: string
219+
url:
220+
description: Link url. Format is `http://...` or `https://...` for external links, `kbn:/app/...` for links internal to Kibana.
221+
type: string
222+
pattern: '^(http(s)?://|kbn:/)'
223+
type:
224+
description: Type of link. `next_steps` for links to locations that can be relevant right after configuring the policy. `action` for actions that can be performed while the policy is in use.
225+
type: string
226+
enum:
227+
- action
228+
- next_step
229+
content:
230+
description: Link description
231+
type: string
232+
required:
233+
- title
234+
- url
235+
- type
208236
icons:
209237
description: List of icons for by this package.
210238
type: array
@@ -410,6 +438,8 @@ spec:
410438
- access
411439
deployment_modes:
412440
$ref: "#/definitions/deployment_modes"
441+
configuration_links:
442+
$ref: "#/definitions/configuration_links"
413443
inputs:
414444
description: List of inputs supported by policy template.
415445
type: array
@@ -519,6 +549,10 @@ spec:
519549

520550
# JSON patches for newer versions should be placed on top
521551
versions:
552+
- before: 3.3.1
553+
patch:
554+
- op: remove
555+
path: "/properties/policy_templates/items/properties/configuration_links"
522556
- before: 3.2.0
523557
patch:
524558
- op: remove

‎test/packages/bad_configuration_links/LICENSE.txt‎

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.

‎test/packages/bad_configuration_links/NOTICE.txt‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Elastic package-spec
2+
Copyright 2021 Elasticsearch B.V.

‎test/packages/bad_configuration_links/changelog.yml‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
- version: 1.0.1
2+
changes:
3+
- description: Add kibana configuration links
4+
type: enhancement
5+
link: https://github.com/elastic/package-spec/pull/834
6+
- version: 1.0.0
7+
changes:
8+
- description: LTS version
9+
type: enhancement
10+
link: https://github.com/elastic/package-spec/pull/256
11+
- version: 1.0.0-next
12+
changes:
13+
- description: release candidate
14+
type: enhancement
15+
link: https://github.com/elastic/package-spec/pull/172
16+
- version: 0.1.1
17+
changes:
18+
- description: Change A
19+
type: enhancement
20+
link: https://github.com/elastic/package-spec/pull/193
21+
- description: Change B
22+
type: enhancement
23+
link: https://github.com/elastic/package-spec/pull/193
24+
- description: Change C
25+
type: enhancement
26+
link: https://github.com/elastic/package-spec/pull/193
27+
- version: 0.1.2
28+
changes:
29+
- description: initial release
30+
type: enhancement
31+
link: https://github.com/elastic/package-spec/pull/131

‎test/packages/bad_configuration_links/docs/README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
This is a template for the package README.

‎test/packages/bad_configuration_links/img/kibana-system.png‎

200 KB
Loading

‎test/packages/bad_configuration_links/img/metricbeat_system_dashboard.png‎

562 KB
Loading

0 commit comments

Comments
 (0)