Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Security Solution][POC] Bundle Security Solution OAS per domain #183026

Closed

Conversation

maximpn
Copy link
Contributor

@maximpn maximpn commented May 9, 2024

Addresses: #183019

NOTE: We're not planning to merge this PR. This PR is part of a discussion with @lcawl, @jloleysens, and @lukeelmers on https://github.com/elastic/security-team/issues/9407 and the structure of API docs.

Summary

This PR implements Security Solution OAS per domain automatic bundling by including it into PR's build pipeline.

Result bundles are valid OAS and written into x-pack/plugins/security_solution/docs/openapi/ and ready to be consumed.

Important! This PR just demonstrates conceptual OAS bundles segregation by domains while doesn't focus on spotting these domains. A set of domaina will be decided at the next step after discussion with tech leads.

@maximpn maximpn added release_note:skip Skip the PR/issue when compiling release notes docs Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc. Project:Serverless Work as part of the Serverless project for its initial release v8.15.0 labels May 9, 2024
@maximpn maximpn self-assigned this May 9, 2024
@maximpn maximpn force-pushed the bundle-security-solution-oas-by-domains branch 4 times, most recently from 7351319 to 2f68641 Compare May 11, 2024 06:54
@maximpn maximpn marked this pull request as ready for review May 13, 2024 08:13
@maximpn maximpn requested review from a team as code owners May 13, 2024 08:13
@maximpn maximpn requested a review from nikitaindik May 13, 2024 08:13
@elasticmachine
Copy link
Contributor

Pinging @elastic/security-solution (Team: SecuritySolution)

Copy link
Member

@jbudz jbudz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

.buildkite

@maximpn maximpn force-pushed the bundle-security-solution-oas-by-domains branch from 2f68641 to d6b24ba Compare May 16, 2024 07:48
@kibana-ci
Copy link
Collaborator

kibana-ci commented May 16, 2024

💔 Build Failed

Failed CI Steps

Test Failures

  • [job] [logs] FTR Configs #16 / Agent policies fleet_agent_policies POST /api/fleet/agent_policies/_bulk_get should populate package_policies if called with ?full=true
  • [job] [logs] FTR Configs #16 / Agent policies fleet_agent_policies POST /api/fleet/agent_policies/_bulk_get should populate package_policies if called with ?full=true

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id before after diff
securitySolution 5473 5475 +2

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id before after diff
securitySolution 15.1MB 15.1MB +6.3KB

History

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

cc @maximpn

@maximpn maximpn removed the request for review from nikitaindik May 16, 2024 10:37
@maximpn maximpn marked this pull request as draft May 16, 2024 14:50
@banderror banderror removed the v8.15.0 label May 17, 2024
@banderror
Copy link
Contributor

@maximpn Can we close this PR now that we've collected feedback?

@maximpn
Copy link
Contributor Author

maximpn commented Jun 3, 2024

Closing this PR since it was only needed to drive a discussion, see decisions in #183019 (comment).

@maximpn maximpn closed this Jun 3, 2024
@maximpn maximpn deleted the bundle-security-solution-oas-by-domains branch June 3, 2024 11:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Project:Serverless Work as part of the Serverless project for its initial release release_note:skip Skip the PR/issue when compiling release notes Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants