Create the "Asset Inventory" Kibana Plugin #202291

albertoblaz · 2024-11-29T12:32:30Z

Summary

Closes #201704.

Create an empty "Asset Inventory" plugin with the minimal boilerplate required to set it up, install it and run it on Kibana with a blank slate.

I generated the files using the node scripts/generate_plugin <NAME> script as per this documentation page.

Screenshots

Main page (Sample page)

Implementation details

Generated a new Kibana plugin with minimal boilerplate and zero dependencies
Use Cloud Security Posture plugin as configuration reference
Render "Inventory" title on the main page
Ensure the plugin is properly integrated into Kibana's build and can be loaded without errors
Place the plugin under the x-pack/plugins directory
Include Readme file
Introduce placeholders for initialization of pipelines and transforms following Cloud Security Posture plugin initialize function.

PR Checklist

No docs for now ~~Documentation was added for features that require explanation or tutorials~~
The PR description includes the appropriate Release Notes section, and the correct release_note:* label is applied per the guidelines

Risks

No risks at all since this is totally green-field and will be hidden by a feature toggle.

albertoblaz · 2024-11-29T14:11:01Z

x-pack/plugins/asset_inventory/server/create_transforms/create_transforms.ts

+  // TODO initialize transforms here
+  // await initializeTransform(esClient, <TRANSFORM_HERE>, logger);


NOTE: Placeholder for transforms initialization. Please let me know if this is enough or if I should uncomment the line and add some specific transforms

albertoblaz · 2024-11-29T14:11:54Z

x-pack/plugins/asset_inventory/server/create_transforms/create_transforms.ts

This file was copy-pasted from x-pack/plugins/cloud_security_posture/server/create_transforms/create_transforms.ts. Let me know if we should reuse it somehow instead

IMO it would be better to add this when you know you need it so it is not forgotten.

🤔 Asset Inventory likely needs transformers, however, are the changes for asset inventory minimal? Maybe we should consider creating a shared transformer package

Maybe we should consider creating a shared transformer package

I think that's a great idea, the transform methods can be adapted to be more general, and we can also leverage our team package where we see fit.

If you prefer that can be done on a follow-up PR, we can keep this file for now and create a follow-up Github issue to move to the shared package.

albertoblaz · 2024-11-29T14:12:36Z

x-pack/plugins/asset_inventory/server/plugin.ts

+    // TODO Invoke initialize() when it's due
+    // this.initialize(core).catch(() => {});


NOTE: Uncomment this line to initialize transforms on start

x-pack/plugins/asset_inventory/translations/ja-JP.json

albertoblaz · 2024-11-29T14:13:25Z

x-pack/plugins/asset_inventory/tsconfig.json

+    "public/**/*.json",
+    "server/**/*.ts",
+    "server/**/*.json",
+    // "../../typings/**/*",


To-do: Remove comment

Just thinking if it would be easier to exclude. 🤔

seanrathier

Overall LGTM, there are some project files I think we should not need, but the code looks good to go except for 1 suggestion.

x-pack/plugins/asset_inventory/.eslintrc.js

x-pack/plugins/asset_inventory/.gitignore

x-pack/plugins/asset_inventory/.i18nrc.json

x-pack/plugins/asset_inventory/common/index.ts

x-pack/plugins/asset_inventory/kibana.jsonc

seanrathier · 2024-11-29T16:12:26Z

x-pack/plugins/asset_inventory/public/components/app.tsx

+            showSearchBar={true}
+            useDefaultBehaviors={true}
+          />
+          <EuiPageTemplate restrictWidth="1000px">


Why are we restricting the width to 1000px?

🤔 Should we use break points here?
https://eui.elastic.co/#/theming/breakpoints/values

This was auto-generated by the script. I agree we should change it but the UI is not relevant at this point. We just wanted to have an empty plugin to start working upon it

seanrathier · 2024-11-29T16:18:49Z

x-pack/plugins/asset_inventory/server/create_transforms/create_transforms.ts

IMO it would be better to add this when you know you need it so it is not forgotten.

🤔 Asset Inventory likely needs transformers, however, are the changes for asset inventory minimal? Maybe we should consider creating a shared transformer package

x-pack/plugins/asset_inventory/server/plugin.ts

x-pack/plugins/asset_inventory/translations/ja-JP.json

seanrathier · 2024-11-29T16:28:14Z

x-pack/plugins/asset_inventory/tsconfig.json

+    "public/**/*.json",
+    "server/**/*.ts",
+    "server/**/*.json",
+    // "../../typings/**/*",


Just thinking if it would be easier to exclude. 🤔

seanrathier · 2024-11-29T16:54:49Z

One thing that I did see in the Fleet plugin was that they had their Cypress test in the plugin directory, which is WAY more convenient than having them in x-pack/test/asset-inventory or x-pack/test/test_serverless/.../asset_inventory

I am not saying we should use Cypress or Selinium, but keeping the integration tests local would make more sense if we can.

albertoblaz · 2024-11-29T16:57:40Z

One thing that I did see in the Fleet plugin was that they had their Cypress test in the plugin directory, which is WAY more convenient than having them in x-pack/test/asset-inventory or x-pack/test/test_serverless/.../asset_inventory

I am not saying we should use Cypress or Selinium, but keeping the integration tests local would make more sense if we can.

Yeah, 100% agree. I prefer having source code and tests next to each other rather than in a totally different folder. I haven't created any test folder so far, but I think we should follow that convention 👍

elasticmachine · 2024-11-29T17:42:09Z

Pinging @elastic/kibana-cloud-security-posture (Team:Cloud Security)

x-pack/plugins/asset_inventory/.i18nrc.json

x-pack/plugins/asset_inventory/common/index.ts

x-pack/plugins/asset_inventory/kibana.jsonc

x-pack/plugins/asset_inventory/package.json

opauloh · 2024-11-30T00:54:50Z

x-pack/plugins/asset_inventory/kibana.jsonc

+      "xpack",
+      "assetInventory"
+    ],
+    "requiredPlugins": ["navigation"],


I think it's ok as it is to get started with the plugin, and then we add the required plugins as needed

I am pretty sure that we need the security if the plugin falls in the Security section of Kibana.

security is actually not related to the security solution, it's a plugin that exposes authorization and authentication services. Not needed at the moment as there's no server-side API implemented.

x-pack/plugins/asset_inventory/.i18nrc.json

x-pack/plugins/asset_inventory/public/types.ts

opauloh · 2024-11-30T01:44:33Z

x-pack/plugins/asset_inventory/server/create_transforms/create_transforms.ts

Maybe we should consider creating a shared transformer package

I think that's a great idea, the transform methods can be adapted to be more general, and we can also leverage our team package where we see fit.

If you prefer that can be done on a follow-up PR, we can keep this file for now and create a follow-up Github issue to move to the shared package.

x-pack/plugins/asset_inventory/translations/ja-JP.json

x-pack/plugins/asset_inventory/public/components/app.tsx

- Move to x-pack/plugins folder

- Add author - Use consistent naming - Remove unused scripts - Add license - Set version to 1.0.0

- Will style with @emotion/react instead

- package.json, tsconfig.json, yarn.lock

opauloh

Looks good to me, thanks for providing a great starter for the asset inventory plugin

elasticmachine · 2024-12-03T07:05:51Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: 08b0be5

Failed CI Steps

:pipeline:🪄 Run Dynamic Pipeline: .buildkite/scripts/pipelines/pull_request/pipeline.sh

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`assetInventory`	-	16	+16

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
`assetInventory`	-	6	+6

Async chunks

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

id	before	after	diff
`assetInventory`	-	1.2KB	+1.2KB

Page load bundle

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

id	before	after	diff
`assetInventory`	-	3.1KB	+3.1KB

Unknown metric groups

API count

id	before	after	diff
`assetInventory`	-	6	+6

async chunk count

id	before	after	diff
`assetInventory`	-	1	+1

ESLint disabled line counts

id	before	after	diff
`assetInventory`	-	5	+5

References to deprecated APIs

id	before	after	diff
`assetInventory`	-	1	+1

Total ESLint disabled count

id	before	after	diff
`assetInventory`	-	5	+5

History

cc @albertoblaz

gsoldevila

LGTM!

kibanamachine · 2024-12-03T10:30:11Z

Starting backport for target branches: 8.x

https://github.com/elastic/kibana/actions/runs/12137753913

kibanamachine · 2024-12-03T10:34:55Z

💔 All backports failed

Status	Branch	Result
❌	8.x	Backport failed because of merge conflicts You might need to backport the following PRs to 8.x: - [Security Solution] - Update codeowners (#202046) - [Discover / Logs] Add new "Saved Search component" (#199787) - [Infra] Unskip infra serverless tests (#202146)

Manual backport

To create the backport manually run:

node scripts/backport --pr 202291

Questions ?

Please refer to the Backport tool documentation

albertoblaz · 2024-12-03T21:54:06Z

💚 All backports created successfully

Status	Branch	Result
✅	8.x

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

# Backport This will backport the following commits from `main` to `8.x`: - [Create the "Asset Inventory" Kibana Plugin (#202291)](#202291)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  --------- Co-authored-by: kibanamachine <[email protected]>

## Summary Closes elastic#201704. Create an empty "Asset Inventory" plugin with the minimal boilerplate required to set it up, install it and run it on Kibana with a blank slate. I generated the files using the `node scripts/generate_plugin <NAME>` script as per [this documentation page](https://docs.elastic.dev/kibana-dev-docs/getting-started/hello-world-app#2-option-2---use-the-automatic-plugin-generator). ### Screenshots <details><summary>Main page (Sample page)</summary> <img width="2498" alt="Screenshot 2024-11-29 at 14 20 57" src="https://github.com/user-attachments/assets/9d8a3751-519b-4661-bc90-cbb1e836b111"> </details> ### Implementation details - [x] Generated a new Kibana plugin with minimal boilerplate and zero dependencies - [x] Use [Cloud Security Posture](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cloud_security_posture) plugin as configuration reference - [x] Render "Inventory" title on the main page - [x] Ensure the plugin is properly integrated into Kibana's build and can be loaded without errors - [x] Place the plugin under the `x-pack/plugins` directory - [x] Include Readme file - [x] Introduce placeholders for initialization of pipelines and transforms following [Cloud Security Posture](https://github.com/elastic/kibana/blob/main/x-pack/plugins/cloud_security_posture/server/plugin.ts) plugin initialize function. ### PR Checklist - [ ] No docs for now ~~[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials~~ - [x] The PR description includes the appropriate Release Notes section, and the correct `release_note:*` label is applied per the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) ### Risks No risks at all since this is totally green-field and will be hidden by a feature toggle. --------- Co-authored-by: kibanamachine <[email protected]> Co-authored-by: Paulo Silva <[email protected]>

albertoblaz self-assigned this Nov 29, 2024

albertoblaz force-pushed the asset-inventory-empty-plugin branch from 2c5c68d to 4df3e74 Compare November 29, 2024 13:25

albertoblaz requested review from romulets and a team November 29, 2024 14:07

albertoblaz commented Nov 29, 2024

View reviewed changes

seanrathier reviewed Nov 29, 2024

View reviewed changes

albertoblaz force-pushed the asset-inventory-empty-plugin branch from 98c00bb to 031a4fc Compare November 29, 2024 17:40

albertoblaz marked this pull request as ready for review November 29, 2024 17:42

albertoblaz requested a review from a team as a code owner November 29, 2024 17:42

opauloh reviewed Nov 30, 2024

View reviewed changes

albertoblaz added 12 commits December 2, 2024 10:36

Auto-generate asset-inventory plugin

810cd88

- Move to x-pack/plugins folder

Fix tsconfig.json. Extend from correct base config

dec7691

Enhance package.json based on existing plugins

5cf1eec

- Add author - Use consistent naming - Remove unused scripts - Add license - Set version to 1.0.0

Delete .scss files.

58926ec

- Will style with @emotion/react instead

Convert kibana.json -> .jsonc. Mimic CSP config

1d34c57

Mimic CSP plugin tsconfig.json

9fe76f2

Update references to plugin after building Kibana

37a5e55

- package.json, tsconfig.json, yarn.lock

Render "Inventory" on main plugin page

be8e5be

Update README.md

6866096

Add placeholder code for transforms initialization

5154d27

Remove UI boilerplate generated by script

5fe347c

Improve phrasing in plugin description

b20f8e1

albertoblaz added 2 commits December 2, 2024 11:50

Update bundle limits

b8aee1b

Fix linting issues

15dcb5a

albertoblaz requested a review from a team as a code owner December 2, 2024 10:51

Update FTR tests

4c1cf24

albertoblaz requested a review from a team as a code owner December 2, 2024 16:01

albertoblaz requested review from seanrathier and opauloh December 2, 2024 16:31

Ikuni17 approved these changes Dec 2, 2024

View reviewed changes

opauloh added 3 commits December 2, 2024 16:45

Merge branch 'main' into asset-inventory-empty-plugin

1d03d3f

removing navigation

2a4bb6a

removing asset inventory from graph

2d45a8e

opauloh removed the request for review from a team December 3, 2024 04:47

opauloh approved these changes Dec 3, 2024

View reviewed changes

[CI] Auto-commit changed files from 'node scripts/notice'

08b0be5

gsoldevila approved these changes Dec 3, 2024

View reviewed changes

albertoblaz merged commit e5b1773 into elastic:main Dec 3, 2024
8 checks passed

albertoblaz deleted the asset-inventory-empty-plugin branch December 3, 2024 10:30

kibanamachine added the v9.0.0 label Dec 3, 2024

This was referenced Dec 3, 2024

🌊 Adjust codeowners for streams code #202367

Merged

[deps] Replace faker with @faker-js #201105

Merged

Update @elastic/appex-ai-infra (main) - not abandoned - abandoned #200579

Merged

albertoblaz mentioned this pull request Dec 3, 2024

[8.x] Create the "Asset Inventory" Kibana Plugin (#202291) #202827

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create the "Asset Inventory" Kibana Plugin #202291

Create the "Asset Inventory" Kibana Plugin #202291

albertoblaz commented Nov 29, 2024 •

edited by kibanamachine

Loading

albertoblaz Nov 29, 2024 •

edited

Loading

albertoblaz Nov 29, 2024

seanrathier Nov 29, 2024

opauloh Nov 30, 2024

albertoblaz Nov 29, 2024 •

edited

Loading

albertoblaz Nov 29, 2024

seanrathier Nov 29, 2024

seanrathier left a comment

seanrathier Nov 29, 2024 •

edited

Loading

albertoblaz Nov 29, 2024

seanrathier Nov 29, 2024

seanrathier Nov 29, 2024

seanrathier commented Nov 29, 2024

albertoblaz commented Nov 29, 2024

elasticmachine commented Nov 29, 2024

opauloh Nov 30, 2024

opauloh Nov 30, 2024

opauloh left a comment •

edited

Loading

elasticmachine commented Dec 3, 2024

API count

async chunk count

ESLint disabled line counts

References to deprecated APIs

Total ESLint disabled count

gsoldevila left a comment

kibanamachine commented Dec 3, 2024

kibanamachine commented Dec 3, 2024

albertoblaz commented Dec 3, 2024

		// TODO initialize transforms here
		// await initializeTransform(esClient, <TRANSFORM_HERE>, logger);

		// TODO Invoke initialize() when it's due
		// this.initialize(core).catch(() => {});

Create the "Asset Inventory" Kibana Plugin #202291

Create the "Asset Inventory" Kibana Plugin #202291

Conversation

albertoblaz commented Nov 29, 2024 • edited by kibanamachine Loading

Summary

Screenshots

Implementation details

PR Checklist

Risks

albertoblaz Nov 29, 2024 • 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

albertoblaz Nov 29, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

seanrathier left a comment

Choose a reason for hiding this comment

seanrathier Nov 29, 2024 • 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

seanrathier commented Nov 29, 2024

albertoblaz commented Nov 29, 2024

elasticmachine commented Nov 29, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

opauloh left a comment • edited Loading

Choose a reason for hiding this comment

elasticmachine commented Dec 3, 2024

💛 Build succeeded, but was flaky

Failed CI Steps

Metrics [docs]

Module Count

Public APIs missing comments

Async chunks

Page load bundle

API count

async chunk count

ESLint disabled line counts

References to deprecated APIs

Total ESLint disabled count

History

gsoldevila left a comment

Choose a reason for hiding this comment

kibanamachine commented Dec 3, 2024

kibanamachine commented Dec 3, 2024

💔 All backports failed

Manual backport

Questions ?

albertoblaz commented Dec 3, 2024

💚 All backports created successfully

Questions ?

albertoblaz commented Nov 29, 2024 •

edited by kibanamachine

Loading

albertoblaz Nov 29, 2024 •

edited

Loading

albertoblaz Nov 29, 2024 •

edited

Loading

seanrathier Nov 29, 2024 •

edited

Loading

opauloh left a comment •

edited

Loading