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

[Docs] Add dev docs for saved object IDs #127205

Closed
jportner opened this issue Mar 8, 2022 · 1 comment
Closed

[Docs] Add dev docs for saved object IDs #127205

jportner opened this issue Mar 8, 2022 · 1 comment
Labels
docs Team:Security Team focused on: Auth, Users, Roles, Spaces, Audit Logging, and more!

Comments

@jportner
Copy link
Contributor

jportner commented Mar 8, 2022

Many consumers of saved objects rely on the object IDs, either directly or indirectly.

With the introduction of sharing saved objects, many saved object types have been converted to become "share-capable" in the 8.0 release, causing some object IDs to change to enforce globally unique IDs for this object type (#100489).

However, object IDs can change on upgrade to 8.0 and/or when importing/copying saved objects. Changing IDs on upgrade is documented here, but changing IDs on import/copy isn't.

Further, upgrading a single old object by importing it into a newer version of Kibana (triggering a "document migration") doesn't behave exactly the same way as upgrading all old objects by installing a new version of Kibana (triggering an "index migration") -- more details here.

We should put some additional dev docs on consuming saved objects, what to expect when it comes to share-capable object IDs, and best practices for testing migrations/imports.

@jportner jportner added Team:Security Team focused on: Auth, Users, Roles, Spaces, Audit Logging, and more! docs labels Mar 8, 2022
@elasticmachine
Copy link
Contributor

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

@legrego legrego closed this as not planned Won't fix, can't repro, duplicate, stale Jan 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Team:Security Team focused on: Auth, Users, Roles, Spaces, Audit Logging, and more!
Projects
None yet
Development

No branches or pull requests

3 participants