[Fleet] use @kbn/config-schema in Fleet API (Part 1) #192883

juliaElastic · 2024-09-13T14:37:17Z

Summary

Readd #192447 with fixes and tests to validate that the response schemas are correct.

Checklist

Unit or functional tests were updated or added to match the most common scenarios

## Summary Part of elastic#184685 First set of changes, I'm planning to do more prs for the remaining endpoints. Will also look at making sure these schema definitions are included in the final kibana `bundle.json`, related doc: https://elasticco.atlassian.net/wiki/spaces/DOC/pages/450494532/API+reference+docs When all schema definitions are moved to code, the fleet/openapi folder can be deleted. To check the result, add to `kibana.dev.yml`: `server.oas.enabled: true` And then in kibana console, query: ``` GET kbn:/api/oas?pathStartsWith=/api/fleet/setup GET kbn:/api/oas?pathStartsWith=/api/fleet/agents/setup GET kbn:/api/oas?pathStartsWith=/api/fleet/package_policies GET kbn:/api/oas?pathStartsWith=/api/fleet/package_policies/delete GET kbn:/api/oas?pathStartsWith=/api/fleet/settings GET kbn:/api/oas?pathStartsWith=/internal/fleet/settings/enrollment ``` To generate the bundle from code, run: ``` node scripts/capture_oas_snapshot --include-path /api/fleet --no-serverless --update # writes to oas_docs/bundle.json ``` Response: ``` { "openapi": "3.0.0", "info": { "title": "Kibana HTTP APIs", "version": "0.0.0" }, "servers": [ { "url": "http://localhost:5603/julia" } ], "paths": { "/api/fleet/setup": { "post": { "summary": "", "tags": [], "description": "Initiate Fleet setup", "responses": { "200": { "content": { "application/json; Elastic-Api-Version=2023-10-31": { "schema": { "type": "object", "description": "A summary of the result of Fleet's `setup` lifecycle. If `isInitialized` is true, Fleet is ready to accept agent enrollment. `nonFatalErrors` may include useful insight into non-blocking issues with Fleet setup.", "properties": { "isInitialized": { "type": "boolean" }, "nonFatalErrors": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "message": { "type": "string" } }, "additionalProperties": false, "required": [ "name", "message" ] } } }, "additionalProperties": false, "required": [ "isInitialized", "nonFatalErrors" ] } } } }, "400": { "content": { "application/json; Elastic-Api-Version=2023-10-31": { "schema": { "type": "object", "description": "Generic Error", "properties": { "statusCode": { "type": "number" }, "error": { "type": "string" }, "message": { "type": "string" } }, "additionalProperties": false, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "content": { "application/json; Elastic-Api-Version=2023-10-31": { "schema": { "type": "object", "description": "Internal Server Error", "properties": { "message": { "type": "string" } }, "additionalProperties": false, "required": [ "message" ] } } } } }, "parameters": [ { "in": "header", "name": "elastic-api-version", "description": "The version of the API to use", "schema": { "type": "string", "enum": [ "2023-10-31" ], "default": "2023-10-31" } }, { "description": "A required header to protect against CSRF attacks", "in": "header", "name": "kbn-xsrf", "required": true, "schema": { "example": "true", "type": "string" } } ], "operationId": "%2Fapi%2Ffleet%2Fsetup#0" } } }, "components": { "schemas": {}, "securitySchemes": { "basicAuth": { "type": "http", "scheme": "basic" }, "apiKeyAuth": { "type": "apiKey", "in": "header", "name": "Authorization" } } }, "security": [ { "basicAuth": [] } ], "tags": [] } ```

obltmachine · 2024-09-13T14:37:32Z

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

/oblt-deploy : Deploy a Kibana instance using the Observability test environments.
run docs-build : Re-trigger the docs validation. (use unformatted text in the comment!)

juliaElastic · 2024-09-13T14:38:43Z

x-pack/plugins/fleet/server/routes/package_policy/handlers.test.ts

      });
+
+      const validationResp = PackagePolicyResponseSchema.validate(responseItem);


this way I'm making sure the response schema works, trying to fill all fields in objects, including optional ones

elasticmachine · 2024-09-16T12:21:30Z

Pinging @elastic/fleet (Team:Fleet)

criamico · 2024-09-17T10:22:29Z

@juliaElastic I'm testing this branch locally. The specs are correctly generated from dev tools, but I found some failures on package_policies.

Tried to edit an existing package policy and failed with this error
Tried to create a new package policy:

Let me know if you need more info. I'll keep testing other paths.

Note: from package_policies I also deleted one integration policy, upgraded one that had older version and ran dryRun and they all worked for me. As of now the only two endpoints that had issues are the above.

criamico · 2024-09-17T10:48:16Z

I found another error in a case of dryRun - however it seems pretty similar to the edit above:

This was an integration that I had already installed and it fails on this branch.

juliaElastic · 2024-09-17T11:01:09Z

Tried to create a new package policy

Fixed the issue with the create package policy.
I can't reproduce the edit/dryrun error, which integration have you tried? I tested with akamai and endpoint.

criamico · 2024-09-17T12:42:55Z

I can't reproduce the edit/dryrun error, which integration have you tried? I tested with akamai and endpoint.

it happened with an old version of custom logs. I'll pull the latest version and see if I can reproduce it again.

criamico · 2024-09-17T12:53:22Z

With your latest changes, I tested the edit of package policies and it works fine now.

The dryRun worked in one case but I tried again with custom log:

Navigate to app/integrations/detail/log-2.2.0/overview and install it (it's an older version), it works fine for me
Once the integration is installed the "upgrade" button appears

Try to upgrade. For me it fails with this error:

juliaElastic · 2024-09-17T13:36:44Z

Thanks, I found the issue comes from some differences the custom logs has that the model object was not covering.
I'm not sure how can we prevent further issues like this, we would have to test with all packages.

criamico · 2024-09-17T13:51:58Z

I'm not sure how can we prevent further issues like this, we would have to test with all packages.

I was going to ask the same thing. Is there any way we can automate this?

Do you think that it can happen only with the dryRun handler or also with other ones? We should have some degree of confidence that shipping this change won't break many integrations.

juliaElastic · 2024-09-17T14:05:24Z

I'm not sure how can we prevent further issues like this, we would have to test with all packages.

I was going to ask the same thing. Is there any way we can automate this?

Do you think that it can happen only with the dryRun handler or also with other ones? We should have some degree of confidence that shipping this change won't break many integrations.

I could write a script that creates package policies for all packages in EPR, it's only tricky where there are required fields to fill out to create successfully. I suppose errors can happen in any API where the package policy has different fields than defined in the model types.

criamico

Code LGTM

I tested a bit more and didn't find any obvious error, however I am not sure how we can avoid breakages of the package policies apis.

kibana-ci · 2024-09-17T15:57:13Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: 6a98210

Failed CI Steps

Jest Tests #13

Test Failures

[job] [logs] Jest Tests #13 / GlobalDataTagsTable should add new tags

Metrics [docs]

✅ unchanged

History

💔 Build #234840 failed 6a98210
💛 Build #234763 was flaky 0dc0807
💔 Build #234671 failed 2035408
💔 Build #234444 failed d8bc496
💔 Build #234443 failed 8c615a0

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

cc @juliaElastic

juliaElastic · 2024-09-18T13:13:06Z

I'm running cypress tests locally to create a package policy for each package and check that it's successful. It takes a while, not seeing any other issues so far.

## Summary Relates elastic#184685 Readd elastic#192447 with fixes and tests to validate that the response schemas are correct. ### Checklist - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios (cherry picked from commit 406f073)

kibanamachine · 2024-09-18T13:18:00Z

💚 All backports created successfully

Status	Branch	Result
✅	8.x

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

…193296) # Backport This will backport the following commits from `main` to `8.x`: - [[Fleet] use @kbn/config-schema in Fleet API (Part 1) (#192883)](#192883)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  Co-authored-by: Julia Bardi <[email protected]>

…lastic#192883) (elastic#193296)" This reverts commit 9672d81.

juliaElastic and others added 3 commits September 13, 2024 15:26

fix dryrun schema

12eed55

oas part1 add back with tests

2bb810c

juliaElastic added the release_note:skip Skip the PR/issue when compiling release notes label Sep 13, 2024

juliaElastic self-assigned this Sep 13, 2024

juliaElastic commented Sep 13, 2024

View reviewed changes

juliaElastic added the v8.16.0 label Sep 13, 2024

juliaElastic and others added 2 commits September 16, 2024 10:16

fix test

8da4c9c

Merge branch 'main' into oas-part1-tests

5aa24f1

juliaElastic added the backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) label Sep 16, 2024

juliaElastic added 4 commits September 16, 2024 11:14

simplified format test, oprhaned schema + test

f439ee4

test on settings apis

4185b82

setup tests

218a4c8

uninstall token tests

9496857

juliaElastic marked this pull request as ready for review September 16, 2024 12:16

juliaElastic requested a review from a team as a code owner September 16, 2024 12:16

fix nullables

2aade5f

botelastic bot added the Team:Fleet Team label for Observability Data Collection Fleet team label Sep 16, 2024

juliaElastic and others added 4 commits September 16, 2024 16:01

fix test

8c615a0

Merge branch 'main' into oas-part1-tests

d8bc496

Merge branch 'main' into oas-part1-tests

2035408

add missing Settings fields

4ab28e8

fix create package policy schema

0dc0807

fix schema to allow differences in custom logs

6a98210

criamico approved these changes Sep 17, 2024

View reviewed changes

juliaElastic merged commit 406f073 into elastic:main Sep 18, 2024
23 checks passed

kibanamachine added the v9.0.0 label Sep 18, 2024

kibanamachine mentioned this pull request Sep 18, 2024

[8.x] [Fleet] use @kbn/config-schema in Fleet API (Part 1) (#192883) #193296

Merged

kibanamachine mentioned this pull request Sep 18, 2024

[EEM] Add built in definitions for hosts and containers #193157

Merged

juliaElastic added a commit to juliaElastic/kibana that referenced this pull request Sep 19, 2024

Revert "[8.x] [Fleet] use @kbn/config-schema in Fleet API (Part 1) (e…

3774698

…lastic#192883) (elastic#193296)" This reverts commit 9672d81.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Fleet] use @kbn/config-schema in Fleet API (Part 1) #192883

[Fleet] use @kbn/config-schema in Fleet API (Part 1) #192883

juliaElastic commented Sep 13, 2024 •

edited by kibanamachine

Loading

obltmachine commented Sep 13, 2024

juliaElastic Sep 13, 2024

elasticmachine commented Sep 16, 2024

criamico commented Sep 17, 2024 •

edited

Loading

criamico commented Sep 17, 2024

juliaElastic commented Sep 17, 2024

criamico commented Sep 17, 2024

criamico commented Sep 17, 2024 •

edited

Loading

juliaElastic commented Sep 17, 2024

criamico commented Sep 17, 2024 •

edited

Loading

juliaElastic commented Sep 17, 2024 •

edited

Loading

criamico left a comment

kibana-ci commented Sep 17, 2024

juliaElastic commented Sep 18, 2024

kibanamachine commented Sep 18, 2024

		});

		const validationResp = PackagePolicyResponseSchema.validate(responseItem);

[Fleet] use @kbn/config-schema in Fleet API (Part 1) #192883

[Fleet] use @kbn/config-schema in Fleet API (Part 1) #192883

Conversation

juliaElastic commented Sep 13, 2024 • edited by kibanamachine Loading

Summary

Checklist

obltmachine commented Sep 13, 2024

🤖 GitHub comments

juliaElastic Sep 13, 2024

Choose a reason for hiding this comment

elasticmachine commented Sep 16, 2024

criamico commented Sep 17, 2024 • edited Loading

criamico commented Sep 17, 2024

juliaElastic commented Sep 17, 2024

criamico commented Sep 17, 2024

criamico commented Sep 17, 2024 • edited Loading

juliaElastic commented Sep 17, 2024

criamico commented Sep 17, 2024 • edited Loading

juliaElastic commented Sep 17, 2024 • edited Loading

criamico left a comment

Choose a reason for hiding this comment

kibana-ci commented Sep 17, 2024

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

Metrics [docs]

History

juliaElastic commented Sep 18, 2024

kibanamachine commented Sep 18, 2024

💚 All backports created successfully

Questions ?

juliaElastic commented Sep 13, 2024 •

edited by kibanamachine

Loading

criamico commented Sep 17, 2024 •

edited

Loading

criamico commented Sep 17, 2024 •

edited

Loading

criamico commented Sep 17, 2024 •

edited

Loading

juliaElastic commented Sep 17, 2024 •

edited

Loading