Merge branch 'main' into 162950-test-action-variables

elastic · Oct 3, 2023 · d4b5b03 · d4b5b03
2 parents e5f67cd + 0fc24f4
commit d4b5b03
Show file tree

Hide file tree

Showing 6 changed files with 198 additions and 184 deletions.
diff --git a/docs/management/connectors/action-types/servicenow-itom.asciidoc b/docs/management/connectors/action-types/servicenow-itom.asciidoc
@@ -3,6 +3,10 @@
 ++++
 <titleabbrev>{sn-itom}</titleabbrev>
 ++++
+:frontmatter-description: Add a connector that can create {sn} events.
+:frontmatter-tags-products: [kibana] 
+:frontmatter-tags-content-type: [how-to] 
+:frontmatter-tags-user-goals: [configure]
 
 The {sn-itom} connector uses the
 https://docs.servicenow.com/bundle/rome-it-operations-management/page/product/event-management/task/send-events-via-web-service.html[event API]
@@ -79,62 +83,6 @@ JWT Key ID:: The key ID assigned to the JWT verifier map of your OAuth applicati
 Private Key:: The RSA private key generated during setup.
 Private Key Password:: The password for the RSA private key generated during setup, if set.
 
-[float]
-[[preconfigured-servicenow-itom-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:
-
-Connector using Basic Authentication
-[source,text]
---
-xpack.actions.preconfigured:
-  my-servicenow-itom:
-    name: preconfigured-servicenow-connector-type
-    actionTypeId: .servicenow-itom
-    config:
-      apiUrl: https://example.service-now.com/
-    secrets:
-      username: testuser
-      password: passwordkeystorevalue
---
-
-Connector using OAuth
-[source,text]
---
- my-servicenow:
-   name: preconfigured-oauth-servicenow-connector-type
-   actionTypeId: .servicenow-itom
-   config:
-     apiUrl: https://example.service-now.com/
-     usesTableApi: false
-     isOAuth: true
-     userIdentifierValue: testuser@email.com
-     clientId: abcdefghijklmnopqrstuvwxyzabcdef
-     jwtKeyId: fedcbazyxwvutsrqponmlkjihgfedcba
-   secrets:
-     clientSecret: secretsecret
-     privateKey: -----BEGIN RSA PRIVATE KEY-----\nprivatekeyhere\n-----END RSA PRIVATE KEY-----
---
-
-Config defines information for the connector type.
-
-`apiUrl`:: An address that corresponds to *URL*.
-`isOAuth`:: A boolean that corresponds to *Is OAuth* and indicates if the connector uses Basic Authentication or OAuth.
-`userIdentifierValue`:: A string that corresponds to *User Identifier*. Required if `isOAuth` is set to `true`.
-`clientId`:: A string that corresponds to *Client ID*, used for OAuth authentication. Required if `isOAuth` is set to `true`.
-`jwtKeyId`:: A string that corresponds to *JWT Key ID*, used for OAuth authentication. Required if `isOAuth` is set to `true`.
-
-Secrets defines sensitive information for the connector type.
-
-`username`:: A string that corresponds to *Username*. Required if `isOAuth` is set to `false`.
-`password`::  A string that corresponds to *Password*. Should be stored in the <<creating-keystore, {kib} keystore>>. Required if `isOAuth` is set to `false`.
-`clientSecret`:: A string that corresponds to *Client Secret*. Required if `isOAuth` is set to `true`.
-`privateKey`:: A string that corresponds to *Private Key*. Required if `isOAuth` is set to `true`.
-`privateKeyPassword`:: A string that corresponds to *Private Key Password*.
-
 [float]
 [[servicenow-itom-action-configuration]]
 === Test connectors

diff --git a/docs/management/connectors/action-types/servicenow-sir.asciidoc b/docs/management/connectors/action-types/servicenow-sir.asciidoc
@@ -3,6 +3,10 @@
 ++++
 <titleabbrev>{sn-sir}</titleabbrev>
 ++++
+:frontmatter-description: Add a connector that can create {sn} security incidents.
+:frontmatter-tags-products: [kibana] 
+:frontmatter-tags-content-type: [how-to] 
+:frontmatter-tags-user-goals: [configure]
 
 The {sn-sir} connector uses the
 https://developer.servicenow.com/dev.do#!/reference/api/sandiego/rest/c_ImportSetAPI[import set API]
@@ -122,68 +126,6 @@ JWT Key ID:: The key ID assigned to the JWT verifier map of your OAuth applicati
 Private Key:: The RSA private key generated during setup.
 Private Key Password:: The password for the RSA private key generated during setup, if set.
 
-[float]
-[[preconfigured-servicenow-sir-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:
-
-Connector using Basic Authentication
-[source,text]
---
-xpack.actions.preconfigured:
-  my-servicenow-sir:
-    name: preconfigured-servicenow-connector-type
-    actionTypeId: .servicenow-sir
-    config:
-      apiUrl: https://example.service-now.com/
-      usesTableApi: false
-    secrets:
-      username: testuser
-      password: passwordkeystorevalue
---
-
-Connector using OAuth
-[source,text]
---
-xpack.actions.preconfigured:
-  my-servicenow:
-    name: preconfigured-oauth-servicenow-connector-type
-    actionTypeId: .servicenow-sir
-    config:
-      apiUrl: https://example.service-now.com/
-      usesTableApi: false
-      isOAuth: true
-      userIdentifierValue: testuser@email.com
-      clientId: abcdefghijklmnopqrstuvwxyzabcdef
-      jwtKeyId: fedcbazyxwvutsrqponmlkjihgfedcba
-    secrets:
-      clientSecret: secretsecret
-      privateKey: -----BEGIN RSA PRIVATE KEY-----\nprivatekeyhere\n-----END RSA PRIVATE KEY-----
---
-
-Config defines information for the connector type.
-
-`apiUrl`:: An address that corresponds to *URL*.
-`usesTableApi`:: A boolean that indicates if the connector uses the Table API or the Import Set API.
-
-NOTE: If `usesTableApi` is set to false, the Elastic application should be installed in {sn}.
-
-`isOAuth`:: A boolean that corresponds to *Is OAuth* and indicates if the connector uses Basic Authentication or OAuth.
-`userIdentifierValue`:: A string that corresponds to *User Identifier*. Required if `isOAuth` is set to `true`.
-`clientId`:: A string that corresponds to *Client ID*, used for OAuth authentication. Required if `isOAuth` is set to `true`.
-`jwtKeyId`:: A string that corresponds to *JWT Key ID*, used for OAuth authentication. Required if `isOAuth` is set to `true`.
-
-Secrets defines sensitive information for the connector type.
-
-`username`:: A string that corresponds to *Username*. Required if `isOAuth` is set to `false`.
-`password`::  A string that corresponds to *Password*. Should be stored in the <<creating-keystore, {kib} keystore>>. Required if `isOAuth` is set to `false`.
-`clientSecret`:: A string that corresponds to *Client Secret*. Required if `isOAuth` is set to `true`.
-`privateKey`:: A string that corresponds to *Private Key*. Required if `isOAuth` is set to `true`.
-`privateKeyPassword`:: A string that corresponds to *Private Key Password*.
-
 [float]
 [[servicenow-sir-action-configuration]]
 === Test connectors

diff --git a/docs/management/connectors/action-types/servicenow.asciidoc b/docs/management/connectors/action-types/servicenow.asciidoc
@@ -3,6 +3,10 @@
 ++++
 <titleabbrev>{sn-itsm}</titleabbrev>
 ++++
+:frontmatter-description: Add a connector that can create {sn} incidents.
+:frontmatter-tags-products: [kibana] 
+:frontmatter-tags-content-type: [how-to] 
+:frontmatter-tags-user-goals: [configure]
 
 The {sn-itsm} connector uses the
 https://developer.servicenow.com/dev.do#!/reference/api/sandiego/rest/c_ImportSetAPI[import set API]
@@ -206,68 +210,6 @@ JWT Key ID:: The key ID assigned to the JWT Verifier Map of your OAuth applicati
 Private Key:: The RSA private key generated during setup.
 Private Key Password:: The password for the RSA private key generated during setup, if set.
 
-[float]
-[[preconfigured-servicenow-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:
-
-Connector using Basic Authentication
-[source,text]
---
-xpack.actions.preconfigured:
-  my-servicenow:
-    name: preconfigured-servicenow-connector-type
-    actionTypeId: .servicenow
-    config:
-      apiUrl: https://example.service-now.com/
-      usesTableApi: false
-    secrets:
-      username: testuser
-      password: passwordkeystorevalue
---
-
-Connector using OAuth
-[source,text]
---
-xpack.actions.preconfigured:
-  my-servicenow:
-    name: preconfigured-oauth-servicenow-connector-type
-    actionTypeId: .servicenow
-    config:
-      apiUrl: https://example.service-now.com/
-      usesTableApi: false
-      isOAuth: true
-      userIdentifierValue: testuser@email.com
-      clientId: abcdefghijklmnopqrstuvwxyzabcdef
-      jwtKeyId: fedcbazyxwvutsrqponmlkjihgfedcba
-    secrets:
-      clientSecret: secretsecret
-      privateKey: -----BEGIN RSA PRIVATE KEY-----\nprivatekeyhere\n-----END RSA PRIVATE KEY-----
---
-
-Config defines information for the connector type.
-
-`apiUrl`:: An address that corresponds to *URL*.
-`usesTableApi`:: A boolean that indicates if the connector uses the Table API or the Import Set API.
-
-NOTE: If `usesTableApi` is set to false, the Elastic application should be installed in {sn}.
-
-`isOAuth`:: A boolean that corresponds to *Is OAuth* and indicates if the connector uses Basic Authentication or OAuth.
-`userIdentifierValue`:: A string that corresponds to *User Identifier*. Required if `isOAuth` is set to `true`.
-`clientId`:: A string that corresponds to *Client ID*, used for OAuth authentication. Required if `isOAuth` is set to `true`.
-`jwtKeyId`:: A string that corresponds to *JWT Key ID*, used for OAuth authentication. Required if `isOAuth` is set to `true`.
-
-Secrets defines sensitive information for the connector type.
-
-`username`:: A string that corresponds to *Username*. Required if `isOAuth` is set to `false`.
-`password`::  A string that corresponds to *Password*. Should be stored in the <<creating-keystore, {kib} keystore>>. Required if `isOAuth` is set to `false`.
-`clientSecret`:: A string that corresponds to *Client Secret*. Required if `isOAuth` is set to `true`.
-`privateKey`:: A string that corresponds to *Private Key*. Required if `isOAuth` is set to `true`.
-`privateKeyPassword`:: A string that corresponds to *Private Key Password*.
-
 [float]
 [[servicenow-action-configuration]]
 === Test connectors