[Ingest Manager] Rename API /api/ingest_manager => /api/fleet by nchaulet · Pull Request #79193 · elastic/kibana

nchaulet · 2020-10-01T19:07:16Z

Description

In the effort of renaming Ingest manager plugin Fleet, we are renaming our API routes

Details:

Rename ingest manager api

/api/ingest_manager => /api/fleet

/api/ingest_manager/fleet => /api/fleet

Backward compatible routes

cc @blakerouse @michalpristas

For retro-compatibility we keep the agent (enroll, checkin, and ack) API route from 7.9 to be compatible with 7.9 agents
So we have duplicated route for

Enrollment

/api/ingest_manager/fleet/agents/enroll
/api/fleet/agents/enroll

checkin

/api/ingest_manager/fleet/agents/{agentId}/checkin
/api/fleet/agents/{agentId}/checkin

acknowledgements

/api/ingest_manager/fleet/agents/{agentId}/acks
/api/fleet/agents/{agentId}/acks

Breaking change route

Fleet setup do not exists anymore and it's not agents setup

/api/ingest_manager/setup => /api/fleet/agents/setup

All the other APIs call should be migrated from /api/ingest_manager/* to /api/fleet/*

list of things to ensure are checked / tested / passing.

Dev docs

The following Ingest Manager API routes changed:

All APIs route have be moved from /api/ingest_manager/* to /api/fleet/*
All the previous fleet route have be moved from /api/ingest_manager/fleet/* to /api/fleet/* this include
- /api/ingest_manager/fleet/agents => /api/fleet/agents
- /api/ingest_manager/fleet/enrollement_tokens => /api/fleet/enrollement_tokens
Fleet setup API has been move from /api/ingest_manager/fleet/setup to /api/fleet/agents/setup

…tmanager-fleet-api-renaming

nchaulet · 2020-10-01T20:54:09Z

@elasticmachine merge upstream

…tmanager-fleet-api-renaming

elasticmachine · 2020-10-02T12:27:02Z

Pinging @elastic/ingest-management (Team:Ingest Management)

nchaulet · 2020-10-02T12:39:01Z

@jen-huang Maybe you can help with me what kind of release not should we have for this kind of breaking change?

EricDavisX · 2020-10-02T12:49:46Z

list of things to be tracked are now placed in the description section.

x-pack/test/ingest_manager_api_integration/apis/epm/package_install_complete.ts

x-pack/test/ingest_manager_api_integration/apis/setup.ts

x-pack/test/ingest_manager_api_integration/apis/epm/package_install_complete.ts

x-pack/test/ingest_manager_api_integration/apis/epm/setup.ts

x-pack/test/ingest_manager_api_integration/apis/fleet/agents/services.ts

jonathan-buttner · 2020-10-02T13:31:10Z

...lugins/security_solution/public/management/pages/policy/store/policy_list/services/ingest.ts

 import { NewPolicyData } from '../../../../../../../common/endpoint/types';

-const INGEST_API_ROOT = `/api/ingest_manager`;
+const INGEST_API_ROOT = `/api/fleet`;


@paul-tavares @nchaulet thoughts on removing the hardcoded reference and using epmRouteService etc like this: https://github.com/elastic/kibana/blob/master/x-pack/plugins/security_solution/public/common/hooks/endpoint/upgrade.ts#L10

That'd avoid having to find/replace these references in the future

sound good to me if we can avoid hardcoded path :) if this can be done after that PR? there is already a lot of changes going on

yes, I agree that we (security solution) should stop using hardcoded values and start using the const exposed in ingest. @nchaulet we can take that one - you don't have to include it in your PR.

Co-authored-by: John Schulz <john.schulz@elastic.co>

x-pack/plugins/ingest_manager/common/openapi/spec_oas3.json

Co-authored-by: John Schulz <john.schulz@elastic.co>

jen-huang · 2020-10-02T19:09:45Z

@nchaulet I'd recommend release_note:dev_docs label and adding a ## Dev docs section to your PR with information. The release notes script will pull it from there. I had a similar PR with a dev docs section: #74914 - looking at this, mine is outdated now with your changes 😄 Maybe you can copy from mine and adjust the paths, and then I can remove the notes from my PR?

jen-huang · 2020-10-02T19:10:59Z

Also would be great to update this PR with master again, since tests were re-enabled in #79290 a little while ago!

nchaulet · 2020-10-02T21:27:25Z

@nchaulet I'd recommend release_note:dev_docs label and adding a ## Dev docs section to your PR with information. The release notes script will pull it from there. I had a similar PR with a dev docs section: #74914 - looking at this, mine is outdated now with your changes 😄 Maybe you can copy from mine and adjust the paths, and then I can remove the notes from my PR?

What about updating the path in your PR as there is more than just a path change, there is config change too?

nchaulet · 2020-10-04T16:38:29Z

@elasticmachine merge upstream

paul-tavares

Changes to Endpoint LGTM. I will open a separate issue on our side to refactor several areas of our code to use the consts exposed via Fleet.

(FYI: I will update an external tool we have to download/view endpoint user artifacts when you merge this in)

mdelapenya · 2020-10-05T16:00:15Z

Hey @nchaulet, in the E2E we use:

/api/ingest_manager/fleet/setup which I imagine moves to /api/fleet/setup. Is this correct? I ask because in the description above it's not clear if that HTTP endpoint is the same and/or affected:

Breaking change route

Fleet setup do not exists anymore and it's not agents setup
/api/ingest_manager/setup => /api/fleet/agents/setup

Thanks!

jen-huang · 2020-10-05T16:11:41Z

@nchaulet I'd recommend release_note:dev_docs label and adding a ## Dev docs section to your PR with information. The release notes script will pull it from there. I had a similar PR with a dev docs section: #74914 - looking at this, mine is outdated now with your changes 😄 Maybe you can copy from mine and adjust the paths, and then I can remove the notes from my PR?

What about updating the path in your PR as there is more than just a path change, there is config change too?

That works too! In that case feel free to edit my PR description and replace the labels on your PRs with release_note:skip so that we don't pull duplicate notes.

nchaulet · 2020-10-05T19:00:57Z

@elastic/siem it will really be great if can have a review for 7.10

…tmanager-fleet-api-renaming

jfsiii · 2020-10-05T20:35:36Z

@paul-tavares /api/ingest_manager/fleet/setup becomes /api/fleet/agents/setup

jfsiii

👍 to merge for FF

nchaulet · 2020-10-05T22:11:06Z

@elasticmachine merge upstream

…tmanager-fleet-api-renaming

kibanamachine · 2020-10-06T14:29:43Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 75a2794

Metrics [docs]

async chunks size

id	before	after	diff
`ingestManager`	1.1MB	1.1MB	-15.0B
`securitySolution`	10.4MB	10.4MB	-68.0B
total			-83.0B

page load bundle size

id	before	after	diff
`ingestManager`	536.9KB	537.3KB	+361.0B

History

💚 Build #79981 succeeded e923ed3
💔 Build #79930 failed 8c46687
💔 Build #79828 failed 6515f6a
💚 Build #79427 succeeded 145c846
💔 Build #79340 failed e7ab742

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

…c#79193)

…79193) (#79675)

ghost · 2020-10-07T11:40:14Z

Hi Eric

We have executed the smoke testcases under Smoke TestRun for Rename API /api/ingest_manager => /api/fleet for this ticket on latest 8.0.0-SNAPSHOT Kibana cloud environment.

Please let us know if anything is missing from our end.

…into feature/task_manager_429 * 'feature/task_manager_429' of github.com:elastic/kibana: (158 commits) Add license check to direct package upload handler. (#79653) [Ingest Manager] Rename API /api/ingest_manager => /api/fleet (#79193) [Security Solution][Resolver] Simplify CopyableField styling and add comments (#79594) Fine-tunes ML related text on Metrics UI (#79425) [ML] DF Analytics creation wizard: ensure job creation possible when model memory lower than estimate (#79229) Add new "Add Data" tutorials (#77237) Update APM telemetry docs (#79583) Revert "Add support for runtime field types to mappings editor. (#77420)" (#79611) Kibana request headers (#79218) ensure missing indexPattern error is bubbled up to error callout (#79378) Missing space fix (#79585) remove duplicate tab states (#79501) [data.ui] Lazy load UI components in data plugin. (#78889) Add generic type params to search dependency. (#79608) [Ingest Manager] Internal action for policy reassign (#78493) [ILM] Add index_codec to forcemerge action in hot and warm phases (#78175) [Ingest Manager] Update open API spec and add condition to agent upgrade endpoint (#79579) [ML] Hide Data Grid column options when histogram charts are enabled. (#79459) [Telemetry] Synchronous `setup` and `start` methods (#79457) [Observability] Persist time range across apps (#79258) ...

[Ingest Manager] Rename API /api/ingest_manager => /api/fleet

94ed02c

nchaulet added release_note:skip Skip the PR/issue when compiling release notes Team:Fleet Team label for Observability Data Collection Fleet team Ingest Management:beta2 labels Oct 1, 2020

nchaulet self-assigned this Oct 1, 2020

nchaulet added 2 commits October 1, 2020 15:30

rename /api/fleet/fleet => /api/fleet

5cc6f50

Merge branch 'master' of github.com:elastic/kibana into feature-inges…

b7b12a8

…tmanager-fleet-api-renaming

Fix typo in tests

1a674ed

nchaulet force-pushed the feature-ingestmanager-fleet-api-renaming branch from 02a9ea3 to 1a674ed Compare October 2, 2020 01:20

Merge branch 'master' of github.com:elastic/kibana into feature-inges…

9410bc7

…tmanager-fleet-api-renaming

nchaulet marked this pull request as ready for review October 2, 2020 12:27

nchaulet requested a review from a team as a code owner October 2, 2020 12:27

nchaulet requested a review from a team October 2, 2020 12:27

nchaulet requested a review from a team as a code owner October 2, 2020 12:27

nchaulet added v7.10.0 v8.0.0 and removed release_note:skip Skip the PR/issue when compiling release notes labels Oct 2, 2020

jfsiii reviewed Oct 2, 2020

View reviewed changes

jonathan-buttner reviewed Oct 2, 2020

View reviewed changes

Fix /fleet/setup in tests

8724fa7

Co-authored-by: John Schulz <john.schulz@elastic.co>

michalpristas mentioned this pull request Oct 2, 2020

[Ingest Manager] Use new form of fleet API paths elastic/beats#21478

Merged

6 tasks

jfsiii reviewed Oct 2, 2020

View reviewed changes

x-pack/plugins/ingest_manager/common/openapi/spec_oas3.json Outdated Show resolved Hide resolved

Fix open api Spec

31f9056

Co-authored-by: John Schulz <john.schulz@elastic.co>

EricDavisX mentioned this pull request Oct 2, 2020

[Fleet] update apis due to ingest_magement -> fleet api change elastic/e2e-testing#342

Closed

Merge branch 'master' into feature-ingestmanager-fleet-api-renaming

145c846

paul-tavares approved these changes Oct 5, 2020

View reviewed changes

mdelapenya mentioned this pull request Oct 5, 2020

chore: rename ingest_manager endpoints to fleet elastic/e2e-testing#348

Merged

8 tasks

nchaulet removed the release_note:plugin_api_changes Contains a Plugin API changes section for the breaking plugin API changes section. label Oct 5, 2020

EricDavisX mentioned this pull request Oct 5, 2020

[Fleet] duplicate file for legacy backwards compatibility support apis due to ingest_magement -> fleet api change elastic/e2e-testing#349

Closed

nchaulet requested a review from jfsiii October 5, 2020 17:11

nchaulet added the release_note:plugin_api_changes Contains a Plugin API changes section for the breaking plugin API changes section. label Oct 5, 2020

Merge branch 'master' of github.com:elastic/kibana into feature-inges…

6515f6a

…tmanager-fleet-api-renaming

jfsiii approved these changes Oct 5, 2020

View reviewed changes

kibanamachine and others added 3 commits October 5, 2020 18:11

Merge branch 'master' into feature-ingestmanager-fleet-api-renaming

8c46687

Fix merge error

e923ed3

Merge branch 'master' of github.com:elastic/kibana into feature-inges…

75a2794

…tmanager-fleet-api-renaming

nchaulet merged commit 4a160bf into elastic:master Oct 6, 2020

nchaulet deleted the feature-ingestmanager-fleet-api-renaming branch October 6, 2020 14:30

nchaulet added a commit to nchaulet/kibana that referenced this pull request Oct 6, 2020

[Ingest Manager] Rename API /api/ingest_manager => /api/fleet (elasti…

90627ec

…c#79193)

nchaulet mentioned this pull request Oct 6, 2020

[7.x] [Ingest Manager] Rename API /api/ingest_manager => /api/fleet (#79193) #79675

Merged

michalpristas mentioned this pull request Oct 6, 2020

Cherry-pick #21478 to 7.x: Use new form of fleet API paths elastic/beats#21589

Merged

6 tasks

nchaulet added a commit that referenced this pull request Oct 6, 2020

[7.x] [Ingest Manager] Rename API /api/ingest_manager => /api/fleet (#…

644047f

…79193) (#79675)

mtojek mentioned this pull request Oct 12, 2020

Rename ingest_manager to fleet elastic/elastic-package#133

Merged

michalpristas mentioned this pull request Oct 20, 2020

Change Elastic Agent log format elastic/e2e-testing#376

Merged

8 tasks

Conversation

nchaulet commented Oct 1, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Backward compatible routes

Breaking change route

Dev docs

Uh oh!

nchaulet commented Oct 1, 2020

Uh oh!

elasticmachine commented Oct 2, 2020

Uh oh!

nchaulet commented Oct 2, 2020

Uh oh!

EricDavisX commented Oct 2, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jonathan-buttner Oct 2, 2020

Choose a reason for hiding this comment

Uh oh!

nchaulet Oct 2, 2020 • 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!

paul-tavares Oct 5, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jen-huang commented Oct 2, 2020

Uh oh!

jen-huang commented Oct 2, 2020

Uh oh!

nchaulet commented Oct 2, 2020

Uh oh!

nchaulet commented Oct 4, 2020

Uh oh!

paul-tavares left a comment • 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!

mdelapenya commented Oct 5, 2020

Breaking change route

Uh oh!

jen-huang commented Oct 5, 2020

Uh oh!

nchaulet commented Oct 5, 2020

Uh oh!

jfsiii commented Oct 5, 2020

Uh oh!

jfsiii left a comment

Choose a reason for hiding this comment

Uh oh!

nchaulet commented Oct 5, 2020

Uh oh!

kibanamachine commented Oct 6, 2020

💚 Build Succeeded

Metrics [docs]

async chunks size

page load bundle size

History

Uh oh!

ghost commented Oct 7, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

nchaulet commented Oct 1, 2020 •

edited

Loading

EricDavisX commented Oct 2, 2020 •

edited

Loading

nchaulet Oct 2, 2020 •

edited

Loading

paul-tavares left a comment •

edited

Loading