EMT-248: add post action request handler and resources #60581

nnamdifrankie · 2020-03-18T23:45:30Z

Summary

https://github.com/elastic/endpoint-app-team/issues/248

The change creates a new resource for posting new actions for agents.

/api/ingest_manager/fleet/agents/{agent}/actions

Request: - PostNewAgentActionRequest

{
  "body": {
       "action": {
          "type": "CONFIG_CHANGE",
          "data": "data",
          "sent_at": "2020-03-14T19:45:02.620Z"
       }
  }
}

Response - PostNewAgentActionResponse

{
  "success": true,
  "item": {}
}

Checklist

Delete any items that are not applicable to this PR.

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

nnamdifrankie · 2020-03-19T00:36:09Z

@elasticmachine merge upstream

elasticmachine · 2020-03-19T02:22:39Z

Pinging @elastic/ingest-management (Feature:EPM)

…nnamdifrankie/kibana into EMT-248_add_post_action_request_handler

nchaulet · 2020-03-19T13:07:16Z

x-pack/plugins/ingest_manager/server/routes/agent/actions_handlers.ts

+  return async (context, request, response) => {
+    const soClient = actionsService.getSavedObjectsClientContract(request);
+
+    const res = APIKeyService.parseApiKey(request.headers);


This handler is not going to be consumed by the agent, but by kibana UI, we should not validate API key but rely on kibana authentication and use the builtin saved object client. (like the other crud actions we have in ingest manager)

nchaulet · 2020-03-19T13:08:26Z

x-pack/plugins/ingest_manager/server/routes/agent/index.ts

+    {
+      path: AGENT_API_ROUTES.ACTIONS_PATTERN,
+      validate: PostNewAgentActionRequestSchema,
+      options: { tags: [] },


Suggested change

options: { tags: [] },

options: { tags: [`access:${PLUGIN_ID}-all`] },

paul-tavares · 2020-03-19T13:10:34Z

@nnamdifrankie LGTM. One small question: Would there be a need for this API to accept an array of actions instead of just one?

nnamdifrankie · 2020-03-19T13:25:29Z

@paul-tavares perhaps no. Speaking with @nich07as I think we want one action at a time for now.

jfsiii · 2020-03-19T15:52:46Z

x-pack/plugins/ingest_manager/server/services/agents/actions.ts

+
+  Object.assign(agentAction, ...keys(newAgentAction).map(key => ({ [key]: newAgentAction[key] })));
+
+  return agentAction as AgentAction;


Given the name/purpose of this function, I think it's important we don't lose the TS typing here.

I think we can keep it by doing something like

function createAgentAction( createdAt: Date, newAgentAction: NewAgentAction ): AgentAction { const agentAction = { id: "uuid value", created_at: createdAt.toISOString() }; return Object.assign(agentAction, newAgentAction); }

jfsiii · 2020-03-19T15:59:35Z

x-pack/plugins/ingest_manager/common/types/models/agent.ts

@@ -22,6 +22,8 @@ export interface AgentAction extends SavedObjectAttributes {
  sent_at?: string;
 }

+export type NewAgentAction = Pick<AgentAction, 'type' | 'data' | 'sent_at'>;


I think we should follow the pattern used by AgentBase/Agent in this file and do something like

export interface NewAgentAction { type: 'CONFIG_CHANGE' | 'DATA_DUMP' | 'RESUME' | 'PAUSE'; data?: string; sent_at?: string; } export interface AgentAction extends NewAgentAction { id: string; created_at: string; }

Okay will make this change, was limiting the changes to existing structures.

jfsiii · 2020-03-19T16:17:47Z

x-pack/plugins/ingest_manager/server/services/agents/actions.ts

+  return agentAction as AgentAction;
+}
+
+function keys<O extends object>(obj: O): Array<keyof O> {


I believe we can drop this if we alter the way createAgentAction uses Object.assign

nchaulet · 2020-03-19T19:13:25Z

x-pack/plugins/ingest_manager/server/routes/agent/index.ts

+    },
+    postNewAgentActionHandlerBuilder({
+      getAgent: AgentService.getAgent,
+      getSavedObjectsClientContract: getInternalUserSOClient,


Actually we want to use the SOClient that comme from the request directly
like this here const soClient = context.core.savedObjects.client; and not the internal user one

okay will make the change.

jfsiii · 2020-03-19T19:30:32Z

x-pack/plugins/ingest_manager/server/services/agents/actions.ts

+    created_at: createdAt.toISOString(),
+  };
+
+  return Object.assign(agentAction, newAgentAction);


Just realized that this order will have the passed values will overwrite the agentAction values

Is agentConfig the default values or final values?

Object.assign({}, newAgentConfig, agentAction) will use agentConfig as final values

kibanamachine · 2020-03-19T21:39:03Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 58c3420

History

💚 Build #34654 succeeded 74a4729
💚 Build #34608 succeeded 2a3054f
💚 Build #34405 succeeded 982a518
💚 Build #34393 succeeded 26df271
💔 Build #34384 failed 510a073

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

… (#60705) [Ingest]EMT-248: add resource to allow to post new agent action.

* master: (52 commits) [SIEM] Fix types in rules tests (elastic#60736) [Alerting] prevent flickering when fields are updated in an alert (elastic#60666) License checks for actions plugin (elastic#59070) Implemented ability to clear and properly validate alert interval (elastic#60571) WebElementWrapper: add findByTestSubject/findAllByTestSubject to search with data-test-subj (elastic#60568) [Maps] Update layer dependencies to NP (elastic#59585) [Discover] Remove StateManagementConfigProvider (elastic#60221) [ML] Listing all categorization wizard checks (elastic#60502) [Upgrade Assistant] First iteration of batch reindex docs (elastic#59887) [SIEM] Export timeline (elastic#58368) [SIEM] Add support for actions and throttle in Rules (elastic#59641) Fix ace a11y listener (elastic#60639) Add addInfo toast to core notifications service (elastic#60574) fix test description (elastic#60638) [SIEM] Cypress screenshots upload to google cloud (elastic#60556) [canvas/shareable_runtime] sync sass loaders with kbn/optimizer (elastic#60653) [SIEM] Fixes Modification of ML Rules (elastic#60662) [SIEM] [Case] Bulk status update, add comment avatar, id => title in breadcrumbs (elastic#60410) [Alerting] add functional tests for index threshold alertType (elastic#60597) [Ingest]EMT-248: add post action request handler and resources (elastic#60581) ...

…o alerting/tls-warning * 'alerting/tls-warning' of github.com:gmmorris/kibana: (32 commits) [ML] Listing all categorization wizard checks (elastic#60502) [Upgrade Assistant] First iteration of batch reindex docs (elastic#59887) [SIEM] Export timeline (elastic#58368) [SIEM] Add support for actions and throttle in Rules (elastic#59641) Fix ace a11y listener (elastic#60639) Add addInfo toast to core notifications service (elastic#60574) fix test description (elastic#60638) [SIEM] Cypress screenshots upload to google cloud (elastic#60556) [canvas/shareable_runtime] sync sass loaders with kbn/optimizer (elastic#60653) [SIEM] Fixes Modification of ML Rules (elastic#60662) [SIEM] [Case] Bulk status update, add comment avatar, id => title in breadcrumbs (elastic#60410) [Alerting] add functional tests for index threshold alertType (elastic#60597) [Ingest]EMT-248: add post action request handler and resources (elastic#60581) Return incident's url (elastic#60617) [Endpoint] TEST: GET alert details - boundary test for first alert retrieval (elastic#60320) [ML] Transforms: Fix pivot preview table mapping. (elastic#60609) [Endpoint] Log random seed for sample data CLI to console (elastic#60646) Use common event model for determining if event is v0 or v1 (elastic#60667) Disables PR Project Assigner workflow [Reporting] Allow reports to be deleted in Management > Kibana > Reporting (elastic#60077) ...

nnamdifrankie added 2 commits March 18, 2020 19:22

EMT-248: add resource to allow to post new agent action.

67d5714

EMT-248: fix formatting

510a073

nnamdifrankie requested a review from a team March 18, 2020 23:45

nnamdifrankie added release_note:skip Skip the PR/issue when compiling release notes v7.7.0 labels Mar 18, 2020

Merge branch 'master' into EMT-248_add_post_action_request_handler

26df271

nnamdifrankie added the Feature:EPM Fleet team's Elastic Package Manager (aka Integrations) project label Mar 19, 2020

nnamdifrankie added the Feature:Fleet Fleet team's agent central management project label Mar 19, 2020

nnamdifrankie added 2 commits March 18, 2020 22:26

EMT-248: cruft removal

e13cee0

Merge branch 'EMT-248_add_post_action_request_handler' of github.com:…

982a518

…nnamdifrankie/kibana into EMT-248_add_post_action_request_handler

nchaulet reviewed Mar 19, 2020

View reviewed changes

EMT-248: fix PR comments, use kibana access

b47d7a4

jfsiii reviewed Mar 19, 2020

View reviewed changes

nnamdifrankie added 3 commits March 19, 2020 12:56

EMT-248: review comments and some clean up

2a3054f

EMT-248: remove as

d343c93

EMT-248: use union type, do some clean up

74a4729

nchaulet reviewed Mar 19, 2020

View reviewed changes

EMT-248: use core client

58c3420

nchaulet approved these changes Mar 19, 2020

View reviewed changes

jfsiii reviewed Mar 19, 2020

View reviewed changes

nnamdifrankie merged commit d1aaa44 into elastic:master Mar 19, 2020

nnamdifrankie deleted the EMT-248_add_post_action_request_handler branch March 19, 2020 22:16

nnamdifrankie mentioned this pull request Mar 19, 2020

[7.x] [Ingest]EMT-248: add post action request handler and resources (#60581) #60705

Merged

nnamdifrankie added a commit that referenced this pull request Mar 20, 2020

[Ingest]EMT-248: add post action request handler and resources (#60581)…

d22828d

… (#60705) [Ingest]EMT-248: add resource to allow to post new agent action.

ruflin assigned nnamdifrankie Mar 25, 2020

jen-huang added the Team:Fleet Team label for Observability Data Collection Fleet team label Mar 26, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

EMT-248: add post action request handler and resources #60581

EMT-248: add post action request handler and resources #60581

nnamdifrankie commented Mar 18, 2020 •

edited

Loading

nnamdifrankie commented Mar 19, 2020

elasticmachine commented Mar 19, 2020

nchaulet Mar 19, 2020

nchaulet Mar 19, 2020

paul-tavares commented Mar 19, 2020

nnamdifrankie commented Mar 19, 2020

jfsiii Mar 19, 2020

jfsiii Mar 19, 2020

nnamdifrankie Mar 19, 2020 •

edited

Loading

jfsiii Mar 19, 2020

nchaulet Mar 19, 2020

nnamdifrankie Mar 19, 2020

jfsiii Mar 19, 2020

kibanamachine commented Mar 19, 2020

	options: { tags: [] },
	options: { tags: [`access:${PLUGIN_ID}-all`] },


		Object.assign(agentAction, ...keys(newAgentAction).map(key => ({ [key]: newAgentAction[key] })));

		return agentAction as AgentAction;

EMT-248: add post action request handler and resources #60581

EMT-248: add post action request handler and resources #60581

Conversation

nnamdifrankie commented Mar 18, 2020 • edited Loading

Summary

Checklist

nnamdifrankie commented Mar 19, 2020

elasticmachine commented Mar 19, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

paul-tavares commented Mar 19, 2020

nnamdifrankie commented Mar 19, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nnamdifrankie Mar 19, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kibanamachine commented Mar 19, 2020

💚 Build Succeeded

History

nnamdifrankie commented Mar 18, 2020 •

edited

Loading

nnamdifrankie Mar 19, 2020 •

edited

Loading