-
Notifications
You must be signed in to change notification settings - Fork 8.3k
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
Sharing saved objects, phase 2 #80945
Merged
jportner
merged 41 commits into
elastic:master
from
jportner:issue-54837-ssobjects-phase-2
Jan 20, 2021
Merged
Changes from 40 commits
Commits
Show all changes
41 commits
Select commit
Hold shift + click to select a range
d47d578
Small refactor, tweak unit tests
jportner 1b0165b
Add serializer unit tests
jportner e27e6be
Tweak migration loop
jportner 02db847
Do not allow migrations higher than the current Kibana version
jportner c7b6d15
Add "conversion" transforms for object types
jportner 394188b
Add "reference" transforms for object types
jportner 7d3e99d
Add LegacyUrlAlias and SavedObjectsClient.resolve()
jportner 5db1d2c
Create LegacyUrlAlias objects during "conversion" transforms
jportner 0b5ab24
Add integration tests
jportner dd9ecd6
Update docs
jportner 6404b5c
Merge branch 'master' into pr/jportner/80945
jportner 04812c7
Merge branch 'master' into pr/jportner/80945
jportner 42cc694
PR review feedback
jportner 8fbcca7
More PR review feedback
jportner 357ecbe
Merge branch 'master' into pr/jportner/80945
jportner 5a52f54
Merge branch 'master' into issue-54837-ssobjects-phase-2
kibanamachine 3ca6b23
Merge branch 'master' into pr/jportner/80945
jportner 66b850d
Fix 500 error
jportner 729d71c
Merge branch 'master' into issue-54837-ssobjects-phase-2
kibanamachine 6891bcf
Merge branch 'master' into pr/jportner/80945
jportner 5589d31
Fix merge problems
jportner e465648
Merge branch 'master' into pr/jportner/80945
jportner f7b8d40
Add usage data collection for saved objects `resolve` API
jportner abd7d2b
Rename things based on review feedback
jportner 4937925
Merge branch 'master' into pr/jportner/80945
jportner 3b15046
Merge branch 'master' into pr/jportner/80945
jportner 56b38be
Merge branch 'master' into pr/jportner/80945
jportner 0b45201
More PR review feedback
jportner 4a7e0d9
Merge branch 'master' into pr/jportner/80945
jportner c65048a
Merge branch 'master' into pr/jportner/80945
jportner ca96af1
Merge branch 'master' into pr/jportner/80945
jportner b88b376
Small refactor of document migrator
jportner c486690
Update validation in the document migrator
jportner 24a90b3
Expose `coreMigrationVersion` saved object field to consumers
jportner bc3b7e0
Merge branch 'master' into pr/jportner/80945
jportner 7796bc1
Add minimum version for saved object namespace type conversion
jportner 9ebec6c
Merge branch 'master' into pr/jportner/80945
jportner 873e1a6
Merge branch 'master' into pr/jportner/80945
jportner 717efcf
Update license headers
jportner 9f88c39
Merge branch 'master' into pr/jportner/80945
jportner 0b934ca
Merge branch 'master' into pr/jportner/80945
jportner File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,130 @@ | ||
| [[saved-objects-api-resolve]] | ||
| === Resolve object API | ||
| ++++ | ||
| <titleabbrev>Resolve object</titleabbrev> | ||
| ++++ | ||
|
|
||
| experimental[] Retrieve a single {kib} saved object by ID, using any legacy URL alias if it exists. | ||
|
|
||
| Under certain circumstances, when Kibana is upgraded, saved object migrations may necessitate regenerating some object IDs to enable new | ||
| features. When an object's ID is regenerated, a legacy URL alias is created for that object, preserving its old ID. In such a scenario, that | ||
| object can be retrieved via the Resolve API using either its new ID or its old ID. | ||
|
|
||
| [[saved-objects-api-resolve-request]] | ||
| ==== Request | ||
|
|
||
| `GET <kibana host>:<port>/api/saved_objects/resolve/<type>/<id>` | ||
|
|
||
| `GET <kibana host>:<port>/s/<space_id>/api/saved_objects/resolve/<type>/<id>` | ||
|
|
||
| [[saved-objects-api-resolve-params]] | ||
| ==== Path parameters | ||
|
|
||
| `space_id`:: | ||
| (Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used. | ||
|
|
||
|
|
||
| `type`:: | ||
| (Required, string) Valid options include `visualization`, `dashboard`, `search`, `index-pattern`, `config`, and `timelion-sheet`. | ||
|
|
||
| `id`:: | ||
| (Required, string) The ID of the object to retrieve. | ||
|
|
||
| [[saved-objects-api-resolve-codes]] | ||
| ==== Response code | ||
|
|
||
| `200`:: | ||
| Indicates a successful call. | ||
|
|
||
| [[saved-objects-api-resolve-example]] | ||
| ==== Example | ||
|
|
||
| Retrieve the index pattern object with the `my-pattern` ID: | ||
|
|
||
| [source,sh] | ||
| -------------------------------------------------- | ||
| $ curl -X GET api/saved_objects/resolve/index-pattern/my-pattern | ||
| -------------------------------------------------- | ||
| // KIBANA | ||
|
|
||
| The API returns the following: | ||
|
|
||
| [source,sh] | ||
| -------------------------------------------------- | ||
| { | ||
| "saved_object": { | ||
| "id": "my-pattern", | ||
| "type": "index-pattern", | ||
| "version": 1, | ||
| "attributes": { | ||
| "title": "my-pattern-*" | ||
| } | ||
| }, | ||
| "outcome": "exactMatch" | ||
| } | ||
| -------------------------------------------------- | ||
|
|
||
| The `outcome` field may be any of the following: | ||
|
|
||
| * `"exactMatch"` -- One document exactly matched the given ID. | ||
| * `"aliasMatch"` -- One document with a legacy URL alias matched the given ID; in this case the `saved_object.id` field is different than the given ID. | ||
| * `"conflict"` -- Two documents matched the given ID, one was an exact match and another with a legacy URL alias; in this case the `saved_object` object is the exact match, and the `saved_object.id` field is the same as the given ID. | ||
|
|
||
| Retrieve a dashboard object in the `testspace` by ID: | ||
jportner marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| [source,sh] | ||
| -------------------------------------------------- | ||
| $ curl -X GET s/testspace/api/saved_objects/resolve/dashboard/7adfa750-4c81-11e8-b3d7-01146121b73d | ||
| -------------------------------------------------- | ||
| // KIBANA | ||
|
|
||
| The API returns the following: | ||
|
|
||
| [source,sh] | ||
| -------------------------------------------------- | ||
| { | ||
| "saved_object": { | ||
| "id": "7adfa750-4c81-11e8-b3d7-01146121b73d", | ||
| "type": "dashboard", | ||
| "updated_at": "2019-07-23T00:11:07.059Z", | ||
| "version": "WzQ0LDFd", | ||
| "attributes": { | ||
| "title": "[Flights] Global Flight Dashboard", | ||
| "hits": 0, | ||
| "description": "Analyze mock flight data for ES-Air, Logstash Airways, Kibana Airlines and JetBeats", | ||
| "panelsJSON": "[ . . . ]", | ||
| "optionsJSON": "{\"hidePanelTitles\":false,\"useMargins\":true}", | ||
| "version": 1, | ||
| "timeRestore": true, | ||
| "timeTo": "now", | ||
| "timeFrom": "now-24h", | ||
| "refreshInterval": { | ||
| "display": "15 minutes", | ||
| "pause": false, | ||
| "section": 2, | ||
| "value": 900000 | ||
| }, | ||
| "kibanaSavedObjectMeta": { | ||
| "searchSourceJSON": "{\"query\":{\"language\":\"kuery\",\"query\":\"\"},\"filter\":[],\"highlightAll\":true,\"version\":true}" | ||
| } | ||
| }, | ||
| "references": [ | ||
| { | ||
| "name": "panel_0", | ||
| "type": "visualization", | ||
| "id": "aeb212e0-4c84-11e8-b3d7-01146121b73d" | ||
| }, | ||
| . . . | ||
| { | ||
| "name": "panel_18", | ||
| "type": "visualization", | ||
| "id": "ed78a660-53a0-11e8-acbd-0be0ad9d822b" | ||
| } | ||
| ], | ||
| "migrationVersion": { | ||
| "dashboard": "7.0.0" | ||
| } | ||
| }, | ||
| "outcome": "conflict" | ||
| } | ||
| -------------------------------------------------- | ||
13 changes: 13 additions & 0 deletions
13
...pment/core/public/kibana-plugin-core-public.savedobject.coremigrationversion.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| <!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
|
||
| [Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObject](./kibana-plugin-core-public.savedobject.md) > [coreMigrationVersion](./kibana-plugin-core-public.savedobject.coremigrationversion.md) | ||
|
|
||
| ## SavedObject.coreMigrationVersion property | ||
|
|
||
| A semver value that is used when upgrading objects between Kibana versions. | ||
|
|
||
| <b>Signature:</b> | ||
|
|
||
| ```typescript | ||
| coreMigrationVersion?: string; | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
13 changes: 13 additions & 0 deletions
13
...lic/kibana-plugin-core-public.savedobjectscreateoptions.coremigrationversion.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| <!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
|
||
| [Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsCreateOptions](./kibana-plugin-core-public.savedobjectscreateoptions.md) > [coreMigrationVersion](./kibana-plugin-core-public.savedobjectscreateoptions.coremigrationversion.md) | ||
|
|
||
| ## SavedObjectsCreateOptions.coreMigrationVersion property | ||
|
|
||
| A semver value that is used when upgrading objects between Kibana versions. | ||
|
|
||
| <b>Signature:</b> | ||
|
|
||
| ```typescript | ||
| coreMigrationVersion?: string; | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
11 changes: 11 additions & 0 deletions
11
...core/public/kibana-plugin-core-public.simplesavedobject.coremigrationversion.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| <!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
|
||
| [Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SimpleSavedObject](./kibana-plugin-core-public.simplesavedobject.md) > [coreMigrationVersion](./kibana-plugin-core-public.simplesavedobject.coremigrationversion.md) | ||
|
|
||
| ## SimpleSavedObject.coreMigrationVersion property | ||
|
|
||
| <b>Signature:</b> | ||
|
|
||
| ```typescript | ||
| coreMigrationVersion: SavedObjectType<T>['coreMigrationVersion']; | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We mention here (and elsewhere) about legacy URLs, but we don't ever explain what they are or why they're important. We can leave this as a followup item if you'd like.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added this blurb to the top of the resolve API docs page:
I figure that's a good starting point.