diff --git a/code/go/pkg/validator/validator_test.go b/code/go/pkg/validator/validator_test.go index ca481fb47..ad100e1f9 100644 --- a/code/go/pkg/validator/validator_test.go +++ b/code/go/pkg/validator/validator_test.go @@ -44,6 +44,7 @@ func TestValidateFile(t *testing.T) { "custom_ilm_policy": {}, "profiling_symbolizer": {}, "logs_synthetic_mode": {}, + "kibana_configuration_links": {}, "bad_additional_content": { "bad-bad", []string{ @@ -239,6 +240,13 @@ func TestValidateFile(t *testing.T) { "field policy_templates_behavior: policy_templates_behavior must be one of the following: \"all\"", }, }, + "bad_configuration_links": { + "manifest.yml", + []string{ + "field policy_templates.0.configuration_links: Array must have at least 1 items", + "field policy_templates.1.configuration_links.0: url is required", + }, + }, } for pkgName, test := range tests { diff --git a/spec/changelog.yml b/spec/changelog.yml index 738d8fef1..c646e1799 100644 --- a/spec/changelog.yml +++ b/spec/changelog.yml @@ -18,6 +18,9 @@ - description: Added new policy_templates_behavior setting to manage how to show policy templates to the user in Kibana. type: enhancement link: https://github.com/elastic/package-spec/pull/825 + - description: Add support for configuration links to kibana manifest. + type: enhancement + link: https://github.com/elastic/package-spec/pull/834 - version: 3.3.0 changes: - description: Add support for content packages. diff --git a/spec/input/manifest.spec.yml b/spec/input/manifest.spec.yml index 02bc3bf95..fa9bd7456 100644 --- a/spec/input/manifest.spec.yml +++ b/spec/input/manifest.spec.yml @@ -69,6 +69,8 @@ spec: - Collect logs and metrics from Apache instances deployment_modes: $ref: "../integration/manifest.spec.yml#/definitions/deployment_modes" + configuration_links: + $ref: "../integration/manifest.spec.yml#/definitions/configuration_links" icons: $ref: "../integration/manifest.spec.yml#/definitions/icons" screenshots: diff --git a/spec/integration/manifest.spec.yml b/spec/integration/manifest.spec.yml index b3bb960b9..ded75c237 100644 --- a/spec/integration/manifest.spec.yml +++ b/spec/integration/manifest.spec.yml @@ -205,6 +205,33 @@ spec: - organization - division - team + configuration_links: + description: List of links related to inputs and policy templates. + type: array + minItems: 1 + items: + type: object + additionalProperties: false + properties: + title: + description: Link title + type: string + url: + description: Link url + type: string + type: + 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. + type: string + enum: + - action + - next_step + content: + description: Link description + type: string + required: + - title + - url + - type icons: description: List of icons for by this package. type: array @@ -410,6 +437,8 @@ spec: - access deployment_modes: $ref: "#/definitions/deployment_modes" + configuration_links: + $ref: "#/definitions/configuration_links" inputs: description: List of inputs supported by policy template. type: array @@ -519,6 +548,10 @@ spec: # JSON patches for newer versions should be placed on top versions: + - before: 3.3.1 + patch: + - op: remove + path: "/properties/policy_templates/items/properties/configuration_links" - before: 3.2.0 patch: - op: remove diff --git a/test/packages/bad_configuration_links/LICENSE.txt b/test/packages/bad_configuration_links/LICENSE.txt new file mode 100644 index 000000000..d64569567 --- /dev/null +++ b/test/packages/bad_configuration_links/LICENSE.txt @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/test/packages/bad_configuration_links/NOTICE.txt b/test/packages/bad_configuration_links/NOTICE.txt new file mode 100644 index 000000000..c76edc139 --- /dev/null +++ b/test/packages/bad_configuration_links/NOTICE.txt @@ -0,0 +1,2 @@ +Elastic package-spec +Copyright 2021 Elasticsearch B.V. \ No newline at end of file diff --git a/test/packages/bad_configuration_links/changelog.yml b/test/packages/bad_configuration_links/changelog.yml new file mode 100644 index 000000000..b87e10200 --- /dev/null +++ b/test/packages/bad_configuration_links/changelog.yml @@ -0,0 +1,31 @@ +- version: 1.0.1 + changes: + - description: Add kibana configuration links + type: enhancement + link: https://github.com/elastic/package-spec/pull/834 +- version: 1.0.0 + changes: + - description: LTS version + type: enhancement + link: https://github.com/elastic/package-spec/pull/256 +- version: 1.0.0-next + changes: + - description: release candidate + type: enhancement + link: https://github.com/elastic/package-spec/pull/172 +- version: 0.1.1 + changes: + - description: Change A + type: enhancement + link: https://github.com/elastic/package-spec/pull/193 + - description: Change B + type: enhancement + link: https://github.com/elastic/package-spec/pull/193 + - description: Change C + type: enhancement + link: https://github.com/elastic/package-spec/pull/193 +- version: 0.1.2 + changes: + - description: initial release + type: enhancement + link: https://github.com/elastic/package-spec/pull/131 diff --git a/test/packages/bad_configuration_links/docs/README.md b/test/packages/bad_configuration_links/docs/README.md new file mode 100644 index 000000000..1a9dfb44c --- /dev/null +++ b/test/packages/bad_configuration_links/docs/README.md @@ -0,0 +1 @@ +This is a template for the package README. \ No newline at end of file diff --git a/test/packages/bad_configuration_links/img/kibana-system.png b/test/packages/bad_configuration_links/img/kibana-system.png new file mode 100644 index 000000000..8741a5662 Binary files /dev/null and b/test/packages/bad_configuration_links/img/kibana-system.png differ diff --git a/test/packages/bad_configuration_links/img/metricbeat_system_dashboard.png b/test/packages/bad_configuration_links/img/metricbeat_system_dashboard.png new file mode 100644 index 000000000..2ff6ad8bd Binary files /dev/null and b/test/packages/bad_configuration_links/img/metricbeat_system_dashboard.png differ diff --git a/test/packages/bad_configuration_links/img/system.svg b/test/packages/bad_configuration_links/img/system.svg new file mode 100644 index 000000000..0aba96275 --- /dev/null +++ b/test/packages/bad_configuration_links/img/system.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/test/packages/bad_configuration_links/manifest.yml b/test/packages/bad_configuration_links/manifest.yml new file mode 100644 index 000000000..484c23d92 --- /dev/null +++ b/test/packages/bad_configuration_links/manifest.yml @@ -0,0 +1,131 @@ +format_version: 3.3.1 +name: bad_links +title: Bad Configuration Links +description: Bad configuration links examples +version: 1.0.1 +type: integration +source: + license: "Apache-2.0" +conditions: + kibana: + version: '^8.10.0' + elastic: + subscription: 'basic' + capabilities: + - observability + - security +vars: + - name: package_password + type: password + title: Package Level Secret + show_user: true + secret: true + - name: bearer_token_file + title: A file to a secret, but not a secret itself. + type: text + show_user: true + - name: token_url + title: A URL to get secrets, but not a secret itself. + type: url + show_user: true +policy_templates_behavior: individual_policies +policy_templates: + - name: apache + title: Apache logs and metrics + description: Collect logs and metrics from Apache instances + deployment_modes: + agentless: + enabled: true + organization: elastic + division: observability + team: obs-infraobs-integrations + # bad format: empty array + configuration_links: [] + inputs: + - type: apache/metrics + title: Collect metrics from Apache instances + description: Collecting Apache status metrics + multi: false + vars: + - name: input_password + type: password + title: Input Level Secret + show_user: true + secret: true + - name: api_key + type: password + title: Some API key + show_user: true + secret: true + hide_in_deployment_modes: + - default + - name: hosts + type: url + url_allowed_schemes: ['http', 'https'] + title: Hosts + multi: true + required: true + show_user: true + default: + - http://127.0.0.1 + hide_in_deployment_modes: + - agentless + - name: apache-agentless + title: Apache logs and metrics in agentless + description: Collect logs and metrics from Apache instances in agentless + deployment_modes: + agentless: + enabled: true + organization: security + division: engineering + team: cloud-security + # bad format: missing fields + configuration_links: + - title: Security overview + type: next_step + inputs: + - type: apache/metrics + title: Collect metrics in agentless + description: Collecting metrics in agentless mode + multi: false + vars: + - name: input_password + type: password + title: Input Level Secret + show_user: true + secret: true + - name: hosts + type: url + url_allowed_schemes: ['http', 'https'] + title: Hosts + multi: true + required: true + show_user: true + default: + - http://127.0.0.1 +owner: + github: elastic/foobar + type: elastic +screenshots: + - src: /img/kibana-system.png + title: kibana system + size: 1220x852 + type: image/png + - src: /img/metricbeat_system_dashboard.png + title: metricbeat system dashboard + size: 2097x1933 + type: image/png +icons: + - src: /img/system.svg + title: system + size: 1000x1000 + type: image/svg+xml +agent: + privileges: + root: true +# /main is a specific action underneath the monitor privilege. Declaring +# "monitor/main" limits the provided privilege, "monitor", to only the "main" +# action. +elasticsearch: + privileges: + cluster: [monitor/main] diff --git a/test/packages/bad_configuration_links/validation.yml b/test/packages/bad_configuration_links/validation.yml new file mode 100644 index 000000000..1a9fc84c5 --- /dev/null +++ b/test/packages/bad_configuration_links/validation.yml @@ -0,0 +1,3 @@ +errors: + exclude_checks: + - PSR00001 # Allow to use unreleased features in GA package. diff --git a/test/packages/good_v3/changelog.yml b/test/packages/good_v3/changelog.yml index 61f4d434b..b87e10200 100644 --- a/test/packages/good_v3/changelog.yml +++ b/test/packages/good_v3/changelog.yml @@ -1,3 +1,8 @@ +- version: 1.0.1 + changes: + - description: Add kibana configuration links + type: enhancement + link: https://github.com/elastic/package-spec/pull/834 - version: 1.0.0 changes: - description: LTS version diff --git a/test/packages/good_v3/manifest.yml b/test/packages/good_v3/manifest.yml index 7ed15ecbe..14519231a 100644 --- a/test/packages/good_v3/manifest.yml +++ b/test/packages/good_v3/manifest.yml @@ -2,7 +2,7 @@ format_version: 3.4.0 name: good_v3 title: Good package description: This package is good for format version 3 -version: 1.0.0 +version: 1.0.1 type: integration source: license: "Apache-2.0" @@ -39,7 +39,11 @@ policy_templates: organization: elastic division: observability team: obs-infraobs-integrations - + configuration_links: + - title: Security overview + url: "/security/overview" + type: next_step + content: "View security overview" inputs: - type: apache/metrics title: Collect metrics from Apache instances diff --git a/test/packages/kibana_configuration_links/LICENSE.txt b/test/packages/kibana_configuration_links/LICENSE.txt new file mode 100644 index 000000000..d64569567 --- /dev/null +++ b/test/packages/kibana_configuration_links/LICENSE.txt @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/test/packages/kibana_configuration_links/NOTICE.txt b/test/packages/kibana_configuration_links/NOTICE.txt new file mode 100644 index 000000000..c76edc139 --- /dev/null +++ b/test/packages/kibana_configuration_links/NOTICE.txt @@ -0,0 +1,2 @@ +Elastic package-spec +Copyright 2021 Elasticsearch B.V. \ No newline at end of file diff --git a/test/packages/kibana_configuration_links/changelog.yml b/test/packages/kibana_configuration_links/changelog.yml new file mode 100644 index 000000000..b87e10200 --- /dev/null +++ b/test/packages/kibana_configuration_links/changelog.yml @@ -0,0 +1,31 @@ +- version: 1.0.1 + changes: + - description: Add kibana configuration links + type: enhancement + link: https://github.com/elastic/package-spec/pull/834 +- version: 1.0.0 + changes: + - description: LTS version + type: enhancement + link: https://github.com/elastic/package-spec/pull/256 +- version: 1.0.0-next + changes: + - description: release candidate + type: enhancement + link: https://github.com/elastic/package-spec/pull/172 +- version: 0.1.1 + changes: + - description: Change A + type: enhancement + link: https://github.com/elastic/package-spec/pull/193 + - description: Change B + type: enhancement + link: https://github.com/elastic/package-spec/pull/193 + - description: Change C + type: enhancement + link: https://github.com/elastic/package-spec/pull/193 +- version: 0.1.2 + changes: + - description: initial release + type: enhancement + link: https://github.com/elastic/package-spec/pull/131 diff --git a/test/packages/kibana_configuration_links/docs/README.md b/test/packages/kibana_configuration_links/docs/README.md new file mode 100644 index 000000000..1a9dfb44c --- /dev/null +++ b/test/packages/kibana_configuration_links/docs/README.md @@ -0,0 +1 @@ +This is a template for the package README. \ No newline at end of file diff --git a/test/packages/kibana_configuration_links/img/kibana-system.png b/test/packages/kibana_configuration_links/img/kibana-system.png new file mode 100644 index 000000000..8741a5662 Binary files /dev/null and b/test/packages/kibana_configuration_links/img/kibana-system.png differ diff --git a/test/packages/kibana_configuration_links/img/metricbeat_system_dashboard.png b/test/packages/kibana_configuration_links/img/metricbeat_system_dashboard.png new file mode 100644 index 000000000..2ff6ad8bd Binary files /dev/null and b/test/packages/kibana_configuration_links/img/metricbeat_system_dashboard.png differ diff --git a/test/packages/kibana_configuration_links/img/system.svg b/test/packages/kibana_configuration_links/img/system.svg new file mode 100644 index 000000000..0aba96275 --- /dev/null +++ b/test/packages/kibana_configuration_links/img/system.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/test/packages/kibana_configuration_links/manifest.yml b/test/packages/kibana_configuration_links/manifest.yml new file mode 100644 index 000000000..11703ad7e --- /dev/null +++ b/test/packages/kibana_configuration_links/manifest.yml @@ -0,0 +1,130 @@ +format_version: 3.3.1 +name: kibana_configuration_links +title: Kibana Configuration Links +description: Kibana configuration links examples +version: 1.0.1 +type: integration +source: + license: "Apache-2.0" +conditions: + kibana: + version: '^8.10.0' + elastic: + subscription: 'basic' + capabilities: + - observability + - security +vars: + - name: package_password + type: password + title: Package Level Secret + show_user: true + secret: true + - name: bearer_token_file + title: A file to a secret, but not a secret itself. + type: text + show_user: true + - name: token_url + title: A URL to get secrets, but not a secret itself. + type: url + show_user: true +policy_templates_behavior: individual_policies +policy_templates: + - name: apache + title: Apache logs and metrics + description: Collect logs and metrics from Apache instances + deployment_modes: + agentless: + enabled: true + organization: elastic + division: observability + team: obs-infraobs-integrations + configuration_links: + - title: Security overview + url: "/security/overview" + type: next_step + content: "View security overview" + inputs: + - type: apache/metrics + title: Collect metrics from Apache instances + description: Collecting Apache status metrics + multi: false + vars: + - name: input_password + type: password + title: Input Level Secret + show_user: true + secret: true + - name: api_key + type: password + title: Some API key + show_user: true + secret: true + hide_in_deployment_modes: + - default + - name: hosts + type: url + url_allowed_schemes: ['http', 'https'] + title: Hosts + multi: true + required: true + show_user: true + default: + - http://127.0.0.1 + hide_in_deployment_modes: + - agentless + - name: apache-agentless + title: Apache logs and metrics in agentless + description: Collect logs and metrics from Apache instances in agentless + deployment_modes: + agentless: + enabled: true + organization: security + division: engineering + team: cloud-security + inputs: + - type: apache/metrics + title: Collect metrics in agentless + description: Collecting metrics in agentless mode + multi: false + vars: + - name: input_password + type: password + title: Input Level Secret + show_user: true + secret: true + - name: hosts + type: url + url_allowed_schemes: ['http', 'https'] + title: Hosts + multi: true + required: true + show_user: true + default: + - http://127.0.0.1 +owner: + github: elastic/foobar + type: elastic +screenshots: + - src: /img/kibana-system.png + title: kibana system + size: 1220x852 + type: image/png + - src: /img/metricbeat_system_dashboard.png + title: metricbeat system dashboard + size: 2097x1933 + type: image/png +icons: + - src: /img/system.svg + title: system + size: 1000x1000 + type: image/svg+xml +agent: + privileges: + root: true +# /main is a specific action underneath the monitor privilege. Declaring +# "monitor/main" limits the provided privilege, "monitor", to only the "main" +# action. +elasticsearch: + privileges: + cluster: [monitor/main] diff --git a/test/packages/kibana_configuration_links/validation.yml b/test/packages/kibana_configuration_links/validation.yml new file mode 100644 index 000000000..1a9fc84c5 --- /dev/null +++ b/test/packages/kibana_configuration_links/validation.yml @@ -0,0 +1,3 @@ +errors: + exclude_checks: + - PSR00001 # Allow to use unreleased features in GA package.