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

[Fleet] RBAC - Make agents write APIs space aware - 4/4 #191277

Merged

Conversation

jillguyonnet
Copy link
Contributor

@jillguyonnet jillguyonnet commented Aug 26, 2024

Summary

Closes #185040

Followup to:
#188507
#189519
#190069

This PR contains the last required changed for making Fleet agents write APIs space aware:

  • Implement space awareness in the following endpoints:
    • POST /agents/{agentId}/unenroll
    • POST /agents/{agentId}/request_diagnostics
    • POST /agents/bulk_unenroll
    • POST /agents/bulk_request_diagnostics
  • Fix a bug in POST /agents/bulk_update_agent_tags where the space id was not passed.
  • Simply the setting of the namespaces property when creating agent actions when the space id is known.
  • Rename currentNamespace to currentSpaceId where appropriate (see comment below).
  • Add API integration tests and consolidate existing ones. ⚠️ At the time of writing, I would like there to be more tests covering bulk query processing in batches, which are currently lacking. I have experienced difficulties getting those tests to pass consistently. Filed followup issue for those.

A note on terminology

As pointed out in #191083 (comment), it seems that the terms "namespace" and "space id" are occasionally used interchangeably in some parts of the codebase to refer to a Kibana space. For instance, documents in Fleet indices (agents, agent policies, agent actions...) possess a namespaces property to track the spaces they belong to. The current space id is also returned using the Saved Object client's getCurrentNamespace function.

However, "namespace" is also a datastream property. In the Agent policy settings UI, the "Spaces" property (which will be linked to the saved object's namespaces property) is above the "Default namespace" property, which relates to the integration's data streams:
Screenshot 2024-08-26 at 14 51 10

This should not be a source of major issues, but is best clarified for future reference. In this PR, I've replaced some occurrences of namespace with spaceId where appropriate to try to maximise the use of the latter.

Testing

  • This PR should be put through the Flaky Test Runner prior to merging (I will kick the job).
  • Manual testing should also be performed for the new endpoints mentioned above.

Checklist

@jillguyonnet
Copy link
Contributor Author

/ci

@obltmachine
Copy link

🤖 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!)

@jillguyonnet jillguyonnet added Team:Fleet Team label for Observability Data Collection Fleet team release_note:skip Skip the PR/issue when compiling release notes labels Aug 26, 2024
@jillguyonnet jillguyonnet self-assigned this Aug 26, 2024
@jillguyonnet jillguyonnet requested a review from nchaulet August 26, 2024 13:02
@jillguyonnet
Copy link
Contributor Author

Hey @nchaulet - this PR should be ready for first review - I've detailed the changes in the description to help with the review. I'm still looking if I can figure out tests for queries in batches as these have proven unstable, otherwise I think this is everything.

@jillguyonnet
Copy link
Contributor Author

/ci

@kibanamachine
Copy link
Contributor

Flaky Test Runner Stats

🎉 All tests passed! - kibana-flaky-test-suite-runner#6810

[✅] x-pack/test/fleet_api_integration/config.space_awareness.ts: 200/200 tests passed.

see run history

@jillguyonnet jillguyonnet marked this pull request as ready for review August 27, 2024 13:22
@jillguyonnet jillguyonnet requested a review from a team as a code owner August 27, 2024 13:22
@elasticmachine
Copy link
Contributor

Pinging @elastic/fleet (Team:Fleet)

Copy link
Contributor

@juliaElastic juliaElastic left a comment

Choose a reason for hiding this comment

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

LGTM

@jillguyonnet
Copy link
Contributor Author

@elasticmachine merge upstream

@jillguyonnet
Copy link
Contributor Author

@elasticmachine merge upstream

@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

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

cc @jillguyonnet

Copy link
Member

@nchaulet nchaulet left a comment

Choose a reason for hiding this comment

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

Code LGTM 🚀 renaming namespace => spaceId remove a lot of confusion that's great

@jillguyonnet jillguyonnet merged commit 3ba243d into elastic:main Aug 30, 2024
21 checks passed
@jillguyonnet jillguyonnet deleted the fleet/185040-rbac-agents-write-api-4 branch August 30, 2024 07:06
@kibanamachine kibanamachine added v8.16.0 backport:skip This commit does not require backporting labels Aug 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:skip This commit does not require backporting release_note:skip Skip the PR/issue when compiling release notes Team:Fleet Team label for Observability Data Collection Fleet team v8.16.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Fleet] Make Fleet agents write APIs space aware
7 participants