Add JSON patch to remove SLO assets for spec versions less than 3.4.0 by mrodm · Pull Request #884 · elastic/package-spec

mrodm · 2025-03-21T14:23:16Z

What does this PR do?

Remove SLO assets in content package for spec versions < 3.4.0, as it is applied in the integration packages.

Ensure that all the kibana validation rules are also executed in content packages.

Why is it important?

Keep the same behavior in content and integration packages.

Checklist

I have added test packages to test/packages that prove my change is effective.
I have added an entry in spec/changelog.yml.
Test changes with packages in the integrations repository https://buildkite.com/elastic/integrations/builds/23702

Related issues

Relates Initial definition of content pack[age]s #777
Relates Add SLO assets to the package spec #767

mrodm · 2025-03-21T14:25:19Z

test/packages/good_content/validation.yml

+errors:
+  exclude_checks:
+    - PSR00001 # Allow to use unreleased features in GA package.


Added since 3.4.0 is not released yet (-next prerelease tag)

mrodm · 2025-03-21T14:43:50Z

test/packages/good_content/manifest.yml

@@ -1,4 +1,4 @@
-format_version: 3.3.1
+format_version: 3.4.0


Should it be updated the spec version for the compliance test here ?

package-spec/compliance/features/basic.feature

Lines 16 to 19 in 4366bf7

@3.3.0

Scenario: Content package can be installed

Given the "good_content" package is installed

#Then there are no errors.

That test is running successfully even if that spec version is not updated.

If the package has SLOs it should be updated, yes.

If that spec version is updated to be @3.4.0, I guess it should be needed to add a new compliance test for 3.4.0.

Or should it be updated the one with stack 9.1.0-SNAPSHOT to 3.4.0 ? @jsoriano

package-spec/.buildkite/pipeline.trigger.compliance.tests.sh

Line 31 in 4366bf7

compliance_test 9.1.0-SNAPSHOT 3.3.3

Would it be better to create a new content package without SLO , so it can be tested that scenario with previous spec versions 3.3.0 ?

Added a new basic_content test package , to be able to keep testing content packages with spec version 3.3.0 (and previous Elastic stacks). Added in 6250bd1

mrodm · 2025-03-21T15:31:54Z

test integrations

elastic-vault-github-plugin-prod · 2025-03-21T15:37:53Z

Created or updated PR in integrations repository to test this version. Check elastic/integrations#13242

jsoriano · 2025-03-21T16:11:58Z

test/packages/good_content/manifest.yml

@@ -1,4 +1,4 @@
-format_version: 3.3.1
+format_version: 3.4.0


If the package has SLOs it should be updated, yes.

jsoriano · 2025-03-21T16:13:15Z

code/go/internal/validator/spec.go

 		{fn: semantic.ValidateKibanaNoDanglingObjectIDs, since: semver.MustParse("3.0.0")},
 		{fn: semantic.ValidateKibanaFilterPresent, since: semver.MustParse("3.0.0")},
-		{fn: semantic.ValidateKibanaNoLegacyVisualizations, types: []string{"integration"}, since: semver.MustParse("3.0.0")},
+		{fn: semantic.ValidateKibanaNoLegacyVisualizations, types: []string{"integration", "content"}, since: semver.MustParse("3.0.0")},


Should these changes be mentioned in the changelog too?

Added a new changelog entry for these changes in dd33139

mrodm · 2025-03-21T16:22:52Z

Validated in elastic/integrations#13242 that testing of the current content packages (kubernetes_otel and nginx_ingress_controller_otel) defined in the integrations repository is successful.

Buildkite build: https://buildkite.com/elastic/integrations/builds/23702

mrodm · 2025-03-21T17:12:05Z

.buildkite/pipeline.trigger.compliance.tests.sh

 EOF

 # Generate each test we want to do.
+compliance_test 9.1.0-SNAPSHOT 3.4.0


This would allow to test the installation of good_content package that contains SLO assets.

@3.4.0 Scenario: Content package can be installed Given the "good_content" package is installed #Then there are no errors.

Does it make sense?

Or maybe, just use the new basic_content package for compliance testing and remove the testing of good_content (this contains SLO assets)?

If good_content package is removed from these tests, there is no need to add this new compliance test with spec 3.4.0.

Compliance tests for 3.4.0 in 9.1.0 should fail, because 3.4.0 is not implemented yet. Or is it?

It's not failing the current compliance tests, but I don't see any SLO assets created when I tested locally to install in Elastic stack 9.1.0-SNAPSHOT (related PR not merged yet elastic/kibana#186974).

It has been updated the compliance test using the good_content package to validate that there is a specific SLO asset installed. Currently, it's failing when using spec 3.4.0 and latest Elastic stack 9.1.0-SNAPSHOT.

https://buildkite.com/elastic/package-spec/builds/1053#0195c88d-3a38-44db-a668-f1c14f0cf477

Therefore, I will remove the compliance test for that scenario (9.1.0-SNAPSHOT and spec 3.4.0): 5b59414

elasticmachine · 2025-03-24T14:57:09Z

💚 Build Succeeded

Buildkite Build
Commit: 5b59414

History

💔 Build #1053 failed 68f0ca3
💔 Build #1052 failed 335b842
💚 Build #1051 succeeded d03827b
💔 Build #1050 failed 432bfa3
💚 Build #1047 succeeded dd33139

cc @mrodm

mrodm added 2 commits March 21, 2025 13:42

Add JSON patch to remove slo folder in content packages

d7b0288

Add slo assets into good_content test package

b225c40

mrodm self-assigned this Mar 21, 2025

mrodm added 2 commits March 21, 2025 15:23

Add changelog entry

b01367e

Remove security capability

3161ea5

mrodm commented Mar 21, 2025

View reviewed changes

mrodm marked this pull request as ready for review March 21, 2025 14:44

mrodm requested a review from a team as a code owner March 21, 2025 14:44

Run kibana validation rules in content packages too

72fa169

elastic-vault-github-plugin-prod bot mentioned this pull request Mar 21, 2025

Test branch package-spec#884 - DO NOT MERGE elastic/integrations#13242

Closed

jsoriano previously approved these changes Mar 21, 2025

View reviewed changes

jsoriano reviewed Mar 21, 2025

View reviewed changes

Add another changelog entry

dd33139

mrodm dismissed jsoriano’s stale review via dd33139 March 21, 2025 16:24

mrodm added 4 commits March 21, 2025 17:49

Add basic content package for compliance tests

6250bd1

Add missing attribute in dashboard

c8d3ffc

Include compliance test for 3.4.0 with current latest snapshot

833b6d8

Set spec version 3.3.0 for basic_content

432bfa3

mrodm commented Mar 21, 2025

View reviewed changes

Set 3.3.1 spec version for basic_content

d03827b

mrodm requested a review from jsoriano March 21, 2025 17:40

mrodm added 3 commits March 24, 2025 13:09

Add new compliance checks for SLO and dashboards

335b842

Refactor kibana functions

68f0ca3

Remove compliance test for 9.1.0-SNAPSHOT and spec 3.4.0

5b59414

jsoriano approved these changes Mar 24, 2025

View reviewed changes

mrodm merged commit c5acb1c into elastic:main Mar 24, 2025
3 checks passed

mrodm deleted the patch_remove_slo_folder_content_packages branch March 24, 2025 16:37

	@3.3.0
	Scenario: Content package can be installed
	Given the "good_content" package is installed
	#Then there are no errors.

Conversation

mrodm commented Mar 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

Why is it important?

Checklist

Related issues

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mrodm commented Mar 21, 2025

Uh oh!

elastic-vault-github-plugin-prod bot commented Mar 21, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mrodm commented Mar 21, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mrodm Mar 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mrodm Mar 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

elasticmachine commented Mar 24, 2025

💚 Build Succeeded

History

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

mrodm commented Mar 21, 2025 •

edited

Loading

mrodm Mar 21, 2025 •

edited

Loading

mrodm Mar 24, 2025 •

edited

Loading