Skip to content
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

Create the "Asset Inventory" Kibana Plugin #201704

Closed
7 tasks done
opauloh opened this issue Nov 26, 2024 · 2 comments · Fixed by #202291
Closed
7 tasks done

Create the "Asset Inventory" Kibana Plugin #201704

opauloh opened this issue Nov 26, 2024 · 2 comments · Fixed by #202291
Assignees
@albertoblaz
Labels
Team:Cloud Security Cloud Security team related
Milestone
9.0

Comments

@opauloh
Copy link
Contributor

opauloh commented Nov 26, 2024 •
edited by albertoblaz
Loading

Motivation

To provide users with a centralized place to view and manage their assets within Kibana, we need to create a new "Asset Inventory" plugin. This will serve as the foundational component for all subsequent asset management features.

Definition of Done

  • Generate a new Kibana plugin based on the Cloud Security Posture plugin.
  • Create a blank plugin that displays only the title "Inventory" on its 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 for consistent packaging.
  • Include Readme file
  • Ensure the empty plugin doesn't include unneeded dependency
  • Introduce placeholders for initialization of pipelines and transforms following Cloud Security Posture plugin initialize function.

Out of scope

  • Adding any functionality beyond displaying the title "Inventory".
  • Implementing navigation menus or additional UI components.
  • Adding server-side functionality beyond the required for plugin initialization

Related tasks/epics

  • Part of the "Asset Inventory" Epic.
  • Prerequisite for navigation menu additions and other features.
@opauloh opauloh added this to the 8.18 milestone Nov 26, 2024
@botelastic botelastic bot added the needs-team Issues missing a team label label Nov 26, 2024
This was referenced Nov 26, 2024
Closed
Closed
@opauloh opauloh added the Team:Cloud Security Cloud Security team related label Nov 26, 2024
@elasticmachine
Copy link
Contributor

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

@botelastic botelastic bot removed the needs-team Issues missing a team label label Nov 26, 2024
@opauloh opauloh mentioned this issue Nov 26, 2024
Closed
4 tasks
@opauloh
Copy link
Contributor Author

opauloh commented Nov 28, 2024

Since @romulets verified that the plugin generator doesn't work for private (x-pack) plugins, I updated the description to create the plugin based on the cloud_security_posture plugin.

@romulets please coordinate any handover task with @albertoblaz if needed

@albertoblaz albertoblaz mentioned this issue Nov 29, 2024
Merged
9 tasks
hop-dev pushed a commit to hop-dev/kibana that referenced this issue Dec 5, 2024
@albertoblaz @kibanamachine
@opauloh @hop-dev
Create the "Asset Inventory" Kibana Plugin (elastic#202291)
44b09fd 
## 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]>
CAWilson94 pushed a commit to CAWilson94/kibana that referenced this issue Dec 9, 2024
@albertoblaz @kibanamachine
@opauloh @CAWilson94
Create the "Asset Inventory" Kibana Plugin (elastic#202291)
f6d8558 
## 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]>
CAWilson94 pushed a commit to CAWilson94/kibana that referenced this issue Dec 12, 2024
@albertoblaz @kibanamachine
@opauloh @CAWilson94
Create the "Asset Inventory" Kibana Plugin (elastic#202291)
09f4184 
## 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]>
@opauloh opauloh modified the milestones: 8.18, 9.0 Dec 19, 2024
@albertoblaz albertoblaz mentioned this issue Jan 9, 2025
Merged
3 tasks
albertoblaz added a commit that referenced this issue Jan 9, 2025
@albertoblaz @opauloh @kibanamachine
Turn AssetInventory sub-plugin into a Security solution page (#205363)
1e9606d 
## Summary

Turn AssetInventory plugin into a simple Security solution page based on
this conversation:
- elastic/security-team#10346

Follow-up of this work, where we initially developed the Asset Inventory
bare-bones as a plugin:
- #201704

Part of this work stream though not originally planned:
- elastic/security-team#11247

### Motivation

Reasoning behind is enabling fast development changes without any major
refactors in other packages/components that need to be reused, which
seems impossible as of now with the current codebase.

### Checklist

- [x] If a plugin configuration key changed, check if it needs to be
allowlisted in the cloud and added to the [docker
list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)
- [x] 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.
- [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)

### Identify risks

In the future, we'll probably have to turn AssetInventory into a
sub-plugin again. Doing so doesn't bring any risk in the present, and
should only involve the re-generation of the deleted files in this PR.

---------

Co-authored-by: Paulo Henrique <[email protected]>
Co-authored-by: kibanamachine <[email protected]>
Zacqary pushed a commit to Zacqary/kibana that referenced this issue Jan 9, 2025
@albertoblaz @opauloh
@kibanamachine @Zacqary
Turn AssetInventory sub-plugin into a Security solution page (elastic…
56e0632 
…#205363)

## Summary

Turn AssetInventory plugin into a simple Security solution page based on
this conversation:
- elastic/security-team#10346

Follow-up of this work, where we initially developed the Asset Inventory
bare-bones as a plugin:
- elastic#201704

Part of this work stream though not originally planned:
- elastic/security-team#11247

### Motivation

Reasoning behind is enabling fast development changes without any major
refactors in other packages/components that need to be reused, which
seems impossible as of now with the current codebase.

### Checklist

- [x] If a plugin configuration key changed, check if it needs to be
allowlisted in the cloud and added to the [docker
list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)
- [x] 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.
- [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)

### Identify risks

In the future, we'll probably have to turn AssetInventory into a
sub-plugin again. Doing so doesn't bring any risk in the present, and
should only involve the re-generation of the deleted files in this PR.

---------

Co-authored-by: Paulo Henrique <[email protected]>
Co-authored-by: kibanamachine <[email protected]>
CAWilson94 pushed a commit to CAWilson94/kibana that referenced this issue Jan 13, 2025
@albertoblaz @opauloh
@kibanamachine @CAWilson94
Turn AssetInventory sub-plugin into a Security solution page (elastic…
fa99e55 
…#205363)

## Summary

Turn AssetInventory plugin into a simple Security solution page based on
this conversation:
- elastic/security-team#10346

Follow-up of this work, where we initially developed the Asset Inventory
bare-bones as a plugin:
- elastic#201704

Part of this work stream though not originally planned:
- elastic/security-team#11247

### Motivation

Reasoning behind is enabling fast development changes without any major
refactors in other packages/components that need to be reused, which
seems impossible as of now with the current codebase.

### Checklist

- [x] If a plugin configuration key changed, check if it needs to be
allowlisted in the cloud and added to the [docker
list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)
- [x] 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.
- [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)

### Identify risks

In the future, we'll probably have to turn AssetInventory into a
sub-plugin again. Doing so doesn't bring any risk in the present, and
should only involve the re-generation of the deleted files in this PR.

---------

Co-authored-by: Paulo Henrique <[email protected]>
Co-authored-by: kibanamachine <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@albertoblaz albertoblaz

Labels
Team:Cloud Security Cloud Security team related
Projects
None yet
Milestone
9.0
Development

Successfully merging a pull request may close this issue.

Create the "Asset Inventory" Kibana Plugin albertoblaz/kibana
4 participants
@albertoblaz @romulets @elasticmachine @opauloh