mirror of
https://github.com/elastic/kibana.git
synced 2025-04-24 17:59:23 -04:00
d962d8c039
# Backport This will backport the following commits from `main` to `8.6`: - [[DOCS] Edit layout of connector pages (#151534)](https://github.com/elastic/kibana/pull/151534) <!--- Backport version: 8.9.7 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Lisa Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2023-02-21T16:20:21Z","message":"[DOCS] Edit layout of connector pages (#151534)","sha":"3759d73bac53a7d818531ffa9f55fe91aba39797","branchLabelMapping":{"^v8.8.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:ResponseOps","docs","Feature:Actions/ConnectorTypes","backport:prev-minor","v8.7.0","v8.8.0","v8.6.3"],"number":151534,"url":"https://github.com/elastic/kibana/pull/151534","mergeCommit":{"message":"[DOCS] Edit layout of connector pages (#151534)","sha":"3759d73bac53a7d818531ffa9f55fe91aba39797"}},"sourceBranch":"main","suggestedTargetBranches":["8.6"],"targetPullRequestStates":[{"branch":"8.7","label":"v8.7.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"url":"https://github.com/elastic/kibana/pull/151738","number":151738,"state":"MERGED","mergeCommit":{"sha":"950a4b8d7534f8f24d97b3088826411f3f5a47f7","message":"[8.7] [DOCS] Edit layout of connector pages (#151534) (#151738)\n\n# Backport\n\nThis will backport the following commits from `main` to `8.7`:\n- [[DOCS] Edit layout of connector pages\n(#151534)](https://github.com/elastic/kibana/pull/151534)\n\n<!--- Backport version: 8.9.7 -->\n\n### Questions ?\nPlease refer to the [Backport tool\ndocumentation](https://github.com/sqren/backport)\n\n<!--BACKPORT [{\"author\":{\"name\":\"Lisa\nCawley\",\"email\":\"lcawley@elastic.co\"},\"sourceCommit\":{\"committedDate\":\"2023-02-21T16:20:21Z\",\"message\":\"[DOCS]\nEdit layout of connector pages\n(#151534)\",\"sha\":\"3759d73bac53a7d818531ffa9f55fe91aba39797\",\"branchLabelMapping\":{\"^v8.8.0$\":\"main\",\"^v(\\\\d+).(\\\\d+).\\\\d+$\":\"$1.$2\"}},\"sourcePullRequest\":{\"labels\":[\"release_note:skip\",\"Team:ResponseOps\",\"docs\",\"Feature:Actions/ConnectorTypes\",\"backport:prev-minor\",\"v8.7.0\",\"v8.8.0\",\"v8.6.3\"],\"number\":151534,\"url\":\"https://github.com/elastic/kibana/pull/151534\",\"mergeCommit\":{\"message\":\"[DOCS]\nEdit layout of connector pages\n(#151534)\",\"sha\":\"3759d73bac53a7d818531ffa9f55fe91aba39797\"}},\"sourceBranch\":\"main\",\"suggestedTargetBranches\":[\"8.7\",\"8.6\"],\"targetPullRequestStates\":[{\"branch\":\"8.7\",\"label\":\"v8.7.0\",\"labelRegex\":\"^v(\\\\d+).(\\\\d+).\\\\d+$\",\"isSourceBranch\":false,\"state\":\"NOT_CREATED\"},{\"branch\":\"main\",\"label\":\"v8.8.0\",\"labelRegex\":\"^v8.8.0$\",\"isSourceBranch\":true,\"state\":\"MERGED\",\"url\":\"https://github.com/elastic/kibana/pull/151534\",\"number\":151534,\"mergeCommit\":{\"message\":\"[DOCS]\nEdit layout of connector pages\n(#151534)\",\"sha\":\"3759d73bac53a7d818531ffa9f55fe91aba39797\"}},{\"branch\":\"8.6\",\"label\":\"v8.6.3\",\"labelRegex\":\"^v(\\\\d+).(\\\\d+).\\\\d+$\",\"isSourceBranch\":false,\"state\":\"NOT_CREATED\"}]}]\nBACKPORT-->\n\nCo-authored-by: Lisa Cawley <lcawley@elastic.co>"}},{"branch":"main","label":"v8.8.0","labelRegex":"^v8.8.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/151534","number":151534,"mergeCommit":{"message":"[DOCS] Edit layout of connector pages (#151534)","sha":"3759d73bac53a7d818531ffa9f55fe91aba39797"}},{"branch":"8.6","label":"v8.6.3","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT-->
88 lines
2.4 KiB
Text
88 lines
2.4 KiB
Text
[[<ACTION-TYPE>-action-type]]
|
|
== <ACTION-TYPE> connector and action
|
|
++++
|
|
<titleabbrev><ACTION-TYPE></titleabbrev>
|
|
++++
|
|
|
|
Include a short description of the connector type.
|
|
|
|
[float]
|
|
[[define-<ACTION-TYPE>-ui]]
|
|
=== Create connectors in {kib}
|
|
|
|
You can create connectors in *{stack-manage-app} > {connectors-ui}*
|
|
or as needed when you're creating a rule.
|
|
|
|
// Optionally add a screenshot
|
|
|
|
[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]]
|
|
=== Create preconfigured connectors
|
|
|
|
If you are running {kib} on-prem, you can define connectors by
|
|
adding `xpack.actions.preconfigured` settings to your `kibana.yml` file.
|
|
For example:
|
|
|
|
////
|
|
Example preconfigured format for this connector type
|
|
////
|
|
|
|
[source,text]
|
|
--
|
|
xpack.actions.preconfigured:
|
|
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]]
|
|
=== Test connectors
|
|
|
|
You can test connectors with the <<execute-connector-api,run connector API>> or
|
|
as you're creating or editing the connector in {kib}.
|
|
|
|
<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>
|
|
////
|