) => void;
+```
diff --git a/docs/development/core/server/kibana-plugin-core-server.httpresourcesrenderoptions.headers.md b/docs/development/core/server/kibana-plugin-core-server.httpresourcesrenderoptions.headers.md
new file mode 100644
index 0000000000000..bb6dec504ff42
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-core-server.httpresourcesrenderoptions.headers.md
@@ -0,0 +1,18 @@
+
+
+[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpResourcesRenderOptions](./kibana-plugin-core-server.httpresourcesrenderoptions.md) > [headers](./kibana-plugin-core-server.httpresourcesrenderoptions.headers.md)
+
+## HttpResourcesRenderOptions.headers property
+
+HTTP Headers with additional information about response.
+
+Signature:
+
+```typescript
+headers?: ResponseHeaders;
+```
+
+## Remarks
+
+All HTML pages are already pre-configured with `content-security-policy` header that cannot be overridden.
+
diff --git a/docs/development/core/server/kibana-plugin-core-server.httpresourcesrenderoptions.md b/docs/development/core/server/kibana-plugin-core-server.httpresourcesrenderoptions.md
new file mode 100644
index 0000000000000..6563e3c636a99
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-core-server.httpresourcesrenderoptions.md
@@ -0,0 +1,20 @@
+
+
+[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpResourcesRenderOptions](./kibana-plugin-core-server.httpresourcesrenderoptions.md)
+
+## HttpResourcesRenderOptions interface
+
+Allows to configure HTTP response parameters
+
+Signature:
+
+```typescript
+export interface HttpResourcesRenderOptions
+```
+
+## Properties
+
+| Property | Type | Description |
+| --- | --- | --- |
+| [headers](./kibana-plugin-core-server.httpresourcesrenderoptions.headers.md) | ResponseHeaders | HTTP Headers with additional information about response. |
+
diff --git a/docs/development/core/server/kibana-plugin-core-server.httpresourcesrequesthandler.md b/docs/development/core/server/kibana-plugin-core-server.httpresourcesrequesthandler.md
new file mode 100644
index 0000000000000..20f930382955e
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-core-server.httpresourcesrequesthandler.md
@@ -0,0 +1,18 @@
+
+
+[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpResourcesRequestHandler](./kibana-plugin-core-server.httpresourcesrequesthandler.md)
+
+## HttpResourcesRequestHandler type
+
+Extended version of [RequestHandler](./kibana-plugin-core-server.requesthandler.md) having access to [HttpResourcesServiceToolkit](./kibana-plugin-core-server.httpresourcesservicetoolkit.md) to respond with HTML or JS resources.
+
+Signature:
+
+```typescript
+export declare type HttpResourcesRequestHandler = RequestHandler;
+```
+
+## Example
+
+\`\`\`typescript httpResources.register({ path: '/login', validate: { params: schema.object({ id: schema.string() }), }, }, async (context, request, response) => { //.. return response.renderCoreApp(); });
+
diff --git a/docs/development/core/server/kibana-plugin-core-server.httpresourcesresponseoptions.md b/docs/development/core/server/kibana-plugin-core-server.httpresourcesresponseoptions.md
new file mode 100644
index 0000000000000..2ea3ea7e58c78
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-core-server.httpresourcesresponseoptions.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpResourcesResponseOptions](./kibana-plugin-core-server.httpresourcesresponseoptions.md)
+
+## HttpResourcesResponseOptions type
+
+HTTP Resources response parameters
+
+Signature:
+
+```typescript
+export declare type HttpResourcesResponseOptions = HttpResponseOptions;
+```
diff --git a/docs/development/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.md b/docs/development/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.md
new file mode 100644
index 0000000000000..1c221e13f534f
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.md
@@ -0,0 +1,23 @@
+
+
+[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpResourcesServiceToolkit](./kibana-plugin-core-server.httpresourcesservicetoolkit.md)
+
+## HttpResourcesServiceToolkit interface
+
+Extended set of [KibanaResponseFactory](./kibana-plugin-core-server.kibanaresponsefactory.md) helpers used to respond with HTML or JS resource.
+
+Signature:
+
+```typescript
+export interface HttpResourcesServiceToolkit
+```
+
+## Properties
+
+| Property | Type | Description |
+| --- | --- | --- |
+| [renderAnonymousCoreApp](./kibana-plugin-core-server.httpresourcesservicetoolkit.renderanonymouscoreapp.md) | (options?: HttpResourcesRenderOptions) => Promise<IKibanaResponse> | To respond with HTML page bootstrapping Kibana application without retrieving user-specific information. |
+| [renderCoreApp](./kibana-plugin-core-server.httpresourcesservicetoolkit.rendercoreapp.md) | (options?: HttpResourcesRenderOptions) => Promise<IKibanaResponse> | To respond with HTML page bootstrapping Kibana application. |
+| [renderHtml](./kibana-plugin-core-server.httpresourcesservicetoolkit.renderhtml.md) | (options: HttpResourcesResponseOptions) => IKibanaResponse | To respond with a custom HTML page. |
+| [renderJs](./kibana-plugin-core-server.httpresourcesservicetoolkit.renderjs.md) | (options: HttpResourcesResponseOptions) => IKibanaResponse | To respond with a custom JS script file. |
+
diff --git a/docs/development/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.renderanonymouscoreapp.md b/docs/development/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.renderanonymouscoreapp.md
new file mode 100644
index 0000000000000..3dce9d88c8036
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.renderanonymouscoreapp.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpResourcesServiceToolkit](./kibana-plugin-core-server.httpresourcesservicetoolkit.md) > [renderAnonymousCoreApp](./kibana-plugin-core-server.httpresourcesservicetoolkit.renderanonymouscoreapp.md)
+
+## HttpResourcesServiceToolkit.renderAnonymousCoreApp property
+
+To respond with HTML page bootstrapping Kibana application without retrieving user-specific information.
+
+Signature:
+
+```typescript
+renderAnonymousCoreApp: (options?: HttpResourcesRenderOptions) => Promise;
+```
diff --git a/docs/development/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.rendercoreapp.md b/docs/development/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.rendercoreapp.md
new file mode 100644
index 0000000000000..eb4f095bc19be
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.rendercoreapp.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpResourcesServiceToolkit](./kibana-plugin-core-server.httpresourcesservicetoolkit.md) > [renderCoreApp](./kibana-plugin-core-server.httpresourcesservicetoolkit.rendercoreapp.md)
+
+## HttpResourcesServiceToolkit.renderCoreApp property
+
+To respond with HTML page bootstrapping Kibana application.
+
+Signature:
+
+```typescript
+renderCoreApp: (options?: HttpResourcesRenderOptions) => Promise;
+```
diff --git a/docs/development/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.renderhtml.md b/docs/development/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.renderhtml.md
new file mode 100644
index 0000000000000..325d19625df44
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.renderhtml.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpResourcesServiceToolkit](./kibana-plugin-core-server.httpresourcesservicetoolkit.md) > [renderHtml](./kibana-plugin-core-server.httpresourcesservicetoolkit.renderhtml.md)
+
+## HttpResourcesServiceToolkit.renderHtml property
+
+To respond with a custom HTML page.
+
+Signature:
+
+```typescript
+renderHtml: (options: HttpResourcesResponseOptions) => IKibanaResponse;
+```
diff --git a/docs/development/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.renderjs.md b/docs/development/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.renderjs.md
new file mode 100644
index 0000000000000..f8d4418fc6cba
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.renderjs.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpResourcesServiceToolkit](./kibana-plugin-core-server.httpresourcesservicetoolkit.md) > [renderJs](./kibana-plugin-core-server.httpresourcesservicetoolkit.renderjs.md)
+
+## HttpResourcesServiceToolkit.renderJs property
+
+To respond with a custom JS script file.
+
+Signature:
+
+```typescript
+renderJs: (options: HttpResourcesResponseOptions) => IKibanaResponse;
+```
diff --git a/docs/development/core/server/kibana-plugin-core-server.irouter.handlelegacyerrors.md b/docs/development/core/server/kibana-plugin-core-server.irouter.handlelegacyerrors.md
index 94cf3c94187b0..35d109975c83a 100644
--- a/docs/development/core/server/kibana-plugin-core-server.irouter.handlelegacyerrors.md
+++ b/docs/development/core/server/kibana-plugin-core-server.irouter.handlelegacyerrors.md
@@ -9,5 +9,5 @@ Wrap a router handler to catch and converts legacy boom errors to proper custom
Signature:
```typescript
-handleLegacyErrors: (handler: RequestHandler) => RequestHandler;
+handleLegacyErrors: RequestHandlerWrapper;
```
diff --git a/docs/development/core/server/kibana-plugin-core-server.irouter.md b/docs/development/core/server/kibana-plugin-core-server.irouter.md
index 073f02f1a4191..4bade638a65a5 100644
--- a/docs/development/core/server/kibana-plugin-core-server.irouter.md
+++ b/docs/development/core/server/kibana-plugin-core-server.irouter.md
@@ -18,7 +18,7 @@ export interface IRouter
| --- | --- | --- |
| [delete](./kibana-plugin-core-server.irouter.delete.md) | RouteRegistrar<'delete'> | Register a route handler for DELETE request. |
| [get](./kibana-plugin-core-server.irouter.get.md) | RouteRegistrar<'get'> | Register a route handler for GET request. |
-| [handleLegacyErrors](./kibana-plugin-core-server.irouter.handlelegacyerrors.md) | <P, Q, B>(handler: RequestHandler<P, Q, B>) => RequestHandler<P, Q, B> | Wrap a router handler to catch and converts legacy boom errors to proper custom errors. |
+| [handleLegacyErrors](./kibana-plugin-core-server.irouter.handlelegacyerrors.md) | RequestHandlerWrapper | Wrap a router handler to catch and converts legacy boom errors to proper custom errors. |
| [patch](./kibana-plugin-core-server.irouter.patch.md) | RouteRegistrar<'patch'> | Register a route handler for PATCH request. |
| [post](./kibana-plugin-core-server.irouter.post.md) | RouteRegistrar<'post'> | Register a route handler for POST request. |
| [put](./kibana-plugin-core-server.irouter.put.md) | RouteRegistrar<'put'> | Register a route handler for PUT request. |
diff --git a/docs/development/core/server/kibana-plugin-core-server.iscopedrenderingclient.md b/docs/development/core/server/kibana-plugin-core-server.iscopedrenderingclient.md
deleted file mode 100644
index 0632b5e5e2297..0000000000000
--- a/docs/development/core/server/kibana-plugin-core-server.iscopedrenderingclient.md
+++ /dev/null
@@ -1,19 +0,0 @@
-
-
-[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IScopedRenderingClient](./kibana-plugin-core-server.iscopedrenderingclient.md)
-
-## IScopedRenderingClient interface
-
-
-Signature:
-
-```typescript
-export interface IScopedRenderingClient
-```
-
-## Methods
-
-| Method | Description |
-| --- | --- |
-| [render(options)](./kibana-plugin-core-server.iscopedrenderingclient.render.md) | Generate a KibanaResponse which renders an HTML page bootstrapped with the core bundle. Intended as a response body for HTTP route handlers. |
-
diff --git a/docs/development/core/server/kibana-plugin-core-server.iscopedrenderingclient.render.md b/docs/development/core/server/kibana-plugin-core-server.iscopedrenderingclient.render.md
deleted file mode 100644
index ca114bed21149..0000000000000
--- a/docs/development/core/server/kibana-plugin-core-server.iscopedrenderingclient.render.md
+++ /dev/null
@@ -1,41 +0,0 @@
-
-
-[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IScopedRenderingClient](./kibana-plugin-core-server.iscopedrenderingclient.md) > [render](./kibana-plugin-core-server.iscopedrenderingclient.render.md)
-
-## IScopedRenderingClient.render() method
-
-Generate a `KibanaResponse` which renders an HTML page bootstrapped with the `core` bundle. Intended as a response body for HTTP route handlers.
-
-Signature:
-
-```typescript
-render(options?: Pick): Promise;
-```
-
-## Parameters
-
-| Parameter | Type | Description |
-| --- | --- | --- |
-| options | Pick<IRenderOptions, 'includeUserSettings'> | |
-
-Returns:
-
-`Promise`
-
-## Example
-
-
-```ts
-router.get(
- { path: '/', validate: false },
- (context, request, response) =>
- response.ok({
- body: await context.core.rendering.render(),
- headers: {
- 'content-security-policy': context.core.http.csp.header,
- },
- })
-);
-
-```
-
diff --git a/docs/development/core/server/kibana-plugin-core-server.legacyservicesetupdeps.md b/docs/development/core/server/kibana-plugin-core-server.legacyservicesetupdeps.md
index f037b7b3e7cb2..a5c1d59be06d3 100644
--- a/docs/development/core/server/kibana-plugin-core-server.legacyservicesetupdeps.md
+++ b/docs/development/core/server/kibana-plugin-core-server.legacyservicesetupdeps.md
@@ -20,4 +20,5 @@ export interface LegacyServiceSetupDeps
| --- | --- | --- |
| [core](./kibana-plugin-core-server.legacyservicesetupdeps.core.md) | LegacyCoreSetup | |
| [plugins](./kibana-plugin-core-server.legacyservicesetupdeps.plugins.md) | Record<string, unknown> | |
+| [uiPlugins](./kibana-plugin-core-server.legacyservicesetupdeps.uiplugins.md) | UiPlugins | |
diff --git a/docs/development/core/server/kibana-plugin-core-server.legacyservicesetupdeps.uiplugins.md b/docs/development/core/server/kibana-plugin-core-server.legacyservicesetupdeps.uiplugins.md
new file mode 100644
index 0000000000000..d19a7dfcbfcfa
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-core-server.legacyservicesetupdeps.uiplugins.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [LegacyServiceSetupDeps](./kibana-plugin-core-server.legacyservicesetupdeps.md) > [uiPlugins](./kibana-plugin-core-server.legacyservicesetupdeps.uiplugins.md)
+
+## LegacyServiceSetupDeps.uiPlugins property
+
+Signature:
+
+```typescript
+uiPlugins: UiPlugins;
+```
diff --git a/docs/development/core/server/kibana-plugin-core-server.md b/docs/development/core/server/kibana-plugin-core-server.md
index 5c0f10cac5179..5450e84417f89 100644
--- a/docs/development/core/server/kibana-plugin-core-server.md
+++ b/docs/development/core/server/kibana-plugin-core-server.md
@@ -80,6 +80,9 @@ The plugin integrates with the core system via lifecycle events: `setup`
| [EnvironmentMode](./kibana-plugin-core-server.environmentmode.md) | |
| [ErrorHttpResponseOptions](./kibana-plugin-core-server.errorhttpresponseoptions.md) | HTTP response parameters |
| [FakeRequest](./kibana-plugin-core-server.fakerequest.md) | Fake request object created manually by Kibana plugins. |
+| [HttpResources](./kibana-plugin-core-server.httpresources.md) | HttpResources service is responsible for serving static & dynamic assets for Kibana application via HTTP. Provides API allowing plug-ins to respond with: - a pre-configured HTML page bootstrapping Kibana client app - custom HTML page - custom JS script file. |
+| [HttpResourcesRenderOptions](./kibana-plugin-core-server.httpresourcesrenderoptions.md) | Allows to configure HTTP response parameters |
+| [HttpResourcesServiceToolkit](./kibana-plugin-core-server.httpresourcesservicetoolkit.md) | Extended set of [KibanaResponseFactory](./kibana-plugin-core-server.kibanaresponsefactory.md) helpers used to respond with HTML or JS resource. |
| [HttpResponseOptions](./kibana-plugin-core-server.httpresponseoptions.md) | HTTP response parameters |
| [HttpServerInfo](./kibana-plugin-core-server.httpserverinfo.md) | |
| [HttpServiceSetup](./kibana-plugin-core-server.httpservicesetup.md) | Kibana HTTP Service provides own abstraction for work with HTTP stack. Plugins don't have direct access to hapi server and its primitives anymore. Moreover, plugins shouldn't rely on the fact that HTTP Service uses one or another library under the hood. This gives the platform flexibility to upgrade or changing our internal HTTP stack without breaking plugins. If the HTTP Service lacks functionality you need, we are happy to discuss and support your needs. |
@@ -92,7 +95,6 @@ The plugin integrates with the core system via lifecycle events: `setup`
| [IndexSettingsDeprecationInfo](./kibana-plugin-core-server.indexsettingsdeprecationinfo.md) | |
| [IRenderOptions](./kibana-plugin-core-server.irenderoptions.md) | |
| [IRouter](./kibana-plugin-core-server.irouter.md) | Registers route handlers for specified resource path and method. See [RouteConfig](./kibana-plugin-core-server.routeconfig.md) and [RequestHandler](./kibana-plugin-core-server.requesthandler.md) for more information about arguments to route registrations. |
-| [IScopedRenderingClient](./kibana-plugin-core-server.iscopedrenderingclient.md) | |
| [IUiSettingsClient](./kibana-plugin-core-server.iuisettingsclient.md) | Server-side client that provides access to the advanced settings stored in elasticsearch. The settings provide control over the behavior of the Kibana application. For example, a user can specify how to display numeric or date fields. Users can adjust the settings via Management UI. |
| [KibanaRequestEvents](./kibana-plugin-core-server.kibanarequestevents.md) | Request events. |
| [KibanaRequestRoute](./kibana-plugin-core-server.kibanarequestroute.md) | Request specific route information exposed to a handler. |
@@ -118,7 +120,7 @@ The plugin integrates with the core system via lifecycle events: `setup`
| [PluginConfigDescriptor](./kibana-plugin-core-server.pluginconfigdescriptor.md) | Describes a plugin configuration properties. |
| [PluginInitializerContext](./kibana-plugin-core-server.plugininitializercontext.md) | Context that's available to plugins during initialization stage. |
| [PluginManifest](./kibana-plugin-core-server.pluginmanifest.md) | Describes the set of required and optional properties plugin can define in its mandatory JSON manifest file. |
-| [RequestHandlerContext](./kibana-plugin-core-server.requesthandlercontext.md) | Plugin specific context passed to a route handler.Provides the following clients and services: - [rendering](./kibana-plugin-core-server.iscopedrenderingclient.md) - Rendering client which uses the data of the incoming request - [savedObjects.client](./kibana-plugin-core-server.savedobjectsclient.md) - Saved Objects client which uses the credentials of the incoming request - [savedObjects.typeRegistry](./kibana-plugin-core-server.isavedobjecttyperegistry.md) - Type registry containing all the registered types. - [elasticsearch.dataClient](./kibana-plugin-core-server.scopedclusterclient.md) - Elasticsearch data client which uses the credentials of the incoming request - [elasticsearch.adminClient](./kibana-plugin-core-server.scopedclusterclient.md) - Elasticsearch admin client which uses the credentials of the incoming request - [uiSettings.client](./kibana-plugin-core-server.iuisettingsclient.md) - uiSettings client which uses the credentials of the incoming request |
+| [RequestHandlerContext](./kibana-plugin-core-server.requesthandlercontext.md) | Plugin specific context passed to a route handler.Provides the following clients and services: - [savedObjects.client](./kibana-plugin-core-server.savedobjectsclient.md) - Saved Objects client which uses the credentials of the incoming request - [savedObjects.typeRegistry](./kibana-plugin-core-server.isavedobjecttyperegistry.md) - Type registry containing all the registered types. - [elasticsearch.dataClient](./kibana-plugin-core-server.scopedclusterclient.md) - Elasticsearch data client which uses the credentials of the incoming request - [elasticsearch.adminClient](./kibana-plugin-core-server.scopedclusterclient.md) - Elasticsearch admin client which uses the credentials of the incoming request - [uiSettings.client](./kibana-plugin-core-server.iuisettingsclient.md) - uiSettings client which uses the credentials of the incoming request |
| [RouteConfig](./kibana-plugin-core-server.routeconfig.md) | Route specific configuration. |
| [RouteConfigOptions](./kibana-plugin-core-server.routeconfigoptions.md) | Additional route options. |
| [RouteConfigOptionsBody](./kibana-plugin-core-server.routeconfigoptionsbody.md) | Additional body options for a route |
@@ -216,6 +218,8 @@ The plugin integrates with the core system via lifecycle events: `setup`
| [HandlerFunction](./kibana-plugin-core-server.handlerfunction.md) | A function that accepts a context object and an optional number of additional arguments. Used for the generic types in [IContextContainer](./kibana-plugin-core-server.icontextcontainer.md) |
| [HandlerParameters](./kibana-plugin-core-server.handlerparameters.md) | Extracts the types of the additional arguments of a [HandlerFunction](./kibana-plugin-core-server.handlerfunction.md), excluding the [HandlerContextType](./kibana-plugin-core-server.handlercontexttype.md). |
| [Headers](./kibana-plugin-core-server.headers.md) | Http request headers to read. |
+| [HttpResourcesRequestHandler](./kibana-plugin-core-server.httpresourcesrequesthandler.md) | Extended version of [RequestHandler](./kibana-plugin-core-server.requesthandler.md) having access to [HttpResourcesServiceToolkit](./kibana-plugin-core-server.httpresourcesservicetoolkit.md) to respond with HTML or JS resources. |
+| [HttpResourcesResponseOptions](./kibana-plugin-core-server.httpresourcesresponseoptions.md) | HTTP Resources response parameters |
| [HttpResponsePayload](./kibana-plugin-core-server.httpresponsepayload.md) | Data send to the client as a response payload. |
| [IBasePath](./kibana-plugin-core-server.ibasepath.md) | Access or manipulate the Kibana base path[BasePath](./kibana-plugin-core-server.basepath.md) |
| [IClusterClient](./kibana-plugin-core-server.iclusterclient.md) | Represents an Elasticsearch cluster API client created by the platform. It allows to call API on behalf of the internal Kibana user and the actual user that is derived from the request headers (via asScoped(...)).See [ClusterClient](./kibana-plugin-core-server.clusterclient.md). |
@@ -245,6 +249,7 @@ The plugin integrates with the core system via lifecycle events: `setup`
| [RequestHandler](./kibana-plugin-core-server.requesthandler.md) | A function executed when route path matched requested resource path. Request handler is expected to return a result of one of [KibanaResponseFactory](./kibana-plugin-core-server.kibanaresponsefactory.md) functions. |
| [RequestHandlerContextContainer](./kibana-plugin-core-server.requesthandlercontextcontainer.md) | An object that handles registration of http request context providers. |
| [RequestHandlerContextProvider](./kibana-plugin-core-server.requesthandlercontextprovider.md) | Context provider for request handler. Extends request context object with provided functionality or data. |
+| [RequestHandlerWrapper](./kibana-plugin-core-server.requesthandlerwrapper.md) | Type-safe wrapper for [RequestHandler](./kibana-plugin-core-server.requesthandler.md) function. |
| [ResponseError](./kibana-plugin-core-server.responseerror.md) | Error message and optional data send to the client in case of error. |
| [ResponseErrorAttributes](./kibana-plugin-core-server.responseerrorattributes.md) | Additional data to provide error details. |
| [ResponseHeaders](./kibana-plugin-core-server.responseheaders.md) | Http response headers to set. |
diff --git a/docs/development/core/server/kibana-plugin-core-server.requesthandler.md b/docs/development/core/server/kibana-plugin-core-server.requesthandler.md
index 156f38fab0983..cecef7c923568 100644
--- a/docs/development/core/server/kibana-plugin-core-server.requesthandler.md
+++ b/docs/development/core/server/kibana-plugin-core-server.requesthandler.md
@@ -9,7 +9,7 @@ A function executed when route path matched requested resource path. Request han
Signature:
```typescript
-export declare type RequestHandler = (context: RequestHandlerContext, request: KibanaRequest, response: KibanaResponseFactory) => IKibanaResponse | Promise>;
+export declare type RequestHandler = (context: RequestHandlerContext, request: KibanaRequest, response: ResponseFactory) => IKibanaResponse | Promise>;
```
## Example
diff --git a/docs/development/core/server/kibana-plugin-core-server.requesthandlercontext.core.md b/docs/development/core/server/kibana-plugin-core-server.requesthandlercontext.core.md
index 3c6bee114b6ab..0d640e52c3a03 100644
--- a/docs/development/core/server/kibana-plugin-core-server.requesthandlercontext.core.md
+++ b/docs/development/core/server/kibana-plugin-core-server.requesthandlercontext.core.md
@@ -8,7 +8,6 @@
```typescript
core: {
- rendering: IScopedRenderingClient;
savedObjects: {
client: SavedObjectsClientContract;
typeRegistry: ISavedObjectTypeRegistry;
diff --git a/docs/development/core/server/kibana-plugin-core-server.requesthandlercontext.md b/docs/development/core/server/kibana-plugin-core-server.requesthandlercontext.md
index b65ae47f0e0c1..0966b91a4ebf2 100644
--- a/docs/development/core/server/kibana-plugin-core-server.requesthandlercontext.md
+++ b/docs/development/core/server/kibana-plugin-core-server.requesthandlercontext.md
@@ -6,7 +6,7 @@
Plugin specific context passed to a route handler.
-Provides the following clients and services: - [rendering](./kibana-plugin-core-server.iscopedrenderingclient.md) - Rendering client which uses the data of the incoming request - [savedObjects.client](./kibana-plugin-core-server.savedobjectsclient.md) - Saved Objects client which uses the credentials of the incoming request - [savedObjects.typeRegistry](./kibana-plugin-core-server.isavedobjecttyperegistry.md) - Type registry containing all the registered types. - [elasticsearch.dataClient](./kibana-plugin-core-server.scopedclusterclient.md) - Elasticsearch data client which uses the credentials of the incoming request - [elasticsearch.adminClient](./kibana-plugin-core-server.scopedclusterclient.md) - Elasticsearch admin client which uses the credentials of the incoming request - [uiSettings.client](./kibana-plugin-core-server.iuisettingsclient.md) - uiSettings client which uses the credentials of the incoming request
+Provides the following clients and services: - [savedObjects.client](./kibana-plugin-core-server.savedobjectsclient.md) - Saved Objects client which uses the credentials of the incoming request - [savedObjects.typeRegistry](./kibana-plugin-core-server.isavedobjecttyperegistry.md) - Type registry containing all the registered types. - [elasticsearch.dataClient](./kibana-plugin-core-server.scopedclusterclient.md) - Elasticsearch data client which uses the credentials of the incoming request - [elasticsearch.adminClient](./kibana-plugin-core-server.scopedclusterclient.md) - Elasticsearch admin client which uses the credentials of the incoming request - [uiSettings.client](./kibana-plugin-core-server.iuisettingsclient.md) - uiSettings client which uses the credentials of the incoming request
Signature:
@@ -18,5 +18,5 @@ export interface RequestHandlerContext
| Property | Type | Description |
| --- | --- | --- |
-| [core](./kibana-plugin-core-server.requesthandlercontext.core.md) | {
rendering: IScopedRenderingClient;
savedObjects: {
client: SavedObjectsClientContract;
typeRegistry: ISavedObjectTypeRegistry;
};
elasticsearch: {
dataClient: IScopedClusterClient;
adminClient: IScopedClusterClient;
};
uiSettings: {
client: IUiSettingsClient;
};
} | |
+| [core](./kibana-plugin-core-server.requesthandlercontext.core.md) | {
savedObjects: {
client: SavedObjectsClientContract;
typeRegistry: ISavedObjectTypeRegistry;
};
elasticsearch: {
dataClient: IScopedClusterClient;
adminClient: IScopedClusterClient;
};
uiSettings: {
client: IUiSettingsClient;
};
} | |
diff --git a/docs/development/core/server/kibana-plugin-core-server.requesthandlerwrapper.md b/docs/development/core/server/kibana-plugin-core-server.requesthandlerwrapper.md
new file mode 100644
index 0000000000000..a9fe188ee2bff
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-core-server.requesthandlerwrapper.md
@@ -0,0 +1,27 @@
+
+
+[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RequestHandlerWrapper](./kibana-plugin-core-server.requesthandlerwrapper.md)
+
+## RequestHandlerWrapper type
+
+Type-safe wrapper for [RequestHandler](./kibana-plugin-core-server.requesthandler.md) function.
+
+Signature:
+
+```typescript
+export declare type RequestHandlerWrapper = (handler: RequestHandler) => RequestHandler;
+```
+
+## Example
+
+
+```typescript
+export const wrapper: RequestHandlerWrapper = handler => {
+ return async (context, request, response) => {
+ // do some logic
+ ...
+ };
+}
+
+```
+
diff --git a/docs/development/core/server/kibana-plugin-core-server.responseheaders.md b/docs/development/core/server/kibana-plugin-core-server.responseheaders.md
index 4551d1cab8632..fb7d6a10c6b6c 100644
--- a/docs/development/core/server/kibana-plugin-core-server.responseheaders.md
+++ b/docs/development/core/server/kibana-plugin-core-server.responseheaders.md
@@ -9,9 +9,5 @@ Http response headers to set.
Signature:
```typescript
-export declare type ResponseHeaders = {
- [header in KnownHeaders]?: string | string[];
-} & {
- [header: string]: string | string[];
-};
+export declare type ResponseHeaders = Record | Record;
```
diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.md
index d8202545f0eae..a8894286de910 100644
--- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.md
+++ b/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.md
@@ -25,6 +25,5 @@ This is only internal for now, and will only be public when we expose the regist
| [mappings](./kibana-plugin-core-server.savedobjectstype.mappings.md) | SavedObjectsTypeMappingDefinition | The [mapping definition](./kibana-plugin-core-server.savedobjectstypemappingdefinition.md) for the type. |
| [migrations](./kibana-plugin-core-server.savedobjectstype.migrations.md) | SavedObjectMigrationMap | An optional map of [migrations](./kibana-plugin-core-server.savedobjectmigrationfn.md) to be used to migrate the type. |
| [name](./kibana-plugin-core-server.savedobjectstype.name.md) | string | The name of the type, which is also used as the internal id. |
-| [namespaceAgnostic](./kibana-plugin-core-server.savedobjectstype.namespaceagnostic.md) | boolean | Is the type global (true), or not (false). |
| [namespaceType](./kibana-plugin-core-server.savedobjectstype.namespacetype.md) | SavedObjectsNamespaceType | The [namespace type](./kibana-plugin-core-server.savedobjectsnamespacetype.md) for the type. |
diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.namespaceagnostic.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.namespaceagnostic.md
deleted file mode 100644
index e347421590482..0000000000000
--- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.namespaceagnostic.md
+++ /dev/null
@@ -1,18 +0,0 @@
-
-
-[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsType](./kibana-plugin-core-server.savedobjectstype.md) > [namespaceAgnostic](./kibana-plugin-core-server.savedobjectstype.namespaceagnostic.md)
-
-## SavedObjectsType.namespaceAgnostic property
-
-> Warning: This API is now obsolete.
->
-> Use `namespaceType` instead.
->
-
-Is the type global (true), or not (false).
-
-Signature:
-
-```typescript
-namespaceAgnostic?: boolean;
-```
diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.namespacetype.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.namespacetype.md
index 69912f9144980..3a3b0f7f3a9a5 100644
--- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.namespacetype.md
+++ b/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.namespacetype.md
@@ -9,5 +9,5 @@ The [namespace type](./kibana-plugin-core-server.savedobjectsnamespacetype.md) f
Signature:
```typescript
-namespaceType?: SavedObjectsNamespaceType;
+namespaceType: SavedObjectsNamespaceType;
```
diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpatternfield.routes.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpatternfield.indexpattern.md
similarity index 53%
rename from docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpatternfield.routes.md
rename to docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpatternfield.indexpattern.md
index 664a7b7b7ca0e..d1a1ee0905c6e 100644
--- a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpatternfield.routes.md
+++ b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpatternfield.indexpattern.md
@@ -1,11 +1,11 @@
-[Home](./index.md) > [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) > [IndexPatternField](./kibana-plugin-plugins-data-public.indexpatternfield.md) > [routes](./kibana-plugin-plugins-data-public.indexpatternfield.routes.md)
+[Home](./index.md) > [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) > [IndexPatternField](./kibana-plugin-plugins-data-public.indexpatternfield.md) > [indexPattern](./kibana-plugin-plugins-data-public.indexpatternfield.indexpattern.md)
-## IndexPatternField.routes property
+## IndexPatternField.indexPattern property
Signature:
```typescript
-routes: Record;
+indexPattern?: IndexPattern;
```
diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpatternfield.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpatternfield.md
index 430590c7a2505..df0de6ce0e541 100644
--- a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpatternfield.md
+++ b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpatternfield.md
@@ -27,9 +27,9 @@ export declare class Field implements IFieldType
| [esTypes](./kibana-plugin-plugins-data-public.indexpatternfield.estypes.md) | | string[] | |
| [filterable](./kibana-plugin-plugins-data-public.indexpatternfield.filterable.md) | | boolean | |
| [format](./kibana-plugin-plugins-data-public.indexpatternfield.format.md) | | any | |
+| [indexPattern](./kibana-plugin-plugins-data-public.indexpatternfield.indexpattern.md) | | IndexPattern | |
| [lang](./kibana-plugin-plugins-data-public.indexpatternfield.lang.md) | | string | |
| [name](./kibana-plugin-plugins-data-public.indexpatternfield.name.md) | | string | |
-| [routes](./kibana-plugin-plugins-data-public.indexpatternfield.routes.md) | | Record<string, string> | |
| [script](./kibana-plugin-plugins-data-public.indexpatternfield.script.md) | | string | |
| [scripted](./kibana-plugin-plugins-data-public.indexpatternfield.scripted.md) | | boolean | |
| [searchable](./kibana-plugin-plugins-data-public.indexpatternfield.searchable.md) | | boolean | |
diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpatternfieldlist.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpatternfieldlist.md
index 4b7184b7dc151..478b73f5f8581 100644
--- a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpatternfieldlist.md
+++ b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpatternfieldlist.md
@@ -24,5 +24,5 @@ export declare class FieldList extends Array implements IFieldList
| [getByName](./kibana-plugin-plugins-data-public.indexpatternfieldlist.getbyname.md) | | (name: string) => Field | undefined | |
| [getByType](./kibana-plugin-plugins-data-public.indexpatternfieldlist.getbytype.md) | | (type: string) => any[] | |
| [remove](./kibana-plugin-plugins-data-public.indexpatternfieldlist.remove.md) | | (field: IFieldType) => void | |
-| [update](./kibana-plugin-plugins-data-public.indexpatternfieldlist.update.md) | | (field: Field) => void | |
+| [update](./kibana-plugin-plugins-data-public.indexpatternfieldlist.update.md) | | (field: Record<string, any>) => void | |
diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpatternfieldlist.update.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpatternfieldlist.update.md
index ca03ec4b72893..d5156ed41e493 100644
--- a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpatternfieldlist.update.md
+++ b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpatternfieldlist.update.md
@@ -7,5 +7,5 @@
Signature:
```typescript
-update: (field: Field) => void;
+update: (field: Record) => void;
```
diff --git a/docs/images/add_remote_cluster.png b/docs/images/add_remote_cluster.png
index 376b1d8392366..160d29b741c62 100755
Binary files a/docs/images/add_remote_cluster.png and b/docs/images/add_remote_cluster.png differ
diff --git a/docs/images/auto_follow_pattern.png b/docs/images/auto_follow_pattern.png
index 3bf86458eddd7..f80de9352280f 100755
Binary files a/docs/images/auto_follow_pattern.png and b/docs/images/auto_follow_pattern.png differ
diff --git a/docs/images/cross-cluster-replication-list-view.png b/docs/images/cross-cluster-replication-list-view.png
new file mode 100755
index 0000000000000..4c45174cff7f1
Binary files /dev/null and b/docs/images/cross-cluster-replication-list-view.png differ
diff --git a/docs/images/follower_indices.png b/docs/images/follower_indices.png
old mode 100644
new mode 100755
index f103bb3cf2acf..505adeb45ae23
Binary files a/docs/images/follower_indices.png and b/docs/images/follower_indices.png differ
diff --git a/docs/images/remote-clusters-list-view.png b/docs/images/remote-clusters-list-view.png
new file mode 100755
index 0000000000000..c28379863b74b
Binary files /dev/null and b/docs/images/remote-clusters-list-view.png differ
diff --git a/docs/images/tutorial-ilm-custom-policy.png b/docs/images/tutorial-ilm-custom-policy.png
new file mode 100644
index 0000000000000..03b67829f605c
Binary files /dev/null and b/docs/images/tutorial-ilm-custom-policy.png differ
diff --git a/docs/images/tutorial-ilm-delete-phase-creation.png b/docs/images/tutorial-ilm-delete-phase-creation.png
new file mode 100644
index 0000000000000..91a55733c284e
Binary files /dev/null and b/docs/images/tutorial-ilm-delete-phase-creation.png differ
diff --git a/docs/images/tutorial-ilm-delete-rollover.png b/docs/images/tutorial-ilm-delete-rollover.png
new file mode 100644
index 0000000000000..ba021ecc2ac5c
Binary files /dev/null and b/docs/images/tutorial-ilm-delete-rollover.png differ
diff --git a/docs/images/tutorial-ilm-hotphaserollover-default.png b/docs/images/tutorial-ilm-hotphaserollover-default.png
new file mode 100644
index 0000000000000..a9088c63d885d
Binary files /dev/null and b/docs/images/tutorial-ilm-hotphaserollover-default.png differ
diff --git a/docs/images/tutorial-ilm-modify-default-warm-phase-rollover.png b/docs/images/tutorial-ilm-modify-default-warm-phase-rollover.png
new file mode 100644
index 0000000000000..c6f1e9b40e977
Binary files /dev/null and b/docs/images/tutorial-ilm-modify-default-warm-phase-rollover.png differ
diff --git a/docs/ingest_manager/index.asciidoc b/docs/ingest_manager/index.asciidoc
index 1254f412e14c5..22afa88c919e4 100644
--- a/docs/ingest_manager/index.asciidoc
+++ b/docs/ingest_manager/index.asciidoc
@@ -113,7 +113,7 @@ Ingest Management enforces an indexing strategy to allow the system to automatic
{type}-{dataset}-{namespace}
```
-The `{type}` can be `logs` or `metrics`. The `{namespace}` is the part where the user can use free form. The only two requirement are that it has only characters allowed in an Elasticsearch index name and does NOT contain a `-`. The `dataset` is defined by the data that is indexed. The same requirements as for the namespace apply. It is expected that the fields for type, namespace and dataset are part of each event and are constant keywords.
+The `{type}` can be `logs` or `metrics`. The `{namespace}` is the part where the user can use free form. The only two requirement are that it has only characters allowed in an Elasticsearch index name and does NOT contain a `-`. The `dataset` is defined by the data that is indexed. The same requirements as for the namespace apply. It is expected that the fields for type, namespace and dataset are part of each event and are constant keywords. If there is a dataset or a namespace with a `-` inside, it is recommended to replace it either by a `.` or a `_`.
Note: More `{type}`s might be added in the future like `apm` and `endpoint`.
@@ -126,6 +126,8 @@ This indexing strategy has a few advantages:
* Having a global metrics and logs template, allows to create new indices on demand which still follow the convention. This is common in the case of k8s as an example.
* Constant keywords allow to narrow down the indices we need to access for querying very efficiently. This is especially relevant in environments which a large number of indices or with indices on slower nodes.
+Overall it creates smaller indices in size, makes querying more efficient and allows users to define their own naming parts in namespace and still benefiting from all features that can be built on top of the indexing startegy.
+
=== Ingest Pipeline
The ingest pipelines for a specific dataset will have the following naming scheme:
diff --git a/docs/management/index-lifecycle-policies/example-index-lifecycle-policy.asciidoc b/docs/management/index-lifecycle-policies/example-index-lifecycle-policy.asciidoc
index f68708f1b6394..e6d94e9ca61a3 100644
--- a/docs/management/index-lifecycle-policies/example-index-lifecycle-policy.asciidoc
+++ b/docs/management/index-lifecycle-policies/example-index-lifecycle-policy.asciidoc
@@ -1,23 +1,179 @@
[role="xpack"]
+
[[example-using-index-lifecycle-policy]]
-=== Example of using an index lifecycle policy
+=== Tutorial: Use {ilm-init} to manage {filebeat} time-based indices
+
+With {ilm} ({ilm-init}), you can create policies that perform actions automatically
+on indices as they age and grow. {ilm-init} policies help you to manage
+performance, resilience, and retention of your data during its lifecycle. This tutorial shows
+you how to use {kib}’s *Index Lifecycle Policies* to modify and create {ilm-init}
+policies. You can learn more about all of the actions, benefits, and lifecycle
+phases in the {ref}/overview-index-lifecycle-management.html[{ilm-init} overview].
+
+
+[discrete]
+[[example-using-index-lifecycle-policy-scenario]]
+==== Scenario
+
+You’re tasked with sending syslog files to an {es} cluster. This
+log data has the following data retention guidelines:
+
+* Keep logs on hot data nodes for 30 days
+* Roll over to a new index if the size reaches 50GB
+* After 30 days:
+** Move the logs to warm data nodes
+** Set {ref}/glossary.html#glossary-replica-shard[replica shards] to 1
+** {ref}/indices-forcemerge.html[Force merge] multiple index segments to free up the space used by deleted documents
+* Delete logs after 90 days
+
+
+[discrete]
+[[example-using-index-lifecycle-policy-prerequisites]]
+==== Prerequisites
+
+To complete this tutorial, you'll need:
+
+* An {es} cluster with hot and warm nodes configured for shard allocation
+awareness. If you’re using {cloud}/ec-getting-started-templates-hot-warm.html[{ess}],
+choose the hot-warm architecture deployment template.
+
++
+For a self-managed cluster, add node attributes as described for {ref}/shard-allocation-filtering.html[shard allocation filtering]
+to label data nodes as hot or warm. This step is required to migrate shards between
+nodes configured with specific hardware for the hot or warm phases.
++
+For example, you can set this in your `elasticsearch.yml` for each data node:
++
+[source,yaml]
+--------------------------------------------------------------------------------
+node.attr.data: "warm"
+--------------------------------------------------------------------------------
+
+* A server with {filebeat} installed and configured to send logs to the `elasticsearch`
+output as described in {filebeat-ref}/filebeat-getting-started.html[Getting Started with {filebeat}].
+
+[discrete]
+[[example-using-index-lifecycle-policy-view-fb-ilm-policy]]
+==== View the {filebeat} {ilm-init} policy
+
+{filebeat} includes a default {ilm-init} policy that enables rollover. {ilm-init}
+is enabled automatically if you’re using the default `filebeat.yml` and index template.
+
+To view the default policy in {kib}, go to *Management > Index Lifecycle Policies*,
+search for _filebeat_, and choose the _filebeat-version_ policy.
+
+This policy initiates the rollover action when the index size reaches 50GB or
+becomes 30 days old.
+
+[role="screenshot"]
+image::images/tutorial-ilm-hotphaserollover-default.png["Default policy"]
+
+
+[float]
+==== Modify the policy
+
+The default policy is enough to prevent the creation of many tiny daily indices.
+You can modify the policy to meet more complex requirements.
+
+. Activate the warm phase.
+
++
+. Set either of the following options to control when the index moves to the warm phase:
+
+** Provide a value for *Timing for warm phase*. Setting this to *15* keeps the
+indices on hot nodes for a range of 15-45 days, depending on when the initial
+rollover occurred.
+
+** Enable *Move to warm phase on rollover*. The index might move to the warm phase
+more quickly than intended if it reaches the *Maximum index size* before the
+the *Maximum age*.
+
+. In the *Select a node attribute to control shard allocation* dropdown, select
+*data:warm(2)* to migrate shards to warm data nodes.
+
+. Change *Number of replicas* to *1*.
+
+. Enable *Force merge data* and set *Number of segments* to *1*.
++
+NOTE: When rollover is enabled in the hot phase, action timing in the other phases
+is based on the rollover date.
+
++
+[role="screenshot"]
+image::images/tutorial-ilm-modify-default-warm-phase-rollover.png["Modify to add warm phase"]
+
+. Activate the delete phase and set *Timing for delete phase* to *90* days.
++
+[role="screenshot"]
+image::images/tutorial-ilm-delete-rollover.png["Add a delete phase"]
+
+[float]
+==== Create a custom policy
+
+If meeting a specific retention time period is most important, you can create a
+custom policy. For this option, you will use {filebeat} daily indices without
+rollover.
+
+. Create a custom policy in {kib}, go to *Management > Index Lifecycle Policies >
+Create Policy*.
+
+. Activate the warm phase and configure it as follows:
++
+|===
+|*Setting* |*Value*
+
+|Timing for warm phase
+|30 days from index creation
+
+|Node attribute
+|`data:warm`
+
+|Number of replicas
+|1
+
+|Force merge data
+|enable
+
+|Number of segments
+|1
+|===
+
++
+[role="screenshot"]
+image::images/tutorial-ilm-custom-policy.png["Modify the custom policy to add a warm phase"]
+
-A common use case for managing index lifecycle policies is when you’re using
-{beats-ref}/beats-reference.html[Beats] to continually send time-series data,
-such as metrics and log data, to {es}. When you create the Beats packages, an
-index template is installed. The template includes a default policy to apply
-when new indices are created.
++
+. Activate the delete phase and set the timing.
++
+|===
+|*Setting* |*Value*
+|Timing for delete phase
+|90
+|===
-You can edit the policy in {kib}'s *Index Lifecycle Policies*. For example, you might:
++
+[role="screenshot"]
+image::images/tutorial-ilm-delete-phase-creation.png["Delete phase"]
-* Rollover the index when it reaches 50 GB in size or is 30 days old. These
-settings are the default for the Beats lifecycle policy. This avoids
-having 1000s of tiny indices. When a rollover occurs, a new “hot” index is
-created and added to the index alias.
+. Configure the index to use the new policy in *{kib} > Management > Index Lifecycle
+Policies*
-* Move the index into the warm phase, shrink the index down to a single shard,
-and force merge to a single segment.
+.. Find your {ilm-init} policy.
+.. Click the *Actions* link next to your policy name.
+.. Choose *Add policy to index template*.
+.. Select your {filebeat} index template name from the *Index template* list. For example, `filebeat-7.5.x`.
+.. Click *Add Policy* to save the changes.
-* After 60 days, move the index into the cold phase and onto less expensive hardware.
++
+NOTE: If you initially used the default {filebeat} {ilm-init} policy, you will
+see a notice that the template already has a policy associated with it. Confirm
+that you want to overwrite that configuration.
-* Delete the index after 90 days.
++
++
+TIP: When you change the policy associated with the index template, the active
+index will continue to use the policy it was associated with at index creation
+unless you manually update it. The next new index will use the updated policy.
+For more reasons that your {ilm-init} policy changes might be delayed, see
+{ref}/update-lifecycle-policy.html#update-lifecycle-policy[Update Lifecycle Policy].
diff --git a/docs/management/managing-ccr.asciidoc b/docs/management/managing-ccr.asciidoc
new file mode 100644
index 0000000000000..b2db5a80cfe7e
--- /dev/null
+++ b/docs/management/managing-ccr.asciidoc
@@ -0,0 +1,73 @@
+[role="xpack"]
+[[managing-cross-cluster-replication]]
+== Cross-Cluster Replication
+
+Use *Cross-Cluster Replication* to reproduce indices in
+remote clusters on a local cluster. {ref}/xpack-ccr.html[Cross-cluster replication]
+is commonly used to provide remote backups for disaster recovery and for
+geo-proximite copies of data.
+
+To get started, go to *Management > Cross-Cluster Replication*.
+
+[role="screenshot"]
+image::images/cross-cluster-replication-list-view.png[][Cross-cluster replication list view]
+
+[float]
+=== Prerequisites
+
+* You must have a {ref}/modules-remote-clusters.html[remote cluster].
+* Leader indices must meet {ref}/ccr-requirements.html[these requirements].
+* The Elasticsearch version of the local cluster must be the same as or newer than the remote cluster.
+Refer to {ref}/ccr-overview.html[this document] for more information.
+
+[float]
+[[configure-replication]]
+=== Configure replication
+
+Replication requires a leader index, the index being replicated, and a
+follower index, which will contain the leader index's replicated data.
+The follower index is passive in that it can read requests and searches,
+but cannot accept direct writes. Only the leader index is active for direct writes.
+
+You can configure follower indices in two ways:
+
+* Create specific follower indices
+* Create follower indices from an auto-follow pattern
+
+[float]
+==== Create specific follower indices
+
+To replicate data from existing indices, or set up local followers on a case-by-case basis,
+go to *Follower indices*. When you create the follower index, you must reference the
+remote cluster and the leader index that you created in the remote cluster.
+
+[role="screenshot"]
+image::images/follower_indices.png[][UI for adding follower indices]
+
+[float]
+==== Create follower indices from an auto-follow pattern
+
+To automatically detect and follow new indices when they are created on a remote cluster,
+go to *Auto-follow patterns*. Creating an auto-follow pattern is useful when you have
+time series data, like event logs, on the remote cluster that is created or rolled over on a daily basis.
+
+When creating the pattern, you must reference the remote cluster that you
+connected to your local cluster. You must also specify a collection of index patterns
+that match the indices you want to automatically follow.
+
+Once you configure an
+auto-follow pattern, any time a new index with a name that matches the pattern is
+created in the remote cluster, a follower index is automatically configured in the local cluster.
+
+[role="screenshot"]
+image::images/auto_follow_pattern.png[UI for adding an auto-follow pattern]
+
+[float]
+[[manage-replication]]
+=== Manage replication
+
+Use the list views in *Cross-Cluster Replication* to monitor whether the replication is active and
+pause and resume replication. You can also edit and remove the follower indices and auto-follow patterns.
+
+For an example of cross-cluster replication,
+refer to https://www.elastic.co/blog/bi-directional-replication-with-elasticsearch-cross-cluster-replication-ccr[Bi-directional replication with Elasticsearch cross-cluster replication].
diff --git a/docs/management/managing-remote-clusters.asciidoc b/docs/management/managing-remote-clusters.asciidoc
index 6b69cfef5b768..00ec5c7d2ddea 100644
--- a/docs/management/managing-remote-clusters.asciidoc
+++ b/docs/management/managing-remote-clusters.asciidoc
@@ -1,67 +1,39 @@
[[working-remote-clusters]]
== Remote Clusters
-{kib} *Management* provides user interfaces for working with data from remote
-clusters and managing the {ccr} process. You can replicate indices from a
-leader remote cluster to a follower index in a local cluster. The local follower indices
-can be used to provide remote backups for disaster recovery or for geo-proximite copies of data.
+Use *Remote Clusters* to establish a unidirectional
+connection from your cluster to other clusters. This functionality is
+required for {ref}/xpack-ccr.html[cross-cluster replication] and
+{ref}/modules-cross-cluster-search.html[cross-cluster search].
-Before using these features, you should be familiar with the following concepts:
+To get started, go to *Management > Remote Clusters*.
-* {ref}/xpack-ccr.html[{ccr-cap}]
-* {ref}/modules-cross-cluster-search.html[{ccs-cap}]
-* {ref}/cross-cluster-configuring.html[Cross-cluster security requirements]
+[role="screenshot"]
+image::images/remote-clusters-list-view.png[Remote Clusters list view, including Add a remote cluster button]
[float]
[[managing-remote-clusters]]
-== Managing remote clusters
-
-*Remote clusters* helps you manage remote clusters for use with
-{ccs} and {ccr}. You can add and remove remote clusters and check their connectivity.
+=== Add a remote cluster
-Before you use this feature, you should be familiar with the concept of
-{ref}/modules-remote-clusters.html[remote clusters].
+A {ref}/modules-remote-clusters.html[remote cluster] connection works by configuring a remote cluster and
+connecting to a limited number of nodes, called {ref}/modules-remote-clusters.html#sniff-mode[seed nodes],
+in that cluster.
+Alternatively, you can define a single proxy address for the remote cluster.
-Go to *Management > Elasticsearch > Remote clusters* to create or manage your remotes.
+By default, a cross-cluster request, such as a cross-cluster search or
+replication request, fails if any cluster in the request is unavailable.
+To skip a cluster when its unavailable,
+set *Skip if unavailable* to true.
-To set up a new remote, click *Add a remote cluster*. Give the cluster a unique name
-and define the seed nodes for cluster discovery. You can edit or remove your remote clusters
-from the *Remote clusters* list view.
+Once you add a remote cluster, you can configure <>
+to reproduce indices in the remote cluster on a local cluster.
[role="screenshot"]
image::images/add_remote_cluster.png[][UI for adding a remote cluster]
-Once a remote cluster is registered, you can use the tools under *{ccr-cap}*
-to add and manage follower indices on the local cluster, and replicate data from
-indices on the remote cluster based on an auto-follow index pattern.
-
[float]
-[[managing-cross-cluster-replication]]
-== [xpack]#Managing {ccr}#
-
-*{ccr-cap}* helps you create and manage the {ccr} process.
-If you want to replicate data from existing indices, or set up
-local followers on a case-by-case basis, go to *Follower indices*.
-If you want to automatically detect and follow new indices when they are created
-on a remote cluster, you can do so from *Auto-follow patterns*.
-
-Creating an auto-follow pattern is useful when you have time-series data, like a logs index, on the
-remote cluster that is created or rolled over on a daily basis. Once you have configured an
-auto-follow pattern, any time a new index with a name that matches the pattern is
-created in the remote cluster, a follower index is automatically configured in the local cluster.
-
-From the same view, you can also see a list of your saved auto-follow patterns for
-a given remote cluster, and monitor whether the replication is active.
+[[manage-remote-clusters]]
+=== Manage remote clusters
-Before you use these features, you should be familiar with the following concepts:
-
-* {ref}/ccr-requirements.html[Requirements for leader indices]
-* {ref}/ccr-auto-follow.html[Automatically following indices]
-
-To get started, go to *Management > Elasticsearch > {ccr-cap}*.
-
-[role="screenshot"]
-image::images/auto_follow_pattern.png[][UI for adding an auto-follow pattern]
-
-[role="screenshot"]
-image::images/follower_indices.png[][UI for adding follower indices]
+From the *Remote Clusters* list view, you can drill down into each cluster and
+view its status. You can also edit and delete a cluster.
diff --git a/docs/redirects.asciidoc b/docs/redirects.asciidoc
index fd835bde83322..a5503969a3ec1 100644
--- a/docs/redirects.asciidoc
+++ b/docs/redirects.asciidoc
@@ -23,7 +23,7 @@ For more {kib} configuration settings, see <>.
[role="exclude",id="uptime-security"]
== Uptime security
-This page has moved. Please see the new section in the {uptime-guide}/uptime-security.html[Uptime Monitoring Guide].
+This page has moved. Please see the new section in the {heartbeat-ref}/securing-heartbeat.html[Uptime Monitoring Guide].
[role="exclude",id="infra-read-only-access"]
== Configure source read-only access
diff --git a/docs/settings/alert-action-settings.asciidoc b/docs/settings/alert-action-settings.asciidoc
index d7f1ec637d1df..d4dbe9407b7a9 100644
--- a/docs/settings/alert-action-settings.asciidoc
+++ b/docs/settings/alert-action-settings.asciidoc
@@ -9,7 +9,7 @@ Alerts and actions are enabled by default in {kib}, but require you configure th
. <>.
. <>.
-. <>.
+. <>.
You can configure the following settings in the `kibana.yml` file.
@@ -18,7 +18,7 @@ You can configure the following settings in the `kibana.yml` file.
[[general-alert-action-settings]]
==== General settings
-`xpack.encrypted_saved_objects.encryptionKey`::
+`xpack.encryptedSavedObjects.encryptionKey`::
A string of 32 or more characters used to encrypt sensitive properties on alerts and actions before they're stored in {es}. Third party credentials — such as the username and password used to connect to an SMTP service — are an example of encrypted properties.
+
diff --git a/docs/settings/apm-settings.asciidoc b/docs/settings/apm-settings.asciidoc
index 91bbef5690fd5..fd53c3aeb3605 100644
--- a/docs/settings/apm-settings.asciidoc
+++ b/docs/settings/apm-settings.asciidoc
@@ -5,7 +5,10 @@
APM settings
++++
-You do not need to configure any settings to use the APM app. It is enabled by default.
+These settings allow the APM app to function, and specify the data that it surfaces.
+Unless you've customized your setup,
+you do not need to configure any settings to use the APM app.
+It is enabled by default.
[float]
[[apm-indices-settings-kb]]
@@ -33,29 +36,29 @@ image::settings/images/apm-settings.png[APM app settings in Kibana]
If you'd like to change any of the default values,
copy and paste the relevant settings into your `kibana.yml` configuration file.
+Changing these settings may disable features of the APM App.
-xpack.apm.enabled:: Set to `false` to disabled the APM plugin {kib}. Defaults to
-`true`.
+xpack.apm.enabled:: Set to `false` to disable the APM app. Defaults to `true`.
-xpack.apm.ui.enabled:: Set to `false` to hide the APM plugin {kib} from the menu. Defaults to
-`true`.
+xpack.apm.ui.enabled:: Set to `false` to hide the APM app from the menu. Defaults to `true`.
-xpack.apm.ui.transactionGroupBucketSize:: Number of top transaction groups displayed in APM plugin in Kibana. Defaults to `100`.
+xpack.apm.ui.transactionGroupBucketSize:: Number of top transaction groups displayed in the APM app. Defaults to `100`.
-xpack.apm.ui.maxTraceItems:: Max number of child items displayed when viewing trace details. Defaults to `1000`.
+xpack.apm.ui.maxTraceItems:: Maximum number of child items displayed when viewing trace details. Defaults to `1000`.
-apm_oss.indexPattern:: Index pattern is used for integrations with Machine Learning and Kuery Bar. It must match all apm indices. Defaults to `apm-*`.
+apm_oss.indexPattern:: The index pattern used for integrations with Machine Learning and Query Bar.
+It must match all apm indices. Defaults to `apm-*`.
-apm_oss.errorIndices:: Matcher for indices containing error documents. Defaults to `apm-*`.
+apm_oss.errorIndices:: Matcher for all {apm-server-ref}/error-indices.html[error indices]. Defaults to `apm-*`.
-apm_oss.onboardingIndices:: Matcher for indices containing onboarding documents. Defaults to `apm-*`.
+apm_oss.onboardingIndices:: Matcher for all onboarding indices. Defaults to `apm-*`.
-apm_oss.spanIndices:: Matcher for indices containing span documents. Defaults to `apm-*`.
+apm_oss.spanIndices:: Matcher for all {apm-server-ref}/span-indices.html[span indices]. Defaults to `apm-*`.
-apm_oss.transactionIndices:: Matcher for indices containing transaction documents. Defaults to `apm-*`.
+apm_oss.transactionIndices:: Matcher for all {apm-server-ref}/transaction-indices.html[transaction indices]. Defaults to `apm-*`.
-apm_oss.metricsIndices:: Matcher for indices containing metric documents. Defaults to `apm-*`.
+apm_oss.metricsIndices:: Matcher for all {apm-server-ref}/metricset-indices.html[metrics indices]. Defaults to `apm-*`.
-apm_oss.sourcemapIndices:: Matcher for indices containing sourcemap documents. Defaults to `apm-*`.
+apm_oss.sourcemapIndices:: Matcher for all {apm-server-ref}/sourcemap-indices.html[source map indices]. Defaults to `apm-*`.
// end::general-apm-settings[]
diff --git a/docs/uptime-guide/index.asciidoc b/docs/uptime-guide/index.asciidoc
index 7bbc01bb303f1..09763182fa88f 100644
--- a/docs/uptime-guide/index.asciidoc
+++ b/docs/uptime-guide/index.asciidoc
@@ -12,4 +12,3 @@ include::install.asciidoc[]
include::deployment-arch.asciidoc[]
-include::security.asciidoc[]
diff --git a/docs/uptime-guide/install.asciidoc b/docs/uptime-guide/install.asciidoc
index e7c50bb7604ce..0ed1270ca92ce 100644
--- a/docs/uptime-guide/install.asciidoc
+++ b/docs/uptime-guide/install.asciidoc
@@ -56,6 +56,11 @@ Additional information is available in {heartbeat-ref}/heartbeat-configuration.h
[role="screenshot"]
image::images/uptime-setup.png[Installation instructions on the Uptime page in Kibana]
+[[setup-security]]
+=== Step 4: Setup Security
+
+Secure your installation by following the {heartbeat-ref}/securing-heartbeat.html[Secure Heartbeat] documentation.
+
[float]
==== Important considerations
diff --git a/docs/uptime-guide/security.asciidoc b/docs/uptime-guide/security.asciidoc
deleted file mode 100644
index 0c6fa4c6c4f56..0000000000000
--- a/docs/uptime-guide/security.asciidoc
+++ /dev/null
@@ -1,60 +0,0 @@
-[[uptime-security]]
-== Elasticsearch Security
-
-If you use Elasticsearch security, you'll need to enable certain privileges for users
-that would like to access the Uptime app. For example, create user and support roles to implement the privileges:
-
-[float]
-=== Create a role
-
-You'll need a role that lets you access the Heartbeat indices, which by default are `heartbeat-*`.
-You can create this with the following request:
-
-["source","sh",subs="attributes,callouts"]
----------------------------------------------------------------
-PUT /_security/role/uptime
-{ "indices" : [
- {
- "names" : [
- "heartbeat-*"
- ],
- "privileges" : [
- "read",
- "view_index_metadata"
- ],
- "field_security" : {
- "grant" : [
- "*"
- ]
- },
- "allow_restricted_indices" : false
- }
- ],
- "transient_metadata" : {
- "enabled" : true
- }
-}
----------------------------------------------------------------
-// CONSOLE
-
-[float]
-=== Assign the role to a user
-
-Next, you'll need to create a user with both the `uptime` role, and another role with sufficient {kibana-ref}/kibana-privileges.html[Kibana privileges],
-such as the `kibana_admin` role.
-You can do this with the following request:
-
-["source","sh",subs="attributes,callouts"]
----------------------------------------------------------------
-PUT /_security/user/jacknich
-{
- "password" : "j@rV1s",
- "roles" : [ "uptime", "kibana_admin" ],
- "full_name" : "Jack Nicholson",
- "email" : "jacknich@example.com",
- "metadata" : {
- "intelligence" : 7
- }
-}
----------------------------------------------------------------
-// CONSOLE
diff --git a/docs/uptime/images/alert-flyout.png b/docs/uptime/images/alert-flyout.png
new file mode 100644
index 0000000000000..7fc1e3d9aefe2
Binary files /dev/null and b/docs/uptime/images/alert-flyout.png differ
diff --git a/docs/uptime/images/check-history.png b/docs/uptime/images/check-history.png
index 6418495eee9ed..91565bf59aa7f 100644
Binary files a/docs/uptime/images/check-history.png and b/docs/uptime/images/check-history.png differ
diff --git a/docs/uptime/images/error-list.png b/docs/uptime/images/error-list.png
deleted file mode 100644
index 99f017f2945a5..0000000000000
Binary files a/docs/uptime/images/error-list.png and /dev/null differ
diff --git a/docs/uptime/images/monitor-charts.png b/docs/uptime/images/monitor-charts.png
index dbfa43f47656e..522f34662657e 100644
Binary files a/docs/uptime/images/monitor-charts.png and b/docs/uptime/images/monitor-charts.png differ
diff --git a/docs/uptime/images/observability_integrations.png b/docs/uptime/images/observability_integrations.png
index d5c612c7589ca..6589c0c5565dd 100644
Binary files a/docs/uptime/images/observability_integrations.png and b/docs/uptime/images/observability_integrations.png differ
diff --git a/docs/uptime/images/settings.png b/docs/uptime/images/settings.png
new file mode 100644
index 0000000000000..dd36f0a6d702b
Binary files /dev/null and b/docs/uptime/images/settings.png differ
diff --git a/docs/uptime/images/snapshot-view.png b/docs/uptime/images/snapshot-view.png
index 020396d0f3e4c..1fce2e9592c14 100644
Binary files a/docs/uptime/images/snapshot-view.png and b/docs/uptime/images/snapshot-view.png differ
diff --git a/docs/uptime/images/status-bar.png b/docs/uptime/images/status-bar.png
index e0e9b27555900..8d242789cdccd 100644
Binary files a/docs/uptime/images/status-bar.png and b/docs/uptime/images/status-bar.png differ
diff --git a/docs/uptime/index.asciidoc b/docs/uptime/index.asciidoc
index 785b9f818f5bf..a355f8ecf4843 100644
--- a/docs/uptime/index.asciidoc
+++ b/docs/uptime/index.asciidoc
@@ -12,8 +12,10 @@ To get started with Elastic Uptime, refer to {uptime-guide}/install-uptime.html[
* <>
* <>
+* <>
--
include::overview.asciidoc[]
include::monitor.asciidoc[]
+include::settings.asciidoc[]
diff --git a/docs/uptime/monitor.asciidoc b/docs/uptime/monitor.asciidoc
index d54fd02c7c069..8a4be1f11a721 100644
--- a/docs/uptime/monitor.asciidoc
+++ b/docs/uptime/monitor.asciidoc
@@ -5,21 +5,24 @@
The Monitor page will help you get further insight into the performance
of a specific network endpoint. You'll see a detailed visualization of
the monitor's request duration over time, as well as the `up`/`down`
-status over time.
+status over time. You can also also detect anomalies in response time data
+by configuring Machine Learning jobs on this page.
[float]
-=== Status bar
+=== Status panel
[role="screenshot"]
image::uptime/images/status-bar.png[Status bar]
-The Status bar displays a quick summary of the latest information
+The Status panel displays a quick summary of the latest information
regarding your monitor. You can view its latest status, click a link to
visit the targeted URL, see its most recent request duration, and determine the
amount of time that has elapsed since the last check.
-You can use the Status bar to get a quick summary of current performance,
-beyond simply knowing if the monitor is `up` or `down`.
+When two Heartbeat instances are configured in different geographic locations
+the map will show each location as a pinpoint on the map, along with the
+amount of time elapsed since data was last received from that location.
+
[float]
=== Monitor charts
@@ -32,12 +35,14 @@ date range. These charts can help you gain insight into how quickly requests are
by the targeted endpoint, and give you a sense of how frequently a host or endpoint
was down in your selected timespan.
-The first chart displays request duration information for your monitor.
+The Monitor duration chart displays request duration information for your monitor.
The area surrounding the line is the range of request time for the corresponding
-bucket. The line is the average time.
+bucket. The line is the average time. Anomaly detection using Machine Learning
+can be configured in the upper right hand of this panel. When response times change
+in an unexpected way the time range in which they occurred will be given filled with a color.
-Next, is a graphical representation of the check statuses over time. Hover over
-the charts to display crosshairs with more specific numeric data.
+The pings over time chart is a graphical representation of the check statuses over time.
+Hover over the charts to display crosshairs with more specific numeric data.
[role="screenshot"]
image::uptime/images/crosshair-example.png[Chart crosshair]
@@ -49,6 +54,6 @@ image::uptime/images/crosshair-example.png[Chart crosshair]
image::uptime/images/check-history.png[Check history view]
The Check history displays the total count of this monitor's checks for the selected
-date range. You can additionally filter the checks by `status` to help find recent problems
+date range. You can additionally filter the checks by status and location to help find recent problems
on a per-check basis. This table can help you gain some insight into more granular details
about recent individual data points Heartbeat is logging about your host or endpoint.
diff --git a/docs/uptime/overview.asciidoc b/docs/uptime/overview.asciidoc
index 098ce12a56991..71c09c968e512 100644
--- a/docs/uptime/overview.asciidoc
+++ b/docs/uptime/overview.asciidoc
@@ -21,12 +21,12 @@ This control allows you to use automated filter options, as well as input custom
text to select specific monitors by field, URL, ID, and other attributes.
[float]
-=== Snapshot view
+=== Snapshot panel
[role="screenshot"]
image::uptime/images/snapshot-view.png[Snapshot view]
-This view is intended to quickly give you a sense of the overall
+This panel is intended to quickly give you a sense of the overall
status of the environment you're monitoring, or a subset of those monitors.
Here, you can see the total number of detected monitors within the selected
Uptime date range. In addition to the total, the counts for the number of monitors
@@ -49,6 +49,17 @@ way to navigate to a more in-depth visualization for interesting hosts or endpoi
This table includes information like the most recent status, when the monitor was last checked, its
ID and URL, its IP address, and a dedicated sparkline showing its check status over time.
+[float]
+=== Creating and managing alerts
+
+[role="screenshot"]
+image::uptime/images/alert-flyout.png[Create alert flyout]
+
+To receive alerts when a monitor goes down, use the alerting menu at the top of the
+overview page. Use a query in the alert flyout to determine which monitors to check
+with your alert. If you already have a query in the overview page search bar it will
+be carried over into this box.
+
[float]
=== Observability integrations
@@ -60,14 +71,3 @@ Docker related host information, it will provide links to open the Metrics app o
for this host. Additionally, this feature supplies links to simply filter the other views on the host's
IP address, to help you quickly determine if these other solutions contain data relevant to your current
interest.
-
-[float]
-=== Error list
-
-[role="screenshot"]
-image::uptime/images/error-list.png[Error list]
-
-The Error list displays aggregations of errors that Heartbeat has logged. Errors are
-displayed by Error type, monitor ID, and message. Clicking a monitor's ID will take you
-to the corresponding Monitor view, which can provide you richer information about the individual
-data points that are resulting in the displayed errors.
diff --git a/docs/uptime/settings.asciidoc b/docs/uptime/settings.asciidoc
new file mode 100644
index 0000000000000..55da6e802bec6
--- /dev/null
+++ b/docs/uptime/settings.asciidoc
@@ -0,0 +1,27 @@
+[role="xpack"]
+[[uptime-settings]]
+
+== Settings
+
+[role="screenshot"]
+image::uptime/images/settings.png[Filter bar]
+
+The Uptime settings page lets you change which Heartbeat indices are displayed
+by the uptime app. Users must have the 'all' permission to modify items on this page.
+Uptime settings apply to the current space only. Use different settings in different
+spaces to segment different uptime use cases and domains.
+
+As an example, imagine your organization has one team for internal IT services, and another
+for public services. Each team operates independently and is only responsible for its
+own services. In this scenario, you might set up separate Heartbeat instances for each team,
+writing out to index patterns named `it-heartbeat-\*`, and `external-heartbeat-\*`. You would
+create separate roles and users for each in Elasticsearch, each with access to their own spaces,
+named `it` and `external` respectively. Within each space you would navigate to the settings page
+and set the correct index pattern to match only the indices that space is allowed to access.
+
+Note that the pattern set here only restricts what the Uptime app shows. Users may still be able
+to manually query Elasticsearch for data outside this pattern!
+
+See the <>
+and {heartbeat-ref}/securing-heartbeat.html[Heartbeat security]
+docs for more information.
diff --git a/docs/user/alerting/action-types.asciidoc b/docs/user/alerting/action-types.asciidoc
index 02c09736e1fa0..2913bf28dd765 100644
--- a/docs/user/alerting/action-types.asciidoc
+++ b/docs/user/alerting/action-types.asciidoc
@@ -2,181 +2,46 @@
[[action-types]]
== Action and connector types
-{kib} provides the following types of actions:
+Actions are Kibana services or integrations with third-party systems that run as background tasks on the Kibana server when alert conditions are met. {kib} provides the following types of actions:
-* <>
-* <>
-* <>
-* <>
-* <>
-* <>
+[cols="2"]
+|===
-This section describes how to configure connectors and actions for each type.
+a| <>
-[NOTE]
-==============================================
-Some action types are paid commercial features, while others are free.
-For a comparison of the Elastic license levels,
-see https://www.elastic.co/subscriptions[the subscription page].
-==============================================
-
-[float]
-[[email-action-type]]
-=== Email
-
-The email action type uses the SMTP protocol to send mail message, using an integration of https://nodemailer.com/[Nodemailer]. Email message text is sent as both plain text and html text.
-
-[float]
-[[email-connector-configuration]]
-==== Connector configuration
-
-Email connectors have the following configuration properties:
-
-Name:: The name of the connector. The name is used to identify a connector in the management UI connector listing, or in the connector list when configuring an action.
-Sender:: The from address for all emails sent with this connector, specified in `user@host-name` format.
-Host:: Host name of the service provider. If you are using the <> setting, make sure this hostname is whitelisted.
-Port:: The port to connect to on the service provider.
-Secure:: If true the connection will use TLS when connecting to the service provider. See https://nodemailer.com/smtp/#tls-options[nodemailer TLS documentation] for more information.
-Username:: username for 'login' type authentication.
-Password:: password for 'login' type authentication.
-
-[float]
-[[email-action-configuration]]
-==== Action configuration
-
-Email actions have the following configuration properties:
-
-To, CC, BCC:: Each is a list of addresses. Addresses can be specified in `user@host-name` format, or in `name ` format. One of To, CC, or BCC must contain an entry.
-Subject:: The subject line of the email.
-Message:: The message text of the email. Markdown format is supported.
-
-[float]
-[[index-action-type]]
-=== Index
-
-The index action type will index a document into {es}.
-
-[float]
-[[index-connector-configuration]]
-==== Connector configuration
-
-Index connectors have the following configuration properties:
-
-Name:: The name of the connector. The name is used to identify a connector in the management UI connector listing, or in the connector list when configuring an action.
-Index:: The {es} index to be written to.
-Refresh:: Setting for the {ref}/docs-refresh.html[refresh] policy for the write request.
-Execution time field:: This field will be automatically set to the time the alert condition was detected.
-
-[float]
-[[index-action-configuration]]
-==== Action configuration
-
-Index actions have the following properties:
-
-Document:: The document to index in json format.
-
-[float]
-[[pagerduty-action-type]]
-=== PagerDuty
-
-The PagerDuty action type uses the https://v2.developer.pagerduty.com/docs/events-api-v2[v2 Events API] to trigger, acknowledge, and resolve PagerDuty alerts.
-
-[float]
-[[pagerduty-connector-configuration]]
-==== Connector configuration
+| Send email from your server.
-PagerDuty connectors have the following configuration properties:
+a| <>
-Name:: The name of the connector. The name is used to identify a connector in the management UI connector listing, or in the connector list when configuring an action.
-API URL:: An optional PagerDuty event URL. Defaults to `https://events.pagerduty.com/v2/enqueue`. If you are using the <> setting, make sure the hostname is whitelisted.
-Routing Key:: A 32 character PagerDuty Integration Key for an integration on a service or on a global ruleset.
+| Index data into Elasticsearch.
-[float]
-[[pagerduty-action-configuration]]
-==== Action configuration
+a| <>
-PagerDuty actions have the following properties:
+| Send an event in PagerDuty.
-Severity:: The perceived severity of on the affected system. This can be one of `Critical`, `Error`, `Warning` or `Info`(default).
-Event action:: One of `Trigger` (default), `Resolve`, or `Acknowledge`. See https://v2.developer.pagerduty.com/docs/events-api-v2#event-action[event action] for more details.
-Dedup Key:: All actions sharing this key will be associated with the same PagerDuty alert. This value is used to correlate trigger and resolution. This value is *optional*, and if unset defaults to `action:`. The maximum length is *255* characters. See https://v2.developer.pagerduty.com/docs/events-api-v2#alert-de-duplication[alert deduplication] for details.
-Timestamp:: An *optional* https://v2.developer.pagerduty.com/v2/docs/types#datetime[ISO-8601 format date-time], indicating the time the event was detected or generated.
-Component:: An *optional* value indicating the component of the source machine that is responsible for the event, for example `mysql` or `eth0`.
-Group:: An *optional* value indicating the logical grouping of components of a service, for example `app-stack`.
-Source:: An *optional* value indicating the affected system, preferably a hostname or fully qualified domain name. Defaults to the {kib} saved object id of the action.
-Summary:: An *optional* text summary of the event, defaults to `No summary provided`. The maximum length is 1024 characters.
-Class:: An *optional* value indicating the class/type of the event, for example `ping failure` or `cpu load`.
+a| <>
-For more details on these properties, see https://v2.developer.pagerduty.com/v2/docs/send-an-event-events-api-v2[PagerDuty v2 event parameters].
+| Add a message to a Kibana log.
-[float]
-[[server-log-action-type]]
-=== Server log
+a| <>
-This action type writes and entry to the {kib} server log.
+| Send a message to a Slack channel or user.
-[float]
-[[server-log-connector-configuration]]
-==== Connector configuration
+a| <>
-Server log connectors have the following configuration properties:
+| Send a request to a web service.
+|===
-Name:: The name of the connector. The name is used to identify a connector in the management UI connector listing, or in the connector list when configuring an action.
-
-[float]
-[[server-log-action-configuration]]
-==== Action configuration
-
-Server log actions have the following properties:
-
-Message:: The message to log.
-
-[float]
-[[slack-action-type]]
-=== Slack
-
-The Slack action type uses https://api.slack.com/incoming-webhooks[Slack Incoming Webhooks].
-
-[float]
-[[slack-connector-configuration]]
-==== Connector configuration
-
-Slack connectors have the following configuration properties:
-
-Name:: The name of the connector. The name is used to identify a connector in the management UI connector listing, or in the connector list when configuring an action.
-Webhook URL:: The URL of the incoming webhook. See https://api.slack.com/messaging/webhooks#getting_started[Slack Incoming Webhooks] for instructions on generating this URL. If you are using the <> setting, make sure the hostname is whitelisted.
-
-[float]
-[[slack-action-configuration]]
-==== Action configuration
-
-Slack actions have the following properties:
-
-Message:: The message text, converted to the `text` field in the Webhook JSON payload. Currently only the text field is supported. Markdown, images, and other advanced formatting are not yet supported.
-
-[float]
-[[webhook-action-type]]
-=== Webhook
-
-The Webhook action type uses https://github.com/axios/axios[axios] to send a POST or PUT request to a web service.
-
-[float]
-[[webhook-connector-configuration]]
-==== Connector configuration
-
-Webhook connectors have the following configuration properties:
-
-Name:: The name of the connector. The name is used to identify a connector in the management UI connector listing, or in the connector list when configuring an action.
-URL:: The request URL. If you are using the <> setting, make sure the hostname is whitelisted.
-Method:: HTTP request method, either `post`(default) or `put`.
-Headers:: A set of key-value pairs sent as headers with the request
-User:: An optional username. If set, HTTP basic authentication is used. Currently only basic authentication is supported.
-Password:: An optional password. If set, HTTP basic authentication is used. Currently only basic authentication is supported.
-
-[float]
-[[webhook-action-configuration]]
-==== Action configuration
-
-Webhook actions have the following properties:
+[NOTE]
+==============================================
+Some action types are paid commercial features, while others are free.
+For a comparison of the Elastic subscription levels,
+see https://www.elastic.co/subscriptions[the subscription page].
+==============================================
-Body:: A json payload sent to the request URL.
\ No newline at end of file
+include::action-types/email.asciidoc[]
+include::action-types/index.asciidoc[]
+include::action-types/pagerduty.asciidoc[]
+include::action-types/server-log.asciidoc[]
+include::action-types/slack.asciidoc[]
+include::action-types/webhook.asciidoc[]
diff --git a/docs/user/alerting/action-types/email.asciidoc b/docs/user/alerting/action-types/email.asciidoc
new file mode 100644
index 0000000000000..be3623dd9e59c
--- /dev/null
+++ b/docs/user/alerting/action-types/email.asciidoc
@@ -0,0 +1,29 @@
+[role="xpack"]
+[[email-action-type]]
+== Email action type
+
+The email action type uses the SMTP protocol to send mail message, using an integration of https://nodemailer.com/[Nodemailer]. Email message text is sent as both plain text and html text.
+
+[float]
+[[email-connector-configuration]]
+==== Connector configuration
+
+Email connectors have the following configuration properties:
+
+Name:: The name of the connector. The name is used to identify a connector in the management UI connector listing, or in the connector list when configuring an action.
+Sender:: The from address for all emails sent with this connector, specified in `user@host-name` format.
+Host:: Host name of the service provider. If you are using the <> setting, make sure this hostname is whitelisted.
+Port:: The port to connect to on the service provider.
+Secure:: If true the connection will use TLS when connecting to the service provider. See https://nodemailer.com/smtp/#tls-options[nodemailer TLS documentation] for more information.
+Username:: username for 'login' type authentication.
+Password:: password for 'login' type authentication.
+
+[float]
+[[email-action-configuration]]
+==== Action configuration
+
+Email actions have the following configuration properties:
+
+To, CC, BCC:: Each is a list of addresses. Addresses can be specified in `user@host-name` format, or in `name ` format. One of To, CC, or BCC must contain an entry.
+Subject:: The subject line of the email.
+Message:: The message text of the email. Markdown format is supported.
\ No newline at end of file
diff --git a/docs/user/alerting/action-types/index.asciidoc b/docs/user/alerting/action-types/index.asciidoc
new file mode 100644
index 0000000000000..75d9e57b1f212
--- /dev/null
+++ b/docs/user/alerting/action-types/index.asciidoc
@@ -0,0 +1,24 @@
+[role="xpack"]
+[[index-action-type]]
+== Index action type
+
+The index action type will index a document into {es}.
+
+[float]
+[[index-connector-configuration]]
+==== Connector configuration
+
+Index connectors have the following configuration properties:
+
+Name:: The name of the connector. The name is used to identify a connector in the management UI connector listing, or in the connector list when configuring an action.
+Index:: The {es} index to be written to.
+Refresh:: Setting for the {ref}/docs-refresh.html[refresh] policy for the write request.
+Execution time field:: This field will be automatically set to the time the alert condition was detected.
+
+[float]
+[[index-action-configuration]]
+==== Action configuration
+
+Index actions have the following properties:
+
+Document:: The document to index in json format.
\ No newline at end of file
diff --git a/docs/user/alerting/action-types/pagerduty.asciidoc b/docs/user/alerting/action-types/pagerduty.asciidoc
new file mode 100644
index 0000000000000..50a1f31e4a9ae
--- /dev/null
+++ b/docs/user/alerting/action-types/pagerduty.asciidoc
@@ -0,0 +1,33 @@
+[role="xpack"]
+[[pagerduty-action-type]]
+== PagerDuty action type
+
+The PagerDuty action type uses the https://v2.developer.pagerduty.com/docs/events-api-v2[v2 Events API] to trigger, acknowledge, and resolve PagerDuty alerts.
+
+[float]
+[[pagerduty-connector-configuration]]
+==== Connector configuration
+
+PagerDuty connectors have the following configuration properties:
+
+Name:: The name of the connector. The name is used to identify a connector in the management UI connector listing, or in the connector list when configuring an action.
+API URL:: An optional PagerDuty event URL. Defaults to `https://events.pagerduty.com/v2/enqueue`. If you are using the <> setting, make sure the hostname is whitelisted.
+Routing Key:: A 32 character PagerDuty Integration Key for an integration on a service or on a global ruleset.
+
+[float]
+[[pagerduty-action-configuration]]
+==== Action configuration
+
+PagerDuty actions have the following properties:
+
+Severity:: The perceived severity of on the affected system. This can be one of `Critical`, `Error`, `Warning` or `Info`(default).
+Event action:: One of `Trigger` (default), `Resolve`, or `Acknowledge`. See https://v2.developer.pagerduty.com/docs/events-api-v2#event-action[event action] for more details.
+Dedup Key:: All actions sharing this key will be associated with the same PagerDuty alert. This value is used to correlate trigger and resolution. This value is *optional*, and if unset defaults to `action:`. The maximum length is *255* characters. See https://v2.developer.pagerduty.com/docs/events-api-v2#alert-de-duplication[alert deduplication] for details.
+Timestamp:: An *optional* https://v2.developer.pagerduty.com/v2/docs/types#datetime[ISO-8601 format date-time], indicating the time the event was detected or generated.
+Component:: An *optional* value indicating the component of the source machine that is responsible for the event, for example `mysql` or `eth0`.
+Group:: An *optional* value indicating the logical grouping of components of a service, for example `app-stack`.
+Source:: An *optional* value indicating the affected system, preferably a hostname or fully qualified domain name. Defaults to the {kib} saved object id of the action.
+Summary:: An *optional* text summary of the event, defaults to `No summary provided`. The maximum length is 1024 characters.
+Class:: An *optional* value indicating the class/type of the event, for example `ping failure` or `cpu load`.
+
+For more details on these properties, see https://v2.developer.pagerduty.com/v2/docs/send-an-event-events-api-v2[PagerDuty v2 event parameters].
\ No newline at end of file
diff --git a/docs/user/alerting/action-types/server-log.asciidoc b/docs/user/alerting/action-types/server-log.asciidoc
new file mode 100644
index 0000000000000..4efbdf3bea099
--- /dev/null
+++ b/docs/user/alerting/action-types/server-log.asciidoc
@@ -0,0 +1,21 @@
+[role="xpack"]
+[[server-log-action-type]]
+== Server log action type
+
+This action type writes and entry to the {kib} server log.
+
+[float]
+[[server-log-connector-configuration]]
+==== Connector configuration
+
+Server log connectors have the following configuration properties:
+
+Name:: The name of the connector. The name is used to identify a connector in the management UI connector listing, or in the connector list when configuring an action.
+
+[float]
+[[server-log-action-configuration]]
+==== Action configuration
+
+Server log actions have the following properties:
+
+Message:: The message to log.
\ No newline at end of file
diff --git a/docs/user/alerting/action-types/slack.asciidoc b/docs/user/alerting/action-types/slack.asciidoc
new file mode 100644
index 0000000000000..a4bacbf162e46
--- /dev/null
+++ b/docs/user/alerting/action-types/slack.asciidoc
@@ -0,0 +1,22 @@
+[role="xpack"]
+[[slack-action-type]]
+== Slack action type
+
+The Slack action type uses https://api.slack.com/incoming-webhooks[Slack Incoming Webhooks].
+
+[float]
+[[slack-connector-configuration]]
+==== Connector configuration
+
+Slack connectors have the following configuration properties:
+
+Name:: The name of the connector. The name is used to identify a connector in the management UI connector listing, or in the connector list when configuring an action.
+Webhook URL:: The URL of the incoming webhook. See https://api.slack.com/messaging/webhooks#getting_started[Slack Incoming Webhooks] for instructions on generating this URL. If you are using the <> setting, make sure the hostname is whitelisted.
+
+[float]
+[[slack-action-configuration]]
+==== Action configuration
+
+Slack actions have the following properties:
+
+Message:: The message text, converted to the `text` field in the Webhook JSON payload. Currently only the text field is supported. Markdown, images, and other advanced formatting are not yet supported.
\ No newline at end of file
diff --git a/docs/user/alerting/action-types/webhook.asciidoc b/docs/user/alerting/action-types/webhook.asciidoc
new file mode 100644
index 0000000000000..8c211aa83af89
--- /dev/null
+++ b/docs/user/alerting/action-types/webhook.asciidoc
@@ -0,0 +1,26 @@
+[role="xpack"]
+[[webhook-action-type]]
+== Webhook action type
+
+The Webhook action type uses https://github.com/axios/axios[axios] to send a POST or PUT request to a web service.
+
+[float]
+[[webhook-connector-configuration]]
+==== Connector configuration
+
+Webhook connectors have the following configuration properties:
+
+Name:: The name of the connector. The name is used to identify a connector in the management UI connector listing, or in the connector list when configuring an action.
+URL:: The request URL. If you are using the <> setting, make sure the hostname is whitelisted.
+Method:: HTTP request method, either `post`(default) or `put`.
+Headers:: A set of key-value pairs sent as headers with the request
+User:: An optional username. If set, HTTP basic authentication is used. Currently only basic authentication is supported.
+Password:: An optional password. If set, HTTP basic authentication is used. Currently only basic authentication is supported.
+
+[float]
+[[webhook-action-configuration]]
+==== Action configuration
+
+Webhook actions have the following properties:
+
+Body:: A json payload sent to the request URL.
\ No newline at end of file
diff --git a/docs/user/alerting/index.asciidoc b/docs/user/alerting/index.asciidoc
index c7cf1186a44be..df11f5f03a7de 100644
--- a/docs/user/alerting/index.asciidoc
+++ b/docs/user/alerting/index.asciidoc
@@ -154,10 +154,13 @@ Pre-packaged *alert types* simplify setup, hide the details complex domain-speci
[[alerting-setup-prerequisites]]
== Setup and prerequisites
+If you are using an *on-premises* Elastic Stack deployment:
+
+* In the kibana.yml configuration file, add the <> setting.
+
If you are using an *on-premises* Elastic Stack deployment with <>:
-* TLS must be configured for communication <>. {kib} alerting uses <> to secure background alert checks and actions, and API keys require {ref}/configuring-tls.html#tls-http[TLS on the HTTP interface].
-* In the kibana.yml configuration file, add the <>
+* Transport Layer Security (TLS) must be configured for communication <>. {kib} alerting uses <> to secure background alert checks and actions, and API keys require {ref}/configuring-tls.html#tls-http[TLS on the HTTP interface].
[float]
[[alerting-security]]
diff --git a/docs/user/management.asciidoc b/docs/user/management.asciidoc
index fa34802abe2a9..a4ba320e826b1 100644
--- a/docs/user/management.asciidoc
+++ b/docs/user/management.asciidoc
@@ -13,7 +13,7 @@ indices, clusters, licenses, UI settings, index patterns, spaces, and more.
[cols="50, 50"]
|===
-a| <>
+a| <>
Replicate indices on a remote cluster and copy them to a follower index on a local cluster.
This is important for
@@ -85,7 +85,8 @@ set the timespan for notification messages, and much more.
| <>
-Centrally manage your alerts from across {kib}. Create and manage re-usable connectors for triggering actions.
+Centrally manage your alerts across {kib}. Create and manage reusable
+connectors for triggering actions.
| <>
@@ -125,6 +126,8 @@ include::{kib-repo-dir}/management/alerting/connector-management.asciidoc[]
include::{kib-repo-dir}/management/managing-beats.asciidoc[]
+include::{kib-repo-dir}/management/managing-ccr.asciidoc[]
+
include::{kib-repo-dir}/management/index-lifecycle-policies/intro-to-lifecycle-policies.asciidoc[]
include::{kib-repo-dir}/management/index-lifecycle-policies/create-policy.asciidoc[]
diff --git a/docs/user/reporting/chromium-sandbox.asciidoc b/docs/user/reporting/chromium-sandbox.asciidoc
index 5d4fbfb153a0b..bfef5b8b86c6b 100644
--- a/docs/user/reporting/chromium-sandbox.asciidoc
+++ b/docs/user/reporting/chromium-sandbox.asciidoc
@@ -11,12 +11,12 @@ sandboxing techniques differ for each operating system.
The Linux sandbox depends on user namespaces, which were introduced with the 3.8 Linux kernel. However, many
distributions don't have user namespaces enabled by default, or they require the CAP_SYS_ADMIN capability. {reporting}
will automatically disable the sandbox when it is running on Debian and CentOS as additional steps are required to enable
-unprivileged usernamespaces. In these situations, you'll see the following message in your {kib} logs:
-`Enabling the Chromium sandbox provides an additional layer of protection`.
+unprivileged usernamespaces. In these situations, you'll see the following message in your {kib} startup logs:
+`Chromium sandbox provides an additional layer of protection, but is not supported for your OS.
+Automatically setting 'xpack.reporting.capture.browser.chromium.disableSandbox: true'.`
-If your kernel is 3.8 or newer, it's
-recommended to enable usernamespaces and set `xpack.reporting.capture.browser.chromium.disableSandbox: false` in your
-`kibana.yml` to enable the sandbox.
+Reporting will automatically enable the Chromium sandbox at startup when a supported OS is detected. However, if your kernel is 3.8 or newer, it's
+recommended to set `xpack.reporting.capture.browser.chromium.disableSandbox: false` in your `kibana.yml` to explicitly enable usernamespaces.
==== Docker
When running {kib} in a Docker container, all container processes are run within a usernamespace with seccomp-bpf and
diff --git a/examples/embeddable_examples/common/index.ts b/examples/embeddable_examples/common/index.ts
new file mode 100644
index 0000000000000..726420fb9bdc3
--- /dev/null
+++ b/examples/embeddable_examples/common/index.ts
@@ -0,0 +1,20 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+export { TodoSavedObjectAttributes } from './todo_saved_object_attributes';
diff --git a/examples/embeddable_examples/common/todo_saved_object_attributes.ts b/examples/embeddable_examples/common/todo_saved_object_attributes.ts
new file mode 100644
index 0000000000000..21b6df20fea90
--- /dev/null
+++ b/examples/embeddable_examples/common/todo_saved_object_attributes.ts
@@ -0,0 +1,26 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { SavedObjectAttributes } from '../../../src/core/types';
+
+export interface TodoSavedObjectAttributes extends SavedObjectAttributes {
+ task: string;
+ icon?: string;
+ title?: string;
+}
diff --git a/examples/embeddable_examples/kibana.json b/examples/embeddable_examples/kibana.json
index c70bc7009ff51..f446e7f31ac8e 100644
--- a/examples/embeddable_examples/kibana.json
+++ b/examples/embeddable_examples/kibana.json
@@ -3,7 +3,7 @@
"version": "0.0.1",
"kibanaVersion": "kibana",
"configPath": ["embeddable_examples"],
- "server": false,
+ "server": true,
"ui": true,
"requiredPlugins": ["embeddable"],
"optionalPlugins": []
diff --git a/examples/embeddable_examples/public/create_sample_data.ts b/examples/embeddable_examples/public/create_sample_data.ts
new file mode 100644
index 0000000000000..bd5ade18aa91e
--- /dev/null
+++ b/examples/embeddable_examples/public/create_sample_data.ts
@@ -0,0 +1,36 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { SavedObjectsClientContract } from 'kibana/public';
+import { TodoSavedObjectAttributes } from '../common';
+
+export async function createSampleData(client: SavedObjectsClientContract) {
+ await client.create(
+ 'todo',
+ {
+ task: 'Take the garbage out',
+ title: 'Garbage',
+ icon: 'trash',
+ },
+ {
+ id: 'sample-todo-saved-object',
+ overwrite: true,
+ }
+ );
+}
diff --git a/examples/embeddable_examples/public/index.ts b/examples/embeddable_examples/public/index.ts
index 5fcd454b17a5c..4aac63fb52e2b 100644
--- a/examples/embeddable_examples/public/index.ts
+++ b/examples/embeddable_examples/public/index.ts
@@ -17,7 +17,6 @@
* under the License.
*/
-import { PluginInitializer } from 'kibana/public';
export {
HELLO_WORLD_EMBEDDABLE,
HelloWorldEmbeddable,
@@ -26,18 +25,8 @@ export {
export { ListContainer, LIST_CONTAINER } from './list_container';
export { TODO_EMBEDDABLE } from './todo';
-import {
- EmbeddableExamplesPlugin,
- EmbeddableExamplesSetupDependencies,
- EmbeddableExamplesStartDependencies,
-} from './plugin';
+import { EmbeddableExamplesPlugin } from './plugin';
export { SearchableListContainer, SEARCHABLE_LIST_CONTAINER } from './searchable_list_container';
export { MULTI_TASK_TODO_EMBEDDABLE } from './multi_task_todo';
-
-export const plugin: PluginInitializer<
- void,
- void,
- EmbeddableExamplesSetupDependencies,
- EmbeddableExamplesStartDependencies
-> = () => new EmbeddableExamplesPlugin();
+export const plugin = () => new EmbeddableExamplesPlugin();
diff --git a/examples/embeddable_examples/public/plugin.ts b/examples/embeddable_examples/public/plugin.ts
index 31a3037332dda..75d34d2d6878f 100644
--- a/examples/embeddable_examples/public/plugin.ts
+++ b/examples/embeddable_examples/public/plugin.ts
@@ -21,12 +21,20 @@ import { EmbeddableSetup, EmbeddableStart } from '../../../src/plugins/embeddabl
import { Plugin, CoreSetup, CoreStart } from '../../../src/core/public';
import { HelloWorldEmbeddableFactory, HELLO_WORLD_EMBEDDABLE } from './hello_world';
import { TODO_EMBEDDABLE, TodoEmbeddableFactory, TodoInput, TodoOutput } from './todo';
-import { MULTI_TASK_TODO_EMBEDDABLE, MultiTaskTodoEmbeddableFactory } from './multi_task_todo';
+import {
+ MULTI_TASK_TODO_EMBEDDABLE,
+ MultiTaskTodoEmbeddableFactory,
+ MultiTaskTodoInput,
+ MultiTaskTodoOutput,
+} from './multi_task_todo';
import {
SEARCHABLE_LIST_CONTAINER,
SearchableListContainerFactory,
} from './searchable_list_container';
import { LIST_CONTAINER, ListContainerFactory } from './list_container';
+import { createSampleData } from './create_sample_data';
+import { TodoRefInput, TodoRefOutput, TODO_REF_EMBEDDABLE } from './todo/todo_ref_embeddable';
+import { TodoRefEmbeddableFactory } from './todo/todo_ref_embeddable_factory';
export interface EmbeddableExamplesSetupDependencies {
embeddable: EmbeddableSetup;
@@ -36,9 +44,18 @@ export interface EmbeddableExamplesStartDependencies {
embeddable: EmbeddableStart;
}
+export interface EmbeddableExamplesStart {
+ createSampleData: () => Promise;
+}
+
export class EmbeddableExamplesPlugin
implements
- Plugin {
+ Plugin<
+ void,
+ EmbeddableExamplesStart,
+ EmbeddableExamplesSetupDependencies,
+ EmbeddableExamplesStartDependencies
+ > {
public setup(
core: CoreSetup,
deps: EmbeddableExamplesSetupDependencies
@@ -48,7 +65,7 @@ export class EmbeddableExamplesPlugin
new HelloWorldEmbeddableFactory()
);
- deps.embeddable.registerEmbeddableFactory(
+ deps.embeddable.registerEmbeddableFactory(
MULTI_TASK_TODO_EMBEDDABLE,
new MultiTaskTodoEmbeddableFactory()
);
@@ -73,9 +90,21 @@ export class EmbeddableExamplesPlugin
openModal: (await core.getStartServices())[0].overlays.openModal,
}))
);
+
+ deps.embeddable.registerEmbeddableFactory(
+ TODO_REF_EMBEDDABLE,
+ new TodoRefEmbeddableFactory(async () => ({
+ savedObjectsClient: (await core.getStartServices())[0].savedObjects.client,
+ getEmbeddableFactory: (await core.getStartServices())[1].embeddable.getEmbeddableFactory,
+ }))
+ );
}
- public start(core: CoreStart, deps: EmbeddableExamplesStartDependencies) {}
+ public start(core: CoreStart, deps: EmbeddableExamplesStartDependencies) {
+ return {
+ createSampleData: () => createSampleData(core.savedObjects.client),
+ };
+ }
public stop() {}
}
diff --git a/examples/embeddable_examples/public/todo/README.md b/examples/embeddable_examples/public/todo/README.md
new file mode 100644
index 0000000000000..e782511f093b3
--- /dev/null
+++ b/examples/embeddable_examples/public/todo/README.md
@@ -0,0 +1,43 @@
+There are two examples in here:
+ - TodoEmbeddable
+ - TodoRefEmbeddable
+
+ # TodoEmbeddable
+
+ The first example you should review is the HelloWorldEmbeddable. That is as basic an embeddable as you can get.
+ This embeddable is the next step up - an embeddable that renders dynamic input data. The data is simple:
+ - a required task string
+ - an optional title
+ - an optional icon string
+ - an optional search string
+
+It also has output data, which is `hasMatch` - whether or not the search string has matched any input data.
+
+`hasMatch` is a better fit for output data than input data, because it's state that is _derived_ from input data.
+
+For example, if it was input data, you could create a TodoEmbeddable with input like this:
+
+```ts
+ todoEmbeddableFactory.create({ task: 'take out the garabage', search: 'garbage', hasMatch: false });
+```
+
+That's wrong because there is actually a match from the search string inside the task.
+
+The TodoEmbeddable component itself doesn't do anything with the `hasMatch` variable other than set it, but
+if you check out `SearchableListContainer`, you can see an example where this output data is being used.
+
+## TodoRefEmbeddable
+
+This is an example of an embeddable based off of a saved object. The input is just the `savedObjectId` and
+the `search` string. It has even more output parameters, and this time, it does read it's own output parameters in
+order to calculate `hasMatch`.
+
+Output:
+```ts
+{
+ hasMatch: boolean,
+ savedAttributes?: TodoSavedAttributes
+}
+```
+
+`savedAttributes` is optional because it's possible a TodoSavedObject could not be found with the given savedObjectId.
diff --git a/examples/embeddable_examples/public/todo/todo_ref_component.tsx b/examples/embeddable_examples/public/todo/todo_ref_component.tsx
new file mode 100644
index 0000000000000..8e0a17be1ec72
--- /dev/null
+++ b/examples/embeddable_examples/public/todo/todo_ref_component.tsx
@@ -0,0 +1,86 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+import React from 'react';
+import { EuiFlexItem, EuiFlexGroup } from '@elastic/eui';
+
+import { EuiText } from '@elastic/eui';
+import { EuiAvatar } from '@elastic/eui';
+import { EuiIcon } from '@elastic/eui';
+import { EuiFlexGrid } from '@elastic/eui';
+import { withEmbeddableSubscription } from '../../../../src/plugins/embeddable/public';
+import { TodoRefInput, TodoRefOutput, TodoRefEmbeddable } from './todo_ref_embeddable';
+
+interface Props {
+ embeddable: TodoRefEmbeddable;
+ input: TodoRefInput;
+ output: TodoRefOutput;
+}
+
+function wrapSearchTerms(task?: string, search?: string) {
+ if (!search) return task;
+ if (!task) return task;
+ const parts = task.split(new RegExp(`(${search})`, 'g'));
+ return parts.map((part, i) =>
+ part === search ? (
+
+ {part}
+
+ ) : (
+ part
+ )
+ );
+}
+
+export function TodoRefEmbeddableComponentInner({
+ input: { search },
+ output: { savedAttributes },
+}: Props) {
+ const icon = savedAttributes?.icon;
+ const title = savedAttributes?.title;
+ const task = savedAttributes?.task;
+ return (
+
+
+ {icon ? (
+
+ ) : (
+
+ )}
+
+
+
+
+
+ {wrapSearchTerms(title || '', search)}
+
+
+
+ {wrapSearchTerms(task, search)}
+
+
+
+
+ );
+}
+
+export const TodoRefEmbeddableComponent = withEmbeddableSubscription<
+ TodoRefInput,
+ TodoRefOutput,
+ TodoRefEmbeddable
+>(TodoRefEmbeddableComponentInner);
diff --git a/examples/embeddable_examples/public/todo/todo_ref_embeddable.tsx b/examples/embeddable_examples/public/todo/todo_ref_embeddable.tsx
new file mode 100644
index 0000000000000..da2dfb2c1a290
--- /dev/null
+++ b/examples/embeddable_examples/public/todo/todo_ref_embeddable.tsx
@@ -0,0 +1,153 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+import React from 'react';
+import ReactDOM from 'react-dom';
+import { Subscription } from 'rxjs';
+import { TodoSavedObjectAttributes } from 'examples/embeddable_examples/common';
+import { SavedObjectsClientContract } from 'kibana/public';
+import {
+ Embeddable,
+ IContainer,
+ EmbeddableOutput,
+ SavedObjectEmbeddableInput,
+} from '../../../../src/plugins/embeddable/public';
+import { TodoRefEmbeddableComponent } from './todo_ref_component';
+
+// Notice this is not the same value as the 'todo' saved object type. Many of our
+// cases in prod today use the same value, but this is unnecessary.
+export const TODO_REF_EMBEDDABLE = 'TODO_REF_EMBEDDABLE';
+
+export interface TodoRefInput extends SavedObjectEmbeddableInput {
+ /**
+ * Optional search string which will be used to highlight search terms as
+ * well as calculate `output.hasMatch`.
+ */
+ search?: string;
+}
+
+export interface TodoRefOutput extends EmbeddableOutput {
+ /**
+ * Should be true if input.search is defined and the task or title contain
+ * search as a substring.
+ */
+ hasMatch: boolean;
+ /**
+ * Will contain the saved object attributes of the Todo Saved Object that matches
+ * `input.savedObjectId`. If the id is invalid, this may be undefined.
+ */
+ savedAttributes?: TodoSavedObjectAttributes;
+}
+
+/**
+ * Returns whether any attributes contain the search string. If search is empty, true is returned. If
+ * there are no savedAttributes, false is returned.
+ * @param search - the search string
+ * @param savedAttributes - the saved object attributes for the saved object with id `input.savedObjectId`
+ */
+function getHasMatch(search?: string, savedAttributes?: TodoSavedObjectAttributes): boolean {
+ if (!search) return true;
+ if (!savedAttributes) return false;
+ return Boolean(
+ (savedAttributes.task && savedAttributes.task.match(search)) ||
+ (savedAttributes.title && savedAttributes.title.match(search))
+ );
+}
+
+/**
+ * This is an example of an embeddable that is backed by a saved object. It's essentially the
+ * same as `TodoEmbeddable` but that is "by value", while this is "by reference".
+ */
+export class TodoRefEmbeddable extends Embeddable {
+ public readonly type = TODO_REF_EMBEDDABLE;
+ private subscription: Subscription;
+ private node?: HTMLElement;
+ private savedObjectsClient: SavedObjectsClientContract;
+ private savedObjectId?: string;
+
+ constructor(
+ initialInput: TodoRefInput,
+ {
+ parent,
+ savedObjectsClient,
+ }: {
+ parent?: IContainer;
+ savedObjectsClient: SavedObjectsClientContract;
+ }
+ ) {
+ super(initialInput, { hasMatch: false }, parent);
+ this.savedObjectsClient = savedObjectsClient;
+
+ this.subscription = this.getInput$().subscribe(async () => {
+ // There is a little more work today for this embeddable because it has
+ // more output it needs to update in response to input state changes.
+ let savedAttributes: TodoSavedObjectAttributes | undefined;
+
+ // Since this is an expensive task, we save a local copy of the previous
+ // savedObjectId locally and only retrieve the new saved object if the id
+ // actually changed.
+ if (this.savedObjectId !== this.input.savedObjectId) {
+ this.savedObjectId = this.input.savedObjectId;
+ const todoSavedObject = await this.savedObjectsClient.get(
+ 'todo',
+ this.input.savedObjectId
+ );
+ savedAttributes = todoSavedObject?.attributes;
+ }
+
+ // The search string might have changed as well so we need to make sure we recalculate
+ // hasMatch.
+ this.updateOutput({
+ hasMatch: getHasMatch(this.input.search, savedAttributes),
+ savedAttributes,
+ });
+ });
+ }
+
+ public render(node: HTMLElement) {
+ if (this.node) {
+ ReactDOM.unmountComponentAtNode(this.node);
+ }
+ this.node = node;
+ ReactDOM.render(, node);
+ }
+
+ /**
+ * Lets re-sync our saved object to make sure it's up to date!
+ */
+ public async reload() {
+ this.savedObjectId = this.input.savedObjectId;
+ const todoSavedObject = await this.savedObjectsClient.get(
+ 'todo',
+ this.input.savedObjectId
+ );
+ const savedAttributes = todoSavedObject?.attributes;
+ this.updateOutput({
+ hasMatch: getHasMatch(this.input.search, savedAttributes),
+ savedAttributes,
+ });
+ }
+
+ public destroy() {
+ super.destroy();
+ this.subscription.unsubscribe();
+ if (this.node) {
+ ReactDOM.unmountComponentAtNode(this.node);
+ }
+ }
+}
diff --git a/examples/embeddable_examples/public/todo/todo_ref_embeddable_factory.tsx b/examples/embeddable_examples/public/todo/todo_ref_embeddable_factory.tsx
new file mode 100644
index 0000000000000..e585ddd89674f
--- /dev/null
+++ b/examples/embeddable_examples/public/todo/todo_ref_embeddable_factory.tsx
@@ -0,0 +1,83 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+import { i18n } from '@kbn/i18n';
+import { SavedObjectsClientContract } from 'kibana/public';
+import { TodoSavedObjectAttributes } from 'examples/embeddable_examples/common';
+import {
+ IContainer,
+ EmbeddableStart,
+ ErrorEmbeddable,
+ EmbeddableFactoryDefinition,
+} from '../../../../src/plugins/embeddable/public';
+import {
+ TodoRefEmbeddable,
+ TODO_REF_EMBEDDABLE,
+ TodoRefInput,
+ TodoRefOutput,
+} from './todo_ref_embeddable';
+
+interface StartServices {
+ getEmbeddableFactory: EmbeddableStart['getEmbeddableFactory'];
+ savedObjectsClient: SavedObjectsClientContract;
+}
+
+export class TodoRefEmbeddableFactory
+ implements
+ EmbeddableFactoryDefinition<
+ TodoRefInput,
+ TodoRefOutput,
+ TodoRefEmbeddable,
+ TodoSavedObjectAttributes
+ > {
+ public readonly type = TODO_REF_EMBEDDABLE;
+ public readonly savedObjectMetaData = {
+ name: 'Todo',
+ includeFields: ['task', 'icon', 'title'],
+ type: 'todo',
+ getIconForSavedObject: () => 'pencil',
+ };
+
+ constructor(private getStartServices: () => Promise) {}
+
+ public async isEditable() {
+ return true;
+ }
+
+ public createFromSavedObject = (
+ savedObjectId: string,
+ input: Partial & { id: string },
+ parent?: IContainer
+ ): Promise => {
+ return this.create({ ...input, savedObjectId }, parent);
+ };
+
+ public async create(input: TodoRefInput, parent?: IContainer) {
+ const { savedObjectsClient } = await this.getStartServices();
+ return new TodoRefEmbeddable(input, {
+ parent,
+ savedObjectsClient,
+ });
+ }
+
+ public getDisplayName() {
+ return i18n.translate('embeddableExamples.todo.displayName', {
+ defaultMessage: 'Todo (by reference)',
+ });
+ }
+}
diff --git a/examples/embeddable_examples/server/index.ts b/examples/embeddable_examples/server/index.ts
new file mode 100644
index 0000000000000..9ddc3bc2cf715
--- /dev/null
+++ b/examples/embeddable_examples/server/index.ts
@@ -0,0 +1,24 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { PluginInitializer } from 'kibana/server';
+
+import { EmbeddableExamplesPlugin } from './plugin';
+
+export const plugin: PluginInitializer = () => new EmbeddableExamplesPlugin();
diff --git a/examples/embeddable_examples/server/plugin.ts b/examples/embeddable_examples/server/plugin.ts
new file mode 100644
index 0000000000000..d956b834d0d3c
--- /dev/null
+++ b/examples/embeddable_examples/server/plugin.ts
@@ -0,0 +1,31 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { Plugin, CoreSetup, CoreStart } from 'kibana/server';
+import { todoSavedObject } from './todo_saved_object';
+
+export class EmbeddableExamplesPlugin implements Plugin {
+ public setup(core: CoreSetup) {
+ core.savedObjects.registerType(todoSavedObject);
+ }
+
+ public start(core: CoreStart) {}
+
+ public stop() {}
+}
diff --git a/examples/embeddable_examples/server/todo_saved_object.ts b/examples/embeddable_examples/server/todo_saved_object.ts
new file mode 100644
index 0000000000000..58da2014de498
--- /dev/null
+++ b/examples/embeddable_examples/server/todo_saved_object.ts
@@ -0,0 +1,40 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { SavedObjectsType } from 'kibana/server';
+
+export const todoSavedObject: SavedObjectsType = {
+ name: 'todo',
+ hidden: false,
+ namespaceType: 'agnostic',
+ mappings: {
+ properties: {
+ title: {
+ type: 'keyword',
+ },
+ task: {
+ type: 'text',
+ },
+ icon: {
+ type: 'keyword',
+ },
+ },
+ },
+ migrations: {},
+};
diff --git a/examples/embeddable_examples/tsconfig.json b/examples/embeddable_examples/tsconfig.json
index 091130487791b..7fa03739119b4 100644
--- a/examples/embeddable_examples/tsconfig.json
+++ b/examples/embeddable_examples/tsconfig.json
@@ -6,6 +6,7 @@
},
"include": [
"index.ts",
+ "common/**/*.ts",
"public/**/*.ts",
"public/**/*.tsx",
"server/**/*.ts",
diff --git a/examples/embeddable_explorer/public/plugin.tsx b/examples/embeddable_explorer/public/plugin.tsx
index 7c75b108d9912..bba1b1748e207 100644
--- a/examples/embeddable_explorer/public/plugin.tsx
+++ b/examples/embeddable_explorer/public/plugin.tsx
@@ -18,6 +18,7 @@
*/
import { Plugin, CoreSetup, AppMountParameters } from 'kibana/public';
+import { EmbeddableExamplesStart } from 'examples/embeddable_examples/public/plugin';
import { UiActionsService } from '../../../src/plugins/ui_actions/public';
import { EmbeddableStart } from '../../../src/plugins/embeddable/public';
import { Start as InspectorStart } from '../../../src/plugins/inspector/public';
@@ -26,6 +27,7 @@ interface StartDeps {
uiActions: UiActionsService;
embeddable: EmbeddableStart;
inspector: InspectorStart;
+ embeddableExamples: EmbeddableExamplesStart;
}
export class EmbeddableExplorerPlugin implements Plugin {
@@ -36,6 +38,7 @@ export class EmbeddableExplorerPlugin implements Plugin false;
@@ -81456,11 +81449,11 @@ module.exports.generateTasks = pkg.generateTasks;
Object.defineProperty(exports, "__esModule", { value: true });
var optionsManager = __webpack_require__(719);
var taskManager = __webpack_require__(720);
-var reader_async_1 = __webpack_require__(871);
-var reader_stream_1 = __webpack_require__(895);
-var reader_sync_1 = __webpack_require__(896);
-var arrayUtils = __webpack_require__(898);
-var streamUtils = __webpack_require__(899);
+var reader_async_1 = __webpack_require__(876);
+var reader_stream_1 = __webpack_require__(900);
+var reader_sync_1 = __webpack_require__(901);
+var arrayUtils = __webpack_require__(903);
+var streamUtils = __webpack_require__(904);
/**
* Synchronous API.
*/
@@ -82100,9 +82093,9 @@ var extend = __webpack_require__(837);
*/
var compilers = __webpack_require__(840);
-var parsers = __webpack_require__(867);
-var cache = __webpack_require__(868);
-var utils = __webpack_require__(869);
+var parsers = __webpack_require__(872);
+var cache = __webpack_require__(873);
+var utils = __webpack_require__(874);
var MAX_LENGTH = 1024 * 64;
/**
@@ -100635,9 +100628,9 @@ var toRegex = __webpack_require__(728);
*/
var compilers = __webpack_require__(857);
-var parsers = __webpack_require__(863);
-var Extglob = __webpack_require__(866);
-var utils = __webpack_require__(865);
+var parsers = __webpack_require__(868);
+var Extglob = __webpack_require__(871);
+var utils = __webpack_require__(870);
var MAX_LENGTH = 1024 * 64;
/**
@@ -101147,7 +101140,7 @@ var parsers = __webpack_require__(861);
* Module dependencies
*/
-var debug = __webpack_require__(800)('expand-brackets');
+var debug = __webpack_require__(863)('expand-brackets');
var extend = __webpack_require__(737);
var Snapdragon = __webpack_require__(767);
var toRegex = __webpack_require__(728);
@@ -101741,12 +101734,839 @@ exports.createRegex = function(pattern, include) {
/* 863 */
/***/ (function(module, exports, __webpack_require__) {
+/**
+ * Detect Electron renderer process, which is node, but we should
+ * treat as a browser.
+ */
+
+if (typeof process !== 'undefined' && process.type === 'renderer') {
+ module.exports = __webpack_require__(864);
+} else {
+ module.exports = __webpack_require__(867);
+}
+
+
+/***/ }),
+/* 864 */
+/***/ (function(module, exports, __webpack_require__) {
+
+/**
+ * This is the web browser implementation of `debug()`.
+ *
+ * Expose `debug()` as the module.
+ */
+
+exports = module.exports = __webpack_require__(865);
+exports.log = log;
+exports.formatArgs = formatArgs;
+exports.save = save;
+exports.load = load;
+exports.useColors = useColors;
+exports.storage = 'undefined' != typeof chrome
+ && 'undefined' != typeof chrome.storage
+ ? chrome.storage.local
+ : localstorage();
+
+/**
+ * Colors.
+ */
+
+exports.colors = [
+ 'lightseagreen',
+ 'forestgreen',
+ 'goldenrod',
+ 'dodgerblue',
+ 'darkorchid',
+ 'crimson'
+];
+
+/**
+ * Currently only WebKit-based Web Inspectors, Firefox >= v31,
+ * and the Firebug extension (any Firefox version) are known
+ * to support "%c" CSS customizations.
+ *
+ * TODO: add a `localStorage` variable to explicitly enable/disable colors
+ */
+
+function useColors() {
+ // NB: In an Electron preload script, document will be defined but not fully
+ // initialized. Since we know we're in Chrome, we'll just detect this case
+ // explicitly
+ if (typeof window !== 'undefined' && window.process && window.process.type === 'renderer') {
+ return true;
+ }
+
+ // is webkit? http://stackoverflow.com/a/16459606/376773
+ // document is undefined in react-native: https://github.com/facebook/react-native/pull/1632
+ return (typeof document !== 'undefined' && document.documentElement && document.documentElement.style && document.documentElement.style.WebkitAppearance) ||
+ // is firebug? http://stackoverflow.com/a/398120/376773
+ (typeof window !== 'undefined' && window.console && (window.console.firebug || (window.console.exception && window.console.table))) ||
+ // is firefox >= v31?
+ // https://developer.mozilla.org/en-US/docs/Tools/Web_Console#Styling_messages
+ (typeof navigator !== 'undefined' && navigator.userAgent && navigator.userAgent.toLowerCase().match(/firefox\/(\d+)/) && parseInt(RegExp.$1, 10) >= 31) ||
+ // double check webkit in userAgent just in case we are in a worker
+ (typeof navigator !== 'undefined' && navigator.userAgent && navigator.userAgent.toLowerCase().match(/applewebkit\/(\d+)/));
+}
+
+/**
+ * Map %j to `JSON.stringify()`, since no Web Inspectors do that by default.
+ */
+
+exports.formatters.j = function(v) {
+ try {
+ return JSON.stringify(v);
+ } catch (err) {
+ return '[UnexpectedJSONParseError]: ' + err.message;
+ }
+};
+
+
+/**
+ * Colorize log arguments if enabled.
+ *
+ * @api public
+ */
+
+function formatArgs(args) {
+ var useColors = this.useColors;
+
+ args[0] = (useColors ? '%c' : '')
+ + this.namespace
+ + (useColors ? ' %c' : ' ')
+ + args[0]
+ + (useColors ? '%c ' : ' ')
+ + '+' + exports.humanize(this.diff);
+
+ if (!useColors) return;
+
+ var c = 'color: ' + this.color;
+ args.splice(1, 0, c, 'color: inherit')
+
+ // the final "%c" is somewhat tricky, because there could be other
+ // arguments passed either before or after the %c, so we need to
+ // figure out the correct index to insert the CSS into
+ var index = 0;
+ var lastC = 0;
+ args[0].replace(/%[a-zA-Z%]/g, function(match) {
+ if ('%%' === match) return;
+ index++;
+ if ('%c' === match) {
+ // we only are interested in the *last* %c
+ // (the user may have provided their own)
+ lastC = index;
+ }
+ });
+
+ args.splice(lastC, 0, c);
+}
+
+/**
+ * Invokes `console.log()` when available.
+ * No-op when `console.log` is not a "function".
+ *
+ * @api public
+ */
+
+function log() {
+ // this hackery is required for IE8/9, where
+ // the `console.log` function doesn't have 'apply'
+ return 'object' === typeof console
+ && console.log
+ && Function.prototype.apply.call(console.log, console, arguments);
+}
+
+/**
+ * Save `namespaces`.
+ *
+ * @param {String} namespaces
+ * @api private
+ */
+
+function save(namespaces) {
+ try {
+ if (null == namespaces) {
+ exports.storage.removeItem('debug');
+ } else {
+ exports.storage.debug = namespaces;
+ }
+ } catch(e) {}
+}
+
+/**
+ * Load `namespaces`.
+ *
+ * @return {String} returns the previously persisted debug modes
+ * @api private
+ */
+
+function load() {
+ var r;
+ try {
+ r = exports.storage.debug;
+ } catch(e) {}
+
+ // If debug isn't set in LS, and we're in Electron, try to load $DEBUG
+ if (!r && typeof process !== 'undefined' && 'env' in process) {
+ r = process.env.DEBUG;
+ }
+
+ return r;
+}
+
+/**
+ * Enable namespaces listed in `localStorage.debug` initially.
+ */
+
+exports.enable(load());
+
+/**
+ * Localstorage attempts to return the localstorage.
+ *
+ * This is necessary because safari throws
+ * when a user disables cookies/localstorage
+ * and you attempt to access it.
+ *
+ * @return {LocalStorage}
+ * @api private
+ */
+
+function localstorage() {
+ try {
+ return window.localStorage;
+ } catch (e) {}
+}
+
+
+/***/ }),
+/* 865 */
+/***/ (function(module, exports, __webpack_require__) {
+
+
+/**
+ * This is the common logic for both the Node.js and web browser
+ * implementations of `debug()`.
+ *
+ * Expose `debug()` as the module.
+ */
+
+exports = module.exports = createDebug.debug = createDebug['default'] = createDebug;
+exports.coerce = coerce;
+exports.disable = disable;
+exports.enable = enable;
+exports.enabled = enabled;
+exports.humanize = __webpack_require__(866);
+
+/**
+ * The currently active debug mode names, and names to skip.
+ */
+
+exports.names = [];
+exports.skips = [];
+
+/**
+ * Map of special "%n" handling functions, for the debug "format" argument.
+ *
+ * Valid key names are a single, lower or upper-case letter, i.e. "n" and "N".
+ */
+
+exports.formatters = {};
+
+/**
+ * Previous log timestamp.
+ */
+
+var prevTime;
+
+/**
+ * Select a color.
+ * @param {String} namespace
+ * @return {Number}
+ * @api private
+ */
+
+function selectColor(namespace) {
+ var hash = 0, i;
+
+ for (i in namespace) {
+ hash = ((hash << 5) - hash) + namespace.charCodeAt(i);
+ hash |= 0; // Convert to 32bit integer
+ }
+
+ return exports.colors[Math.abs(hash) % exports.colors.length];
+}
+
+/**
+ * Create a debugger with the given `namespace`.
+ *
+ * @param {String} namespace
+ * @return {Function}
+ * @api public
+ */
+
+function createDebug(namespace) {
+
+ function debug() {
+ // disabled?
+ if (!debug.enabled) return;
+
+ var self = debug;
+
+ // set `diff` timestamp
+ var curr = +new Date();
+ var ms = curr - (prevTime || curr);
+ self.diff = ms;
+ self.prev = prevTime;
+ self.curr = curr;
+ prevTime = curr;
+
+ // turn the `arguments` into a proper Array
+ var args = new Array(arguments.length);
+ for (var i = 0; i < args.length; i++) {
+ args[i] = arguments[i];
+ }
+
+ args[0] = exports.coerce(args[0]);
+
+ if ('string' !== typeof args[0]) {
+ // anything else let's inspect with %O
+ args.unshift('%O');
+ }
+
+ // apply any `formatters` transformations
+ var index = 0;
+ args[0] = args[0].replace(/%([a-zA-Z%])/g, function(match, format) {
+ // if we encounter an escaped % then don't increase the array index
+ if (match === '%%') return match;
+ index++;
+ var formatter = exports.formatters[format];
+ if ('function' === typeof formatter) {
+ var val = args[index];
+ match = formatter.call(self, val);
+
+ // now we need to remove `args[index]` since it's inlined in the `format`
+ args.splice(index, 1);
+ index--;
+ }
+ return match;
+ });
+
+ // apply env-specific formatting (colors, etc.)
+ exports.formatArgs.call(self, args);
+
+ var logFn = debug.log || exports.log || console.log.bind(console);
+ logFn.apply(self, args);
+ }
+
+ debug.namespace = namespace;
+ debug.enabled = exports.enabled(namespace);
+ debug.useColors = exports.useColors();
+ debug.color = selectColor(namespace);
+
+ // env-specific initialization logic for debug instances
+ if ('function' === typeof exports.init) {
+ exports.init(debug);
+ }
+
+ return debug;
+}
+
+/**
+ * Enables a debug mode by namespaces. This can include modes
+ * separated by a colon and wildcards.
+ *
+ * @param {String} namespaces
+ * @api public
+ */
+
+function enable(namespaces) {
+ exports.save(namespaces);
+
+ exports.names = [];
+ exports.skips = [];
+
+ var split = (typeof namespaces === 'string' ? namespaces : '').split(/[\s,]+/);
+ var len = split.length;
+
+ for (var i = 0; i < len; i++) {
+ if (!split[i]) continue; // ignore empty strings
+ namespaces = split[i].replace(/\*/g, '.*?');
+ if (namespaces[0] === '-') {
+ exports.skips.push(new RegExp('^' + namespaces.substr(1) + '$'));
+ } else {
+ exports.names.push(new RegExp('^' + namespaces + '$'));
+ }
+ }
+}
+
+/**
+ * Disable debug output.
+ *
+ * @api public
+ */
+
+function disable() {
+ exports.enable('');
+}
+
+/**
+ * Returns true if the given mode name is enabled, false otherwise.
+ *
+ * @param {String} name
+ * @return {Boolean}
+ * @api public
+ */
+
+function enabled(name) {
+ var i, len;
+ for (i = 0, len = exports.skips.length; i < len; i++) {
+ if (exports.skips[i].test(name)) {
+ return false;
+ }
+ }
+ for (i = 0, len = exports.names.length; i < len; i++) {
+ if (exports.names[i].test(name)) {
+ return true;
+ }
+ }
+ return false;
+}
+
+/**
+ * Coerce `val`.
+ *
+ * @param {Mixed} val
+ * @return {Mixed}
+ * @api private
+ */
+
+function coerce(val) {
+ if (val instanceof Error) return val.stack || val.message;
+ return val;
+}
+
+
+/***/ }),
+/* 866 */
+/***/ (function(module, exports) {
+
+/**
+ * Helpers.
+ */
+
+var s = 1000;
+var m = s * 60;
+var h = m * 60;
+var d = h * 24;
+var y = d * 365.25;
+
+/**
+ * Parse or format the given `val`.
+ *
+ * Options:
+ *
+ * - `long` verbose formatting [false]
+ *
+ * @param {String|Number} val
+ * @param {Object} [options]
+ * @throws {Error} throw an error if val is not a non-empty string or a number
+ * @return {String|Number}
+ * @api public
+ */
+
+module.exports = function(val, options) {
+ options = options || {};
+ var type = typeof val;
+ if (type === 'string' && val.length > 0) {
+ return parse(val);
+ } else if (type === 'number' && isNaN(val) === false) {
+ return options.long ? fmtLong(val) : fmtShort(val);
+ }
+ throw new Error(
+ 'val is not a non-empty string or a valid number. val=' +
+ JSON.stringify(val)
+ );
+};
+
+/**
+ * Parse the given `str` and return milliseconds.
+ *
+ * @param {String} str
+ * @return {Number}
+ * @api private
+ */
+
+function parse(str) {
+ str = String(str);
+ if (str.length > 100) {
+ return;
+ }
+ var match = /^((?:\d+)?\.?\d+) *(milliseconds?|msecs?|ms|seconds?|secs?|s|minutes?|mins?|m|hours?|hrs?|h|days?|d|years?|yrs?|y)?$/i.exec(
+ str
+ );
+ if (!match) {
+ return;
+ }
+ var n = parseFloat(match[1]);
+ var type = (match[2] || 'ms').toLowerCase();
+ switch (type) {
+ case 'years':
+ case 'year':
+ case 'yrs':
+ case 'yr':
+ case 'y':
+ return n * y;
+ case 'days':
+ case 'day':
+ case 'd':
+ return n * d;
+ case 'hours':
+ case 'hour':
+ case 'hrs':
+ case 'hr':
+ case 'h':
+ return n * h;
+ case 'minutes':
+ case 'minute':
+ case 'mins':
+ case 'min':
+ case 'm':
+ return n * m;
+ case 'seconds':
+ case 'second':
+ case 'secs':
+ case 'sec':
+ case 's':
+ return n * s;
+ case 'milliseconds':
+ case 'millisecond':
+ case 'msecs':
+ case 'msec':
+ case 'ms':
+ return n;
+ default:
+ return undefined;
+ }
+}
+
+/**
+ * Short format for `ms`.
+ *
+ * @param {Number} ms
+ * @return {String}
+ * @api private
+ */
+
+function fmtShort(ms) {
+ if (ms >= d) {
+ return Math.round(ms / d) + 'd';
+ }
+ if (ms >= h) {
+ return Math.round(ms / h) + 'h';
+ }
+ if (ms >= m) {
+ return Math.round(ms / m) + 'm';
+ }
+ if (ms >= s) {
+ return Math.round(ms / s) + 's';
+ }
+ return ms + 'ms';
+}
+
+/**
+ * Long format for `ms`.
+ *
+ * @param {Number} ms
+ * @return {String}
+ * @api private
+ */
+
+function fmtLong(ms) {
+ return plural(ms, d, 'day') ||
+ plural(ms, h, 'hour') ||
+ plural(ms, m, 'minute') ||
+ plural(ms, s, 'second') ||
+ ms + ' ms';
+}
+
+/**
+ * Pluralization helper.
+ */
+
+function plural(ms, n, name) {
+ if (ms < n) {
+ return;
+ }
+ if (ms < n * 1.5) {
+ return Math.floor(ms / n) + ' ' + name;
+ }
+ return Math.ceil(ms / n) + ' ' + name + 's';
+}
+
+
+/***/ }),
+/* 867 */
+/***/ (function(module, exports, __webpack_require__) {
+
+/**
+ * Module dependencies.
+ */
+
+var tty = __webpack_require__(478);
+var util = __webpack_require__(29);
+
+/**
+ * This is the Node.js implementation of `debug()`.
+ *
+ * Expose `debug()` as the module.
+ */
+
+exports = module.exports = __webpack_require__(865);
+exports.init = init;
+exports.log = log;
+exports.formatArgs = formatArgs;
+exports.save = save;
+exports.load = load;
+exports.useColors = useColors;
+
+/**
+ * Colors.
+ */
+
+exports.colors = [6, 2, 3, 4, 5, 1];
+
+/**
+ * Build up the default `inspectOpts` object from the environment variables.
+ *
+ * $ DEBUG_COLORS=no DEBUG_DEPTH=10 DEBUG_SHOW_HIDDEN=enabled node script.js
+ */
+
+exports.inspectOpts = Object.keys(process.env).filter(function (key) {
+ return /^debug_/i.test(key);
+}).reduce(function (obj, key) {
+ // camel-case
+ var prop = key
+ .substring(6)
+ .toLowerCase()
+ .replace(/_([a-z])/g, function (_, k) { return k.toUpperCase() });
+
+ // coerce string value into JS value
+ var val = process.env[key];
+ if (/^(yes|on|true|enabled)$/i.test(val)) val = true;
+ else if (/^(no|off|false|disabled)$/i.test(val)) val = false;
+ else if (val === 'null') val = null;
+ else val = Number(val);
+
+ obj[prop] = val;
+ return obj;
+}, {});
+
+/**
+ * The file descriptor to write the `debug()` calls to.
+ * Set the `DEBUG_FD` env variable to override with another value. i.e.:
+ *
+ * $ DEBUG_FD=3 node script.js 3>debug.log
+ */
+
+var fd = parseInt(process.env.DEBUG_FD, 10) || 2;
+
+if (1 !== fd && 2 !== fd) {
+ util.deprecate(function(){}, 'except for stderr(2) and stdout(1), any other usage of DEBUG_FD is deprecated. Override debug.log if you want to use a different log function (https://git.io/debug_fd)')()
+}
+
+var stream = 1 === fd ? process.stdout :
+ 2 === fd ? process.stderr :
+ createWritableStdioStream(fd);
+
+/**
+ * Is stdout a TTY? Colored output is enabled when `true`.
+ */
+
+function useColors() {
+ return 'colors' in exports.inspectOpts
+ ? Boolean(exports.inspectOpts.colors)
+ : tty.isatty(fd);
+}
+
+/**
+ * Map %o to `util.inspect()`, all on a single line.
+ */
+
+exports.formatters.o = function(v) {
+ this.inspectOpts.colors = this.useColors;
+ return util.inspect(v, this.inspectOpts)
+ .split('\n').map(function(str) {
+ return str.trim()
+ }).join(' ');
+};
+
+/**
+ * Map %o to `util.inspect()`, allowing multiple lines if needed.
+ */
+
+exports.formatters.O = function(v) {
+ this.inspectOpts.colors = this.useColors;
+ return util.inspect(v, this.inspectOpts);
+};
+
+/**
+ * Adds ANSI color escape codes if enabled.
+ *
+ * @api public
+ */
+
+function formatArgs(args) {
+ var name = this.namespace;
+ var useColors = this.useColors;
+
+ if (useColors) {
+ var c = this.color;
+ var prefix = ' \u001b[3' + c + ';1m' + name + ' ' + '\u001b[0m';
+
+ args[0] = prefix + args[0].split('\n').join('\n' + prefix);
+ args.push('\u001b[3' + c + 'm+' + exports.humanize(this.diff) + '\u001b[0m');
+ } else {
+ args[0] = new Date().toUTCString()
+ + ' ' + name + ' ' + args[0];
+ }
+}
+
+/**
+ * Invokes `util.format()` with the specified arguments and writes to `stream`.
+ */
+
+function log() {
+ return stream.write(util.format.apply(util, arguments) + '\n');
+}
+
+/**
+ * Save `namespaces`.
+ *
+ * @param {String} namespaces
+ * @api private
+ */
+
+function save(namespaces) {
+ if (null == namespaces) {
+ // If you set a process.env field to null or undefined, it gets cast to the
+ // string 'null' or 'undefined'. Just delete instead.
+ delete process.env.DEBUG;
+ } else {
+ process.env.DEBUG = namespaces;
+ }
+}
+
+/**
+ * Load `namespaces`.
+ *
+ * @return {String} returns the previously persisted debug modes
+ * @api private
+ */
+
+function load() {
+ return process.env.DEBUG;
+}
+
+/**
+ * Copied from `node/src/node.js`.
+ *
+ * XXX: It's lame that node doesn't expose this API out-of-the-box. It also
+ * relies on the undocumented `tty_wrap.guessHandleType()` which is also lame.
+ */
+
+function createWritableStdioStream (fd) {
+ var stream;
+ var tty_wrap = process.binding('tty_wrap');
+
+ // Note stream._type is used for test-module-load-list.js
+
+ switch (tty_wrap.guessHandleType(fd)) {
+ case 'TTY':
+ stream = new tty.WriteStream(fd);
+ stream._type = 'tty';
+
+ // Hack to have stream not keep the event loop alive.
+ // See https://github.com/joyent/node/issues/1726
+ if (stream._handle && stream._handle.unref) {
+ stream._handle.unref();
+ }
+ break;
+
+ case 'FILE':
+ var fs = __webpack_require__(23);
+ stream = new fs.SyncWriteStream(fd, { autoClose: false });
+ stream._type = 'fs';
+ break;
+
+ case 'PIPE':
+ case 'TCP':
+ var net = __webpack_require__(805);
+ stream = new net.Socket({
+ fd: fd,
+ readable: false,
+ writable: true
+ });
+
+ // FIXME Should probably have an option in net.Socket to create a
+ // stream from an existing fd which is writable only. But for now
+ // we'll just add this hack and set the `readable` member to false.
+ // Test: ./node test/fixtures/echo.js < /etc/passwd
+ stream.readable = false;
+ stream.read = null;
+ stream._type = 'pipe';
+
+ // FIXME Hack to have stream not keep the event loop alive.
+ // See https://github.com/joyent/node/issues/1726
+ if (stream._handle && stream._handle.unref) {
+ stream._handle.unref();
+ }
+ break;
+
+ default:
+ // Probably an error on in uv_guess_handle()
+ throw new Error('Implement me. Unknown stream file type!');
+ }
+
+ // For supporting legacy API we put the FD here.
+ stream.fd = fd;
+
+ stream._isStdio = true;
+
+ return stream;
+}
+
+/**
+ * Init logic for `debug` instances.
+ *
+ * Create a new `inspectOpts` object in case `useColors` is set
+ * differently for a particular `debug` instance.
+ */
+
+function init (debug) {
+ debug.inspectOpts = {};
+
+ var keys = Object.keys(exports.inspectOpts);
+ for (var i = 0; i < keys.length; i++) {
+ debug.inspectOpts[keys[i]] = exports.inspectOpts[keys[i]];
+ }
+}
+
+/**
+ * Enable namespaces listed in `process.env.DEBUG` initially.
+ */
+
+exports.enable(load());
+
+
+/***/ }),
+/* 868 */
+/***/ (function(module, exports, __webpack_require__) {
+
"use strict";
var brackets = __webpack_require__(858);
-var define = __webpack_require__(864);
-var utils = __webpack_require__(865);
+var define = __webpack_require__(869);
+var utils = __webpack_require__(870);
/**
* Characters to use in text regex (we want to "not" match
@@ -101901,7 +102721,7 @@ module.exports = parsers;
/***/ }),
-/* 864 */
+/* 869 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
@@ -101939,7 +102759,7 @@ module.exports = function defineProperty(obj, prop, val) {
/***/ }),
-/* 865 */
+/* 870 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
@@ -102015,7 +102835,7 @@ utils.createRegex = function(str) {
/***/ }),
-/* 866 */
+/* 871 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
@@ -102026,7 +102846,7 @@ utils.createRegex = function(str) {
*/
var Snapdragon = __webpack_require__(767);
-var define = __webpack_require__(864);
+var define = __webpack_require__(869);
var extend = __webpack_require__(737);
/**
@@ -102034,7 +102854,7 @@ var extend = __webpack_require__(737);
*/
var compilers = __webpack_require__(857);
-var parsers = __webpack_require__(863);
+var parsers = __webpack_require__(868);
/**
* Customize Snapdragon parser and renderer
@@ -102100,7 +102920,7 @@ module.exports = Extglob;
/***/ }),
-/* 867 */
+/* 872 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
@@ -102190,14 +103010,14 @@ function textRegex(pattern) {
/***/ }),
-/* 868 */
+/* 873 */
/***/ (function(module, exports, __webpack_require__) {
module.exports = new (__webpack_require__(849))();
/***/ }),
-/* 869 */
+/* 874 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
@@ -102215,7 +103035,7 @@ utils.define = __webpack_require__(836);
utils.diff = __webpack_require__(853);
utils.extend = __webpack_require__(837);
utils.pick = __webpack_require__(854);
-utils.typeOf = __webpack_require__(870);
+utils.typeOf = __webpack_require__(875);
utils.unique = __webpack_require__(740);
/**
@@ -102513,7 +103333,7 @@ utils.unixify = function(options) {
/***/ }),
-/* 870 */
+/* 875 */
/***/ (function(module, exports) {
var toString = Object.prototype.toString;
@@ -102648,7 +103468,7 @@ function isBuffer(val) {
/***/ }),
-/* 871 */
+/* 876 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
@@ -102667,9 +103487,9 @@ var __extends = (this && this.__extends) || (function () {
};
})();
Object.defineProperty(exports, "__esModule", { value: true });
-var readdir = __webpack_require__(872);
-var reader_1 = __webpack_require__(885);
-var fs_stream_1 = __webpack_require__(889);
+var readdir = __webpack_require__(877);
+var reader_1 = __webpack_require__(890);
+var fs_stream_1 = __webpack_require__(894);
var ReaderAsync = /** @class */ (function (_super) {
__extends(ReaderAsync, _super);
function ReaderAsync() {
@@ -102730,15 +103550,15 @@ exports.default = ReaderAsync;
/***/ }),
-/* 872 */
+/* 877 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
-const readdirSync = __webpack_require__(873);
-const readdirAsync = __webpack_require__(881);
-const readdirStream = __webpack_require__(884);
+const readdirSync = __webpack_require__(878);
+const readdirAsync = __webpack_require__(886);
+const readdirStream = __webpack_require__(889);
module.exports = exports = readdirAsyncPath;
exports.readdir = exports.readdirAsync = exports.async = readdirAsyncPath;
@@ -102822,7 +103642,7 @@ function readdirStreamStat (dir, options) {
/***/ }),
-/* 873 */
+/* 878 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
@@ -102830,11 +103650,11 @@ function readdirStreamStat (dir, options) {
module.exports = readdirSync;
-const DirectoryReader = __webpack_require__(874);
+const DirectoryReader = __webpack_require__(879);
let syncFacade = {
- fs: __webpack_require__(879),
- forEach: __webpack_require__(880),
+ fs: __webpack_require__(884),
+ forEach: __webpack_require__(885),
sync: true
};
@@ -102863,7 +103683,7 @@ function readdirSync (dir, options, internalOptions) {
/***/ }),
-/* 874 */
+/* 879 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
@@ -102872,9 +103692,9 @@ function readdirSync (dir, options, internalOptions) {
const Readable = __webpack_require__(27).Readable;
const EventEmitter = __webpack_require__(379).EventEmitter;
const path = __webpack_require__(16);
-const normalizeOptions = __webpack_require__(875);
-const stat = __webpack_require__(877);
-const call = __webpack_require__(878);
+const normalizeOptions = __webpack_require__(880);
+const stat = __webpack_require__(882);
+const call = __webpack_require__(883);
/**
* Asynchronously reads the contents of a directory and streams the results
@@ -103250,14 +104070,14 @@ module.exports = DirectoryReader;
/***/ }),
-/* 875 */
+/* 880 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
const path = __webpack_require__(16);
-const globToRegExp = __webpack_require__(876);
+const globToRegExp = __webpack_require__(881);
module.exports = normalizeOptions;
@@ -103434,7 +104254,7 @@ function normalizeOptions (options, internalOptions) {
/***/ }),
-/* 876 */
+/* 881 */
/***/ (function(module, exports) {
module.exports = function (glob, opts) {
@@ -103571,13 +104391,13 @@ module.exports = function (glob, opts) {
/***/ }),
-/* 877 */
+/* 882 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
-const call = __webpack_require__(878);
+const call = __webpack_require__(883);
module.exports = stat;
@@ -103652,7 +104472,7 @@ function symlinkStat (fs, path, lstats, callback) {
/***/ }),
-/* 878 */
+/* 883 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
@@ -103713,14 +104533,14 @@ function callOnce (fn) {
/***/ }),
-/* 879 */
+/* 884 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
const fs = __webpack_require__(23);
-const call = __webpack_require__(878);
+const call = __webpack_require__(883);
/**
* A facade around {@link fs.readdirSync} that allows it to be called
@@ -103784,7 +104604,7 @@ exports.lstat = function (path, callback) {
/***/ }),
-/* 880 */
+/* 885 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
@@ -103813,7 +104633,7 @@ function syncForEach (array, iterator, done) {
/***/ }),
-/* 881 */
+/* 886 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
@@ -103821,12 +104641,12 @@ function syncForEach (array, iterator, done) {
module.exports = readdirAsync;
-const maybe = __webpack_require__(882);
-const DirectoryReader = __webpack_require__(874);
+const maybe = __webpack_require__(887);
+const DirectoryReader = __webpack_require__(879);
let asyncFacade = {
fs: __webpack_require__(23),
- forEach: __webpack_require__(883),
+ forEach: __webpack_require__(888),
async: true
};
@@ -103868,7 +104688,7 @@ function readdirAsync (dir, options, callback, internalOptions) {
/***/ }),
-/* 882 */
+/* 887 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
@@ -103895,7 +104715,7 @@ module.exports = function maybe (cb, promise) {
/***/ }),
-/* 883 */
+/* 888 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
@@ -103931,7 +104751,7 @@ function asyncForEach (array, iterator, done) {
/***/ }),
-/* 884 */
+/* 889 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
@@ -103939,11 +104759,11 @@ function asyncForEach (array, iterator, done) {
module.exports = readdirStream;
-const DirectoryReader = __webpack_require__(874);
+const DirectoryReader = __webpack_require__(879);
let streamFacade = {
fs: __webpack_require__(23),
- forEach: __webpack_require__(883),
+ forEach: __webpack_require__(888),
async: true
};
@@ -103963,16 +104783,16 @@ function readdirStream (dir, options, internalOptions) {
/***/ }),
-/* 885 */
+/* 890 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
var path = __webpack_require__(16);
-var deep_1 = __webpack_require__(886);
-var entry_1 = __webpack_require__(888);
-var pathUtil = __webpack_require__(887);
+var deep_1 = __webpack_require__(891);
+var entry_1 = __webpack_require__(893);
+var pathUtil = __webpack_require__(892);
var Reader = /** @class */ (function () {
function Reader(options) {
this.options = options;
@@ -104038,13 +104858,13 @@ exports.default = Reader;
/***/ }),
-/* 886 */
+/* 891 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
-var pathUtils = __webpack_require__(887);
+var pathUtils = __webpack_require__(892);
var patternUtils = __webpack_require__(721);
var DeepFilter = /** @class */ (function () {
function DeepFilter(options, micromatchOptions) {
@@ -104128,7 +104948,7 @@ exports.default = DeepFilter;
/***/ }),
-/* 887 */
+/* 892 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
@@ -104159,13 +104979,13 @@ exports.makeAbsolute = makeAbsolute;
/***/ }),
-/* 888 */
+/* 893 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
-var pathUtils = __webpack_require__(887);
+var pathUtils = __webpack_require__(892);
var patternUtils = __webpack_require__(721);
var EntryFilter = /** @class */ (function () {
function EntryFilter(options, micromatchOptions) {
@@ -104251,7 +105071,7 @@ exports.default = EntryFilter;
/***/ }),
-/* 889 */
+/* 894 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
@@ -104271,8 +105091,8 @@ var __extends = (this && this.__extends) || (function () {
})();
Object.defineProperty(exports, "__esModule", { value: true });
var stream = __webpack_require__(27);
-var fsStat = __webpack_require__(890);
-var fs_1 = __webpack_require__(894);
+var fsStat = __webpack_require__(895);
+var fs_1 = __webpack_require__(899);
var FileSystemStream = /** @class */ (function (_super) {
__extends(FileSystemStream, _super);
function FileSystemStream() {
@@ -104322,14 +105142,14 @@ exports.default = FileSystemStream;
/***/ }),
-/* 890 */
+/* 895 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
-const optionsManager = __webpack_require__(891);
-const statProvider = __webpack_require__(893);
+const optionsManager = __webpack_require__(896);
+const statProvider = __webpack_require__(898);
/**
* Asynchronous API.
*/
@@ -104360,13 +105180,13 @@ exports.statSync = statSync;
/***/ }),
-/* 891 */
+/* 896 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
-const fsAdapter = __webpack_require__(892);
+const fsAdapter = __webpack_require__(897);
function prepare(opts) {
const options = Object.assign({
fs: fsAdapter.getFileSystemAdapter(opts ? opts.fs : undefined),
@@ -104379,7 +105199,7 @@ exports.prepare = prepare;
/***/ }),
-/* 892 */
+/* 897 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
@@ -104402,7 +105222,7 @@ exports.getFileSystemAdapter = getFileSystemAdapter;
/***/ }),
-/* 893 */
+/* 898 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
@@ -104454,7 +105274,7 @@ exports.isFollowedSymlink = isFollowedSymlink;
/***/ }),
-/* 894 */
+/* 899 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
@@ -104485,7 +105305,7 @@ exports.default = FileSystem;
/***/ }),
-/* 895 */
+/* 900 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
@@ -104505,9 +105325,9 @@ var __extends = (this && this.__extends) || (function () {
})();
Object.defineProperty(exports, "__esModule", { value: true });
var stream = __webpack_require__(27);
-var readdir = __webpack_require__(872);
-var reader_1 = __webpack_require__(885);
-var fs_stream_1 = __webpack_require__(889);
+var readdir = __webpack_require__(877);
+var reader_1 = __webpack_require__(890);
+var fs_stream_1 = __webpack_require__(894);
var TransformStream = /** @class */ (function (_super) {
__extends(TransformStream, _super);
function TransformStream(reader) {
@@ -104575,7 +105395,7 @@ exports.default = ReaderStream;
/***/ }),
-/* 896 */
+/* 901 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
@@ -104594,9 +105414,9 @@ var __extends = (this && this.__extends) || (function () {
};
})();
Object.defineProperty(exports, "__esModule", { value: true });
-var readdir = __webpack_require__(872);
-var reader_1 = __webpack_require__(885);
-var fs_sync_1 = __webpack_require__(897);
+var readdir = __webpack_require__(877);
+var reader_1 = __webpack_require__(890);
+var fs_sync_1 = __webpack_require__(902);
var ReaderSync = /** @class */ (function (_super) {
__extends(ReaderSync, _super);
function ReaderSync() {
@@ -104656,7 +105476,7 @@ exports.default = ReaderSync;
/***/ }),
-/* 897 */
+/* 902 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
@@ -104675,8 +105495,8 @@ var __extends = (this && this.__extends) || (function () {
};
})();
Object.defineProperty(exports, "__esModule", { value: true });
-var fsStat = __webpack_require__(890);
-var fs_1 = __webpack_require__(894);
+var fsStat = __webpack_require__(895);
+var fs_1 = __webpack_require__(899);
var FileSystemSync = /** @class */ (function (_super) {
__extends(FileSystemSync, _super);
function FileSystemSync() {
@@ -104722,7 +105542,7 @@ exports.default = FileSystemSync;
/***/ }),
-/* 898 */
+/* 903 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
@@ -104738,7 +105558,7 @@ exports.flatten = flatten;
/***/ }),
-/* 899 */
+/* 904 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
@@ -104759,13 +105579,13 @@ exports.merge = merge;
/***/ }),
-/* 900 */
+/* 905 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
const path = __webpack_require__(16);
-const pathType = __webpack_require__(901);
+const pathType = __webpack_require__(906);
const getExtensions = extensions => extensions.length > 1 ? `{${extensions.join(',')}}` : extensions[0];
@@ -104831,13 +105651,13 @@ module.exports.sync = (input, opts) => {
/***/ }),
-/* 901 */
+/* 906 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
const fs = __webpack_require__(23);
-const pify = __webpack_require__(902);
+const pify = __webpack_require__(907);
function type(fn, fn2, fp) {
if (typeof fp !== 'string') {
@@ -104880,7 +105700,7 @@ exports.symlinkSync = typeSync.bind(null, 'lstatSync', 'isSymbolicLink');
/***/ }),
-/* 902 */
+/* 907 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
@@ -104971,7 +105791,7 @@ module.exports = (obj, opts) => {
/***/ }),
-/* 903 */
+/* 908 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
@@ -104979,9 +105799,9 @@ module.exports = (obj, opts) => {
const fs = __webpack_require__(23);
const path = __webpack_require__(16);
const fastGlob = __webpack_require__(717);
-const gitIgnore = __webpack_require__(904);
-const pify = __webpack_require__(905);
-const slash = __webpack_require__(906);
+const gitIgnore = __webpack_require__(909);
+const pify = __webpack_require__(910);
+const slash = __webpack_require__(911);
const DEFAULT_IGNORE = [
'**/node_modules/**',
@@ -105079,7 +105899,7 @@ module.exports.sync = options => {
/***/ }),
-/* 904 */
+/* 909 */
/***/ (function(module, exports) {
// A simple implementation of make-array
@@ -105548,7 +106368,7 @@ module.exports = options => new IgnoreBase(options)
/***/ }),
-/* 905 */
+/* 910 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
@@ -105623,7 +106443,7 @@ module.exports = (input, options) => {
/***/ }),
-/* 906 */
+/* 911 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
@@ -105641,17 +106461,17 @@ module.exports = input => {
/***/ }),
-/* 907 */
+/* 912 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
const path = __webpack_require__(16);
const {constants: fsConstants} = __webpack_require__(23);
-const pEvent = __webpack_require__(908);
-const CpFileError = __webpack_require__(911);
-const fs = __webpack_require__(915);
-const ProgressEmitter = __webpack_require__(918);
+const pEvent = __webpack_require__(913);
+const CpFileError = __webpack_require__(916);
+const fs = __webpack_require__(920);
+const ProgressEmitter = __webpack_require__(923);
const cpFileAsync = async (source, destination, options, progressEmitter) => {
let readError;
@@ -105765,12 +106585,12 @@ module.exports.sync = (source, destination, options) => {
/***/ }),
-/* 908 */
+/* 913 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
-const pTimeout = __webpack_require__(909);
+const pTimeout = __webpack_require__(914);
const symbolAsyncIterator = Symbol.asyncIterator || '@@asyncIterator';
@@ -106061,12 +106881,12 @@ module.exports.iterator = (emitter, event, options) => {
/***/ }),
-/* 909 */
+/* 914 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
-const pFinally = __webpack_require__(910);
+const pFinally = __webpack_require__(915);
class TimeoutError extends Error {
constructor(message) {
@@ -106112,7 +106932,7 @@ module.exports.TimeoutError = TimeoutError;
/***/ }),
-/* 910 */
+/* 915 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
@@ -106134,12 +106954,12 @@ module.exports = (promise, onFinally) => {
/***/ }),
-/* 911 */
+/* 916 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
-const NestedError = __webpack_require__(912);
+const NestedError = __webpack_require__(917);
class CpFileError extends NestedError {
constructor(message, nested) {
@@ -106153,10 +106973,10 @@ module.exports = CpFileError;
/***/ }),
-/* 912 */
+/* 917 */
/***/ (function(module, exports, __webpack_require__) {
-var inherits = __webpack_require__(913);
+var inherits = __webpack_require__(918);
var NestedError = function (message, nested) {
this.nested = nested;
@@ -106207,7 +107027,7 @@ module.exports = NestedError;
/***/ }),
-/* 913 */
+/* 918 */
/***/ (function(module, exports, __webpack_require__) {
try {
@@ -106215,12 +107035,12 @@ try {
if (typeof util.inherits !== 'function') throw '';
module.exports = util.inherits;
} catch (e) {
- module.exports = __webpack_require__(914);
+ module.exports = __webpack_require__(919);
}
/***/ }),
-/* 914 */
+/* 919 */
/***/ (function(module, exports) {
if (typeof Object.create === 'function') {
@@ -106249,16 +107069,16 @@ if (typeof Object.create === 'function') {
/***/ }),
-/* 915 */
+/* 920 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
const {promisify} = __webpack_require__(29);
const fs = __webpack_require__(22);
-const makeDir = __webpack_require__(916);
-const pEvent = __webpack_require__(908);
-const CpFileError = __webpack_require__(911);
+const makeDir = __webpack_require__(921);
+const pEvent = __webpack_require__(913);
+const CpFileError = __webpack_require__(916);
const stat = promisify(fs.stat);
const lstat = promisify(fs.lstat);
@@ -106355,7 +107175,7 @@ exports.copyFileSync = (source, destination, flags) => {
/***/ }),
-/* 916 */
+/* 921 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
@@ -106363,7 +107183,7 @@ exports.copyFileSync = (source, destination, flags) => {
const fs = __webpack_require__(23);
const path = __webpack_require__(16);
const {promisify} = __webpack_require__(29);
-const semver = __webpack_require__(917);
+const semver = __webpack_require__(922);
const defaults = {
mode: 0o777 & (~process.umask()),
@@ -106512,7 +107332,7 @@ module.exports.sync = (input, options) => {
/***/ }),
-/* 917 */
+/* 922 */
/***/ (function(module, exports) {
exports = module.exports = SemVer
@@ -108114,7 +108934,7 @@ function coerce (version, options) {
/***/ }),
-/* 918 */
+/* 923 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
@@ -108155,7 +108975,7 @@ module.exports = ProgressEmitter;
/***/ }),
-/* 919 */
+/* 924 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
@@ -108201,12 +109021,12 @@ exports.default = module.exports;
/***/ }),
-/* 920 */
+/* 925 */
/***/ (function(module, exports, __webpack_require__) {
"use strict";
-const NestedError = __webpack_require__(921);
+const NestedError = __webpack_require__(926);
class CpyError extends NestedError {
constructor(message, nested) {
@@ -108220,7 +109040,7 @@ module.exports = CpyError;
/***/ }),
-/* 921 */
+/* 926 */
/***/ (function(module, exports, __webpack_require__) {
var inherits = __webpack_require__(29).inherits;
@@ -108276,7 +109096,7 @@ module.exports = NestedError;
/***/ }),
-/* 922 */
+/* 927 */
/***/ (function(module, __webpack_exports__, __webpack_require__) {
"use strict";
diff --git a/packages/kbn-ui-shared-deps/package.json b/packages/kbn-ui-shared-deps/package.json
index 7c5d6a62a11ca..c8614b1df9d5d 100644
--- a/packages/kbn-ui-shared-deps/package.json
+++ b/packages/kbn-ui-shared-deps/package.json
@@ -9,7 +9,7 @@
"kbn:watch": "node scripts/build --watch"
},
"dependencies": {
- "@elastic/charts": "18.2.2",
+ "@elastic/charts": "18.3.0",
"@elastic/eui": "21.0.1",
"@kbn/i18n": "1.0.0",
"abortcontroller-polyfill": "^1.4.0",
diff --git a/rfcs/text/0002_encrypted_attributes.md b/rfcs/text/0002_encrypted_attributes.md
index aa7307edb66bd..c6553c177d995 100644
--- a/rfcs/text/0002_encrypted_attributes.md
+++ b/rfcs/text/0002_encrypted_attributes.md
@@ -166,7 +166,7 @@ take a look at the source code of this library to know how encryption is perform
parameters are used, but in short it's AES Encryption with AES-256-GCM that uses random initialization vector and salt.
As with encryption key for Kibana's session cookie, master encryption key used by `encrypted_saved_objects` plugin can be
-defined as a configuration value (`xpack.encrypted_saved_objects.encryptionKey`) via `kibana.yml`, but it's **highly
+defined as a configuration value (`xpack.encryptedSavedObjects.encryptionKey`) via `kibana.yml`, but it's **highly
recommended** to define this key in the [Kibana Keystore](https://www.elastic.co/guide/en/kibana/current/secure-settings.html)
instead. The master key should be cryptographically safe and be equal or greater than 32 bytes.
diff --git a/src/core/CONVENTIONS.md b/src/core/CONVENTIONS.md
index 0f592d108c561..a82cc27839a1d 100644
--- a/src/core/CONVENTIONS.md
+++ b/src/core/CONVENTIONS.md
@@ -1,6 +1,6 @@
-# Kibana Conventions
-
-- [Kibana Conventions](#kibana-conventions)
+- [Organisational Conventions](#organisational-conventions)
+ - [Definition of done](#definition-of-done)
+- [Technical Conventions](#technical-conventions)
- [Plugin Structure](#plugin-structure)
- [The PluginInitializer](#the-plugininitializer)
- [The Plugin class](#the-plugin-class)
@@ -8,8 +8,34 @@
- [Services](#services)
- [Usage Collection](#usage-collection)
- [Saved Objects Types](#saved-objects-types)
-
-## Plugin Structure
+ - [Naming conventions](#naming-conventions)
+
+## Organisational Conventions
+### Definition of done
+Definition of done for a feature:
+- has a dedicated Github issue describing problem space
+- an umbrella task closed/updated with follow-ups
+- all code review comments are resolved
+- has been verified manually by at least one reviewer
+- can be used by first & third party plugins
+- there is no contradiction between client and server API
+- works for OSS version
+ - works with and without a `server.basePath` configured
+ - cannot crash the Kibana server when it fails
+- works for the commercial version with a license
+ - for a logged-in user
+ - for anonymous user
+ - compatible with Spaces
+- has unit & integration tests for public contracts
+- has functional tests for user scenarios
+- uses standard tooling:
+ - code - `TypeScript`
+ - UI - `React`
+ - tests - `jest` & `FTR`
+- has documentation for the public contract, provides a usage example
+
+## Technical Conventions
+### Plugin Structure
All Kibana plugins built at Elastic should follow the same structure.
@@ -60,7 +86,7 @@ my_plugin/
- More should be fleshed out here...
- Usage collectors for Telemetry should be defined in a separate `server/collectors/` directory.
-### The PluginInitializer
+#### The PluginInitializer
```ts
// my_plugin/public/index.ts
@@ -75,7 +101,7 @@ export {
}
```
-### The Plugin class
+#### The Plugin class
```ts
// my_plugin/public/plugin.ts
@@ -130,7 +156,7 @@ Difference between `setup` and `start`:
The bulk of your plugin logic will most likely live inside _handlers_ registered during `setup`.
-### Applications
+#### Applications
It's important that UI code is not included in the main bundle for your plugin. Our webpack configuration supports
dynamic async imports to split out imports into a separate bundle. Every app's rendering logic and UI code should
@@ -175,7 +201,7 @@ export class MyPlugin implements Plugin {
}
```
-### Services
+#### Services
Service structure should mirror the plugin lifecycle to make reasoning about how the service is executed more clear.
@@ -226,7 +252,7 @@ export class Plugin {
}
```
-### Usage Collection
+#### Usage Collection
For creating and registering a Usage Collector. Collectors should be defined in a separate directory `server/collectors/`. You can read more about usage collectors on `src/plugins/usage_collection/README.md`.
@@ -263,7 +289,7 @@ export function registerMyPluginUsageCollector(usageCollection?: UsageCollection
}
```
-### Saved Objects Types
+#### Saved Objects Types
Saved object type definitions should be defined in their own `server/saved_objects` directory.
diff --git a/src/core/MIGRATION.md b/src/core/MIGRATION.md
index 5d7b467052029..80f12dd78214d 100644
--- a/src/core/MIGRATION.md
+++ b/src/core/MIGRATION.md
@@ -24,6 +24,7 @@
- [7. Switch to new platform services](#7-switch-to-new-platform-services)
- [8. Migrate to the new plugin system](#8-migrate-to-the-new-plugin-system)
- [Bonus: Tips for complex migration scenarios](#bonus-tips-for-complex-migration-scenarios)
+ - [Keep Kibana fast](#keep-kibana-fast)
- [Frequently asked questions](#frequently-asked-questions)
- [Is migrating a plugin an all-or-nothing thing?](#is-migrating-a-plugin-an-all-or-nothing-thing)
- [Do plugins need to be converted to TypeScript?](#do-plugins-need-to-be-converted-to-typescript)
@@ -933,6 +934,66 @@ For a few plugins, some of these steps (such as angular removal) could be a mont
One convention that is useful for this is creating a dedicated `public/np_ready` directory to house the code that is ready to migrate, and gradually move more and more code into it until the rest of your plugin is essentially empty. At that point, you'll be able to copy your `index.ts`, `plugin.ts`, and the contents of `./np_ready` over into your plugin in the new platform, leaving your legacy shim behind. This carries the added benefit of providing a way for us to introduce helpful tooling in the future, such as [custom eslint rules](https://github.com/elastic/kibana/pull/40537), which could be run against that specific directory to ensure your code is ready to migrate.
+## Keep Kibana fast
+**tl;dr**: Load as much code lazily as possible.
+Everyone loves snappy applications with responsive UI and hates spinners. Users deserve the best user experiences regardless of whether they run Kibana locally or in the cloud, regardless of their hardware & environment.
+There are 2 main aspects of the perceived speed of an application: loading time and responsiveness to user actions.
+New platform loads and bootstraps **all** the plugins whenever a user lands on any page. It means that adding every new application affects overall **loading performance** in the new platform, as plugin code is loaded **eagerly** to initialize the plugin and provide plugin API to dependent plugins.
+However, it's usually not necessary that the whole plugin code should be loaded and initialized at once. The plugin could keep on loading code covering API functionality on Kibana bootstrap but load UI related code lazily on-demand, when an application page or management section is mounted.
+Always prefer to require UI root components lazily when possible (such as in mount handlers). Even if their size may seem negligible, they are likely using some heavy-weight libraries that will also be removed from the initial plugin bundle, therefore, reducing its size by a significant amount.
+
+```typescript
+import { Plugin, CoreSetup, AppMountParameters } from 'src/core/public';
+export class MyPlugin implements Plugin {
+ setup(core: CoreSetup, plugins: SetupDeps){
+ core.application.register({
+ id: 'app',
+ title: 'My app',
+ async mount(params: AppMountParameters) {
+ const { mountApp } = await import('./app/mount_app');
+ return mountApp(await core.getStartServices(), params);
+ },
+ });
+ plugins.management.sections.getSection('another').registerApp({
+ id: 'app',
+ title: 'My app',
+ order: 1,
+ async mount(params) {
+ const { mountManagementSection } = await import('./app/mount_management_section');
+ return mountManagementSection(coreSetup, params);
+ },
+ })
+ return {
+ doSomething(){}
+ }
+ }
+}
+```
+
+#### How to understand how big the bundle size of my plugin is?
+New platform plugins are distributed as a pre-built with `@kbn/optimizer` package artifacts. It allows us to get rid of the shipping of `optimizer` in the distributable version of Kibana.
+Every NP plugin artifact contains all plugin dependencies required to run the plugin, except some stateful dependencies shared across plugin bundles via `@kbn/ui-shared-deps`.
+It means that NP plugin artifacts tend to have a bigger size than the legacy platform version.
+To understand the current size of your plugin artifact, run `@kbn/optimizer` as
+```bash
+node scripts/build_kibana_platform_plugins.js --dist --no-examples
+```
+and check the output in the `target` sub-folder of your plugin folder
+```bash
+ls -lh plugins/my_plugin/target/public/
+# output
+# an async chunk loaded on demand
+... 262K 0.plugin.js
+# eagerly loaded chunk
+... 50K my_plugin.plugin.js
+```
+you might see at least one js bundle - `my_plugin.plugin.js`. This is the only artifact loaded by the platform during bootstrap in the browser. The rule of thumb is to keep its size as small as possible.
+Other lazily loaded parts of your plugin present in the same folder as separate chunks under `{number}.plugin.js` names.
+If you want to investigate what your plugin bundle consists of you need to run `@kbn/optimizer` with `--profile` flag to get generated [webpack stats file](https://webpack.js.org/api/stats/).
+Many OSS tools are allowing you to analyze generated stats file
+- [an official tool](http://webpack.github.io/analyse/#modules) from webpack authors
+- [webpack-visualizer](https://chrisbateman.github.io/webpack-visualizer/)
+
## Frequently asked questions
### Is migrating a plugin an all-or-nothing thing?
@@ -1191,26 +1252,27 @@ import { npStart: { plugins } } from 'ui/new_platform';
In server code, `core` can be accessed from either `server.newPlatform` or `kbnServer.newPlatform`. There are not currently very many services available on the server-side:
-| Legacy Platform | New Platform | Notes |
-| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
-| `server.config()` | [`initializerContext.config.create()`](/docs/development/core/server/kibana-plugin-core-server.plugininitializercontext.config.md) | Must also define schema. See _[how to configure plugin](#configure-plugin)_ |
-| `server.route` | [`core.http.createRouter`](/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.createrouter.md) | [Examples](./MIGRATION_EXAMPLES.md#route-registration) |
-| `server.renderApp()` / `server.renderAppWithDefaultConfig()` | [`context.rendering.render()`](/docs/development/core/server/kibana-plugin-core-server.iscopedrenderingclient.render.md) | [Examples](./MIGRATION_EXAMPLES.md#render-html-content) |
-| `request.getBasePath()` | [`core.http.basePath.get`](/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.basepath.md) | |
+| Legacy Platform | New Platform | Notes |
+| ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
+| `server.config()` | [`initializerContext.config.create()`](/docs/development/core/server/kibana-plugin-core-server.plugininitializercontext.config.md) | Must also define schema. See _[how to configure plugin](#configure-plugin)_ |
+| `server.route` | [`core.http.createRouter`](/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.createrouter.md) | [Examples](./MIGRATION_EXAMPLES.md#route-registration) |
+| `server.renderApp()` | [`response.renderCoreApp()`](docs/development/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.rendercoreapp.md) | [Examples](./MIGRATION_EXAMPLES.md#render-html-content) |
+| `server.renderAppWithDefaultConfig()` | [`response.renderAnonymousCoreApp()`](docs/development/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.renderanonymouscoreapp.md) | [Examples](./MIGRATION_EXAMPLES.md#render-html-content) |
+| `request.getBasePath()` | [`core.http.basePath.get`](/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.basepath.md) | |
| `server.plugins.elasticsearch.getCluster('data')` | [`context.core.elasticsearch.dataClient`](/docs/development/core/server/kibana-plugin-core-server.iscopedclusterclient.md) | |
| `server.plugins.elasticsearch.getCluster('admin')` | [`context.core.elasticsearch.adminClient`](/docs/development/core/server/kibana-plugin-core-server.iscopedclusterclient.md) | |
-| `server.plugins.elasticsearch.createCluster(...)` | [`core.elasticsearch.legacy.createClient`](/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicestart.legacy.md) | |
-| `server.savedObjects.setScopedSavedObjectsClientFactory` | [`core.savedObjects.setClientFactoryProvider`](/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.setclientfactoryprovider.md) | |
-| `server.savedObjects.addScopedSavedObjectsClientWrapperFactory` | [`core.savedObjects.addClientWrapper`](/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.addclientwrapper.md) | |
+| `server.plugins.elasticsearch.createCluster(...)` | [`core.elasticsearch.legacy.createClient`](/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicestart.legacy.md) | |
+| `server.savedObjects.setScopedSavedObjectsClientFactory` | [`core.savedObjects.setClientFactoryProvider`](/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.setclientfactoryprovider.md) | |
+| `server.savedObjects.addScopedSavedObjectsClientWrapperFactory` | [`core.savedObjects.addClientWrapper`](/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.addclientwrapper.md) | |
| `server.savedObjects.getSavedObjectsRepository` | [`core.savedObjects.createInternalRepository`](/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.createinternalrepository.md) [`core.savedObjects.createScopedRepository`](/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.createscopedrepository.md) | |
-| `server.savedObjects.getScopedSavedObjectsClient` | [`core.savedObjects.getScopedClient`](/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.getscopedclient.md) | |
-| `request.getSavedObjectsClient` | [`context.core.savedObjects.client`](/docs/development/core/server/kibana-plugin-core-server.requesthandlercontext.core.md) | |
+| `server.savedObjects.getScopedSavedObjectsClient` | [`core.savedObjects.getScopedClient`](/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.getscopedclient.md) | |
+| `request.getSavedObjectsClient` | [`context.core.savedObjects.client`](/docs/development/core/server/kibana-plugin-core-server.requesthandlercontext.core.md) | |
| `request.getUiSettingsService` | [`context.core.uiSettings.client`](/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.md) | |
-| `kibana.Plugin.deprecations` | [Handle plugin configuration deprecations](#handle-plugin-config-deprecations) and [`PluginConfigDescriptor.deprecations`](docs/development/core/server/kibana-plugin-core-server.pluginconfigdescriptor.md) | Deprecations from New Platform are not applied to legacy configuration |
-| `kibana.Plugin.savedObjectSchemas` | [`core.savedObjects.registerType`](docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.registertype.md) | [Examples](./MIGRATION_EXAMPLES.md#saved-objects-types) |
-| `kibana.Plugin.mappings` | [`core.savedObjects.registerType`](docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.registertype.md) | [Examples](./MIGRATION_EXAMPLES.md#saved-objects-types) |
-| `kibana.Plugin.migrations` | [`core.savedObjects.registerType`](docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.registertype.md) | [Examples](./MIGRATION_EXAMPLES.md#saved-objects-types) |
-| `kibana.Plugin.savedObjectsManagement` | [`core.savedObjects.registerType`](docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.registertype.md) | [Examples](./MIGRATION_EXAMPLES.md#saved-objects-types) |
+| `kibana.Plugin.deprecations` | [Handle plugin configuration deprecations](#handle-plugin-config-deprecations) and [`PluginConfigDescriptor.deprecations`](docs/development/core/server/kibana-plugin-core-server.pluginconfigdescriptor.md) | Deprecations from New Platform are not applied to legacy configuration |
+| `kibana.Plugin.savedObjectSchemas` | [`core.savedObjects.registerType`](docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.registertype.md) | [Examples](./MIGRATION_EXAMPLES.md#saved-objects-types) |
+| `kibana.Plugin.mappings` | [`core.savedObjects.registerType`](docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.registertype.md) | [Examples](./MIGRATION_EXAMPLES.md#saved-objects-types) |
+| `kibana.Plugin.migrations` | [`core.savedObjects.registerType`](docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.registertype.md) | [Examples](./MIGRATION_EXAMPLES.md#saved-objects-types) |
+| `kibana.Plugin.savedObjectsManagement` | [`core.savedObjects.registerType`](docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.registertype.md) | [Examples](./MIGRATION_EXAMPLES.md#saved-objects-types) |
_See also: [Server's CoreSetup API Docs](/docs/development/core/server/kibana-plugin-core-server.coresetup.md)_
@@ -1433,8 +1495,9 @@ The above example looks in the new platform as
```
The [request handler context](/docs/development/core/server/kibana-plugin-core-server.requesthandlercontext.md) exposed the next scoped **core** services:
-| Legacy Platform | New Platform |
-| --------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------|
+
+| Legacy Platform | New Platform |
+| --------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| `request.getSavedObjectsClient` | [`context.savedObjects.client`](/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.md) |
| `server.plugins.elasticsearch.getCluster('admin')` | [`context.elasticsearch.adminClient`](/docs/development/core/server/kibana-plugin-core-server.iscopedclusterclient.md) |
| `server.plugins.elasticsearch.getCluster('data')` | [`context.elasticsearch.dataClient`](/docs/development/core/server/kibana-plugin-core-server.iscopedclusterclient.md) |
diff --git a/src/core/MIGRATION_EXAMPLES.md b/src/core/MIGRATION_EXAMPLES.md
index 37d0b9297ed3c..8c5fe4875aaea 100644
--- a/src/core/MIGRATION_EXAMPLES.md
+++ b/src/core/MIGRATION_EXAMPLES.md
@@ -700,21 +700,15 @@ application.register({
## Render HTML Content
You can return a blank HTML page bootstrapped with the core application bundle from an HTTP route handler
-via the `rendering` context. You may wish to do this if you are rendering a chromeless application with a
+via the `httpResources` service. You may wish to do this if you are rendering a chromeless application with a
custom application route or have other custom rendering needs.
-```ts
-router.get(
+```typescript
+httpResources.register(
{ path: '/chromeless', validate: false },
(context, request, response) => {
- const { http, rendering } = context.core;
-
- return response.ok({
- body: await rendering.render(), // generates an HTML document
- headers: {
- 'content-security-policy': http.csp.header,
- },
- });
+ //... some logic
+ return response.renderCoreApp();
}
);
```
@@ -724,18 +718,12 @@ comprises all UI Settings that are *user provided*, then injected into the page.
You may wish to exclude fetching this data if not authorized or to slim the page
size.
-```ts
-router.get(
- { path: '/', validate: false },
+```typescript
+httpResources.register(
+ { path: '/', validate: false, options: { authRequired: false } },
(context, request, response) => {
- const { http, rendering } = context.core;
-
- return response.ok({
- body: await rendering.render({ includeUserSettings: false }),
- headers: {
- 'content-security-policy': http.csp.header,
- },
- });
+ //... some logic
+ return response.renderAnonymousCoreApp();
}
);
```
diff --git a/src/core/public/application/scoped_history.test.ts b/src/core/public/application/scoped_history.test.ts
index c01eb50830516..a56cffef1e2f2 100644
--- a/src/core/public/application/scoped_history.test.ts
+++ b/src/core/public/application/scoped_history.test.ts
@@ -268,11 +268,32 @@ describe('ScopedHistory', () => {
const gh = createMemoryHistory();
gh.push('/app/wow');
const h = new ScopedHistory(gh, '/app/wow');
- expect(h.createHref({ pathname: '' })).toEqual(`/`);
+ expect(h.createHref({ pathname: '' })).toEqual(`/app/wow`);
+ expect(h.createHref({})).toEqual(`/app/wow`);
expect(h.createHref({ pathname: '/new-page', search: '?alpha=true' })).toEqual(
- `/new-page?alpha=true`
+ `/app/wow/new-page?alpha=true`
);
});
+
+ it('behave correctly with slash-ending basePath', () => {
+ const gh = createMemoryHistory();
+ gh.push('/app/wow/');
+ const h = new ScopedHistory(gh, '/app/wow/');
+ expect(h.createHref({ pathname: '' })).toEqual(`/app/wow/`);
+ expect(h.createHref({ pathname: '/new-page', search: '?alpha=true' })).toEqual(
+ `/app/wow/new-page?alpha=true`
+ );
+ });
+
+ it('skips the scoped history path when `prependBasePath` is false', () => {
+ const gh = createMemoryHistory();
+ gh.push('/app/wow');
+ const h = new ScopedHistory(gh, '/app/wow');
+ expect(h.createHref({ pathname: '' }, { prependBasePath: false })).toEqual(`/`);
+ expect(
+ h.createHref({ pathname: '/new-page', search: '?alpha=true' }, { prependBasePath: false })
+ ).toEqual(`/new-page?alpha=true`);
+ });
});
describe('action', () => {
diff --git a/src/core/public/application/scoped_history.ts b/src/core/public/application/scoped_history.ts
index c5febc7604feb..9fa8f0b7f8148 100644
--- a/src/core/public/application/scoped_history.ts
+++ b/src/core/public/application/scoped_history.ts
@@ -219,11 +219,26 @@ export class ScopedHistory
/**
* Creates an href (string) to the location.
+ * If `prependBasePath` is true (default), it will prepend the location's path with the scoped history basePath.
*
* @param location
+ * @param prependBasePath
*/
- public createHref = (location: LocationDescriptorObject): Href => {
+ public createHref = (
+ location: LocationDescriptorObject,
+ { prependBasePath = true }: { prependBasePath?: boolean } = {}
+ ): Href => {
this.verifyActive();
+ if (prependBasePath) {
+ location = this.prependBasePath(location);
+ if (location.pathname === undefined) {
+ // we always want to create an url relative to the basePath
+ // so if pathname is not present, we use the history's basePath as default
+ // we are doing that here because `prependBasePath` should not
+ // alter pathname for other method calls
+ location.pathname = this.basePath;
+ }
+ }
return this.parentHistory.createHref(location);
};
@@ -254,8 +269,7 @@ export class ScopedHistory
* Prepends the base path to string.
*/
private prependBasePathToString(path: string): string {
- path = path.startsWith('/') ? path.slice(1) : path;
- return path.length ? `${this.basePath}/${path}` : this.basePath;
+ return path.length ? `${this.basePath}/${path}`.replace(/\/{2,}/g, '/') : this.basePath;
}
/**
diff --git a/src/core/public/mocks.ts b/src/core/public/mocks.ts
index 0c4930592b233..959ffaa7e7e08 100644
--- a/src/core/public/mocks.ts
+++ b/src/core/public/mocks.ts
@@ -48,6 +48,7 @@ export { overlayServiceMock } from './overlays/overlay_service.mock';
export { uiSettingsServiceMock } from './ui_settings/ui_settings_service.mock';
export { savedObjectsServiceMock } from './saved_objects/saved_objects_service.mock';
export { scopedHistoryMock } from './application/scoped_history.mock';
+export { applicationServiceMock } from './application/application_service.mock';
function createCoreSetupMock({
basePath = '',
@@ -62,9 +63,8 @@ function createCoreSetupMock({
application: applicationServiceMock.createSetupContract(),
context: contextServiceMock.createSetupContract(),
fatalErrors: fatalErrorsServiceMock.createSetupContract(),
- getStartServices: jest.fn, object, any]>, []>(
- () =>
- Promise.resolve([createCoreStartMock({ basePath }), pluginStartDeps, pluginStartContract])
+ getStartServices: jest.fn, any, any]>, []>(() =>
+ Promise.resolve([createCoreStartMock({ basePath }), pluginStartDeps, pluginStartContract])
),
http: httpServiceMock.createSetupContract({ basePath }),
notifications: notificationServiceMock.createSetupContract(),
diff --git a/src/core/public/public.api.md b/src/core/public/public.api.md
index a5aa37becabc2..6d95d1bc7069c 100644
--- a/src/core/public/public.api.md
+++ b/src/core/public/public.api.md
@@ -1196,7 +1196,9 @@ export class ScopedHistory implements History | undefined) => UnregisterCallback;
- createHref: (location: LocationDescriptorObject) => string;
+ createHref: (location: LocationDescriptorObject, { prependBasePath }?: {
+ prependBasePath?: boolean | undefined;
+ }) => string;
createSubHistory: (basePath: string) => ScopedHistory;
go: (n: number) => void;
goBack: () => void;
diff --git a/src/core/server/elasticsearch/elasticsearch_service.ts b/src/core/server/elasticsearch/elasticsearch_service.ts
index 684f6e15caff9..18725f04a05b5 100644
--- a/src/core/server/elasticsearch/elasticsearch_service.ts
+++ b/src/core/server/elasticsearch/elasticsearch_service.ts
@@ -33,7 +33,12 @@ import { CoreService } from '../../types';
import { merge } from '../../utils';
import { CoreContext } from '../core_context';
import { Logger } from '../logging';
-import { ClusterClient, ScopeableRequest } from './cluster_client';
+import {
+ ClusterClient,
+ ScopeableRequest,
+ IClusterClient,
+ ICustomClusterClient,
+} from './cluster_client';
import { ElasticsearchClientConfig } from './elasticsearch_client_config';
import { ElasticsearchConfig, ElasticsearchConfigType } from './elasticsearch_config';
import { InternalHttpServiceSetup, GetAuthHeaders } from '../http/';
@@ -58,12 +63,14 @@ export class ElasticsearchService
implements CoreService {
private readonly log: Logger;
private readonly config$: Observable;
- private subscription: Subscription | undefined;
+ private subscription?: Subscription;
private stop$ = new Subject();
private kibanaVersion: string;
- createClient: InternalElasticsearchServiceSetup['createClient'] | undefined;
- dataClient: InternalElasticsearchServiceSetup['dataClient'] | undefined;
- adminClient: InternalElasticsearchServiceSetup['adminClient'] | undefined;
+ private createClient?: (
+ type: string,
+ clientConfig?: Partial
+ ) => ICustomClusterClient;
+ private adminClient?: IClusterClient;
constructor(private readonly coreContext: CoreContext) {
this.kibanaVersion = coreContext.env.packageInfo.version;
diff --git a/src/core/server/http/index.ts b/src/core/server/http/index.ts
index a75eb04fa0120..ca9dfde2e71dc 100644
--- a/src/core/server/http/index.ts
+++ b/src/core/server/http/index.ts
@@ -38,6 +38,7 @@ export {
LifecycleResponseFactory,
RedirectResponseOptions,
RequestHandler,
+ RequestHandlerWrapper,
ResponseError,
ResponseErrorAttributes,
ResponseHeaders,
diff --git a/src/core/server/http/lifecycle/on_pre_response.ts b/src/core/server/http/lifecycle/on_pre_response.ts
index 50d3d7b47bf8d..050881472bc80 100644
--- a/src/core/server/http/lifecycle/on_pre_response.ts
+++ b/src/core/server/http/lifecycle/on_pre_response.ts
@@ -148,7 +148,7 @@ function findHeadersIntersection(
log: Logger
) {
Object.keys(headers).forEach(headerName => {
- if (responseHeaders[headerName] !== undefined) {
+ if (Reflect.has(responseHeaders, headerName)) {
log.warn(`onPreResponseHandler rewrote a response header [${headerName}].`);
}
});
diff --git a/src/core/server/http/router/error_wrapper.ts b/src/core/server/http/router/error_wrapper.ts
index 8f895753c38c3..af99812eff4b3 100644
--- a/src/core/server/http/router/error_wrapper.ts
+++ b/src/core/server/http/router/error_wrapper.ts
@@ -18,20 +18,10 @@
*/
import Boom from 'boom';
-import { KibanaRequest } from './request';
-import { KibanaResponseFactory } from './response';
-import { RequestHandler } from './router';
-import { RequestHandlerContext } from '../../../server';
-import { RouteMethod } from './route';
+import { RequestHandlerWrapper } from './router';
-export const wrapErrors = (
- handler: RequestHandler
-): RequestHandler => {
- return async (
- context: RequestHandlerContext,
- request: KibanaRequest,
- response: KibanaResponseFactory
- ) => {
+export const wrapErrors: RequestHandlerWrapper = handler => {
+ return async (context, request, response) => {
try {
return await handler(context, request, response);
} catch (e) {
diff --git a/src/core/server/http/router/headers.ts b/src/core/server/http/router/headers.ts
index 19eaee5081996..b79cc0d325f1e 100644
--- a/src/core/server/http/router/headers.ts
+++ b/src/core/server/http/router/headers.ts
@@ -56,9 +56,9 @@ export type Headers = { [header in KnownHeaders]?: string | string[] | undefined
* Http response headers to set.
* @public
*/
-export type ResponseHeaders = { [header in KnownHeaders]?: string | string[] } & {
- [header: string]: string | string[];
-};
+export type ResponseHeaders =
+ | Record
+ | Record;
const normalizeHeaderField = (field: string) => field.trim().toLowerCase();
diff --git a/src/core/server/http/router/index.ts b/src/core/server/http/router/index.ts
index d254f391ca5e4..83ceff4a25d86 100644
--- a/src/core/server/http/router/index.ts
+++ b/src/core/server/http/router/index.ts
@@ -18,7 +18,7 @@
*/
export { Headers, filterHeaders, ResponseHeaders, KnownHeaders } from './headers';
-export { Router, RequestHandler, IRouter, RouteRegistrar } from './router';
+export { Router, RequestHandler, RequestHandlerWrapper, IRouter, RouteRegistrar } from './router';
export {
KibanaRequest,
KibanaRequestEvents,
diff --git a/src/core/server/http/router/router.ts b/src/core/server/http/router/router.ts
index bb56ee3727d1a..b4e7fc2a989b6 100644
--- a/src/core/server/http/router/router.ts
+++ b/src/core/server/http/router/router.ts
@@ -98,7 +98,7 @@ export interface IRouter {
* Wrap a router handler to catch and converts legacy boom errors to proper custom errors.
* @param handler {@link RequestHandler} - a route handler to wrap
*/
- handleLegacyErrors: (handler: RequestHandler) => RequestHandler;
+ handleLegacyErrors: RequestHandlerWrapper;
/**
* Returns all routes registered with this router.
@@ -237,9 +237,7 @@ export class Router implements IRouter {
return [...this.routes];
}
- public handleLegacyErrors(handler: RequestHandler): RequestHandler {
- return wrapErrors(handler);
- }
+ public handleLegacyErrors = wrapErrors;
private async handle({
routeSchemas,
@@ -316,9 +314,33 @@ export type RequestHandler<
P = unknown,
Q = unknown,
B = unknown,
- Method extends RouteMethod = any
+ Method extends RouteMethod = any,
+ ResponseFactory extends KibanaResponseFactory = KibanaResponseFactory
> = (
context: RequestHandlerContext,
request: KibanaRequest,
- response: KibanaResponseFactory
+ response: ResponseFactory
) => IKibanaResponse | Promise>;
+
+/**
+ * Type-safe wrapper for {@link RequestHandler} function.
+ * @example
+ * ```typescript
+ * export const wrapper: RequestHandlerWrapper = handler => {
+ * return async (context, request, response) => {
+ * // do some logic
+ * ...
+ * };
+ * }
+ * ```
+ * @public
+ */
+export type RequestHandlerWrapper = <
+ P,
+ Q,
+ B,
+ Method extends RouteMethod = any,
+ ResponseFactory extends KibanaResponseFactory = KibanaResponseFactory
+>(
+ handler: RequestHandler
+) => RequestHandler;
diff --git a/src/core/server/http_resources/http_resources_service.mock.ts b/src/core/server/http_resources/http_resources_service.mock.ts
new file mode 100644
index 0000000000000..4536b0898cad9
--- /dev/null
+++ b/src/core/server/http_resources/http_resources_service.mock.ts
@@ -0,0 +1,50 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+import { httpServerMock } from '../http/http_server.mocks';
+import { HttpResources, HttpResourcesServiceToolkit } from './types';
+
+const createHttpResourcesMock = (): jest.Mocked => ({
+ register: jest.fn(),
+});
+
+function createInternalHttpResourcesSetup() {
+ return {
+ createRegistrar: createHttpResourcesMock,
+ };
+}
+
+function createHttpResourcesResponseFactory() {
+ const mocked: jest.Mocked = {
+ renderCoreApp: jest.fn(),
+ renderAnonymousCoreApp: jest.fn(),
+ renderHtml: jest.fn(),
+ renderJs: jest.fn(),
+ };
+
+ return {
+ ...httpServerMock.createResponseFactory(),
+ ...mocked,
+ };
+}
+
+export const httpResourcesMock = {
+ createRegistrar: createHttpResourcesMock,
+ createSetupContract: createInternalHttpResourcesSetup,
+ createResponseFactory: createHttpResourcesResponseFactory,
+};
diff --git a/src/core/server/http_resources/http_resources_service.test.ts b/src/core/server/http_resources/http_resources_service.test.ts
new file mode 100644
index 0000000000000..e6f129ba12d78
--- /dev/null
+++ b/src/core/server/http_resources/http_resources_service.test.ts
@@ -0,0 +1,258 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+import { IRouter, RouteConfig } from '../http';
+
+import { coreMock } from '../mocks';
+import { mockCoreContext } from '../core_context.mock';
+import { httpServiceMock } from '../http/http_service.mock';
+import { httpServerMock } from '../http/http_server.mocks';
+import { renderingMock } from '../rendering/rendering_service.mock';
+import { HttpResourcesService, SetupDeps } from './http_resources_service';
+import { httpResourcesMock } from './http_resources_service.mock';
+
+const coreContext = mockCoreContext.create();
+
+describe('HttpResources service', () => {
+ let service: HttpResourcesService;
+ let setupDeps: SetupDeps;
+ let router: jest.Mocked;
+ const kibanaRequest = httpServerMock.createKibanaRequest();
+ const context = { core: coreMock.createRequestHandlerContext() };
+ describe('#createRegistrar', () => {
+ beforeEach(() => {
+ setupDeps = {
+ http: httpServiceMock.createSetupContract(),
+ rendering: renderingMock.createSetupContract(),
+ };
+ service = new HttpResourcesService(coreContext);
+ router = httpServiceMock.createRouter();
+ });
+
+ describe('register', () => {
+ describe('renderCoreApp', () => {
+ it('formats successful response', async () => {
+ const routeConfig: RouteConfig = { path: '/', validate: false };
+ const { createRegistrar } = await service.setup(setupDeps);
+ const { register } = createRegistrar(router);
+ register(routeConfig, async (ctx, req, res) => {
+ return res.renderCoreApp();
+ });
+ const [[, routeHandler]] = router.get.mock.calls;
+
+ const responseFactory = httpResourcesMock.createResponseFactory();
+ await routeHandler(context, kibanaRequest, responseFactory);
+ expect(setupDeps.rendering.render).toHaveBeenCalledWith(
+ kibanaRequest,
+ context.core.uiSettings.client,
+ {
+ includeUserSettings: true,
+ }
+ );
+ });
+
+ it('can attach headers, except the CSP header', async () => {
+ const routeConfig: RouteConfig = { path: '/', validate: false };
+ const { createRegistrar } = await service.setup(setupDeps);
+ const { register } = createRegistrar(router);
+ register(routeConfig, async (ctx, req, res) => {
+ return res.renderCoreApp({
+ headers: {
+ 'content-security-policy': "script-src 'unsafe-eval'",
+ 'x-kibana': '42',
+ },
+ });
+ });
+
+ const [[, routeHandler]] = router.get.mock.calls;
+
+ const responseFactory = httpResourcesMock.createResponseFactory();
+ await routeHandler(context, kibanaRequest, responseFactory);
+
+ expect(responseFactory.ok).toHaveBeenCalledWith({
+ body: '',
+ headers: {
+ 'x-kibana': '42',
+ 'content-security-policy':
+ "script-src 'unsafe-eval' 'self'; worker-src blob: 'self'; style-src 'unsafe-inline' 'self'",
+ },
+ });
+ });
+ });
+ describe('renderAnonymousCoreApp', () => {
+ it('formats successful response', async () => {
+ const routeConfig: RouteConfig = { path: '/', validate: false };
+ const { createRegistrar } = await service.setup(setupDeps);
+ const { register } = createRegistrar(router);
+ register(routeConfig, async (ctx, req, res) => {
+ return res.renderAnonymousCoreApp();
+ });
+ const [[, routeHandler]] = router.get.mock.calls;
+
+ const responseFactory = httpResourcesMock.createResponseFactory();
+ await routeHandler(context, kibanaRequest, responseFactory);
+ expect(setupDeps.rendering.render).toHaveBeenCalledWith(
+ kibanaRequest,
+ context.core.uiSettings.client,
+ {
+ includeUserSettings: false,
+ }
+ );
+ });
+
+ it('can attach headers, except the CSP header', async () => {
+ const routeConfig: RouteConfig = { path: '/', validate: false };
+ const { createRegistrar } = await service.setup(setupDeps);
+ const { register } = createRegistrar(router);
+ register(routeConfig, async (ctx, req, res) => {
+ return res.renderAnonymousCoreApp({
+ headers: {
+ 'content-security-policy': "script-src 'unsafe-eval'",
+ 'x-kibana': '42',
+ },
+ });
+ });
+
+ const [[, routeHandler]] = router.get.mock.calls;
+
+ const responseFactory = httpResourcesMock.createResponseFactory();
+ await routeHandler(context, kibanaRequest, responseFactory);
+
+ expect(responseFactory.ok).toHaveBeenCalledWith({
+ body: '',
+ headers: {
+ 'x-kibana': '42',
+ 'content-security-policy':
+ "script-src 'unsafe-eval' 'self'; worker-src blob: 'self'; style-src 'unsafe-inline' 'self'",
+ },
+ });
+ });
+ });
+ describe('renderHtml', () => {
+ it('formats successful response', async () => {
+ const htmlBody = '';
+ const routeConfig: RouteConfig = { path: '/', validate: false };
+ const { createRegistrar } = await service.setup(setupDeps);
+ const { register } = createRegistrar(router);
+ register(routeConfig, async (ctx, req, res) => {
+ return res.renderHtml({ body: htmlBody });
+ });
+ const [[, routeHandler]] = router.get.mock.calls;
+
+ const responseFactory = httpResourcesMock.createResponseFactory();
+ await routeHandler(context, kibanaRequest, responseFactory);
+ expect(responseFactory.ok).toHaveBeenCalledWith({
+ body: htmlBody,
+ headers: {
+ 'content-type': 'text/html',
+ 'content-security-policy':
+ "script-src 'unsafe-eval' 'self'; worker-src blob: 'self'; style-src 'unsafe-inline' 'self'",
+ },
+ });
+ });
+
+ it('can attach headers, except the CSP & "content-type" headers', async () => {
+ const htmlBody = '';
+ const routeConfig: RouteConfig = { path: '/', validate: false };
+ const { createRegistrar } = await service.setup(setupDeps);
+ const { register } = createRegistrar(router);
+ register(routeConfig, async (ctx, req, res) => {
+ return res.renderHtml({
+ body: htmlBody,
+ headers: {
+ 'content-type': 'text/html5',
+ 'content-security-policy': "script-src 'unsafe-eval'",
+ 'x-kibana': '42',
+ },
+ });
+ });
+
+ const [[, routeHandler]] = router.get.mock.calls;
+
+ const responseFactory = httpResourcesMock.createResponseFactory();
+ await routeHandler(context, kibanaRequest, responseFactory);
+
+ expect(responseFactory.ok).toHaveBeenCalledWith({
+ body: htmlBody,
+ headers: {
+ 'content-type': 'text/html',
+ 'x-kibana': '42',
+ 'content-security-policy':
+ "script-src 'unsafe-eval' 'self'; worker-src blob: 'self'; style-src 'unsafe-inline' 'self'",
+ },
+ });
+ });
+ });
+ describe('renderJs', () => {
+ it('formats successful response', async () => {
+ const jsBody = 'alert(1);';
+ const routeConfig: RouteConfig = { path: '/', validate: false };
+ const { createRegistrar } = await service.setup(setupDeps);
+ const { register } = createRegistrar(router);
+ register(routeConfig, async (ctx, req, res) => {
+ return res.renderJs({ body: jsBody });
+ });
+ const [[, routeHandler]] = router.get.mock.calls;
+
+ const responseFactory = httpResourcesMock.createResponseFactory();
+ await routeHandler(context, kibanaRequest, responseFactory);
+ expect(responseFactory.ok).toHaveBeenCalledWith({
+ body: jsBody,
+ headers: {
+ 'content-type': 'text/javascript',
+ 'content-security-policy':
+ "script-src 'unsafe-eval' 'self'; worker-src blob: 'self'; style-src 'unsafe-inline' 'self'",
+ },
+ });
+ });
+
+ it('can attach headers, except the CSP & "content-type" headers', async () => {
+ const jsBody = 'alert(1);';
+ const routeConfig: RouteConfig = { path: '/', validate: false };
+ const { createRegistrar } = await service.setup(setupDeps);
+ const { register } = createRegistrar(router);
+ register(routeConfig, async (ctx, req, res) => {
+ return res.renderJs({
+ body: jsBody,
+ headers: {
+ 'content-type': 'text/html',
+ 'content-security-policy': "script-src 'unsafe-eval'",
+ 'x-kibana': '42',
+ },
+ });
+ });
+
+ const [[, routeHandler]] = router.get.mock.calls;
+
+ const responseFactory = httpResourcesMock.createResponseFactory();
+ await routeHandler(context, kibanaRequest, responseFactory);
+
+ expect(responseFactory.ok).toHaveBeenCalledWith({
+ body: jsBody,
+ headers: {
+ 'content-type': 'text/javascript',
+ 'x-kibana': '42',
+ 'content-security-policy':
+ "script-src 'unsafe-eval' 'self'; worker-src blob: 'self'; style-src 'unsafe-inline' 'self'",
+ },
+ });
+ });
+ });
+ });
+ });
+});
diff --git a/src/core/server/http_resources/http_resources_service.ts b/src/core/server/http_resources/http_resources_service.ts
new file mode 100644
index 0000000000000..bc79ad68f4099
--- /dev/null
+++ b/src/core/server/http_resources/http_resources_service.ts
@@ -0,0 +1,130 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+import { RequestHandlerContext } from 'src/core/server';
+
+import { CoreContext } from '../core_context';
+import {
+ IRouter,
+ RouteConfig,
+ InternalHttpServiceSetup,
+ KibanaRequest,
+ KibanaResponseFactory,
+} from '../http';
+
+import { Logger } from '../logging';
+import { InternalRenderingServiceSetup } from '../rendering';
+import { CoreService } from '../../types';
+
+import {
+ InternalHttpResourcesSetup,
+ HttpResources,
+ HttpResourcesResponseOptions,
+ HttpResourcesRenderOptions,
+ HttpResourcesRequestHandler,
+ HttpResourcesServiceToolkit,
+} from './types';
+
+export interface SetupDeps {
+ http: InternalHttpServiceSetup;
+ rendering: InternalRenderingServiceSetup;
+}
+
+export class HttpResourcesService implements CoreService {
+ private readonly logger: Logger;
+ constructor(core: CoreContext) {
+ this.logger = core.logger.get('http-resources');
+ }
+
+ setup(deps: SetupDeps) {
+ this.logger.debug('setting up HttpResourcesService');
+ return {
+ createRegistrar: this.createRegistrar.bind(this, deps),
+ };
+ }
+
+ start() {}
+ stop() {}
+
+ private createRegistrar(deps: SetupDeps, router: IRouter): HttpResources {
+ return {
+ register: (
+ route: RouteConfig,
+ handler: HttpResourcesRequestHandler
+ ) => {
+ return router.get(route, (context, request, response) => {
+ return handler(context, request, {
+ ...response,
+ ...this.createResponseToolkit(deps, context, request, response),
+ });
+ });
+ },
+ };
+ }
+
+ private createResponseToolkit(
+ deps: SetupDeps,
+ context: RequestHandlerContext,
+ request: KibanaRequest,
+ response: KibanaResponseFactory
+ ): HttpResourcesServiceToolkit {
+ const cspHeader = deps.http.csp.header;
+ return {
+ async renderCoreApp(options: HttpResourcesRenderOptions = {}) {
+ const body = await deps.rendering.render(request, context.core.uiSettings.client, {
+ includeUserSettings: true,
+ });
+
+ return response.ok({
+ body,
+ headers: { ...options.headers, 'content-security-policy': cspHeader },
+ });
+ },
+ async renderAnonymousCoreApp(options: HttpResourcesRenderOptions = {}) {
+ const body = await deps.rendering.render(request, context.core.uiSettings.client, {
+ includeUserSettings: false,
+ });
+
+ return response.ok({
+ body,
+ headers: { ...options.headers, 'content-security-policy': cspHeader },
+ });
+ },
+ renderHtml(options: HttpResourcesResponseOptions) {
+ return response.ok({
+ body: options.body,
+ headers: {
+ ...options.headers,
+ 'content-type': 'text/html',
+ 'content-security-policy': cspHeader,
+ },
+ });
+ },
+ renderJs(options: HttpResourcesResponseOptions) {
+ return response.ok({
+ body: options.body,
+ headers: {
+ ...options.headers,
+ 'content-type': 'text/javascript',
+ 'content-security-policy': cspHeader,
+ },
+ });
+ },
+ };
+ }
+}
diff --git a/src/core/server/http_resources/index.ts b/src/core/server/http_resources/index.ts
new file mode 100644
index 0000000000000..b373c6a9efa89
--- /dev/null
+++ b/src/core/server/http_resources/index.ts
@@ -0,0 +1,29 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+export { HttpResourcesService } from './http_resources_service';
+
+export {
+ HttpResourcesRenderOptions,
+ HttpResourcesResponseOptions,
+ HttpResourcesServiceToolkit,
+ HttpResourcesRequestHandler,
+ HttpResources,
+ InternalHttpResourcesSetup,
+} from './types';
diff --git a/src/core/server/http_resources/integration_tests/http_resources_service.test.ts b/src/core/server/http_resources/integration_tests/http_resources_service.test.ts
new file mode 100644
index 0000000000000..0a5daa02e17e9
--- /dev/null
+++ b/src/core/server/http_resources/integration_tests/http_resources_service.test.ts
@@ -0,0 +1,203 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+import { schema } from '@kbn/config-schema';
+import * as kbnTestServer from '../../../../test_utils/kbn_server';
+
+describe('http resources service', () => {
+ describe('register', () => {
+ let root: ReturnType;
+ const defaultCspRules = "script-src 'self'";
+ beforeEach(async () => {
+ root = kbnTestServer.createRoot({
+ csp: {
+ rules: [defaultCspRules],
+ },
+ });
+ }, 30000);
+
+ afterEach(async () => {
+ await root.shutdown();
+ });
+
+ describe('renderAnonymousCoreApp', () => {
+ it('renders core application', async () => {
+ const { http, httpResources } = await root.setup();
+
+ const router = http.createRouter('');
+ const resources = httpResources.createRegistrar(router);
+ resources.register({ path: '/render-core', validate: false }, (context, req, res) =>
+ res.renderAnonymousCoreApp()
+ );
+
+ await root.start();
+ const response = await kbnTestServer.request.get(root, '/render-core').expect(200);
+
+ expect(response.text.length).toBeGreaterThan(0);
+ });
+
+ it('attaches CSP header', async () => {
+ const { http, httpResources } = await root.setup();
+
+ const router = http.createRouter('');
+ const resources = httpResources.createRegistrar(router);
+ resources.register({ path: '/render-core', validate: false }, (context, req, res) =>
+ res.renderAnonymousCoreApp()
+ );
+
+ await root.start();
+ const response = await kbnTestServer.request.get(root, '/render-core').expect(200);
+
+ expect(response.header['content-security-policy']).toBe(defaultCspRules);
+ });
+
+ it('can attach headers, except the CSP header', async () => {
+ const { http, httpResources } = await root.setup();
+
+ const router = http.createRouter('');
+ const resources = httpResources.createRegistrar(router);
+ resources.register({ path: '/render-core', validate: false }, (context, req, res) =>
+ res.renderAnonymousCoreApp({
+ headers: {
+ 'content-security-policy': "script-src 'unsafe-eval'",
+ 'x-kibana': '42',
+ },
+ })
+ );
+
+ await root.start();
+ const response = await kbnTestServer.request.get(root, '/render-core').expect(200);
+
+ expect(response.header['content-security-policy']).toBe(defaultCspRules);
+ expect(response.header['x-kibana']).toBe('42');
+ });
+ });
+
+ describe('custom renders', () => {
+ it('renders html', async () => {
+ const { http, httpResources } = await root.setup();
+
+ const router = http.createRouter('');
+ const resources = httpResources.createRegistrar(router);
+ const htmlBody = `
+
+
+
+ HTML body
+
+
+ `;
+ resources.register({ path: '/render-html', validate: false }, (context, req, res) =>
+ res.renderHtml({ body: htmlBody })
+ );
+
+ await root.start();
+ const response = await kbnTestServer.request.get(root, '/render-html').expect(200);
+
+ expect(response.text).toBe(htmlBody);
+ expect(response.header['content-type']).toBe('text/html; charset=utf-8');
+ });
+
+ it('renders javascript', async () => {
+ const { http, httpResources } = await root.setup();
+
+ const router = http.createRouter('');
+ const resources = httpResources.createRegistrar(router);
+ const jsBody = 'window.alert("from js body");';
+ resources.register({ path: '/render-js', validate: false }, (context, req, res) =>
+ res.renderJs({ body: jsBody })
+ );
+
+ await root.start();
+ const response = await kbnTestServer.request.get(root, '/render-js').expect(200);
+
+ expect(response.text).toBe(jsBody);
+ expect(response.header['content-type']).toBe('text/javascript; charset=utf-8');
+ });
+
+ it('attaches CSP header', async () => {
+ const { http, httpResources } = await root.setup();
+
+ const router = http.createRouter('');
+ const resources = httpResources.createRegistrar(router);
+ const htmlBody = `
+
+
+
+ HTML body
+
+
+ `;
+ resources.register({ path: '/render-html', validate: false }, (context, req, res) =>
+ res.renderHtml({ body: htmlBody })
+ );
+
+ await root.start();
+ const response = await kbnTestServer.request.get(root, '/render-html').expect(200);
+
+ expect(response.header['content-security-policy']).toBe(defaultCspRules);
+ });
+
+ it('can attach headers, except the CSP & "content-type" headers', async () => {
+ const { http, httpResources } = await root.setup();
+
+ const router = http.createRouter('');
+ const resources = httpResources.createRegistrar(router);
+ resources.register({ path: '/render-core', validate: false }, (context, req, res) =>
+ res.renderHtml({
+ body: 'Hi
',
+ headers: {
+ 'content-security-policy': "script-src 'unsafe-eval'",
+ 'content-type': 'text/html',
+ 'x-kibana': '42',
+ },
+ })
+ );
+
+ await root.start();
+ const response = await kbnTestServer.request.get(root, '/render-core').expect(200);
+
+ expect(response.header['content-security-policy']).toBe(defaultCspRules);
+ expect(response.header['x-kibana']).toBe('42');
+ });
+
+ it('can adjust route config', async () => {
+ const { http, httpResources } = await root.setup();
+
+ const router = http.createRouter('');
+ const resources = httpResources.createRegistrar(router);
+ const validate = {
+ params: schema.object({
+ id: schema.string(),
+ }),
+ };
+
+ resources.register({ path: '/render-js-with-param/{id}', validate }, (context, req, res) =>
+ res.renderJs({ body: `window.alert(${req.params.id});` })
+ );
+
+ await root.start();
+ const response = await kbnTestServer.request
+ .get(root, '/render-js-with-param/42')
+ .expect(200);
+
+ expect(response.text).toBe('window.alert(42);');
+ });
+ });
+ });
+});
diff --git a/src/core/server/http_resources/types.ts b/src/core/server/http_resources/types.ts
new file mode 100644
index 0000000000000..d761e2def1023
--- /dev/null
+++ b/src/core/server/http_resources/types.ts
@@ -0,0 +1,116 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import {
+ IRouter,
+ RouteConfig,
+ IKibanaResponse,
+ ResponseHeaders,
+ HttpResponseOptions,
+ KibanaResponseFactory,
+ RequestHandler,
+} from '../http';
+
+/**
+ * Allows to configure HTTP response parameters
+ * @public
+ */
+export interface HttpResourcesRenderOptions {
+ /**
+ * HTTP Headers with additional information about response.
+ * @remarks
+ * All HTML pages are already pre-configured with `content-security-policy` header that cannot be overridden.
+ * */
+ headers?: ResponseHeaders;
+}
+
+/**
+ * HTTP Resources response parameters
+ * @public
+ */
+export type HttpResourcesResponseOptions = HttpResponseOptions;
+
+/**
+ * Extended set of {@link KibanaResponseFactory} helpers used to respond with HTML or JS resource.
+ * @public
+ */
+export interface HttpResourcesServiceToolkit {
+ /** To respond with HTML page bootstrapping Kibana application. */
+ renderCoreApp: (options?: HttpResourcesRenderOptions) => Promise;
+ /** To respond with HTML page bootstrapping Kibana application without retrieving user-specific information. */
+ renderAnonymousCoreApp: (options?: HttpResourcesRenderOptions) => Promise;
+ /** To respond with a custom HTML page. */
+ renderHtml: (options: HttpResourcesResponseOptions) => IKibanaResponse;
+ /** To respond with a custom JS script file. */
+ renderJs: (options: HttpResourcesResponseOptions) => IKibanaResponse;
+}
+
+/**
+ * Extended version of {@link RequestHandler} having access to {@link HttpResourcesServiceToolkit}
+ * to respond with HTML or JS resources.
+ * @param context {@link RequestHandlerContext} - the core context exposed for this request.
+ * @param request {@link KibanaRequest} - object containing information about requested resource,
+ * such as path, method, headers, parameters, query, body, etc.
+ * @param response {@link KibanaResponseFactory} {@libk HttpResourcesServiceToolkit} - a set of helper functions used to respond to a request.
+ *
+ * @example
+ * ```typescript
+ * httpResources.register({
+ * path: '/login',
+ * validate: {
+ * params: schema.object({ id: schema.string() }),
+ * },
+ * },
+ * async (context, request, response) => {
+ * //..
+ * return response.renderCoreApp();
+ * });
+ * @public
+ */
+export type HttpResourcesRequestHandler = RequestHandler<
+ P,
+ Q,
+ B,
+ 'get',
+ KibanaResponseFactory & HttpResourcesServiceToolkit
+>;
+
+/**
+ * Allows to configure HTTP response parameters
+ * @internal
+ */
+export interface InternalHttpResourcesSetup {
+ createRegistrar(router: IRouter): HttpResources;
+}
+
+/**
+ * HttpResources service is responsible for serving static & dynamic assets for Kibana application via HTTP.
+ * Provides API allowing plug-ins to respond with:
+ * - a pre-configured HTML page bootstrapping Kibana client app
+ * - custom HTML page
+ * - custom JS script file.
+ * @public
+ */
+export interface HttpResources {
+ /** To register a route handler executing passed function to form response. */
+ register: (
+ route: RouteConfig,
+ handler: HttpResourcesRequestHandler
+ ) => void;
+}
diff --git a/src/core/server/index.ts b/src/core/server/index.ts
index 039988fa08968..ef57fae159d7e 100644
--- a/src/core/server/index.ts
+++ b/src/core/server/index.ts
@@ -47,7 +47,8 @@ import {
} from './elasticsearch';
import { HttpServiceSetup } from './http';
-import { IScopedRenderingClient } from './rendering';
+import { HttpResources } from './http_resources';
+
import { PluginsServiceSetup, PluginsServiceStart, PluginOpaqueId } from './plugins';
import { ContextSetup } from './context';
import { IUiSettingsClient, UiSettingsServiceSetup, UiSettingsServiceStart } from './ui_settings';
@@ -146,6 +147,7 @@ export {
OnPreResponseInfo,
RedirectResponseOptions,
RequestHandler,
+ RequestHandlerWrapper,
RequestHandlerContextContainer,
RequestHandlerContextProvider,
ResponseError,
@@ -175,7 +177,15 @@ export {
DestructiveRouteMethod,
SafeRouteMethod,
} from './http';
-export { RenderingServiceSetup, IRenderOptions } from './rendering';
+
+export {
+ HttpResourcesRenderOptions,
+ HttpResourcesResponseOptions,
+ HttpResourcesServiceToolkit,
+ HttpResourcesRequestHandler,
+} from './http_resources';
+
+export { IRenderOptions } from './rendering';
export { Logger, LoggerFactory, LogMeta, LogRecord, LogLevel } from './logging';
export {
@@ -313,8 +323,6 @@ export {
* Plugin specific context passed to a route handler.
*
* Provides the following clients and services:
- * - {@link IScopedRenderingClient | rendering} - Rendering client
- * which uses the data of the incoming request
* - {@link SavedObjectsClient | savedObjects.client} - Saved Objects client
* which uses the credentials of the incoming request
* - {@link ISavedObjectTypeRegistry | savedObjects.typeRegistry} - Type registry containing
@@ -330,7 +338,6 @@ export {
*/
export interface RequestHandlerContext {
core: {
- rendering: IScopedRenderingClient;
savedObjects: {
client: SavedObjectsClientContract;
typeRegistry: ISavedObjectTypeRegistry;
@@ -362,7 +369,10 @@ export interface CoreSetup {
getAuthHeaders: () => undefined,
} as any,
},
+ httpResources: httpResourcesMock.createSetupContract(),
savedObjects: savedObjectsServiceMock.createInternalSetupContract(),
plugins: {
initialized: true,
contracts: new Map([['plugin-id', 'plugin-value']]),
- uiPlugins: {
- public: new Map([['plugin-id', {} as DiscoveredPlugin]]),
- internal: new Map([
- [
- 'plugin-id',
- {
- publicTargetDir: 'path/to/target/public',
- publicAssetsDir: '/plugins/name/assets/',
- },
- ],
- ]),
- browserConfigs: new Map(),
- },
},
rendering: renderingServiceMock,
metrics: metricsServiceMock.createInternalSetupContract(),
@@ -110,6 +99,19 @@ beforeEach(() => {
status: statusServiceMock.createInternalSetupContract(),
},
plugins: { 'plugin-id': 'plugin-value' },
+ uiPlugins: {
+ public: new Map([['plugin-id', {} as DiscoveredPlugin]]),
+ internal: new Map([
+ [
+ 'plugin-id',
+ {
+ publicTargetDir: 'path/to/target/public',
+ publicAssetsDir: '/plugins/name/assets/',
+ },
+ ],
+ ]),
+ browserConfigs: new Map(),
+ },
};
startDeps = {
diff --git a/src/core/server/legacy/legacy_service.ts b/src/core/server/legacy/legacy_service.ts
index f77230301ce02..fd3ebfe120599 100644
--- a/src/core/server/legacy/legacy_service.ts
+++ b/src/core/server/legacy/legacy_service.ts
@@ -269,6 +269,7 @@ export class LegacyService implements CoreService {
uiSettings: { asScopedToClient: startDeps.core.uiSettings.asScopedToClient },
};
+ const router = setupDeps.core.http.createRouter('', this.legacyId);
const coreSetup: CoreSetup = {
capabilities: setupDeps.core.capabilities,
context: setupDeps.core.context,
@@ -283,7 +284,8 @@ export class LegacyService implements CoreService {
null,
this.legacyId
),
- createRouter: () => setupDeps.core.http.createRouter('', this.legacyId),
+ createRouter: () => router,
+ resources: setupDeps.core.httpResources.createRegistrar(router),
registerOnPreAuth: setupDeps.core.http.registerOnPreAuth,
registerAuth: setupDeps.core.http.registerAuth,
registerOnPostAuth: setupDeps.core.http.registerOnPostAuth,
@@ -342,7 +344,7 @@ export class LegacyService implements CoreService {
},
hapiServer: setupDeps.core.http.server,
kibanaMigrator: startDeps.core.savedObjects.migrator,
- uiPlugins: setupDeps.core.plugins.uiPlugins,
+ uiPlugins: setupDeps.uiPlugins,
elasticsearch: setupDeps.core.elasticsearch,
rendering: setupDeps.core.rendering,
uiSettings: setupDeps.core.uiSettings,
diff --git a/src/core/server/legacy/types.ts b/src/core/server/legacy/types.ts
index 0c1a7730f92a7..38cb9e6835ce9 100644
--- a/src/core/server/legacy/types.ts
+++ b/src/core/server/legacy/types.ts
@@ -22,8 +22,8 @@ import { Server } from 'hapi';
import { ChromeNavLink } from '../../public';
import { KibanaRequest, LegacyRequest } from '../http';
import { InternalCoreSetup, InternalCoreStart } from '../internal_types';
-import { PluginsServiceSetup, PluginsServiceStart } from '../plugins';
-import { RenderingServiceSetup } from '../rendering';
+import { PluginsServiceSetup, PluginsServiceStart, UiPlugins } from '../plugins';
+import { InternalRenderingServiceSetup } from '../rendering';
import { SavedObjectsLegacyUiExports } from '../types';
/**
@@ -34,7 +34,7 @@ export type LegacyVars = Record;
type LegacyCoreSetup = InternalCoreSetup & {
plugins: PluginsServiceSetup;
- rendering: RenderingServiceSetup;
+ rendering: InternalRenderingServiceSetup;
};
type LegacyCoreStart = InternalCoreStart & { plugins: PluginsServiceStart };
@@ -173,6 +173,7 @@ export type LegacyUiExports = SavedObjectsLegacyUiExports & {
export interface LegacyServiceSetupDeps {
core: LegacyCoreSetup;
plugins: Record;
+ uiPlugins: UiPlugins;
}
/**
diff --git a/src/core/server/mocks.ts b/src/core/server/mocks.ts
index faf73044cac4d..3b9a39db72278 100644
--- a/src/core/server/mocks.ts
+++ b/src/core/server/mocks.ts
@@ -23,10 +23,12 @@ import { CspConfig } from './csp';
import { loggingServiceMock } from './logging/logging_service.mock';
import { elasticsearchServiceMock } from './elasticsearch/elasticsearch_service.mock';
import { httpServiceMock } from './http/http_service.mock';
+import { httpResourcesMock } from './http_resources/http_resources_service.mock';
import { contextServiceMock } from './context/context_service.mock';
import { savedObjectsServiceMock } from './saved_objects/saved_objects_service.mock';
import { savedObjectsClientMock } from './saved_objects/service/saved_objects_client.mock';
import { typeRegistryMock as savedObjectsTypeRegistryMock } from './saved_objects/saved_objects_type_registry.mock';
+import { renderingMock } from './rendering/rendering_service.mock';
import { uiSettingsServiceMock } from './ui_settings/ui_settings_service.mock';
import { SharedGlobalConfig } from './plugins';
import { InternalCoreSetup, InternalCoreStart } from './internal_types';
@@ -36,6 +38,7 @@ import { uuidServiceMock } from './uuid/uuid_service.mock';
import { statusServiceMock } from './status/status_service.mock';
export { httpServerMock } from './http/http_server.mocks';
+export { httpResourcesMock } from './http_resources/http_resources_service.mock';
export { sessionStorageMock } from './http/cookie_session_storage.mocks';
export { configServiceMock } from './config/config_service.mock';
export { elasticsearchServiceMock } from './elasticsearch/elasticsearch_service.mock';
@@ -45,6 +48,7 @@ export { savedObjectsRepositoryMock } from './saved_objects/service/lib/reposito
export { typeRegistryMock as savedObjectsTypeRegistryMock } from './saved_objects/saved_objects_type_registry.mock';
export { uiSettingsServiceMock } from './ui_settings/ui_settings_service.mock';
export { metricsServiceMock } from './metrics/metrics_service.mock';
+export { renderingMock } from './rendering/rendering_service.mock';
export function pluginInitializerContextConfigMock(config: T) {
const globalConfig: SharedGlobalConfig = {
@@ -120,6 +124,7 @@ function createCoreSetupMock({
get: httpService.auth.get,
isAuthenticated: httpService.auth.isAuthenticated,
},
+ resources: httpResourcesMock.createRegistrar(),
getServerInfo: httpService.getServerInfo,
};
httpMock.createRouter.mockImplementation(() => httpService.createRouter(''));
@@ -167,6 +172,8 @@ function createInternalCoreSetupMock() {
savedObjects: savedObjectsServiceMock.createInternalSetupContract(),
status: statusServiceMock.createInternalSetupContract(),
uuid: uuidServiceMock.createSetupContract(),
+ httpResources: httpResourcesMock.createSetupContract(),
+ rendering: renderingMock.createSetupContract(),
uiSettings: uiSettingsServiceMock.createSetupContract(),
};
return setupDeps;
@@ -184,9 +191,6 @@ function createInternalCoreStartMock() {
function createCoreRequestHandlerContextMock() {
return {
- rendering: {
- render: jest.fn(),
- },
savedObjects: {
client: savedObjectsClientMock.create(),
typeRegistry: savedObjectsTypeRegistryMock.create(),
diff --git a/src/core/server/plugins/index.ts b/src/core/server/plugins/index.ts
index c7ef213c8f187..e480de750bb1a 100644
--- a/src/core/server/plugins/index.ts
+++ b/src/core/server/plugins/index.ts
@@ -17,7 +17,12 @@
* under the License.
*/
-export { PluginsService, PluginsServiceSetup, PluginsServiceStart } from './plugins_service';
+export {
+ PluginsService,
+ PluginsServiceSetup,
+ PluginsServiceStart,
+ UiPlugins,
+} from './plugins_service';
export { config } from './plugins_config';
/** @internal */
export { isNewPlatformPlugin } from './discovery';
diff --git a/src/core/server/plugins/plugin_context.ts b/src/core/server/plugins/plugin_context.ts
index 61d97aea97459..ab18a9cbbc062 100644
--- a/src/core/server/plugins/plugin_context.ts
+++ b/src/core/server/plugins/plugin_context.ts
@@ -136,6 +136,8 @@ export function createPluginSetupContext(
deps: PluginsServiceSetupDeps,
plugin: PluginWrapper
): CoreSetup {
+ const router = deps.http.createRouter('', plugin.opaqueId);
+
return {
capabilities: {
registerProvider: deps.capabilities.registerProvider,
@@ -155,7 +157,8 @@ export function createPluginSetupContext(
null,
plugin.opaqueId
),
- createRouter: () => deps.http.createRouter('', plugin.opaqueId),
+ createRouter: () => router,
+ resources: deps.httpResources.createRegistrar(router),
registerOnPreAuth: deps.http.registerOnPreAuth,
registerAuth: deps.http.registerAuth,
registerOnPostAuth: deps.http.registerOnPostAuth,
diff --git a/src/core/server/plugins/plugins_service.mock.ts b/src/core/server/plugins/plugins_service.mock.ts
index 29e5b83b2e4c7..a40566767ddae 100644
--- a/src/core/server/plugins/plugins_service.mock.ts
+++ b/src/core/server/plugins/plugins_service.mock.ts
@@ -23,14 +23,10 @@ type PluginsServiceMock = jest.Mocked>;
const createSetupContractMock = (): PluginsServiceSetup => ({
contracts: new Map(),
- uiPlugins: {
- browserConfigs: new Map(),
- internal: new Map(),
- public: new Map(),
- },
initialized: true,
});
const createStartContractMock = () => ({ contracts: new Map() });
+
const createServiceMock = (): PluginsServiceMock => ({
discover: jest.fn(),
setup: jest.fn().mockResolvedValue(createSetupContractMock()),
@@ -38,8 +34,17 @@ const createServiceMock = (): PluginsServiceMock => ({
stop: jest.fn(),
});
+function createUiPlugins() {
+ return {
+ browserConfigs: new Map(),
+ internal: new Map(),
+ public: new Map(),
+ };
+}
+
export const pluginServiceMock = {
create: createServiceMock,
createSetupContract: createSetupContractMock,
createStartContract: createStartContractMock,
+ createUiPlugins,
};
diff --git a/src/core/server/plugins/plugins_service.test.ts b/src/core/server/plugins/plugins_service.test.ts
index 14147ab9f2a8d..38fda12bd290f 100644
--- a/src/core/server/plugins/plugins_service.test.ts
+++ b/src/core/server/plugins/plugins_service.test.ts
@@ -120,6 +120,7 @@ describe('PluginsService', () => {
pluginsService = new PluginsService({ coreId, env, logger, configService });
[mockPluginSystem] = MockPluginsSystem.mock.instances as any;
+ mockPluginSystem.uiPlugins.mockReturnValue(new Map());
});
afterEach(() => {
@@ -202,7 +203,6 @@ describe('PluginsService', () => {
.mockImplementation(path => Promise.resolve(!path.includes('disabled')));
mockPluginSystem.setupPlugins.mockResolvedValue(new Map());
- mockPluginSystem.uiPlugins.mockReturnValue(new Map());
mockDiscover.mockReturnValue({
error$: from([]),
@@ -234,8 +234,6 @@ describe('PluginsService', () => {
const setup = await pluginsService.setup(setupDeps);
expect(setup.contracts).toBeInstanceOf(Map);
- expect(setup.uiPlugins.public).toBeInstanceOf(Map);
- expect(setup.uiPlugins.internal).toBeInstanceOf(Map);
expect(mockPluginSystem.addPlugin).not.toHaveBeenCalled();
expect(mockPluginSystem.setupPlugins).toHaveBeenCalledTimes(1);
expect(mockPluginSystem.setupPlugins).toHaveBeenCalledWith(setupDeps);
@@ -273,7 +271,8 @@ describe('PluginsService', () => {
plugin$: from([firstPlugin, secondPlugin]),
});
- await expect(pluginsService.discover()).resolves.toBeUndefined();
+ const { pluginTree } = await pluginsService.discover();
+ expect(pluginTree).toBeUndefined();
expect(mockDiscover).toHaveBeenCalledTimes(1);
expect(mockPluginSystem.addPlugin).toHaveBeenCalledTimes(2);
@@ -308,7 +307,8 @@ describe('PluginsService', () => {
plugin$: from([firstPlugin, secondPlugin, thirdPlugin, lastPlugin, missingDepsPlugin]),
});
- await expect(pluginsService.discover()).resolves.toBeUndefined();
+ const { pluginTree } = await pluginsService.discover();
+ expect(pluginTree).toBeUndefined();
expect(mockDiscover).toHaveBeenCalledTimes(1);
expect(mockPluginSystem.addPlugin).toHaveBeenCalledTimes(4);
@@ -466,12 +466,8 @@ describe('PluginsService', () => {
});
mockPluginSystem.uiPlugins.mockReturnValue(new Map([pluginToDiscoveredEntry(plugin)]));
- await pluginsService.discover();
- const {
- uiPlugins: { browserConfigs },
- } = await pluginsService.setup(setupDeps);
-
- const uiConfig$ = browserConfigs.get('plugin-with-expose');
+ const { uiPlugins } = await pluginsService.discover();
+ const uiConfig$ = uiPlugins.browserConfigs.get('plugin-with-expose');
expect(uiConfig$).toBeDefined();
const uiConfig = await uiConfig$!.pipe(take(1)).toPromise();
@@ -506,12 +502,8 @@ describe('PluginsService', () => {
});
mockPluginSystem.uiPlugins.mockReturnValue(new Map([pluginToDiscoveredEntry(plugin)]));
- await pluginsService.discover();
- const {
- uiPlugins: { browserConfigs },
- } = await pluginsService.setup(setupDeps);
-
- expect([...browserConfigs.entries()]).toHaveLength(0);
+ const { uiPlugins } = await pluginsService.discover();
+ expect([...uiPlugins.browserConfigs.entries()]).toHaveLength(0);
});
});
@@ -539,8 +531,7 @@ describe('PluginsService', () => {
describe('uiPlugins.internal', () => {
it('includes disabled plugins', async () => {
config$.next({ plugins: { initialize: true }, plugin1: { enabled: false } });
- await pluginsService.discover();
- const { uiPlugins } = await pluginsService.setup(setupDeps);
+ const { uiPlugins } = await pluginsService.discover();
expect(uiPlugins.internal).toMatchInlineSnapshot(`
Map {
"plugin-1" => Object {
diff --git a/src/core/server/plugins/plugins_service.ts b/src/core/server/plugins/plugins_service.ts
index a0ecee47c675f..d7a348affe94f 100644
--- a/src/core/server/plugins/plugins_service.ts
+++ b/src/core/server/plugins/plugins_service.ts
@@ -39,23 +39,25 @@ export interface PluginsServiceSetup {
initialized: boolean;
/** Setup contracts returned by plugins. */
contracts: Map;
- uiPlugins: {
- /**
- * Paths to all discovered ui plugin entrypoints on the filesystem, even if
- * disabled.
- */
- internal: Map;
-
- /**
- * Information needed by client-side to load plugins and wire dependencies.
- */
- public: Map;
-
- /**
- * Configuration for plugins to be exposed to the client-side.
- */
- browserConfigs: Map>;
- };
+}
+
+/** @internal */
+export interface UiPlugins {
+ /**
+ * Paths to all discovered ui plugin entrypoints on the filesystem, even if
+ * disabled.
+ */
+ internal: Map;
+
+ /**
+ * Information needed by client-side to load plugins and wire dependencies.
+ */
+ public: Map;
+
+ /**
+ * Configuration for plugins to be exposed to the client-side.
+ */
+ browserConfigs: Map>;
}
/** @internal */
@@ -97,8 +99,17 @@ export class PluginsService implements CoreService;
-export const setupMock: jest.Mocked = {
+export const setupMock: jest.Mocked = {
render: jest.fn(),
};
export const mockSetup = jest.fn().mockResolvedValue(setupMock);
diff --git a/src/core/server/rendering/rendering_service.mock.ts b/src/core/server/rendering/rendering_service.mock.ts
new file mode 100644
index 0000000000000..7eba332512386
--- /dev/null
+++ b/src/core/server/rendering/rendering_service.mock.ts
@@ -0,0 +1,31 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { InternalRenderingServiceSetup } from './types';
+
+function createRenderingSetup() {
+ const mocked: jest.Mocked = {
+ render: jest.fn().mockResolvedValue(''),
+ };
+ return mocked;
+}
+
+export const renderingMock = {
+ createSetupContract: createRenderingSetup,
+};
diff --git a/src/core/server/rendering/rendering_service.test.ts b/src/core/server/rendering/rendering_service.test.ts
index 43ff4f633085c..d1c527aca4dba 100644
--- a/src/core/server/rendering/rendering_service.test.ts
+++ b/src/core/server/rendering/rendering_service.test.ts
@@ -22,7 +22,7 @@ import { load } from 'cheerio';
import { httpServerMock } from '../http/http_server.mocks';
import { uiSettingsServiceMock } from '../ui_settings/ui_settings_service.mock';
import { mockRenderingServiceParams, mockRenderingSetupDeps } from './__mocks__/params';
-import { RenderingServiceSetup } from './types';
+import { InternalRenderingServiceSetup } from './types';
import { RenderingService } from './rendering_service';
const INJECTED_METADATA = {
@@ -62,15 +62,9 @@ describe('RenderingService', () => {
});
describe('setup()', () => {
- it('creates instance of RenderingServiceSetup', async () => {
- const rendering = await service.setup(mockRenderingSetupDeps);
-
- expect(rendering.render).toBeInstanceOf(Function);
- });
-
describe('render()', () => {
let uiSettings: ReturnType;
- let render: RenderingServiceSetup['render'];
+ let render: InternalRenderingServiceSetup['render'];
beforeEach(async () => {
uiSettings = uiSettingsServiceMock.createClient();
@@ -78,6 +72,13 @@ describe('RenderingService', () => {
registered: { name: 'title' },
});
render = (await service.setup(mockRenderingSetupDeps)).render;
+ await service.start({
+ legacy: {
+ legacyInternals: {
+ getVars: () => ({}),
+ },
+ },
+ } as any);
});
it('renders "core" page', async () => {
diff --git a/src/core/server/rendering/rendering_service.tsx b/src/core/server/rendering/rendering_service.tsx
index dbafd5806bd74..a02d85d22b2cb 100644
--- a/src/core/server/rendering/rendering_service.tsx
+++ b/src/core/server/rendering/rendering_service.tsx
@@ -23,41 +23,37 @@ import { take } from 'rxjs/operators';
import { i18n } from '@kbn/i18n';
+import { UiPlugins } from '../plugins';
import { CoreService } from '../../types';
import { CoreContext } from '../core_context';
import { Template } from './views';
+import { LegacyService } from '../legacy';
import {
IRenderOptions,
RenderingSetupDeps,
- RenderingServiceSetup,
+ InternalRenderingServiceSetup,
RenderingMetadata,
} from './types';
/** @internal */
-export class RenderingService implements CoreService {
+export class RenderingService implements CoreService {
+ private legacyInternals?: LegacyService['legacyInternals'];
constructor(private readonly coreContext: CoreContext) {}
public async setup({
http,
legacyPlugins,
- plugins,
- }: RenderingSetupDeps): Promise {
- async function getUiConfig(pluginId: string) {
- const browserConfig = plugins.uiPlugins.browserConfigs.get(pluginId);
-
- return ((await browserConfig?.pipe(take(1)).toPromise()) ?? {}) as Record;
- }
-
+ uiPlugins,
+ }: RenderingSetupDeps): Promise {
return {
render: async (
request,
uiSettings,
- {
- app = { getId: () => 'core' },
- includeUserSettings = true,
- vars = {},
- }: IRenderOptions = {}
+ { app = { getId: () => 'core' }, includeUserSettings = true, vars }: IRenderOptions = {}
) => {
+ if (!this.legacyInternals) {
+ throw new Error('Cannot render before "start"');
+ }
const { env } = this.coreContext;
const basePath = http.basePath.get(request);
const serverBasePath = http.basePath.serverBasePath;
@@ -87,12 +83,12 @@ export class RenderingService implements CoreService {
translationsUrl: `${basePath}/translations/${i18n.getLocale()}.json`,
},
csp: { warnLegacyBrowsers: http.csp.warnLegacyBrowsers },
- vars,
+ vars: vars ?? (await this.legacyInternals!.getVars('core', request)),
uiPlugins: await Promise.all(
- [...plugins.uiPlugins.public].map(async ([id, plugin]) => ({
+ [...uiPlugins.public].map(async ([id, plugin]) => ({
id,
plugin,
- config: await getUiConfig(id),
+ config: await this.getUiConfig(uiPlugins, id),
}))
),
legacyMetadata: {
@@ -116,7 +112,15 @@ export class RenderingService implements CoreService {
};
}
- public async start() {}
+ public async start({ legacy }: { legacy: LegacyService }) {
+ this.legacyInternals = legacy.legacyInternals;
+ }
public async stop() {}
+
+ private async getUiConfig(uiPlugins: UiPlugins, pluginId: string) {
+ const browserConfig = uiPlugins.browserConfigs.get(pluginId);
+
+ return ((await browserConfig?.pipe(take(1)).toPromise()) ?? {}) as Record;
+ }
}
diff --git a/src/core/server/rendering/types.ts b/src/core/server/rendering/types.ts
index cfaa23d491139..2a3be93055006 100644
--- a/src/core/server/rendering/types.ts
+++ b/src/core/server/rendering/types.ts
@@ -23,7 +23,7 @@ import { Env } from '../config';
import { ICspConfig } from '../csp';
import { InternalHttpServiceSetup, KibanaRequest, LegacyRequest } from '../http';
import { LegacyNavLink, LegacyServiceDiscoverPlugins } from '../legacy';
-import { PluginsServiceSetup, DiscoveredPlugin } from '../plugins';
+import { UiPlugins, DiscoveredPlugin } from '../plugins';
import { IUiSettingsClient, UserProvidedValues } from '../ui_settings';
/** @internal */
@@ -75,7 +75,7 @@ export interface RenderingMetadata {
export interface RenderingSetupDeps {
http: InternalHttpServiceSetup;
legacyPlugins: LegacyServiceDiscoverPlugins;
- plugins: PluginsServiceSetup;
+ uiPlugins: UiPlugins;
}
/** @public */
@@ -102,31 +102,8 @@ export interface IRenderOptions {
vars?: Record;
}
-/** @public */
-export interface IScopedRenderingClient {
- /**
- * Generate a `KibanaResponse` which renders an HTML page bootstrapped
- * with the `core` bundle. Intended as a response body for HTTP route handlers.
- *
- * @example
- * ```ts
- * router.get(
- * { path: '/', validate: false },
- * (context, request, response) =>
- * response.ok({
- * body: await context.core.rendering.render(),
- * headers: {
- * 'content-security-policy': context.core.http.csp.header,
- * },
- * })
- * );
- * ```
- */
- render(options?: Pick): Promise;
-}
-
/** @internal */
-export interface RenderingServiceSetup {
+export interface InternalRenderingServiceSetup {
/**
* Generate a `KibanaResponse` which renders an HTML page bootstrapped
* with the `core` bundle or the ID of another specified legacy bundle.
diff --git a/src/core/server/saved_objects/migrations/core/build_index_map.test.ts b/src/core/server/saved_objects/migrations/core/build_index_map.test.ts
index 44add4e977006..2c710d4eaa079 100644
--- a/src/core/server/saved_objects/migrations/core/build_index_map.test.ts
+++ b/src/core/server/saved_objects/migrations/core/build_index_map.test.ts
@@ -26,7 +26,7 @@ const createRegistry = (...types: Array>) => {
types.forEach(type =>
registry.registerType({
name: 'unknown',
- namespaceAgnostic: false,
+ namespaceType: 'single',
hidden: false,
mappings: { properties: {} },
migrations: {},
@@ -41,7 +41,7 @@ test('mappings without index pattern goes to default index', () => {
kibanaIndexName: '.kibana',
registry: createRegistry({
name: 'type1',
- namespaceAgnostic: false,
+ namespaceType: 'single',
}),
indexMap: {
type1: {
@@ -73,7 +73,7 @@ test(`mappings with custom index pattern doesn't go to default index`, () => {
kibanaIndexName: '.kibana',
registry: createRegistry({
name: 'type1',
- namespaceAgnostic: false,
+ namespaceType: 'single',
indexPattern: '.other_kibana',
}),
indexMap: {
@@ -106,7 +106,7 @@ test('creating a script gets added to the index pattern', () => {
kibanaIndexName: '.kibana',
registry: createRegistry({
name: 'type1',
- namespaceAgnostic: false,
+ namespaceType: 'single',
indexPattern: '.other_kibana',
convertToAliasScript: `ctx._id = ctx._source.type + ':' + ctx._id`,
}),
@@ -141,12 +141,12 @@ test('throws when two scripts are defined for an index pattern', () => {
const registry = createRegistry(
{
name: 'type1',
- namespaceAgnostic: false,
+ namespaceType: 'single',
convertToAliasScript: `ctx._id = ctx._source.type + ':' + ctx._id`,
},
{
name: 'type2',
- namespaceAgnostic: false,
+ namespaceType: 'single',
convertToAliasScript: `ctx._id = ctx._source.type + ':' + ctx._id`,
}
);
diff --git a/src/core/server/saved_objects/migrations/core/document_migrator.test.ts b/src/core/server/saved_objects/migrations/core/document_migrator.test.ts
index ef3f546b5e574..64270c677ff20 100644
--- a/src/core/server/saved_objects/migrations/core/document_migrator.test.ts
+++ b/src/core/server/saved_objects/migrations/core/document_migrator.test.ts
@@ -32,7 +32,7 @@ const createRegistry = (...types: Array>) => {
types.forEach(type =>
registry.registerType({
name: 'unknown',
- namespaceAgnostic: false,
+ namespaceType: 'single',
hidden: false,
mappings: { properties: {} },
migrations: {},
diff --git a/src/core/server/saved_objects/migrations/kibana/kibana_migrator.mock.ts b/src/core/server/saved_objects/migrations/kibana/kibana_migrator.mock.ts
index 257b32c1e4c23..3f5c0c3876615 100644
--- a/src/core/server/saved_objects/migrations/kibana/kibana_migrator.mock.ts
+++ b/src/core/server/saved_objects/migrations/kibana/kibana_migrator.mock.ts
@@ -27,7 +27,7 @@ const defaultSavedObjectTypes: SavedObjectsType[] = [
{
name: 'testtype',
hidden: false,
- namespaceAgnostic: false,
+ namespaceType: 'single',
mappings: {
properties: {
name: { type: 'keyword' },
diff --git a/src/core/server/saved_objects/migrations/kibana/kibana_migrator.test.ts b/src/core/server/saved_objects/migrations/kibana/kibana_migrator.test.ts
index 336eeff99f47b..cda0e86f15bdf 100644
--- a/src/core/server/saved_objects/migrations/kibana/kibana_migrator.test.ts
+++ b/src/core/server/saved_objects/migrations/kibana/kibana_migrator.test.ts
@@ -28,8 +28,8 @@ const createRegistry = (types: Array>) => {
types.forEach(type =>
registry.registerType({
name: 'unknown',
- namespaceAgnostic: false,
hidden: false,
+ namespaceType: 'single',
mappings: { properties: {} },
migrations: {},
...type,
@@ -120,7 +120,7 @@ function mockOptions(): KibanaMigratorOptions {
{
name: 'testtype',
hidden: false,
- namespaceAgnostic: false,
+ namespaceType: 'single',
mappings: {
properties: {
name: { type: 'keyword' },
@@ -131,7 +131,7 @@ function mockOptions(): KibanaMigratorOptions {
{
name: 'testtype2',
hidden: false,
- namespaceAgnostic: false,
+ namespaceType: 'single',
indexPattern: 'other-index',
mappings: {
properties: {
diff --git a/src/core/server/saved_objects/routes/integration_tests/test_utils.ts b/src/core/server/saved_objects/routes/integration_tests/test_utils.ts
index 82a889f75d3c1..23e0285201dc7 100644
--- a/src/core/server/saved_objects/routes/integration_tests/test_utils.ts
+++ b/src/core/server/saved_objects/routes/integration_tests/test_utils.ts
@@ -49,7 +49,7 @@ export const createExportableType = (name: string): SavedObjectsType => {
return {
name,
hidden: false,
- namespaceAgnostic: false,
+ namespaceType: 'single',
mappings: {
properties: {},
},
diff --git a/src/core/server/saved_objects/saved_objects_type_registry.test.ts b/src/core/server/saved_objects/saved_objects_type_registry.test.ts
index 84337474f3ee3..f82822f90f489 100644
--- a/src/core/server/saved_objects/saved_objects_type_registry.test.ts
+++ b/src/core/server/saved_objects/saved_objects_type_registry.test.ts
@@ -183,14 +183,6 @@ describe('SavedObjectTypeRegistry', () => {
expectResult(false, { namespaceType: 'single' });
expectResult(false, { namespaceType: undefined });
});
-
- // deprecated test cases
- it(`returns true when namespaceAgnostic is true`, () => {
- expectResult(true, { namespaceAgnostic: true, namespaceType: 'agnostic' });
- expectResult(true, { namespaceAgnostic: true, namespaceType: 'multiple' });
- expectResult(true, { namespaceAgnostic: true, namespaceType: 'single' });
- expectResult(true, { namespaceAgnostic: true, namespaceType: undefined });
- });
});
describe('#isSingleNamespace', () => {
@@ -213,14 +205,6 @@ describe('SavedObjectTypeRegistry', () => {
expectResult(false, { namespaceType: 'agnostic' });
expectResult(false, { namespaceType: 'multiple' });
});
-
- // deprecated test cases
- it(`returns false when namespaceAgnostic is true`, () => {
- expectResult(false, { namespaceAgnostic: true, namespaceType: 'agnostic' });
- expectResult(false, { namespaceAgnostic: true, namespaceType: 'multiple' });
- expectResult(false, { namespaceAgnostic: true, namespaceType: 'single' });
- expectResult(false, { namespaceAgnostic: true, namespaceType: undefined });
- });
});
describe('#isMultiNamespace', () => {
@@ -243,14 +227,6 @@ describe('SavedObjectTypeRegistry', () => {
expectResult(false, { namespaceType: 'single' });
expectResult(false, { namespaceType: undefined });
});
-
- // deprecated test cases
- it(`returns false when namespaceAgnostic is true`, () => {
- expectResult(false, { namespaceAgnostic: true, namespaceType: 'agnostic' });
- expectResult(false, { namespaceAgnostic: true, namespaceType: 'multiple' });
- expectResult(false, { namespaceAgnostic: true, namespaceType: 'single' });
- expectResult(false, { namespaceAgnostic: true, namespaceType: undefined });
- });
});
describe('#isHidden', () => {
diff --git a/src/core/server/saved_objects/saved_objects_type_registry.ts b/src/core/server/saved_objects/saved_objects_type_registry.ts
index be3fdb86a994c..740313a53d1e2 100644
--- a/src/core/server/saved_objects/saved_objects_type_registry.ts
+++ b/src/core/server/saved_objects/saved_objects_type_registry.ts
@@ -72,11 +72,7 @@ export class SavedObjectTypeRegistry {
* resolves to `false` if the type is not registered
*/
public isNamespaceAgnostic(type: string) {
- return (
- this.types.get(type)?.namespaceType === 'agnostic' ||
- this.types.get(type)?.namespaceAgnostic ||
- false
- );
+ return this.types.get(type)?.namespaceType === 'agnostic';
}
/**
@@ -84,6 +80,7 @@ export class SavedObjectTypeRegistry {
* resolves to `true` if the type is not registered
*/
public isSingleNamespace(type: string) {
+ // in the case we somehow registered a type with an invalid `namespaceType`, treat it as single-namespace
return !this.isNamespaceAgnostic(type) && !this.isMultiNamespace(type);
}
@@ -92,7 +89,7 @@ export class SavedObjectTypeRegistry {
* resolves to `false` if the type is not registered
*/
public isMultiNamespace(type: string) {
- return !this.isNamespaceAgnostic(type) && this.types.get(type)?.namespaceType === 'multiple';
+ return this.types.get(type)?.namespaceType === 'multiple';
}
/**
diff --git a/src/core/server/saved_objects/service/index.ts b/src/core/server/saved_objects/service/index.ts
index f44824238aa21..9f625b4732e26 100644
--- a/src/core/server/saved_objects/service/index.ts
+++ b/src/core/server/saved_objects/service/index.ts
@@ -36,7 +36,6 @@ export interface SavedObjectsLegacyService {
getScopedSavedObjectsClient: SavedObjectsClientProvider['getClient'];
SavedObjectsClient: typeof SavedObjectsClient;
types: string[];
- importAndExportableTypes: string[];
schema: SavedObjectsSchema;
getSavedObjectsRepository(...rest: any[]): any;
importExport: {
diff --git a/src/core/server/saved_objects/service/lib/repository_create_repository.test.ts b/src/core/server/saved_objects/service/lib/repository_create_repository.test.ts
index a6b580e9b3461..ea881805e1ae6 100644
--- a/src/core/server/saved_objects/service/lib/repository_create_repository.test.ts
+++ b/src/core/server/saved_objects/service/lib/repository_create_repository.test.ts
@@ -32,7 +32,7 @@ describe('SavedObjectsRepository#createRepository', () => {
typeRegistry.registerType({
name: 'nsAgnosticType',
hidden: false,
- namespaceAgnostic: true,
+ namespaceType: 'agnostic',
mappings: {
properties: {
name: { type: 'keyword' },
@@ -44,7 +44,7 @@ describe('SavedObjectsRepository#createRepository', () => {
typeRegistry.registerType({
name: 'nsType',
hidden: false,
- namespaceAgnostic: false,
+ namespaceType: 'single',
indexPattern: 'beats',
mappings: {
properties: {
@@ -56,7 +56,7 @@ describe('SavedObjectsRepository#createRepository', () => {
typeRegistry.registerType({
name: 'hiddenType',
hidden: true,
- namespaceAgnostic: true,
+ namespaceType: 'agnostic',
mappings: {
properties: {
name: { type: 'keyword' },
diff --git a/src/core/server/saved_objects/types.ts b/src/core/server/saved_objects/types.ts
index 9efc82603b179..b50c6dc9a1abf 100644
--- a/src/core/server/saved_objects/types.ts
+++ b/src/core/server/saved_objects/types.ts
@@ -202,15 +202,10 @@ export interface SavedObjectsType {
* See {@link SavedObjectsServiceStart.createInternalRepository | createInternalRepository}.
*/
hidden: boolean;
- /**
- * Is the type global (true), or not (false).
- * @deprecated Use `namespaceType` instead.
- */
- namespaceAgnostic?: boolean;
/**
* The {@link SavedObjectsNamespaceType | namespace type} for the type.
*/
- namespaceType?: SavedObjectsNamespaceType;
+ namespaceType: SavedObjectsNamespaceType;
/**
* If defined, the type instances will be stored in the given index instead of the default one.
*/
diff --git a/src/core/server/saved_objects/utils.test.ts b/src/core/server/saved_objects/utils.test.ts
index 64bdf1771decc..033aeea7c018d 100644
--- a/src/core/server/saved_objects/utils.test.ts
+++ b/src/core/server/saved_objects/utils.test.ts
@@ -421,14 +421,6 @@ describe('convertTypesToLegacySchema', () => {
namespaceType: 'multiple',
mappings: { properties: {} },
},
- // deprecated test case
- {
- name: 'typeD',
- hidden: false,
- namespaceAgnostic: true,
- namespaceType: 'multiple', // if namespaceAgnostic and namespaceType are both set, namespaceAgnostic takes precedence
- mappings: { properties: {} },
- },
];
expect(convertTypesToLegacySchema(types)).toEqual({
typeA: {
@@ -448,12 +440,6 @@ describe('convertTypesToLegacySchema', () => {
isNamespaceAgnostic: false,
multiNamespace: true,
},
- // deprecated test case
- typeD: {
- hidden: false,
- isNamespaceAgnostic: true,
- multiNamespace: false,
- },
});
});
});
diff --git a/src/core/server/saved_objects/utils.ts b/src/core/server/saved_objects/utils.ts
index 5348963812629..af7c08d1fbfcc 100644
--- a/src/core/server/saved_objects/utils.ts
+++ b/src/core/server/saved_objects/utils.ts
@@ -82,8 +82,8 @@ export const convertTypesToLegacySchema = (
return {
...schema,
[type.name]: {
- isNamespaceAgnostic: type.namespaceAgnostic || type.namespaceType === 'agnostic',
- multiNamespace: !type.namespaceAgnostic && type.namespaceType === 'multiple',
+ isNamespaceAgnostic: type.namespaceType === 'agnostic',
+ multiNamespace: type.namespaceType === 'multiple',
hidden: type.hidden,
indexPattern: type.indexPattern,
convertToAliasScript: type.convertToAliasScript,
diff --git a/src/core/server/server.api.md b/src/core/server/server.api.md
index a35bca7375286..dd08df06c73d2 100644
--- a/src/core/server/server.api.md
+++ b/src/core/server/server.api.md
@@ -632,7 +632,9 @@ export interface CoreSetup;
// (undocumented)
- http: HttpServiceSetup;
+ http: HttpServiceSetup & {
+ resources: HttpResources;
+ };
// (undocumented)
metrics: MetricsServiceSetup;
// (undocumented)
@@ -861,6 +863,30 @@ export type Headers = {
[header: string]: string | string[] | undefined;
};
+// @public
+export interface HttpResources {
+ register: (route: RouteConfig, handler: HttpResourcesRequestHandler) => void;
+}
+
+// @public
+export interface HttpResourcesRenderOptions {
+ headers?: ResponseHeaders;
+}
+
+// @public
+export type HttpResourcesRequestHandler = RequestHandler;
+
+// @public
+export type HttpResourcesResponseOptions = HttpResponseOptions;
+
+// @public
+export interface HttpResourcesServiceToolkit {
+ renderAnonymousCoreApp: (options?: HttpResourcesRenderOptions) => Promise;
+ renderCoreApp: (options?: HttpResourcesRenderOptions) => Promise;
+ renderHtml: (options: HttpResourcesResponseOptions) => IKibanaResponse;
+ renderJs: (options: HttpResourcesResponseOptions) => IKibanaResponse;
+}
+
// @public
export interface HttpResponseOptions {
body?: HttpResponsePayload;
@@ -989,7 +1015,7 @@ export interface IRouter {
//
// @internal
getRoutes: () => RouterRoute[];
- handleLegacyErrors: (handler: RequestHandler) => RequestHandler;
+ handleLegacyErrors: RequestHandlerWrapper;
patch: RouteRegistrar<'patch'>;
post: RouteRegistrar<'post'>;
put: RouteRegistrar<'put'>;
@@ -1008,11 +1034,6 @@ export type ISavedObjectTypeRegistry = Omit;
-// @public (undocumented)
-export interface IScopedRenderingClient {
- render(options?: Pick): Promise;
-}
-
// @public
export interface IUiSettingsClient {
get: (key: string) => Promise;
@@ -1150,6 +1171,10 @@ export interface LegacyServiceSetupDeps {
core: LegacyCoreSetup;
// (undocumented)
plugins: Record;
+ // Warning: (ae-forgotten-export) The symbol "UiPlugins" needs to be exported by the entry point index.d.ts
+ //
+ // (undocumented)
+ uiPlugins: UiPlugins;
}
// @public @deprecated (undocumented)
@@ -1466,12 +1491,6 @@ export type PluginOpaqueId = symbol;
export interface PluginsServiceSetup {
contracts: Map;
initialized: boolean;
- // (undocumented)
- uiPlugins: {
- internal: Map;
- public: Map;
- browserConfigs: Map>;
- };
}
// @internal (undocumented)
@@ -1496,19 +1515,13 @@ export type RedirectResponseOptions = HttpResponseOptions & {
};
};
-// @internal (undocumented)
-export interface RenderingServiceSetup {
- render(request: R, uiSettings: IUiSettingsClient, options?: IRenderOptions): Promise;
-}
-
// @public
-export type RequestHandler = (context: RequestHandlerContext, request: KibanaRequest, response: KibanaResponseFactory) => IKibanaResponse | Promise>;
+export type RequestHandler = (context: RequestHandlerContext, request: KibanaRequest, response: ResponseFactory) => IKibanaResponse | Promise>;
// @public
export interface RequestHandlerContext {
// (undocumented)
core: {
- rendering: IScopedRenderingClient;
savedObjects: {
client: SavedObjectsClientContract;
typeRegistry: ISavedObjectTypeRegistry;
@@ -1529,6 +1542,9 @@ export type RequestHandlerContextContainer = IContextContainer = IContextProvider, TContextName>;
+// @public
+export type RequestHandlerWrapper = (handler: RequestHandler) => RequestHandler