-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into add-ftr-metrics
- Loading branch information
Showing
1,768 changed files
with
14,072 additions
and
53,051 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
11 changes: 0 additions & 11 deletions
11
...gins/data/public/kibana-plugin-plugins-data-public.searchstrategyprovider.id.md
This file was deleted.
Oops, something went wrong.
11 changes: 0 additions & 11 deletions
11
...ata/public/kibana-plugin-plugins-data-public.searchstrategyprovider.isviable.md
This file was deleted.
Oops, something went wrong.
20 changes: 0 additions & 20 deletions
20
...plugins/data/public/kibana-plugin-plugins-data-public.searchstrategyprovider.md
This file was deleted.
Oops, something went wrong.
11 changes: 0 additions & 11 deletions
11
.../data/public/kibana-plugin-plugins-data-public.searchstrategyprovider.search.md
This file was deleted.
Oops, something went wrong.
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
Binary file added
BIN
+90.1 KB
docs/user/alerting/images/alert-pre-configured-connectors-dropdown.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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,88 @@ | ||
[role="xpack"] | ||
[[pre-configured-connectors]] | ||
|
||
== Preconfigured connectors | ||
|
||
You can preconfigure an action connector to have all the information it needs prior to startup | ||
by adding it to the `kibana.yml` file. | ||
Sensitive configuration information, such as credentials, can use the {kib} keystore. | ||
|
||
Preconfigured connectors offer the following capabilities: | ||
|
||
- Require no setup. Configuration and credentials needed to execute an | ||
action are predefined, including the connector name and ID. | ||
- Appear in all spaces because they are not saved objects. | ||
- Cannot be edited or deleted. | ||
|
||
[float] | ||
[[preconfigured-connector-example]] | ||
=== Example of a preconfigured connector | ||
|
||
The following example shows a valid configuration 2 out-of-the box connector. | ||
|
||
[source,console] | ||
------------------------ | ||
xpack.actions.preconfigured: | ||
- id: 'my-slack1' <1> | ||
actionTypeId: .slack <2> | ||
name: 'Slack #xyz' <3> | ||
config: <4> | ||
webhookUrl: 'https://hooks.slack.com/services/abcd/efgh/ijklmnopqrstuvwxyz' | ||
- id: 'webhook-service' | ||
actionTypeId: .webhook | ||
name: 'Email service' | ||
config: | ||
url: 'https://email-alert-service.elastic.co' | ||
method: post | ||
headers: | ||
header1: value1 | ||
header2: value2 | ||
secrets: <5> | ||
user: elastic | ||
password: changeme | ||
------------------------ | ||
|
||
<1> `id` is the action connector identifier. | ||
<2> `actionTypeId` is the action type identifier. | ||
<3> `name` is the name of the preconfigured connector. | ||
<4> `config` is the action type specific to the configuration. | ||
<5> `secrets` is sensitive configuration, such as username, password, and keys. | ||
|
||
[NOTE] | ||
============================================== | ||
Sensitive properties, such as passwords, can also be stored in the {kib} keystore. | ||
============================================== | ||
|
||
[float] | ||
[[pre-configured-connector-alert-form]] | ||
=== Creating an alert with a preconfigured connector | ||
|
||
When attaching an action to an alert, | ||
select from a list of available action types, and | ||
then select the Slack or Webhook type. Those action types were configured previously. | ||
The preconfigured connector is installed and is automatically selected. | ||
|
||
[role="screenshot"] | ||
image::images/alert-pre-configured-slack-connector.png[Create alert with selected Slack action type] | ||
|
||
The dropdown is populated with additional preconfigured Slack connectors. | ||
The `preconfigured` label distinguishes them from space-aware connectors that use saved objects. | ||
|
||
[role="screenshot"] | ||
image::images/alert-pre-configured-connectors-dropdown.png[Dropdown list with pre-cofigured connectors] | ||
|
||
[float] | ||
[[managing-pre-configured-connectors]] | ||
=== Managing preconfigured connectors | ||
|
||
Preconfigured connectors appear in the connector list, regardless of which space the user is in. | ||
They are tagged as “preconfigured” and cannot be deleted. | ||
|
||
[role="screenshot"] | ||
image::images/pre-configured-connectors-managing.png[Connectors managing tab with pre-cofigured] | ||
|
||
Clicking on a preconfigured connector shows the description, but not any of the configuration. | ||
A message indicates that this is a preconfigured connector. | ||
|
||
[role="screenshot"] | ||
image::images/pre-configured-connectors-view-screen.png[Pre-configured connector view details] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,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 { isConfigSchema } from './is_config_schema'; |
56 changes: 56 additions & 0 deletions
56
packages/kbn-config-schema/src/typeguards/is_config_schema.test.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
/* | ||
* 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 '..'; | ||
import { isConfigSchema } from './is_config_schema'; | ||
|
||
describe('isConfigSchema', () => { | ||
it('returns true for every sub classes of `Type`', () => { | ||
expect(isConfigSchema(schema.any())).toBe(true); | ||
expect(isConfigSchema(schema.arrayOf(schema.string()))).toBe(true); | ||
expect(isConfigSchema(schema.boolean())).toBe(true); | ||
expect(isConfigSchema(schema.buffer())).toBe(true); | ||
expect(isConfigSchema(schema.byteSize())).toBe(true); | ||
expect(isConfigSchema(schema.duration())).toBe(true); | ||
expect(isConfigSchema(schema.literal(''))).toBe(true); | ||
expect(isConfigSchema(schema.mapOf(schema.string(), schema.number()))).toBe(true); | ||
expect(isConfigSchema(schema.nullable(schema.string()))).toBe(true); | ||
expect(isConfigSchema(schema.number())).toBe(true); | ||
expect(isConfigSchema(schema.object({}))).toBe(true); | ||
expect(isConfigSchema(schema.oneOf([schema.string()]))).toBe(true); | ||
expect(isConfigSchema(schema.recordOf(schema.string(), schema.object({})))).toBe(true); | ||
expect(isConfigSchema(schema.string())).toBe(true); | ||
expect(isConfigSchema(schema.stream())).toBe(true); | ||
}); | ||
|
||
it('returns false for every javascript data type', () => { | ||
expect(isConfigSchema('foo')).toBe(false); | ||
expect(isConfigSchema(42)).toBe(false); | ||
expect(isConfigSchema(new Date())).toBe(false); | ||
expect(isConfigSchema(null)).toBe(false); | ||
expect(isConfigSchema(undefined)).toBe(false); | ||
expect(isConfigSchema([1, 2, 3])).toBe(false); | ||
expect(isConfigSchema({ foo: 'bar' })).toBe(false); | ||
expect(isConfigSchema(function() {})).toBe(false); | ||
}); | ||
|
||
it('returns true as long as `__isKbnConfigSchemaType` is true', () => { | ||
expect(isConfigSchema({ __isKbnConfigSchemaType: true })).toBe(true); | ||
}); | ||
}); |
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
Oops, something went wrong.