[Fleet] Present users with a Kubernetes manifest for deploying agent in fleet managed mode for Kubernetes #127703

MichaelKatsoulis · 2022-03-15T08:16:14Z

Summary

This PR updates agent addition instructions in case a policy contains Kubernetes integration.

It closes #92113

Checklist

Delete any items that are not applicable to this PR.

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
Any UI touched in this PR is usable by keyboard only (learn more about keyboard accessibility)
Any UI touched in this PR does not create any new axe failures (run axe in browser: FF, Chrome)
If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the docker list
This renders correctly on smaller devices using a responsive layout. (You can test this in your browser)
This was checked for cross-browser compatibility

For maintainers

This was checked for breaking API changes and was labeled appropriately

elasticmachine · 2022-03-15T08:16:20Z

Pinging @elastic/fleet (Team:Fleet)

…naged-flyout

kpollich · 2022-03-15T11:51:37Z

Just a heads up, the Fleet team has some in-progress work in this area that may result in conflicts: #80841

MichaelKatsoulis · 2022-03-15T12:03:54Z

Just a heads up, the Fleet team has some in-progress work in this area that may result in conflicts: #80841

Thanks for the heads up!

juliaElastic · 2022-03-16T14:05:06Z

x-pack/plugins/fleet/public/components/agent_enrollment_flyout/steps.tsx


 import { AdvancedAgentAuthenticationSettings } from './advanced_agent_authentication_settings';
 import { SelectCreateAgentPolicy } from './agent_policy_select_create';

-export const DownloadStep = (hasFleetServer: boolean) => {
+export const DownloadStep = (hasFleetServer: boolean, isK8s: string, enrollmentAPIKey: string) => {


you could make isK8s and enrollmentAPIKey optional parameters, to avoid passing '' when not needed

…naged-flyout

juliaElastic · 2022-03-16T14:13:32Z

It would be nice if you could add some unit test coverage on the changes.

barkbay · 2022-03-17T09:19:18Z

x-pack/plugins/fleet/public/components/agent_enrollment_flyout/steps.tsx

+    isK8s === 'IS_KUBERNETES' ? (
+      <FormattedMessage
+        id="xpack.fleet.agentEnrollment.downloadDescriptionForK8s"
+        defaultMessage="Copy or download the Kubernetes manifest inside the Kubernetes cluster. Check {FleetUrlVariable} and {FleetTokenVariable} in the Daemonset environment variables and apply the manifest."


I'm wondering if it could be misleading if user deployed Agent using ECK? I'm not sure what the "Kubernetes manifest" would be in that case ? (not sure I have the full picture, so my comment might not be relevant).
CC @Kushmaro

There is a point in what you are saying. ECK process is different and uses different manifests https://www.elastic.co/guide/en/cloud-on-k8s/current/k8s-deploy-eck.html. But this could be an extra addition in the instructions. With this PR I am just implementing #92113

IMHO we should promote both "regular" k8s manifests, however, we may want to promote ECK manifests (or related messaging) prior.
What I mean here - is that when a customer would like to "run something elastic with k8s" we should first let them know that ECK is the best way of doing so. regardless of where such a message exists.

@Kushmaro Can you clarify what you meant by - > "both "regular" k8s manifests" and
"run something elastic with k8s"

If I understood @barkbay correctly, then the add->agent flyout should also generate agent configuration yaml and set of instructions to be followed in ECK user journey. The current solution assumes vanilla K8s setup, not associated with how the stack components are deployed.

@barkbay @Kushmaro are you able to create another issue in this repo for accounting for ECK user requirement?

CC @mlunadia

criamico · 2022-03-17T15:02:21Z

@MichaelKatsoulis we're working on a complete redesign of this flyout for 8.2. We'll have to change the steps and remove some of them. Can we find a way to coordinate on these PRs to make these changes easier?

MichaelKatsoulis · 2022-03-18T07:12:34Z

@MichaelKatsoulis we're working on a complete redesign of this flyout for 8.2. We'll have to change the steps and remove some of them. Can we find a way to coordinate on these PRs to make these changes easier?

@criamico if the changes you are working on will affect that much the add agent instructions in fleet managed then of course we should coordinate. We could schedule a call if you like.

criamico · 2022-03-18T10:27:27Z

@MichaelKatsoulis we're working on a complete redesign of this flyout for 8.2. We'll have to change the steps and remove some of them. Can we find a way to coordinate on these PRs to make these changes easier?

@criamico if the changes you are working on will affect that much the add agent instructions in fleet managed then of course we should coordinate. We could schedule a call if you like.

Yes I think it would be better as the redesign is going to modify the flyout in a substantial way. Let me find a time to schedule a call.

MichaelKatsoulis · 2022-03-21T08:11:26Z

After a discussion with @criamico, we have decided to freeze this until the restructuring of the flyout is finished. Then I will do my changes on top.

…t-managed-flyout

nchaulet · 2022-03-29T15:56:13Z

x-pack/plugins/fleet/public/components/agent_enrollment_flyout/index.tsx

@@ -93,6 +95,32 @@ export const AgentEnrollmentFlyout: React.FunctionComponent<Props> = ({
    checkPolicyIsFleetServer();
  }, [policyId]);

+  const [isK8s, setIsK8s] = useState<'IS_LOADING' | 'IS_KUBERNETES' | 'IS_NOT_KUBERNETES'>(


I think we can move this to it's own hook and use the same hook for standalone instructions

kpollich

Refactored hooks LGTM 🚀

nchaulet

UI work as expected 🚀

kibana-ci · 2022-03-29T19:49:49Z

💚 Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`fleet`	575	577	+2

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`	1254	1262	+8

Async chunks

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

id	before	after	diff
`fleet`	679.4KB	682.5KB	+3.1KB

Page load bundle

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

id	before	after	diff
`fleet`	110.4KB	110.7KB	+353.0B

Unknown metric groups

API count

id	before	after	diff
`fleet`	1371	1379	+8

ESLint disabled in files

id	before	after	diff
`apm`	15	14	-1
`osquery`	5	4	-1
`securitySolution`	69	68	-1
`uptime`	7	6	-1
total			-4

ESLint disabled line counts

id	before	after	diff
`apm`	88	85	-3
`enterpriseSearch`	9	7	-2
`fleet`	47	46	-1
`osquery`	122	119	-3
`uptime`	49	43	-6
total			-15

References to deprecated APIs

id	before	after	diff
`canvas`	70	64	-6
`dashboard`	78	72	-6
`data`	475	465	-10
`dataEnhanced`	55	49	-6
`discover`	26	20	-6
`fleet`	20	19	-1
`lens`	18	14	-4
`management`	2	1	-1
`maps`	456	330	-126
`monitoring`	40	28	-12
`upgradeAssistant`	12	7	-5
`visDefaultEditor`	205	155	-50
`visTypeVega`	4	3	-1
`visualizations`	17	13	-4
total			-238

Total ESLint disabled count

id	before	after	diff
`apm`	103	99	-4
`enterpriseSearch`	9	7	-2
`fleet`	55	54	-1
`osquery`	127	123	-4
`securitySolution`	509	508	-1
`uptime`	56	49	-7
total			-19

History

💚 Build #34552 succeeded d731d0b
💚 Build #31286 succeeded c04e283
💔 Build #31272 failed 31436d0
💔 Build #31020 failed 24c8f8b
💔 Build #30535 failed 08bc977
💔 Build #30484 failed ec24f16

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

cc @nchaulet

kibanamachine · 2022-03-30T20:26:18Z

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create backports run node scripts/backport --pr 127703 or prevent reminders by adding the backport:skip label.

kibanamachine · 2022-03-31T20:36:17Z

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create backports run node scripts/backport --pr 127703 or prevent reminders by adding the backport:skip label.

amolnater-qasource · 2022-04-12T10:39:25Z

Hi Team
We have revalidated this PR on latest 8.2 Snapshot Kibana cloud environment.

We have observed detailed instructions under Add agent flyout when Kubernetes integration is added.

Build details:
BUILD: 51835
COMMIT: 6fcd2d0
Screenshot:

Hence marking this as QA:Validated.
Thanks

Update agent addition instructions in fleet managed mode

40452d2

MichaelKatsoulis requested a review from a team as a code owner March 15, 2022 08:16

botelastic bot added the Team:Fleet Team label for Observability Data Collection Fleet team label Mar 15, 2022

MichaelKatsoulis marked this pull request as draft March 15, 2022 08:17

MichaelKatsoulis added 3 commits March 15, 2022 12:20

lint

09aba53

Merge remote-tracking branch 'upstream/main' into kubernetes-fleet-ma…

8bc9335

…naged-flyout

Linting fixes

fd7e3af

MichaelKatsoulis requested review from nchaulet and jen-huang March 15, 2022 10:55

Types fix

34eaf42

MichaelKatsoulis marked this pull request as ready for review March 15, 2022 12:04

MichaelKatsoulis added the v8.2.0 label Mar 15, 2022

Check types update

ec24f16

MichaelKatsoulis added the release_note:enhancement label Mar 15, 2022

Minor fix

08bc977

jen-huang changed the title ~~Update agent addition instructions in fleet managed mode~~ [Fleet] Update add agent instructions in fleet managed mode for Kubernetes Mar 15, 2022

juliaElastic reviewed Mar 16, 2022

View reviewed changes

MichaelKatsoulis added 2 commits March 16, 2022 16:09

Remove leftover

b2b9a68

Merge remote-tracking branch 'upstream/main' into kubernetes-fleet-ma…

24c8f8b

…naged-flyout

barkbay reviewed Mar 17, 2022

View reviewed changes

MichaelKatsoulis added 2 commits March 17, 2022 11:55

Fix CI

31436d0

Eslint fixes

c04e283

jen-huang removed their request for review March 17, 2022 18:00

MichaelKatsoulis closed this Mar 18, 2022

MichaelKatsoulis reopened this Mar 18, 2022

joshdover assigned nchaulet Mar 29, 2022

nchaulet added 2 commits March 29, 2022 11:24

Merge branch 'main' of github.com:elastic/kibana into kubernetes-flee…

13e52bc

…t-managed-flyout

Fix merge issue

d731d0b

nchaulet reviewed Mar 29, 2022

View reviewed changes

Refacto hooks

5a9df4c

kpollich approved these changes Mar 29, 2022

View reviewed changes

Handle error

addee65

nchaulet approved these changes Mar 29, 2022

View reviewed changes

nchaulet enabled auto-merge (squash) March 29, 2022 19:15

nchaulet merged commit b160853 into elastic:main Mar 29, 2022

jen-huang added the QA:Ready for Testing Code is merged and ready for QA to validate label Mar 29, 2022

kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label Mar 30, 2022

jen-huang added backport:skip This commit does not require backporting and removed backport missing Added to PRs automatically when the are determined to be missing a backport. labels Mar 31, 2022

amolnater-qasource added QA:Validated Issue has been validated by QA and removed QA:Ready for Testing Code is merged and ready for QA to validate labels Apr 12, 2022

jen-huang mentioned this pull request Apr 13, 2022

[Fleet] k8 instructions is lost after agent flyout redesign #130201

Closed

eyalkraft mentioned this pull request Apr 20, 2022

[Change Proposal] Add an optional field "Deployment instruction template" for integrations elastic/package-spec#320

Open

mlunadia mentioned this pull request Jun 20, 2022

Improve consistency of Fleet UI deployment to Kubernetes experience #134747

Closed

mlunadia changed the title ~~[Fleet] Update add agent instructions in fleet managed mode for Kubernetes~~ [Fleet] Present users with a Kubernetes manifest for deploying agent in fleet managed mode for Kubernetes Jun 30, 2022

This pull request was closed.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Fleet] Present users with a Kubernetes manifest for deploying agent in fleet managed mode for Kubernetes #127703

[Fleet] Present users with a Kubernetes manifest for deploying agent in fleet managed mode for Kubernetes #127703

MichaelKatsoulis commented Mar 15, 2022 •

edited

Loading

elasticmachine commented Mar 15, 2022

kpollich commented Mar 15, 2022

MichaelKatsoulis commented Mar 15, 2022

juliaElastic Mar 16, 2022

juliaElastic commented Mar 16, 2022

barkbay Mar 17, 2022

MichaelKatsoulis Mar 18, 2022

Kushmaro Mar 21, 2022

mukeshelastic Mar 22, 2022

criamico commented Mar 17, 2022

MichaelKatsoulis commented Mar 18, 2022

criamico commented Mar 18, 2022

MichaelKatsoulis commented Mar 21, 2022

nchaulet Mar 29, 2022

kpollich left a comment

nchaulet left a comment

kibana-ci commented Mar 29, 2022

API count

ESLint disabled in files

ESLint disabled line counts

References to deprecated APIs

Total ESLint disabled count

kibanamachine commented Mar 30, 2022

kibanamachine commented Mar 31, 2022

amolnater-qasource commented Apr 12, 2022

[Fleet] Present users with a Kubernetes manifest for deploying agent in fleet managed mode for Kubernetes #127703

[Fleet] Present users with a Kubernetes manifest for deploying agent in fleet managed mode for Kubernetes #127703

Conversation

MichaelKatsoulis commented Mar 15, 2022 • edited Loading

Summary

Checklist

For maintainers

elasticmachine commented Mar 15, 2022

kpollich commented Mar 15, 2022

MichaelKatsoulis commented Mar 15, 2022

juliaElastic Mar 16, 2022

Choose a reason for hiding this comment

juliaElastic commented Mar 16, 2022

barkbay Mar 17, 2022

Choose a reason for hiding this comment

MichaelKatsoulis Mar 18, 2022

Choose a reason for hiding this comment

Kushmaro Mar 21, 2022

Choose a reason for hiding this comment

mukeshelastic Mar 22, 2022

Choose a reason for hiding this comment

criamico commented Mar 17, 2022

MichaelKatsoulis commented Mar 18, 2022

criamico commented Mar 18, 2022

MichaelKatsoulis commented Mar 21, 2022

nchaulet Mar 29, 2022

Choose a reason for hiding this comment

kpollich left a comment

Choose a reason for hiding this comment

nchaulet left a comment

Choose a reason for hiding this comment

kibana-ci commented Mar 29, 2022

💚 Build Succeeded

Metrics [docs]

Module Count

Public APIs missing comments

Async chunks

Page load bundle

API count

ESLint disabled in files

ESLint disabled line counts

References to deprecated APIs

Total ESLint disabled count

History

kibanamachine commented Mar 30, 2022

kibanamachine commented Mar 31, 2022

amolnater-qasource commented Apr 12, 2022

MichaelKatsoulis commented Mar 15, 2022 •

edited

Loading