[Deprecations] Logs Sources settings in all spaces by afharo · Pull Request #203042 · elastic/kibana

afharo · 2024-12-05T00:54:08Z

Summary

Resolves #202649.

Logs Sources deprecations now check all spaces for the deprecated configuration:
From the any space (including those not having any deprecations):

How to test the deprecation

Open the "Logs settings" and select Indices/Data view deprecated options:

The automated mitigation API PUT /api/logs_shared/deprecations/migrate_log_view_settings is also fixed to loop through all the spaces to resolve the issue.

In order to achieve this piece of work, I had to extend the current Saved Objects client to expose 1 new method:

asScopedToNamespace: Returns a new client scoped to the specified Space ID.

Checklist

Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios

Identify risks

As highlighted by the @legrego, the new API lists all available Spaces, but it doesn't limit it by access to features inside that Space (i.e.: it doesn't list all Spaces the user has access to the o11y features only). This may lead to noise in the audit logs if abused.
- Potential mitigation is to document the API to be used with caution. As it's mostly intended for deprecations and migrations.

elasticmachine · 2024-12-05T16:01:00Z

Pinging @elastic/kibana-core (Team:Core)

elasticmachine · 2024-12-05T16:01:02Z

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

elasticmachine · 2024-12-05T16:01:04Z

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

github-actions · 2024-12-05T16:06:45Z

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

/oblt-deploy : Deploy a Kibana instance using the Observability test environments.
run docs-build : Re-trigger the docs validation. (use unformatted text in the comment!)

TinaHeiligers · 2024-12-05T23:20:34Z

packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts

+
+  /**
+   * Given a list of namespace strings, returns a subset that the user is authorized to search in.
+   * If a wildcard '*' is used, it is expanded to an explicit list of namespace strings.


We need to make it super clear that the explicit list of namespace strings only includes the namespaces the current user has access to othewise consumers might incorrectly interpret that as a list of all namespaces.

Suggested change

* If a wildcard '*' is used, it is expanded to an explicit list of namespace strings.

* If a wildcard '*' is used, it is expanded to an explicit list of namespace strings the current user has access to.

And it's worth noting that this will include any namespace the user has ANY access to.

TinaHeiligers

Looks ok at a glance. The new APIs need tests, especially given that they're public and carry risks. It'd be helpful to point out the risks associated with using these APIs.
Initial code review only. I'll re-review once concerns are addressed.

TinaHeiligers · 2024-12-05T23:25:28Z

packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts

+  getSearchableNamespaces: (namespaces: string[] | undefined) => Promise<string[]>;
+
+  /**
+   * Returns a new Saved Objects client scoped to the new namespace.


Suggested change

* Returns a new Saved Objects client scoped to the new namespace.

* Returns a new Saved Objects client scoped to the current user and current namespace.

We're not creating a namespace, only a client that is scoped to one

packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts

TinaHeiligers · 2024-12-05T23:56:14Z

packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts

+  getSearchableNamespaces: (namespaces: string[] | undefined) => Promise<string[]>;
+
+  /**
+   * Returns a new Saved Objects repository scoped to the new namespace.


Suggested change

* Returns a new Saved Objects repository scoped to the new namespace.

* Returns a new Saved Objects repository scoped to a specific namespace.

TinaHeiligers · 2024-12-05T23:58:28Z

packages/core/saved-objects/core-saved-objects-server/src/extensions/spaces.ts

   */
  getSearchableNamespaces: (namespaces: string[] | undefined) => Promise<string[]>;
+  /**
+   * Returns a new Saved Objects Spaces Extension scoped to the new namespace.


Suggested change

* Returns a new Saved Objects Spaces Extension scoped to the new namespace.

* Returns a new Saved Objects Spaces Extension scoped to a specific namespace.

TinaHeiligers · 2024-12-06T00:41:17Z

x-pack/plugins/observability_solution/logs_shared/server/deprecations/log_sources_setting.ts

+export const getLogSourcesSettingDeprecationInfo = async (
+  params: LogSourcesSettingDeprecationParams
+): Promise<DeprecationsDetails[]> => {
+  const allAvailableSpaces = await params.context.savedObjectsClient.getSearchableNamespaces(['*']);


Requires end users to actively enable Log sources in each space.
We need that documented.

Sorry, I don't fully understand this comment. We're reading a SO, and it's perfectly fine if the SO doesn't exist. Why would we need Log sources to be enabled in each space for this logic to work?

Dosant

x-pack/plugins/reporting/server/deprecations/migrate_existing_indices_ilm_policy.test.ts lgtm

elasticmachine · 2024-12-16T11:19:14Z

💚 Build Succeeded

Buildkite Build
Commit: 339a047
Kibana Serverless Image: docker.elastic.co/kibana-ci/kibana-serverless:pr-203042-339a047ee815

Metrics [docs]

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
`@kbn/core-deprecations-server`	13	14	+1
`@kbn/core-deprecations-server-internal`	3	4	+1
total			+2

Unknown metric groups

API count

id	before	after	diff
`@kbn/core-deprecations-server`	16	17	+1
`@kbn/core-deprecations-server-internal`	4	5	+1
`@kbn/core-saved-objects-api-server`	357	361	+4
`@kbn/core-saved-objects-server`	564	566	+2
total			+8

History

💚 Build #259626 succeeded 7776e31
💔 Build #259604 failed b0ad7c1
💔 Build #259580 failed 11716b9
💔 Build #259564 failed 024bb68
💔 Build #259559 failed d759cbd

cc @afharo

## Summary #203042 highlighted these APIs not having comments. ### Checklist - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials

## Summary elastic#203042 highlighted these APIs not having comments. ### Checklist - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials (cherry picked from commit 25b171d)

Kerry350

Thank you for improving this 👌

kibanamachine · 2024-12-16T12:41:16Z

Starting backport for target branches: 8.x

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

kibanamachine · 2024-12-16T12:46:21Z

💔 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: - [Inference Connector] Changed UI/UX due to the new RFC for the _inference/_service (#203363)

Manual backport

To create the backport manually run:

node scripts/backport --pr 203042

Questions ?

Please refer to the Backport tool documentation

(cherry picked from commit 2ed3442) # Conflicts: # x-pack/platform/plugins/private/translations/translations/zh-CN.json

afharo · 2024-12-16T19:42:46Z

💚 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

…204476) # Backport This will backport the following commits from `main` to `8.x`: - [[Deprecations] Logs Sources settings in all spaces (#203042)](#203042)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)

## Summary elastic#203042 highlighted these APIs not having comments. ### Checklist - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials

[Deprecations] Logs Sources settings in all spaces

0f800e6

afharo self-assigned this Dec 5, 2024

afharo added 4 commits December 5, 2024 01:59

Add TSDocs

4721ac5

Fix i18n labels

08c00be

Fix types (mocks)

61489d8

Fix types (mocks)

08bf159

afharo marked this pull request as ready for review December 5, 2024 16:00

afharo requested review from a team as code owners December 5, 2024 16:00

afharo added 5 commits December 5, 2024 17:06

[Deprecations] Logs Sources settings in all spaces

79969b2

Add TSDocs

8e2dde0

Fix i18n labels

2ca3ce9

Fix types (mocks)

cac8be0

Fix types (mocks)

acf77fd

afharo force-pushed the deprecations/log-sources-check-in-all-spaces branch from 08bf159 to acf77fd Compare December 5, 2024 16:06

botelastic bot added the ci:project-deploy-observability Create an Observability project label Dec 5, 2024

TinaHeiligers reviewed Dec 5, 2024

View reviewed changes

TinaHeiligers reviewed Dec 6, 2024

View reviewed changes

jeramysoucy self-requested a review December 9, 2024 13:16

kibanamachine and others added 5 commits December 11, 2024 17:56

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

212ea7d

Fix types

d759cbd

Fix mock

024bb68

Fix mock

11716b9

Fix another mock

b0ad7c1

afharo requested a review from a team as a code owner December 12, 2024 07:33

Merge branch 'main' into deprecations/log-sources-check-in-all-spaces

7776e31

afharo mentioned this pull request Dec 13, 2024

[Deprecations/Docs] Address uncommented apis #204198

Merged

1 task

Dosant approved these changes Dec 13, 2024

View reviewed changes

Kerry350 self-requested a review December 13, 2024 16:16

Merge branch 'main' into deprecations/log-sources-check-in-all-spaces

339a047

Kerry350 approved these changes Dec 16, 2024

View reviewed changes

afharo merged commit 2ed3442 into elastic:main Dec 16, 2024

afharo deleted the deprecations/log-sources-check-in-all-spaces branch December 16, 2024 12:40

kibanamachine added the v9.0.0 label Dec 16, 2024

jeramysoucy mentioned this pull request Dec 16, 2024

Support getting all user-accessible spaces by permission #204475

Open

afharo mentioned this pull request Dec 16, 2024

[8.x] [Deprecations] Logs Sources settings in all spaces (#203042) #204476

Merged

afharo added a commit to afharo/kibana that referenced this pull request Dec 16, 2024

[Deprecations] Logs Sources settings in all spaces (elastic#203042)

5c18753

(cherry picked from commit 2ed3442) # Conflicts: # x-pack/platform/plugins/private/translations/translations/zh-CN.json

kibanamachine added the v8.18.0 label Dec 16, 2024

JoseLuisGJ pushed a commit to JoseLuisGJ/kibana that referenced this pull request Dec 19, 2024

[Deprecations] Logs Sources settings in all spaces (elastic#203042)

2b5cdc2

	* If a wildcard '*' is used, it is expanded to an explicit list of namespace strings.
	* If a wildcard '*' is used, it is expanded to an explicit list of namespace strings the current user has access to.

	* Returns a new Saved Objects client scoped to the new namespace.
	* Returns a new Saved Objects client scoped to the current user and current namespace.

	* Returns a new Saved Objects repository scoped to the new namespace.
	* Returns a new Saved Objects repository scoped to a specific namespace.

	* Returns a new Saved Objects Spaces Extension scoped to the new namespace.
	* Returns a new Saved Objects Spaces Extension scoped to a specific namespace.

Conversation

afharo commented Dec 5, 2024 • edited by kibanamachine Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

How to test the deprecation

Checklist

Identify risks

Uh oh!

elasticmachine commented Dec 5, 2024

Uh oh!

elasticmachine commented Dec 5, 2024

Uh oh!

elasticmachine commented Dec 5, 2024

Uh oh!

github-actions bot commented Dec 5, 2024

🤖 GitHub comments

Uh oh!

TinaHeiligers Dec 5, 2024

Choose a reason for hiding this comment

Uh oh!

jeramysoucy Dec 9, 2024

Choose a reason for hiding this comment

Uh oh!

TinaHeiligers left a comment

Choose a reason for hiding this comment

Uh oh!

TinaHeiligers Dec 5, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

TinaHeiligers Dec 5, 2024

Choose a reason for hiding this comment

Uh oh!

TinaHeiligers Dec 5, 2024

Choose a reason for hiding this comment

Uh oh!

TinaHeiligers Dec 6, 2024

Choose a reason for hiding this comment

Uh oh!

afharo Dec 11, 2024

Choose a reason for hiding this comment

Uh oh!

Dosant left a comment

Choose a reason for hiding this comment

Uh oh!

elasticmachine commented Dec 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

💚 Build Succeeded

Metrics [docs]

Public APIs missing comments

API count

History

Uh oh!

Kerry350 left a comment

Choose a reason for hiding this comment

Uh oh!

kibanamachine commented Dec 16, 2024

Uh oh!

kibanamachine commented Dec 16, 2024

💔 All backports failed

Manual backport

Questions ?

Uh oh!

afharo commented Dec 16, 2024

💚 All backports created successfully

Questions ?

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

afharo commented Dec 5, 2024 •

edited by kibanamachine

Loading

elasticmachine commented Dec 16, 2024 •

edited

Loading