a7c9d3f1e0
* Renaming alerts to rules * Updating formatted messages * Updating i18n labels * Completed renaming in UI * Updating client routes including redirect * wip docs update * Reverting title changes for now * Fixing types check * Fixing unit tests * Fixing functional test * Fixing functional test * docs wip * wip docs update * Finished first run through docs * docs docs docs * Fixing bad merge * Fixing functional test * Docs cleanup * Cleaning up i18n labels * Fixing functional test * Updating screenshots * Updating screenshots * Updating screenshots * Updating terminology in alerting examples * Updating terminology in alerting examples Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
72 lines
1.9 KiB
Plaintext
72 lines
1.9 KiB
Plaintext
[[<ACTION-TYPE>-action-type]]
|
|
=== <ACTION-TYPE> connector and action
|
|
++++
|
|
<titleabbrev><ACTION-TYPE></titleabbrev>
|
|
++++
|
|
|
|
Include a short description of the connector type.
|
|
|
|
[float]
|
|
[[<ACTION-TYPE>-connector-configuration]]
|
|
==== Connector configuration
|
|
|
|
<ACTION-TYPE> connectors have the following configuration properties.
|
|
|
|
////
|
|
List of user-facing connector configurations. This should align with the fields available in the Create connector flyout form for this connector type.
|
|
////
|
|
|
|
Property1:: A short description of this property.
|
|
Property2:: A short description of this property with format hints. This can be specified in `this specific format`.
|
|
|
|
[float]
|
|
[[Preconfigured-<ACTION-TYPE>-configuration]]
|
|
==== Preconfigured connector type
|
|
|
|
////
|
|
Example preconfigured format for this connector type
|
|
////
|
|
|
|
[source,text]
|
|
--
|
|
my-<ACTION-TYPE>:
|
|
name: preconfigured-<ACTION-TYPE>-connector-type
|
|
actionTypeId: .<ACTION-TYPE>
|
|
config:
|
|
property1: value1
|
|
property2: value2
|
|
secrets:
|
|
property3: value3
|
|
--
|
|
|
|
////
|
|
List of properties from the ConfigSchema and SecretsSchema for this action type.
|
|
////
|
|
Config defines information for the connector type.
|
|
|
|
`property1`:: A short description of this property.
|
|
`property2`:: A short descriptionn of this property.
|
|
|
|
Secrets defines sensitive information for the connector type.
|
|
|
|
`property3`:: A short descriptionn of this property.
|
|
|
|
[float]
|
|
[[<ACTION-TYPE>-action-configuration]]
|
|
==== Action configuration
|
|
|
|
<ACTION-TYPE> actions have the following properties.
|
|
|
|
////
|
|
List of user-facing action configurations. This should align with the fields available in the Action section of the Create/Update alert flyout.
|
|
////
|
|
|
|
Property1:: A short description of this property.
|
|
Property2:: A short description of this property with format hints. This can be specified in `this specific format`.
|
|
|
|
////
|
|
Optional - additional configuration details here
|
|
[[configuring-<ACTION-TYPE>]]
|
|
==== Configure <ACTION-TYPE>
|
|
////
|