-
Notifications
You must be signed in to change notification settings - Fork 8.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
147 changed files
with
3,370 additions
and
804 deletions.
There are no files selected for viewing
13 changes: 13 additions & 0 deletions
13
.../development/core/server/kibana-plugin-core-server.corepreboot.elasticsearch.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CorePreboot](./kibana-plugin-core-server.corepreboot.md) > [elasticsearch](./kibana-plugin-core-server.corepreboot.elasticsearch.md) | ||
|
||
## CorePreboot.elasticsearch property | ||
|
||
[ElasticsearchServicePreboot](./kibana-plugin-core-server.elasticsearchservicepreboot.md) | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
elasticsearch: ElasticsearchServicePreboot; | ||
``` |
12 changes: 12 additions & 0 deletions
12
docs/development/core/server/kibana-plugin-core-server.corepreboot.http.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CorePreboot](./kibana-plugin-core-server.corepreboot.md) > [http](./kibana-plugin-core-server.corepreboot.http.md) | ||
|
||
## CorePreboot.http property | ||
|
||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
http: HttpServicePreboot; | ||
``` |
21 changes: 21 additions & 0 deletions
21
docs/development/core/server/kibana-plugin-core-server.corepreboot.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CorePreboot](./kibana-plugin-core-server.corepreboot.md) | ||
|
||
## CorePreboot interface | ||
|
||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface CorePreboot | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [elasticsearch](./kibana-plugin-core-server.corepreboot.elasticsearch.md) | <code>ElasticsearchServicePreboot</code> | [ElasticsearchServicePreboot](./kibana-plugin-core-server.elasticsearchservicepreboot.md) | | ||
| [http](./kibana-plugin-core-server.corepreboot.http.md) | <code>HttpServicePreboot</code> | | | ||
| [preboot](./kibana-plugin-core-server.corepreboot.preboot.md) | <code>PrebootServicePreboot</code> | | | ||
|
12 changes: 12 additions & 0 deletions
12
docs/development/core/server/kibana-plugin-core-server.corepreboot.preboot.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CorePreboot](./kibana-plugin-core-server.corepreboot.md) > [preboot](./kibana-plugin-core-server.corepreboot.preboot.md) | ||
|
||
## CorePreboot.preboot property | ||
|
||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
preboot: PrebootServicePreboot; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
13 changes: 13 additions & 0 deletions
13
docs/development/core/server/kibana-plugin-core-server.discoveredplugin.type.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [DiscoveredPlugin](./kibana-plugin-core-server.discoveredplugin.md) > [type](./kibana-plugin-core-server.discoveredplugin.type.md) | ||
|
||
## DiscoveredPlugin.type property | ||
|
||
Type of the plugin, defaults to `standard`<!-- -->. Plugins with the `preboot` type are only initialized and function at the preboot stage. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
readonly type: PluginType; | ||
``` |
22 changes: 22 additions & 0 deletions
22
...ent/core/server/kibana-plugin-core-server.elasticsearchservicepreboot.config.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchServicePreboot](./kibana-plugin-core-server.elasticsearchservicepreboot.md) > [config](./kibana-plugin-core-server.elasticsearchservicepreboot.config.md) | ||
|
||
## ElasticsearchServicePreboot.config property | ||
|
||
Default Elasticsearch config. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
readonly config: ElasticsearchConfig; | ||
``` | ||
|
||
## Example | ||
|
||
|
||
```js | ||
const defaultConfig = core.elasticsearch.config; | ||
|
||
``` | ||
|
23 changes: 23 additions & 0 deletions
23
...re/server/kibana-plugin-core-server.elasticsearchservicepreboot.createclient.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchServicePreboot](./kibana-plugin-core-server.elasticsearchservicepreboot.md) > [createClient](./kibana-plugin-core-server.elasticsearchservicepreboot.createclient.md) | ||
|
||
## ElasticsearchServicePreboot.createClient property | ||
|
||
Create application specific Elasticsearch cluster API client with customized config. See [IClusterClient](./kibana-plugin-core-server.iclusterclient.md)<!-- -->. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
readonly createClient: (type: string, clientConfig?: Partial<ElasticsearchClientConfig>) => ICustomClusterClient; | ||
``` | ||
|
||
## Example | ||
|
||
|
||
```js | ||
const client = elasticsearch.createClient('my-app-name', config); | ||
const data = await client.asInternalUser.search(); | ||
|
||
``` | ||
|
20 changes: 20 additions & 0 deletions
20
...evelopment/core/server/kibana-plugin-core-server.elasticsearchservicepreboot.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchServicePreboot](./kibana-plugin-core-server.elasticsearchservicepreboot.md) | ||
|
||
## ElasticsearchServicePreboot interface | ||
|
||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface ElasticsearchServicePreboot | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [config](./kibana-plugin-core-server.elasticsearchservicepreboot.config.md) | <code>ElasticsearchConfig</code> | Default Elasticsearch config. | | ||
| [createClient](./kibana-plugin-core-server.elasticsearchservicepreboot.createclient.md) | <code>(type: string, clientConfig?: Partial<ElasticsearchClientConfig>) => ICustomClusterClient</code> | Create application specific Elasticsearch cluster API client with customized config. See [IClusterClient](./kibana-plugin-core-server.iclusterclient.md)<!-- -->. | | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
13 changes: 13 additions & 0 deletions
13
docs/development/core/server/kibana-plugin-core-server.pluginmanifest.type.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginManifest](./kibana-plugin-core-server.pluginmanifest.md) > [type](./kibana-plugin-core-server.pluginmanifest.type.md) | ||
|
||
## PluginManifest.type property | ||
|
||
Type of the plugin, defaults to `standard`<!-- -->. Plugins with the `preboot` type are only initialized and function at the preboot stage. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
readonly type: PluginType; | ||
``` |
20 changes: 20 additions & 0 deletions
20
docs/development/core/server/kibana-plugin-core-server.plugintype.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginType](./kibana-plugin-core-server.plugintype.md) | ||
|
||
## PluginType enum | ||
|
||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare enum PluginType | ||
``` | ||
|
||
## Enumeration Members | ||
|
||
| Member | Value | Description | | ||
| --- | --- | --- | | ||
| preboot | <code>"preboot"</code> | | | ||
| standard | <code>"standard"</code> | | | ||
|
19 changes: 19 additions & 0 deletions
19
docs/development/core/server/kibana-plugin-core-server.prebootplugin.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PrebootPlugin](./kibana-plugin-core-server.prebootplugin.md) | ||
|
||
## PrebootPlugin interface | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface PrebootPlugin<TSetup = void, TPluginsSetup extends object = object> | ||
``` | ||
|
||
## Methods | ||
|
||
| Method | Description | | ||
| --- | --- | | ||
| [setup(core, plugins)](./kibana-plugin-core-server.prebootplugin.setup.md) | | | ||
| [stop()](./kibana-plugin-core-server.prebootplugin.stop.md) | | | ||
|
23 changes: 23 additions & 0 deletions
23
docs/development/core/server/kibana-plugin-core-server.prebootplugin.setup.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PrebootPlugin](./kibana-plugin-core-server.prebootplugin.md) > [setup](./kibana-plugin-core-server.prebootplugin.setup.md) | ||
|
||
## PrebootPlugin.setup() method | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
setup(core: CorePreboot, plugins: TPluginsSetup): TSetup; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| core | <code>CorePreboot</code> | | | ||
| plugins | <code>TPluginsSetup</code> | | | ||
|
||
<b>Returns:</b> | ||
|
||
`TSetup` | ||
|
15 changes: 15 additions & 0 deletions
15
docs/development/core/server/kibana-plugin-core-server.prebootplugin.stop.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PrebootPlugin](./kibana-plugin-core-server.prebootplugin.md) > [stop](./kibana-plugin-core-server.prebootplugin.stop.md) | ||
|
||
## PrebootPlugin.stop() method | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
stop?(): void; | ||
``` | ||
<b>Returns:</b> | ||
`void` | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# `prebootExample` plugin | ||
|
||
The example of the `preboot` plugin. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
{ | ||
"id": "prebootExample", | ||
"owner": { | ||
"name": "Platform Security", | ||
"githubTeam": "kibana-security" | ||
}, | ||
"description": "The example of the `preboot` plugin.", | ||
"version": "8.0.0", | ||
"kibanaVersion": "kibana", | ||
"configPath": ["prebootExample"], | ||
"type": "preboot", | ||
"server": true, | ||
"ui": true, | ||
"requiredPlugins": [], | ||
"requiredBundles": [] | ||
} |
Oops, something went wrong.