-
Notifications
You must be signed in to change notification settings - Fork 8.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into remove-defaultAppId
- Loading branch information
Showing
337 changed files
with
8,144 additions
and
3,719 deletions.
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
59 changes: 59 additions & 0 deletions
59
docs/api/spaces-management/disable_legacy_url_aliases.asciidoc
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,59 @@ | ||
| [[spaces-api-disable-legacy-url-aliases]] | ||
| === Disable legacy URL aliases API | ||
| ++++ | ||
| <titleabbrev>Disable legacy URL aliases</titleabbrev> | ||
| ++++ | ||
|
|
||
| experimental[] Disable a <<legacy-url-aliases,legacy URL alias>> in {kib}. | ||
|
|
||
| [[spaces-api-disable-legacy-url-aliases-request]] | ||
| ==== {api-request-title} | ||
|
|
||
| `POST <kibana host>:<port>/api/spaces/_disable_legacy_url_aliases` | ||
|
|
||
| [role="child_attributes"] | ||
| [[spaces-api-disable-legacy-url-aliases-request-body]] | ||
| ==== {api-request-body-title} | ||
|
|
||
| `aliases`:: | ||
| (Required, object array) The aliases to disable. | ||
| + | ||
| .Properties of `aliases` | ||
| [%collapsible%open] | ||
| ===== | ||
| `targetSpace`::: | ||
| (Required, string) The space where the alias target object exists. | ||
| `targetType`::: | ||
| (Required, string) The type of the alias target object. | ||
| `sourceId`::: | ||
| (Required, string) The ID of the alias source object. This is the "legacy" object ID. | ||
| ===== | ||
|
|
||
| [[spaces-api-disable-legacy-url-aliases-response-codes]] | ||
| ==== {api-response-codes-title} | ||
|
|
||
| `204`:: | ||
| Indicates a successful call. | ||
|
|
||
| [[spaces-api-disable-legacy-url-aliases-example]] | ||
| ==== {api-examples-title} | ||
|
|
||
| [source,sh] | ||
| -------------------------------------------------- | ||
| $ curl -X POST api/spaces/_disable_legacy_url_aliases | ||
| { | ||
| "aliases": [ | ||
| { | ||
| "targetSpace": "bills-space", | ||
| "targetType": "dashboard", | ||
| "sourceId": "123" | ||
| } | ||
| ] | ||
| } | ||
| -------------------------------------------------- | ||
| // KIBANA | ||
|
|
||
| This example leaves the alias intact, but the legacy URL for this alias, http://localhost:5601/s/bills-space/app/dashboards#/view/123, will | ||
| no longer function. The dashboard still exists, and you can access it with the new URL. |
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,45 @@ | ||
| [[legacy-url-aliases]] | ||
| == Legacy URL Aliases | ||
|
|
||
| This page describes legacy URL aliases: what they are, where they come from, and how to disable them. | ||
|
|
||
| [[legacy-url-aliases-overview]] | ||
| === Overview | ||
|
|
||
| Many saved object types were converted in {kib} 8.0, so they can eventually be shared across <<xpack-spaces,spaces>>. Before 8.0, you could | ||
| have two objects with the same type and same ID in two different spaces. Part of this conversion is to make sure all object IDs of a given | ||
| type are *globally unique across all spaces*. | ||
|
|
||
| {kib} creates a special entity called a **legacy URL alias** for each saved object that requires a new ID. This legacy URL alias allows | ||
| {kib} to preserve any deep link URLs that exist for these objects. | ||
|
|
||
| [[legacy-url-aliases-example]] | ||
| === Example | ||
|
|
||
| Consider the following scenario: | ||
|
|
||
| You have {kib} 7.16, and you create a new dashboard.The ID of this dashboard is "123". You create a new space called "Bill's space" and | ||
| <<managing-saved-objects-copy-to-space,copy>> your dashboard to the other space. Now you have two different dashboards that can be accessed | ||
| at the following URLs: | ||
|
|
||
| * *Default space*: `http://localhost:5601/app/dashboards#/view/123` | ||
| * *Bill's space*: `http://localhost:5601/s/bills-space/app/dashboards#/view/123` | ||
|
|
||
| You use these two dashboards frequently, so you bookmark them in your web browser. After some time, you decide to upgrade to {kib} 8.0. When | ||
| these two dashboards go through the conversion process, the one in "Bill's space" will have its ID changed to "456". The URL to access that | ||
| dashboard is different -- not to worry though, there is a legacy URL alias for that dashboard. | ||
|
|
||
| If you use your bookmark to access that dashboard using its old URL, {kib} detects that you are using a legacy URL, and finds the new object | ||
| ID. If you navigate to `http://localhost:5601/s/bills-space/app/dashboards#/view/123`, you'll see a message indicating that the dashboard | ||
| has a new URL, and you're automatically redirected to `http://localhost:5601/s/bills-space/app/dashboards#/view/456`. | ||
|
|
||
| [[legacy-url-aliases-handling-errors]] | ||
| === Handling errors | ||
|
|
||
| Legacy URL aliases are intended to be fully transparent, but there are rare situations where this can lead to an error. For example, you | ||
| might have a dashboard and one of the visualizations fails to load, directing you to this page. If you encounter an error in this situation, | ||
| you might want to disable the legacy URL alias completely. This leaves the saved object intact, and you will not lose any data -- you just | ||
| won't be able to use the old URL to access that saved object. | ||
|
|
||
| To disable a legacy URL alias, you need three pieces of information: the `targetSpace`, the `targetType`, and the `sourceId`. Then use the | ||
| <<spaces-api-disable-legacy-url-aliases,`_disable_legacy_url_aliases`>> API to disable the problematic legacy URL alias. |
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
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,9 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License | ||
| * 2.0 and the Server Side Public License, v 1; you may not use this file except | ||
| * in compliance with, at your election, the Elastic License 2.0 or the Server | ||
| * Side Public License, v 1. | ||
| */ | ||
|
|
||
| export * from './update_vscode_config_cli'; |
40 changes: 40 additions & 0 deletions
40
packages/kbn-dev-utils/src/vscode_config/managed_config_keys.ts
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,40 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License | ||
| * 2.0 and the Server Side Public License, v 1; you may not use this file except | ||
| * in compliance with, at your election, the Elastic License 2.0 or the Server | ||
| * Side Public License, v 1. | ||
| */ | ||
|
|
||
| export interface ManagedConfigKey { | ||
| key: string; | ||
| value: Record<string, any>; | ||
| } | ||
|
|
||
| /** | ||
| * Defines the keys which we overrite in user's vscode config for the workspace. We currently | ||
| * only support object values because that's all we needed to support, but support for non object | ||
| * values should be easy to add. | ||
| */ | ||
| export const MANAGED_CONFIG_KEYS: ManagedConfigKey[] = [ | ||
| { | ||
| key: 'files.watcherExclude', | ||
| value: { | ||
| ['**/.eslintcache']: true, | ||
| ['**/.es']: true, | ||
| ['**/.yarn-local-mirror']: true, | ||
| ['**/.chromium']: true, | ||
| ['**/packages/kbn-pm/dist/index.js']: true, | ||
| ['**/bazel-*']: true, | ||
| ['**/node_modules']: true, | ||
| ['**/target']: true, | ||
| ['**/*.log']: true, | ||
| }, | ||
| }, | ||
| { | ||
| key: 'search.exclude', | ||
| value: { | ||
| ['**/packages/kbn-pm/dist/index.js']: true, | ||
| }, | ||
| }, | ||
| ]; |
Oops, something went wrong.