Skip to content

[Fleet] Add bulk migration endpoint #223956

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.

Sign up for GitHub

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

Jump to bottom
Merged
Supplementing merged 16 commits into from
Jun 18, 2025
Merged

[Fleet] Add bulk migration endpoint #223956

Supplementing merged 16 commits into from
Jun 18, 2025

Conversation

@Supplementing
Copy link
Contributor

@Supplementing Supplementing commented Jun 13, 2025 •
edited
Loading

Summary

Closes #217618

  • Added bulk migration endpoint to allow migration agents from one cluster to another in bulk.

POST /api/fleet/agents/bulk_migrate

The params are:
agents(required) - an array of Agent ID's
enrollment_token (required) - the enrollment token retrieved from the remote cluster
uri (required) - the URL of the remote cluster to enroll the agents into
settings (optional) -additional settings such as certificate authorities, etc

Checklist

Check the PR satisfies following conditions.

Reviewers should verify this PR satisfies this list as well.

  • Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
  • Documentation was added for features that require explanation or tutorials
  • Unit or functional tests were updated or added to match the most common scenarios
  • If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the docker list
  • This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The release_note:breaking label should be applied in these situations.
  • Flaky Test Runner was used on any tests changed
  • The PR description includes the appropriate Release Notes section, and the correct release_note:* label is applied per the guidelines

Identify risks

N/A

Release Notes

  • Added endpoint allowing a user to migrate an bulk agents to another cluster by specifying the URL and Enrollment Token. Note: tamper protected and fleet agents can not be migrated and attempting to do so will return a 403 status code.

@Supplementing Supplementing added release_note:skip Skip the PR/issue when compiling release notes backport:skip This PR does not require backporting labels Jun 13, 2025
@Supplementing Supplementing requested a review from a team as a code owner June 13, 2025 17:03
@Supplementing Supplementing added the Team:Fleet Team label for Observability Data Collection Fleet team label Jun 13, 2025
@elasticmachine
Copy link
Contributor

elasticmachine commented Jun 13, 2025

Pinging @elastic/fleet (Team:Fleet)

@Supplementing
Copy link
Contributor Author

Supplementing commented Jun 13, 2025

@elasticmachine merge upstream

elasticmachine and others added 6 commits June 13, 2025 19:09
@elasticmachine
Merge branch 'main' into feature-bulk-migration-endpoint
4ec9e28
@Supplementing
removed replace_token from options for bulk migrations schema
05f2926
@Supplementing
merged remote
b8a649d
@Supplementing
removed exclusive test
35b1cc6
@kibanamachine
[CI] Auto-commit changed files from 'node scripts/capture_oas_snapsho…
80f02c1 
…t --include-path /api/status --include-path /api/alerting/rule/ --include-path /api/alerting/rules --include-path /api/actions --include-path /api/security/role --include-path /api/spaces --include-path /api/streams --include-path /api/fleet --include-path /api/dashboards --include-path /api/saved_objects/_import --include-path /api/saved_objects/_export --include-path /api/maintenance_window --update'
@kibanamachine
[CI] Auto-commit changed files from 'make api-docs'
56d8184
@Supplementing
Copy link
Contributor Author

Supplementing commented Jun 16, 2025

@elasticmachine merge upstream

kibanamachine and others added 4 commits June 16, 2025 18:14
@kibanamachine
[CI] Auto-commit changed files from 'node scripts/capture_oas_snapsho…
5368b94 
…t --include-path /api/status --include-path /api/alerting/rule/ --include-path /api/alerting/rules --include-path /api/actions --include-path /api/security/role --include-path /api/spaces --include-path /api/streams --include-path /api/fleet --include-path /api/dashboards --include-path /api/saved_objects/_import --include-path /api/saved_objects/_export --include-path /api/maintenance_window --update'
@kibanamachine
[CI] Auto-commit changed files from 'make api-docs'
4dee224
@Supplementing
removed old param from test
b283697
@Supplementing
Merge branch 'feature-bulk-migration-endpoint' of https://github.com/…
b776947 
…Supplementing/kibana into feature-bulk-migration-endpoint
juliaElastic
juliaElastic approved these changes Jun 17, 2025
View reviewed changes
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

criamico
criamico reviewed Jun 17, 2025
View reviewed changes
x-pack/platform/plugins/shared/fleet/server/types/rest_spec/agent.ts
certificate_authorities: schema.maybe(schema.string()),
elastic_agent_cert: schema.maybe(schema.string()),
elastic_agent_cert_key: schema.maybe(schema.string()),
elastic_agent_cert_key_passphrase: schema.maybe(schema.string()),
Copy link
Contributor

@criamico criamico Jun 17, 2025

Choose a reason for hiding this comment

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

I see that these are in the requirements, but it's not clear to me what they're needed for. Are they just passed to the action? Are they saved somewhere afterwards?
I'm asking because we might have issues if we store these keys as plain text, they should be saved as secrets in that case.

Copy link
Contributor Author

@Supplementing Supplementing Jun 17, 2025

Choose a reason for hiding this comment

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

I see that these are in the requirements, but it's not clear to me what they're needed for. Are they just passed to the action? Are they saved somewhere afterwards? I'm asking because we might have issues if we store these keys as plain text, they should be saved as secrets in that case.

They're passed to the action as additional settings. Maybe @michalpristas can expand more if needed.

@elasticmachine
Copy link
Contributor

elasticmachine commented Jun 17, 2025

💚 Build Succeeded

Metrics [docs]

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id before after diff
fleet 1425 1426 +1

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id before after diff
fleet 167.6KB 167.6KB +48.0B
Unknown metric groups

API count

id before after diff
fleet 1554 1555 +1

History

@Supplementing Supplementing mentioned this pull request Jun 17, 2025
Merged
7 tasks
@Supplementing Supplementing merged commit e2770f3 into elastic:main Jun 18, 2025
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@criamico criamico criamico left review comments

@juliaElastic juliaElastic juliaElastic approved these changes

Assignees

No one assigned

Labels

backport:skip This PR 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 v9.1.0

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Bulk migration - API endpoint

5 participants

@Supplementing @elasticmachine @criamico @juliaElastic @kibanamachine