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.

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

[Inventory] Use observability:entityCentricExperience to enable inventory #192323

Closed
smith opened this issue Sep 8, 2024 · 5 comments · Fixed by #193533
Closed

[Inventory] Use observability:entityCentricExperience to enable inventory #192323

smith opened this issue Sep 8, 2024 · 5 comments · Fixed by #193533
Assignees
Labels
Feature:EntitiesInventory Observability entities inventory feature Team:obs-ux-infra_services Observability Infrastructure & Services User Experience Team technical debt Improvement of the software architecture and operational architecture

Comments

@smith
Copy link
Contributor

smith commented Sep 8, 2024

In #191798 the visibility of the inventory navigation is controlled by the kibana.yml setting xpack.inventory.enabled. It should use the observability:entityCentricExperience advanced setting instead.

✔ Acceptance critieria

  • xpack.inventory.enabled does not exist (it can be removed without deprecation since it was never used by customers)
  • When the observability:entityCentricExperience advanced setting is enabled I can see and use the top-level inventory navigation.
@smith smith added technical debt Improvement of the software architecture and operational architecture Feature:EntitiesInventory Observability entities inventory feature labels Sep 8, 2024
@botelastic botelastic bot added the needs-team Issues missing a team label label Sep 8, 2024
@smith smith added Team:obs-ux-infra_services Observability Infrastructure & Services User Experience Team and removed needs-team Issues missing a team label labels Sep 8, 2024
@elasticmachine
Copy link
Contributor

Pinging @elastic/obs-ux-infra_services-team (Team:obs-ux-infra_services)

@kpatticha kpatticha changed the title Use observability:entityCentricExperience to enable inventory [Inventory] Use observability:entityCentricExperience to enable inventory Sep 12, 2024
@iblancof iblancof self-assigned this Sep 16, 2024
@iblancof
Copy link
Contributor

@smith are we sure we want to enable this with the observability:entityCentricExperience advanced setting instead of using the xpack.inventory.enabled flag in thekibana.yml before all the development is finished?

This issue was in the "Ready" column, and I started working on it, but this question came to mind.

cc:@roshan-elastic, @cauemarcondes, @kpatticha

@smith
Copy link
Contributor Author

smith commented Sep 16, 2024

@smith are we sure we want to enable this with the observability:entityCentricExperience advanced setting instead of using the xpack.inventory.enabled flag in thekibana.yml before all the development is finished?

Yes. The difference between the two is:

  • kibana.yml items have to be on the allow list to be available on cloud or serverless
  • kibana.yml changes require a restart of the kibana node process
  • Advanced settings can be enabled per space (in the UI) or per kibana instance (with overrides in Kibana.yml)

If the advanced setting is enabled and a user sees technical preview software on serverless that is not finished it is not a problem.

The next release feature freeze is October 15 and at that time things will be in a much less unfinished state.

@iblancof
Copy link
Contributor

If the advanced setting is enabled and a user sees technical preview software on serverless that is not finished it is not a problem.

This is the answer I was looking for, thanks @smith!!

@kpatticha
Copy link
Contributor

@iblancof feel free to raise any questions or concerns, even if the ticket is in the "Ready" state.

kibanamachine pushed a commit to kibanamachine/kibana that referenced this issue Sep 30, 2024
…e nav adjustments (elastic#193533)

## Summary

Closes elastic#192323 and
elastic#193393.

### Plugin enablement
The enablement of the new Inventory plugin was previously managed via
the `xpack.inventory.enabled` setting in kibana.yml. With this PR, we
transition to enabling it through the
`observability:entitycentricexperience` advanced setting.

### Position in side nav
Additionally, this PR includes adjustments to the placement of the new
Inventory page within the side navigation and the addition of the "Tech
Preview" badge in the navigation where it was supported.

|Navigation|Screenshot|
|-|-|
|Stateful classic (first nav)|![Screenshot 2024-09-25 at 11 25
46](https://github.com/user-attachments/assets/54e92632-9931-4f5b-8648-8a32afcd0caf)|
|Stateful classic (O11y)|![Screenshot 2024-09-25 at 11 25
56](https://github.com/user-attachments/assets/ae644eb2-2559-4be0-8659-ef709399a871)|
|Stateful new O11y|![Screenshot 2024-09-25 at 11 27
52](https://github.com/user-attachments/assets/c404232c-2630-4220-9bb8-315b0f0fc55f)|
|Serverless|![Screenshot 2024-09-25 at 11 23
07](https://github.com/user-attachments/assets/7f7e6c79-7f0f-4f7d-8fed-260d73ad4d3f)|

### Global search
A modification was made to the global search to prevent a duplicate
result from appearing during searches by removing the deeplinks when
registering the plugin. The UI changes are shown below.

>[!WARNING]
If this modification causes any other issues, please let me know in a
comment.

|With deeplink (before)|Without deeplink (after)|
|-|-|

|![global_search_with_deeplink](https://github.com/user-attachments/assets/3ef5641c-3add-4892-af2f-46f72ff1722e)|![global_search_without_deeplink](https://github.com/user-attachments/assets/8ad92f27-13a2-4b85-8958-588e597f94d9)|

### Services rename to Service Inventory
Another needed change was to rename the nav item Services to Service
Inventory

>[!NOTE]
Screenshots were taken before the navigation sorting was agreed with
product, so the "Inventory" item does not appear in the right position.

|Navigation|Screenshot|
|-|-|
|Stateful classic
(O11y)|![services_stateful_classic](https://github.com/user-attachments/assets/25ed1294-40fe-47be-9319-fe294acce8f8)|
|Stateful new
O11y|![services_stateful_new](https://github.com/user-attachments/assets/4ae9495c-56bc-4327-b2f6-b6ac9f68bd21)|

|Serverless|![services_serverless](https://github.com/user-attachments/assets/81ff51f4-3b0e-41fd-b7c6-79e8aa44e575)|

>[!NOTE]
The rename of infra Inventory to Infrastructure Inventory is being
tracked separately in elastic#192324.

### Tech preview badge in page
Lastly, the "Technical Preview" badge has been added to the page title.

>[!NOTE]
The screenshot was taken before the navigation sorting was agreed with
product, so the "Inventory" item does not appear in the right position.

![inventory_title_badge](https://github.com/user-attachments/assets/172c5b8e-258e-4127-b792-40910e9dede0)

### Plugin registration in server
To make the Inventory available in the spaces and privileges
configuration the plugin has been registered in the features service.

>[!WARNING]
I lack detailed context in this area, so I’ve added default empty
configurations for most attributes. If any adjustments or improvements
are needed, please let me know.

|Space config|Privileges|
|-|-|
|![Screenshot 2024-09-23 at 10 57
35](https://github.com/user-attachments/assets/1c3a45b6-fd67-4706-8fc4-ee42a9206787)|![Screenshot
2024-09-23 at 10 57
14](https://github.com/user-attachments/assets/a852c15d-133c-459d-be77-2d73e662ffdb)|

---------

Co-authored-by: Kate Patticha <[email protected]>
Co-authored-by: kibanamachine <[email protected]>
(cherry picked from commit 26f5e14)
kibanamachine added a commit that referenced this issue Sep 30, 2024
… + side nav adjustments (#193533) (#194408)

# Backport

This will backport the following commits from `main` to `8.x`:
- [[Inventory] Use observability:entitycentricexperience to enable +
side nav adjustments
(#193533)](#193533)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Irene
Blanco","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-09-30T10:37:37Z","message":"[Inventory]
Use observability:entitycentricexperience to enable + side nav
adjustments (#193533)\n\n## Summary\r\n\r\nCloses
#192323
and\r\nhttps://github.com//issues/193393.\r\n\r\n###
Plugin enablement\r\nThe enablement of the new Inventory plugin was
previously managed via\r\nthe `xpack.inventory.enabled` setting in
kibana.yml. With this PR, we\r\ntransition to enabling it through
the\r\n`observability:entitycentricexperience` advanced
setting.\r\n\r\n\r\n### Position in side nav\r\nAdditionally, this PR
includes adjustments to the placement of the new\r\nInventory page
within the side navigation and the addition of the \"Tech\r\nPreview\"
badge in the navigation where it was
supported.\r\n\r\n|Navigation|Screenshot|\r\n|-|-|\r\n|Stateful classic
(first nav)|![Screenshot 2024-09-25 at 11
25\r\n46](https://github.com/user-attachments/assets/54e92632-9931-4f5b-8648-8a32afcd0caf)|\r\n|Stateful
classic (O11y)|![Screenshot 2024-09-25 at 11
25\r\n56](https://github.com/user-attachments/assets/ae644eb2-2559-4be0-8659-ef709399a871)|\r\n|Stateful
new O11y|![Screenshot 2024-09-25 at 11
27\r\n52](https://github.com/user-attachments/assets/c404232c-2630-4220-9bb8-315b0f0fc55f)|\r\n|Serverless|![Screenshot
2024-09-25 at 11
23\r\n07](https://github.com/user-attachments/assets/7f7e6c79-7f0f-4f7d-8fed-260d73ad4d3f)|\r\n\r\n\r\n###
Global search\r\nA modification was made to the global search to prevent
a duplicate\r\nresult from appearing during searches by removing the
deeplinks when\r\nregistering the plugin. The UI changes are shown
below.\r\n\r\n>[!WARNING]\r\nIf this modification causes any other
issues, please let me know in a\r\ncomment.\r\n\r\n|With deeplink
(before)|Without deeplink
(after)|\r\n|-|-|\r\n\r\n|![global_search_with_deeplink](https://github.com/user-attachments/assets/3ef5641c-3add-4892-af2f-46f72ff1722e)|![global_search_without_deeplink](https://github.com/user-attachments/assets/8ad92f27-13a2-4b85-8958-588e597f94d9)|\r\n\r\n###
Services rename to Service Inventory\r\nAnother needed change was to
rename the nav item Services to Service\r\nInventory\r\n\r\n>[!NOTE]
\r\nScreenshots were taken before the navigation sorting was agreed
with\r\nproduct, so the \"Inventory\" item does not appear in the right
position.\r\n\r\n|Navigation|Screenshot|\r\n|-|-|\r\n|Stateful
classic\r\n(O11y)|![services_stateful_classic](https://github.com/user-attachments/assets/25ed1294-40fe-47be-9319-fe294acce8f8)|\r\n|Stateful
new\r\nO11y|![services_stateful_new](https://github.com/user-attachments/assets/4ae9495c-56bc-4327-b2f6-b6ac9f68bd21)|\r\n\r\n|Serverless|![services_serverless](https://github.com/user-attachments/assets/81ff51f4-3b0e-41fd-b7c6-79e8aa44e575)|\r\n\r\n>[!NOTE]
\r\nThe rename of infra Inventory to Infrastructure Inventory is
being\r\ntracked separately in
https://github.com/elastic/kibana/issues/192324.\r\n\r\n\r\n### Tech
preview badge in page\r\nLastly, the \"Technical Preview\" badge has
been added to the page title.\r\n\r\n>[!NOTE] \r\nThe screenshot was
taken before the navigation sorting was agreed with\r\nproduct, so the
\"Inventory\" item does not appear in the right
position.\r\n\r\n\r\n\r\n![inventory_title_badge](https://github.com/user-attachments/assets/172c5b8e-258e-4127-b792-40910e9dede0)\r\n\r\n\r\n###
Plugin registration in server\r\nTo make the Inventory available in the
spaces and privileges\r\nconfiguration the plugin has been registered in
the features service.\r\n\r\n>[!WARNING]\r\nI lack detailed context in
this area, so I’ve added default empty\r\nconfigurations for most
attributes. If any adjustments or improvements\r\nare needed, please let
me know.\r\n\r\n|Space config|Privileges|\r\n|-|-|\r\n|![Screenshot
2024-09-23 at 10
57\r\n35](https://github.com/user-attachments/assets/1c3a45b6-fd67-4706-8fc4-ee42a9206787)|![Screenshot\r\n2024-09-23
at 10
57\r\n14](https://github.com/user-attachments/assets/a852c15d-133c-459d-be77-2d73e662ffdb)|\r\n\r\n---------\r\n\r\nCo-authored-by:
Kate Patticha <[email protected]>\r\nCo-authored-by:
kibanamachine
<[email protected]>","sha":"26f5e1482b23548d1b06bec9e5fedf7dfa93a620","branchLabelMapping":{"^v9.0.0$":"main","^v8.16.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","backport:prev-minor","ci:project-deploy-observability","Team:obs-ux-infra_services","Team:obs-ux-management","v8.16.0"],"title":"[Inventory]
Use observability:entitycentricexperience to enable + side nav
adjustments","number":193533,"url":"https://github.com/elastic/kibana/pull/193533","mergeCommit":{"message":"[Inventory]
Use observability:entitycentricexperience to enable + side nav
adjustments (#193533)\n\n## Summary\r\n\r\nCloses
#192323
and\r\nhttps://github.com//issues/193393.\r\n\r\n###
Plugin enablement\r\nThe enablement of the new Inventory plugin was
previously managed via\r\nthe `xpack.inventory.enabled` setting in
kibana.yml. With this PR, we\r\ntransition to enabling it through
the\r\n`observability:entitycentricexperience` advanced
setting.\r\n\r\n\r\n### Position in side nav\r\nAdditionally, this PR
includes adjustments to the placement of the new\r\nInventory page
within the side navigation and the addition of the \"Tech\r\nPreview\"
badge in the navigation where it was
supported.\r\n\r\n|Navigation|Screenshot|\r\n|-|-|\r\n|Stateful classic
(first nav)|![Screenshot 2024-09-25 at 11
25\r\n46](https://github.com/user-attachments/assets/54e92632-9931-4f5b-8648-8a32afcd0caf)|\r\n|Stateful
classic (O11y)|![Screenshot 2024-09-25 at 11
25\r\n56](https://github.com/user-attachments/assets/ae644eb2-2559-4be0-8659-ef709399a871)|\r\n|Stateful
new O11y|![Screenshot 2024-09-25 at 11
27\r\n52](https://github.com/user-attachments/assets/c404232c-2630-4220-9bb8-315b0f0fc55f)|\r\n|Serverless|![Screenshot
2024-09-25 at 11
23\r\n07](https://github.com/user-attachments/assets/7f7e6c79-7f0f-4f7d-8fed-260d73ad4d3f)|\r\n\r\n\r\n###
Global search\r\nA modification was made to the global search to prevent
a duplicate\r\nresult from appearing during searches by removing the
deeplinks when\r\nregistering the plugin. The UI changes are shown
below.\r\n\r\n>[!WARNING]\r\nIf this modification causes any other
issues, please let me know in a\r\ncomment.\r\n\r\n|With deeplink
(before)|Without deeplink
(after)|\r\n|-|-|\r\n\r\n|![global_search_with_deeplink](https://github.com/user-attachments/assets/3ef5641c-3add-4892-af2f-46f72ff1722e)|![global_search_without_deeplink](https://github.com/user-attachments/assets/8ad92f27-13a2-4b85-8958-588e597f94d9)|\r\n\r\n###
Services rename to Service Inventory\r\nAnother needed change was to
rename the nav item Services to Service\r\nInventory\r\n\r\n>[!NOTE]
\r\nScreenshots were taken before the navigation sorting was agreed
with\r\nproduct, so the \"Inventory\" item does not appear in the right
position.\r\n\r\n|Navigation|Screenshot|\r\n|-|-|\r\n|Stateful
classic\r\n(O11y)|![services_stateful_classic](https://github.com/user-attachments/assets/25ed1294-40fe-47be-9319-fe294acce8f8)|\r\n|Stateful
new\r\nO11y|![services_stateful_new](https://github.com/user-attachments/assets/4ae9495c-56bc-4327-b2f6-b6ac9f68bd21)|\r\n\r\n|Serverless|![services_serverless](https://github.com/user-attachments/assets/81ff51f4-3b0e-41fd-b7c6-79e8aa44e575)|\r\n\r\n>[!NOTE]
\r\nThe rename of infra Inventory to Infrastructure Inventory is
being\r\ntracked separately in
https://github.com/elastic/kibana/issues/192324.\r\n\r\n\r\n### Tech
preview badge in page\r\nLastly, the \"Technical Preview\" badge has
been added to the page title.\r\n\r\n>[!NOTE] \r\nThe screenshot was
taken before the navigation sorting was agreed with\r\nproduct, so the
\"Inventory\" item does not appear in the right
position.\r\n\r\n\r\n\r\n![inventory_title_badge](https://github.com/user-attachments/assets/172c5b8e-258e-4127-b792-40910e9dede0)\r\n\r\n\r\n###
Plugin registration in server\r\nTo make the Inventory available in the
spaces and privileges\r\nconfiguration the plugin has been registered in
the features service.\r\n\r\n>[!WARNING]\r\nI lack detailed context in
this area, so I’ve added default empty\r\nconfigurations for most
attributes. If any adjustments or improvements\r\nare needed, please let
me know.\r\n\r\n|Space config|Privileges|\r\n|-|-|\r\n|![Screenshot
2024-09-23 at 10
57\r\n35](https://github.com/user-attachments/assets/1c3a45b6-fd67-4706-8fc4-ee42a9206787)|![Screenshot\r\n2024-09-23
at 10
57\r\n14](https://github.com/user-attachments/assets/a852c15d-133c-459d-be77-2d73e662ffdb)|\r\n\r\n---------\r\n\r\nCo-authored-by:
Kate Patticha <[email protected]>\r\nCo-authored-by:
kibanamachine
<[email protected]>","sha":"26f5e1482b23548d1b06bec9e5fedf7dfa93a620"}},"sourceBranch":"main","suggestedTargetBranches":["8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/193533","number":193533,"mergeCommit":{"message":"[Inventory]
Use observability:entitycentricexperience to enable + side nav
adjustments (#193533)\n\n## Summary\r\n\r\nCloses
#192323
and\r\nhttps://github.com//issues/193393.\r\n\r\n###
Plugin enablement\r\nThe enablement of the new Inventory plugin was
previously managed via\r\nthe `xpack.inventory.enabled` setting in
kibana.yml. With this PR, we\r\ntransition to enabling it through
the\r\n`observability:entitycentricexperience` advanced
setting.\r\n\r\n\r\n### Position in side nav\r\nAdditionally, this PR
includes adjustments to the placement of the new\r\nInventory page
within the side navigation and the addition of the \"Tech\r\nPreview\"
badge in the navigation where it was
supported.\r\n\r\n|Navigation|Screenshot|\r\n|-|-|\r\n|Stateful classic
(first nav)|![Screenshot 2024-09-25 at 11
25\r\n46](https://github.com/user-attachments/assets/54e92632-9931-4f5b-8648-8a32afcd0caf)|\r\n|Stateful
classic (O11y)|![Screenshot 2024-09-25 at 11
25\r\n56](https://github.com/user-attachments/assets/ae644eb2-2559-4be0-8659-ef709399a871)|\r\n|Stateful
new O11y|![Screenshot 2024-09-25 at 11
27\r\n52](https://github.com/user-attachments/assets/c404232c-2630-4220-9bb8-315b0f0fc55f)|\r\n|Serverless|![Screenshot
2024-09-25 at 11
23\r\n07](https://github.com/user-attachments/assets/7f7e6c79-7f0f-4f7d-8fed-260d73ad4d3f)|\r\n\r\n\r\n###
Global search\r\nA modification was made to the global search to prevent
a duplicate\r\nresult from appearing during searches by removing the
deeplinks when\r\nregistering the plugin. The UI changes are shown
below.\r\n\r\n>[!WARNING]\r\nIf this modification causes any other
issues, please let me know in a\r\ncomment.\r\n\r\n|With deeplink
(before)|Without deeplink
(after)|\r\n|-|-|\r\n\r\n|![global_search_with_deeplink](https://github.com/user-attachments/assets/3ef5641c-3add-4892-af2f-46f72ff1722e)|![global_search_without_deeplink](https://github.com/user-attachments/assets/8ad92f27-13a2-4b85-8958-588e597f94d9)|\r\n\r\n###
Services rename to Service Inventory\r\nAnother needed change was to
rename the nav item Services to Service\r\nInventory\r\n\r\n>[!NOTE]
\r\nScreenshots were taken before the navigation sorting was agreed
with\r\nproduct, so the \"Inventory\" item does not appear in the right
position.\r\n\r\n|Navigation|Screenshot|\r\n|-|-|\r\n|Stateful
classic\r\n(O11y)|![services_stateful_classic](https://github.com/user-attachments/assets/25ed1294-40fe-47be-9319-fe294acce8f8)|\r\n|Stateful
new\r\nO11y|![services_stateful_new](https://github.com/user-attachments/assets/4ae9495c-56bc-4327-b2f6-b6ac9f68bd21)|\r\n\r\n|Serverless|![services_serverless](https://github.com/user-attachments/assets/81ff51f4-3b0e-41fd-b7c6-79e8aa44e575)|\r\n\r\n>[!NOTE]
\r\nThe rename of infra Inventory to Infrastructure Inventory is
being\r\ntracked separately in
https://github.com/elastic/kibana/issues/192324.\r\n\r\n\r\n### Tech
preview badge in page\r\nLastly, the \"Technical Preview\" badge has
been added to the page title.\r\n\r\n>[!NOTE] \r\nThe screenshot was
taken before the navigation sorting was agreed with\r\nproduct, so the
\"Inventory\" item does not appear in the right
position.\r\n\r\n\r\n\r\n![inventory_title_badge](https://github.com/user-attachments/assets/172c5b8e-258e-4127-b792-40910e9dede0)\r\n\r\n\r\n###
Plugin registration in server\r\nTo make the Inventory available in the
spaces and privileges\r\nconfiguration the plugin has been registered in
the features service.\r\n\r\n>[!WARNING]\r\nI lack detailed context in
this area, so I’ve added default empty\r\nconfigurations for most
attributes. If any adjustments or improvements\r\nare needed, please let
me know.\r\n\r\n|Space config|Privileges|\r\n|-|-|\r\n|![Screenshot
2024-09-23 at 10
57\r\n35](https://github.com/user-attachments/assets/1c3a45b6-fd67-4706-8fc4-ee42a9206787)|![Screenshot\r\n2024-09-23
at 10
57\r\n14](https://github.com/user-attachments/assets/a852c15d-133c-459d-be77-2d73e662ffdb)|\r\n\r\n---------\r\n\r\nCo-authored-by:
Kate Patticha <[email protected]>\r\nCo-authored-by:
kibanamachine
<[email protected]>","sha":"26f5e1482b23548d1b06bec9e5fedf7dfa93a620"}},{"branch":"8.x","label":"v8.16.0","branchLabelMappingKey":"^v8.16.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Irene Blanco <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature:EntitiesInventory Observability entities inventory feature Team:obs-ux-infra_services Observability Infrastructure & Services User Experience Team technical debt Improvement of the software architecture and operational architecture
Projects
None yet
4 participants