mirror of
https://github.com/elastic/kibana.git
synced 2025-04-23 17:28:26 -04:00
# Backport This will backport the following commits from `main` to `8.11`: - [[DOCS] Add preconfigured AWS Bedrock connector (#168663)](https://github.com/elastic/kibana/pull/168663) <!--- 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-10-16T15:23:12Z","message":"[DOCS] Add preconfigured AWS Bedrock connector (#168663)","sha":"15ac35135190388268a05bdc9f87b0ea4780e786","branchLabelMapping":{"^v8.12.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:ResponseOps","docs","Team: SecuritySolution","Feature:Actions/ConnectorTypes","v8.11.0","v8.12.0"],"number":168663,"url":"https://github.com/elastic/kibana/pull/168663","mergeCommit":{"message":"[DOCS] Add preconfigured AWS Bedrock connector (#168663)","sha":"15ac35135190388268a05bdc9f87b0ea4780e786"}},"sourceBranch":"main","suggestedTargetBranches":["8.11"],"targetPullRequestStates":[{"branch":"8.11","label":"v8.11.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.12.0","labelRegex":"^v8.12.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/168663","number":168663,"mergeCommit":{"message":"[DOCS] Add preconfigured AWS Bedrock connector (#168663)","sha":"15ac35135190388268a05bdc9f87b0ea4780e786"}}]}] BACKPORT--> Co-authored-by: Lisa Cawley <lcawley@elastic.co>
This commit is contained in:
Kibana Machine
GitHub
parent
70b88bed7b
commit
f5e0945c62
5 changed files with 59 additions and 50 deletions
|
|
@ -28,43 +28,10 @@ List of user-facing connector configurations. This should align with the fields
|
|||
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
|
||||
Add preconfigured settings for this connector type in alert-action-settings.asciidoc and an example in pre-configured-connectors.asciidoc.
|
||||
////
|
||||
|
||||
[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
|
||||
|
|
|
|||
|
|
@ -7,9 +7,9 @@ Connectors provide a central place to store connection information for services
|
|||
[cols="2"]
|
||||
|===
|
||||
|
||||
a| <<bedrock-action-type,AWS Bedrock>>
|
||||
a| <<bedrock-action-type,{bedrock}>>
|
||||
|
||||
| Send a request to AWS Bedrock.
|
||||
| Send a request to {bedrock}.
|
||||
|
||||
a| <<d3security-action-type,D3 Security>>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,15 +1,15 @@
|
|||
[[bedrock-action-type]]
|
||||
== AWS Bedrock connector and action
|
||||
== {bedrock} connector and action
|
||||
++++
|
||||
<titleabbrev>AWS Bedrock</titleabbrev>
|
||||
<titleabbrev>{bedrock}</titleabbrev>
|
||||
++++
|
||||
:frontmatter-description: Add a connector that can send requests to AWS Bedrock.
|
||||
:frontmatter-description: Add a connector that can send requests to {bedrock}.
|
||||
:frontmatter-tags-products: [kibana]
|
||||
:frontmatter-tags-content-type: [how-to]
|
||||
:frontmatter-tags-user-goals: [configure]
|
||||
|
||||
|
||||
The AWS Bedrock connector uses https://github.com/axios/axios[axios] to send a POST request to AWS Bedrock. The connector uses the <<execute-connector-api,run connector API>> to send the request.
|
||||
The {bedrock} connector uses https://github.com/axios/axios[axios] to send a POST request to {bedrock}. The connector uses the <<execute-connector-api,run connector API>> to send the request.
|
||||
|
||||
[float]
|
||||
[[define-bedrock-ui]]
|
||||
|
|
@ -19,18 +19,18 @@ You can create connectors in *{stack-manage-app} > {connectors-ui}*. For exampl
|
|||
|
||||
[role="screenshot"]
|
||||
// TODO: need logo before screenshot
|
||||
image::management/connectors/images/bedrock-connector.png[AWS Bedrock connector]
|
||||
image::management/connectors/images/bedrock-connector.png[{bedrock} connector]
|
||||
|
||||
[float]
|
||||
[[bedrock-connector-configuration]]
|
||||
==== Connector configuration
|
||||
|
||||
AWS Bedrock connectors have the following configuration properties:
|
||||
{bedrock} connectors have the following configuration properties:
|
||||
|
||||
Name:: The name of the connector.
|
||||
API URL:: The AWS Bedrock request URL.
|
||||
Default model:: The GAI model for AWS Bedrock to use. Current support is for the Anthropic Claude models, defaulting to Claude 2. The model can be set on a per request basis by including a "model" parameter alongside the request body.
|
||||
Region:: The AWS Bedrock request URL.
|
||||
API URL:: The {bedrock} request URL.
|
||||
Default model:: The GAI model for {bedrock} to use. Current support is for the Anthropic Claude models, defaulting to Claude 2. The model can be set on a per request basis by including a "model" parameter alongside the request body.
|
||||
Region:: The {bedrock} request URL.
|
||||
Access Key:: The AWS access key for authentication.
|
||||
Secret:: The secret for authentication.
|
||||
|
||||
|
|
@ -43,11 +43,11 @@ as you're creating or editing the connector in {kib}. For example:
|
|||
|
||||
[role="screenshot"]
|
||||
// TODO: need logo before screenshot
|
||||
image::management/connectors/images/bedrock-params.png[AWS Bedrock params test]
|
||||
image::management/connectors/images/bedrock-params.png[{bedrock} params test]
|
||||
|
||||
The AWS Bedrock actions have the following configuration properties.
|
||||
The {bedrock} actions have the following configuration properties.
|
||||
|
||||
Body:: A stringified JSON payload sent to the AWS Bedrock Invoke Model API URL. For example:
|
||||
Body:: A stringified JSON payload sent to the {bedrock} Invoke Model API URL. For example:
|
||||
+
|
||||
[source,text]
|
||||
--
|
||||
|
|
|
|||
|
|
@ -1,5 +1,9 @@
|
|||
[[pre-configured-connectors]]
|
||||
== Preconfigured connectors
|
||||
:frontmatter-description: Define connectors in the {kib} configuration file.
|
||||
:frontmatter-tags-products: [kibana]
|
||||
:frontmatter-tags-content-type: [how-to]
|
||||
:frontmatter-tags-user-goals: [configure]
|
||||
|
||||
If you are running {kib} on-prem, you can preconfigure a connector to have all
|
||||
the information it needs prior to startup by adding it to the `kibana.yml` file.
|
||||
|
|
@ -20,6 +24,7 @@ predefined, including the connector name and ID.
|
|||
|
||||
Add `xpack.actions.preconfigured` settings to your `kibana.yml` file. The
|
||||
settings vary depending on which type of connector you're adding.
|
||||
Refer to <<preconfigured-connector-settings>>.
|
||||
|
||||
This example shows a valid configuration for a Slack connector and a Webhook
|
||||
connector:
|
||||
|
|
@ -107,6 +112,7 @@ Index names must start with `kibana-alert-history-` to take advantage of the pre
|
|||
[[preconfigured-connector-examples]]
|
||||
=== Examples
|
||||
|
||||
* <<preconfigured-bedrock-configuration>>
|
||||
* <<preconfigured-d3security-configuration>>
|
||||
* <<preconfigured-email-configuration>>
|
||||
* <<preconfigured-gen-ai-configuration>>
|
||||
|
|
@ -128,6 +134,30 @@ Index names must start with `kibana-alert-history-` to take advantage of the pre
|
|||
* <<preconfigured-cases-webhook-configuration>>
|
||||
* <<preconfigured-xmatters-configuration>>
|
||||
|
||||
[float]
|
||||
[[preconfigured-bedrock-configuration]]
|
||||
==== {bedrock} connectors
|
||||
|
||||
The following example creates an <<bedrock-action-type,{bedrock} connector>>:
|
||||
|
||||
[source,text]
|
||||
--
|
||||
xpack.actions.preconfigured:
|
||||
my-bedrock:
|
||||
name: preconfigured-bedrock-connector-type
|
||||
actionTypeId: .bedrock
|
||||
config:
|
||||
apiUrl: https://bedrock.us-east-1.amazonaws.com <1>
|
||||
defaultModel: anthropic.claude-v2 <2>
|
||||
secrets:
|
||||
accessKey: key-value <3>
|
||||
secret: secret-value <4>
|
||||
--
|
||||
<1> The {bedrock} request URL.
|
||||
<2> The default model to use for requests. Current support is for the Anthropic Claude models, defaulting to Claude 2.
|
||||
<3> The AWS access key for authentication.
|
||||
<4> The AWS secret for authentication.
|
||||
|
||||
[float]
|
||||
[[preconfigured-d3security-configuration]]
|
||||
==== D3 Security connectors
|
||||
|
|
@ -302,7 +332,7 @@ xpack.actions.preconfigured:
|
|||
secrets:
|
||||
apiKey: superlongapikey <4>
|
||||
--
|
||||
<1> The OpenAI request URL
|
||||
<1> The OpenAI request URL.
|
||||
<2> The OpenAI API provider, either `OpenAI` or `Azure OpenAI`.
|
||||
<3> The default model to use for requests. This setting is optional and applicable only when `apiProvider` is `OpenAI`.
|
||||
<4> The OpenAI or Azure OpenAI API key for authentication.
|
||||
|
|
|
|||
|
|
@ -267,6 +267,7 @@ For a <<openai-action-type,OpenAI connector>>, specifies the OpenAI API provider
|
|||
A configuration URL that varies by connector:
|
||||
+
|
||||
--
|
||||
* For an <<bedrock-action-type,{bedrock} connector>>, specifies the {bedrock} request URL.
|
||||
* For a <<openai-action-type,OpenAI connector>>, specifies the OpenAI request URL.
|
||||
* For a <<resilient-action-type,{ibm-r} connector>>, specifies the {ibm-r} instance URL.
|
||||
* For a <<jira-action-type,Jira connector>>, specifies the Jira instance URL.
|
||||
|
|
@ -327,7 +328,12 @@ NOTE: If you are using the `xpack.actions.allowedHosts` setting, make sure the h
|
|||
For a <<cases-webhook-action-type,{webhook-cm} connector>>, specifies a string from the response body of the create case method that corresponds to the external service identifier.
|
||||
|
||||
`xpack.actions.preconfigured.<connector-id>.config.defaultModel`::
|
||||
For a <<openai-action-type,OpenAI connector>>, specifies the default model to use for requests. It is optional and applicable only when `xpack.actions.preconfigured.<connector-id>.config.apiProvider` is `OpenAI`.
|
||||
The default model to use for requests, which varies by connector:
|
||||
+
|
||||
--
|
||||
* For an <<bedrock-action-type,{bedrock} connector>>, current support is for the Anthropic Claude models. Defaults to `anthropic.claude-v2`.
|
||||
* For a <<openai-action-type,OpenAI connector>>, it is optional and applicable only when `xpack.actions.preconfigured.<connector-id>.config.apiProvider` is `OpenAI`.
|
||||
--
|
||||
|
||||
`xpack.actions.preconfigured.<connector-id>.config.executionTimeField`::
|
||||
For an <<index-action-type,index connector>>, a field that indicates when the document was indexed.
|
||||
|
|
@ -463,6 +469,9 @@ Sensitive configuration details, such as username, password, and keys, which are
|
|||
+
|
||||
TIP: Sensitive properties, such as passwords, should be stored in the <<creating-keystore,{kib} keystore>>.
|
||||
|
||||
`xpack.actions.preconfigured.<connector-id>.secrets.accessKey`::
|
||||
For an <<bedrock-action-type,{bedrock} connector>>, specifies the AWS access key for authentication.
|
||||
|
||||
`xpack.actions.preconfigured.<connector-id>.secrets.apikey`::
|
||||
An API key secret that varies by connector:
|
||||
+
|
||||
|
|
@ -517,6 +526,9 @@ For a <<servicenow-action-type,{sn-itsm}>>, <<servicenow-sir-action-type,{sn-sir
|
|||
`xpack.actions.preconfigured.<connector-id>.secrets.routingKey`::
|
||||
For a <<pagerduty-action-type,PagerDuty connector>>, specifies the 32 character PagerDuty Integration Key for an integration on a service, also referred to as the routing key.
|
||||
|
||||
`xpack.actions.preconfigured.<connector-id>.secrets.secret`::
|
||||
For an <<bedrock-action-type,{bedrock} connector>>, specifies the AWS secret for authentication.
|
||||
|
||||
`xpack.actions.preconfigured.<connector-id>.secrets.secretsUrl`::
|
||||
For an <<xmatters-action-type,xMatters connector>> with URL authentication, specifies the request URL for the Elastic Alerts trigger in xMatters with the API key included in the URL.
|
||||
It is used only when `xpack.actions.preconfigured.<connector-id>.config.usesBasic` is `false`.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue