[DOCS] Move preconfigured PagerDuty connector details (#165361)

2025-04-24 09:48:58 -04:00 · 2023-09-06 14:39:40 -07:00 · 2023-09-06 14:39:40 -07:00 · 977d7f8628
commit 977d7f8628
parent 49ff1f152e
9 changed files with 141 additions and 40 deletions
--- a/docs/api-generated/connectors/connector-apis-passthru.asciidoc
+++ b/docs/api-generated/connectors/connector-apis-passthru.asciidoc
@ -1006,6 +1006,7 @@ Any modifications made to this file will be overwritten.
    <li><a href="#config_properties_index"><code>config_properties_index</code> - Connector request properties for an index connector</a></li>
    <li><a href="#config_properties_jira"><code>config_properties_jira</code> - Connector request properties for a Jira connector</a></li>
    <li><a href="#config_properties_opsgenie"><code>config_properties_opsgenie</code> - Connector request properties for an Opsgenie connector</a></li>
+    <li><a href="#config_properties_pagerduty"><code>config_properties_pagerduty</code> - Connector request properties for a PagerDuty connector</a></li>
    <li><a href="#config_properties_resilient"><code>config_properties_resilient</code> - Connector request properties for a IBM Resilient connector</a></li>
    <li><a href="#config_properties_servicenow"><code>config_properties_servicenow</code> - Connector request properties for a ServiceNow ITSM connector</a></li>
    <li><a href="#config_properties_servicenow_itom"><code>config_properties_servicenow_itom</code> - Connector request properties for a ServiceNow ITSM connector</a></li>
@ -1089,6 +1090,7 @@ Any modifications made to this file will be overwritten.
    <li><a href="#secrets_properties_genai"><code>secrets_properties_genai</code> - Connector secrets properties for a generative AI connector</a></li>
    <li><a href="#secrets_properties_jira"><code>secrets_properties_jira</code> - Connector secrets properties for a Jira connector</a></li>
    <li><a href="#secrets_properties_opsgenie"><code>secrets_properties_opsgenie</code> - Connector secrets properties for an Opsgenie connector</a></li>
+    <li><a href="#secrets_properties_pagerduty"><code>secrets_properties_pagerduty</code> - Connector secrets properties for a PagerDuty connector</a></li>
    <li><a href="#secrets_properties_resilient"><code>secrets_properties_resilient</code> - Connector secrets properties for IBM Resilient connector</a></li>
    <li><a href="#secrets_properties_servicenow"><code>secrets_properties_servicenow</code> - Connector secrets properties for ServiceNow ITOM, ServiceNow ITSM, and ServiceNow SecOps connectors</a></li>
    <li><a href="#secrets_properties_slack_api"><code>secrets_properties_slack_api</code> - Connector secrets properties for a Web API Slack connector</a></li>
@ -1100,6 +1102,7 @@ Any modifications made to this file will be overwritten.
    <li><a href="#update_connector_request_index"><code>update_connector_request_index</code> - Update index connector request</a></li>
    <li><a href="#update_connector_request_jira"><code>update_connector_request_jira</code> - Update Jira connector request</a></li>
    <li><a href="#update_connector_request_opsgenie"><code>update_connector_request_opsgenie</code> - Update Opsgenie connector request</a></li>
+    <li><a href="#update_connector_request_pagerduty"><code>update_connector_request_pagerduty</code> - Update PagerDuty connector request</a></li>
    <li><a href="#update_connector_request_resilient"><code>update_connector_request_resilient</code> - Update IBM Resilient connector request</a></li>
    <li><a href="#update_connector_request_serverlog"><code>update_connector_request_serverlog</code> - Update server log connector request</a></li>
    <li><a href="#update_connector_request_servicenow"><code>update_connector_request_servicenow</code> - Update ServiceNow ITSM connector or ServiceNow SecOps request</a></li>
@ -1409,6 +1412,13 @@ Any modifications made to this file will be overwritten.
      <div class="param">apiUrl </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The Opsgenie URL. For example, <code>https://api.opsgenie.com</code> or <code>https://api.eu.opsgenie.com</code>. If you are using the <code>xpack.actions.allowedHosts</code> setting, add the hostname to the allowed hosts. </div>
    </div>  <!-- field-items -->
  </div>
+  <div class="model">
+    <h3><a name="config_properties_pagerduty"><code>config_properties_pagerduty</code> - Connector request properties for a PagerDuty connector</a> <a class="up" href="#__Models">Up</a></h3>
+    <div class='model-description'>Defines properties for connectors when type is <code>.pagerduty</code>.</div>
+    <div class="field-items">
+      <div class="param">apiUrl (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The PagerDuty event URL. </div>
+    </div>  <!-- field-items -->
+  </div>
  <div class="model">
    <h3><a name="config_properties_resilient"><code>config_properties_resilient</code> - Connector request properties for a IBM Resilient connector</a> <a class="up" href="#__Models">Up</a></h3>
    <div class='model-description'>Defines properties for connectors when type is <code>.resilient</code>.</div>
@ -1574,7 +1584,7 @@ Any modifications made to this file will be overwritten.
    <h3><a name="connector_response_properties_pagerduty"><code>connector_response_properties_pagerduty</code> - Connector response properties for a PagerDuty connector</a> <a class="up" href="#__Models">Up</a></h3>
    <div class='model-description'></div>
    <div class="field-items">
-      <div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#AnyType">map[String, oas_any_type_not_mapped]</a></span> Defines properties for connectors when type is <code>.pagerduty</code>. </div>
+      <div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_pagerduty">config_properties_pagerduty</a></span>  </div>
 <div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
        <div class="param-enum-header">Enum:</div>
        <div class="param-enum">.pagerduty</div>
@ -1856,12 +1866,12 @@ Any modifications made to this file will be overwritten.
    <h3><a name="create_connector_request_pagerduty"><code>create_connector_request_pagerduty</code> - Create PagerDuty connector request</a> <a class="up" href="#__Models">Up</a></h3>
    <div class='model-description'>The PagerDuty connector uses the v2 Events API to trigger, acknowledge, and resolve PagerDuty alerts.</div>
    <div class="field-items">
-      <div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#AnyType">map[String, oas_any_type_not_mapped]</a></span> Defines properties for connectors when type is <code>.pagerduty</code>. </div>
+      <div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_pagerduty">config_properties_pagerduty</a></span>  </div>
 <div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
        <div class="param-enum-header">Enum:</div>
        <div class="param-enum">.pagerduty</div>
 <div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The display name for the connector. </div>
-<div class="param">secrets </div><div class="param-desc"><span class="param-type"><a href="#AnyType">map[String, oas_any_type_not_mapped]</a></span> Defines secrets for connectors when type is <code>.pagerduty</code>. </div>
+<div class="param">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_pagerduty">secrets_properties_pagerduty</a></span>  </div>
    </div>  <!-- field-items -->
  </div>
  <div class="model">
@ -2376,6 +2386,13 @@ Any modifications made to this file will be overwritten.
      <div class="param">apiKey </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The Opsgenie API authentication key for HTTP Basic authentication. </div>
    </div>  <!-- field-items -->
  </div>
+  <div class="model">
+    <h3><a name="secrets_properties_pagerduty"><code>secrets_properties_pagerduty</code> - Connector secrets properties for a PagerDuty connector</a> <a class="up" href="#__Models">Up</a></h3>
+    <div class='model-description'>Defines secrets for connectors when type is <code>.pagerduty</code>.</div>
+    <div class="field-items">
+      <div class="param">routingKey </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> A 32 character PagerDuty Integration Key for an integration on a service. </div>
+    </div>  <!-- field-items -->
+  </div>
  <div class="model">
    <h3><a name="secrets_properties_resilient"><code>secrets_properties_resilient</code> - Connector secrets properties for IBM Resilient connector</a> <a class="up" href="#__Models">Up</a></h3>
    <div class='model-description'>Defines secrets for connectors when type is <code>.resilient</code>.</div>
@ -2471,6 +2488,15 @@ Any modifications made to this file will be overwritten.
 <div class="param">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_opsgenie">secrets_properties_opsgenie</a></span>  </div>
    </div>  <!-- field-items -->
  </div>
+  <div class="model">
+    <h3><a name="update_connector_request_pagerduty"><code>update_connector_request_pagerduty</code> - Update PagerDuty connector request</a> <a class="up" href="#__Models">Up</a></h3>
+    <div class='model-description'></div>
+    <div class="field-items">
+      <div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_pagerduty">config_properties_pagerduty</a></span>  </div>
+<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The display name for the connector. </div>
+<div class="param">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_pagerduty">secrets_properties_pagerduty</a></span>  </div>
+    </div>  <!-- field-items -->
+  </div>
  <div class="model">
    <h3><a name="update_connector_request_resilient"><code>update_connector_request_resilient</code> - Update IBM Resilient connector request</a> <a class="up" href="#__Models">Up</a></h3>
    <div class='model-description'></div>
--- a/docs/management/connectors/action-types/pagerduty.asciidoc
+++ b/docs/management/connectors/action-types/pagerduty.asciidoc
@ -3,6 +3,10 @@
 ++++
 <titleabbrev>PagerDuty</titleabbrev>
 ++++
+:frontmatter-description: Add a connector that can manage PagerDuty alerts.
+:frontmatter-tags-products: [kibana] 
+:frontmatter-tags-content-type: [how-to] 
+:frontmatter-tags-user-goals: [configure]

 The PagerDuty connector uses the https://v2.developer.pagerduty.com/docs/events-api-v2[v2 Events API] to trigger, acknowledge, and resolve PagerDuty alerts.

@ -27,34 +31,6 @@ Name::      The name of the connector. The name is used to identify a  connector
 API URL::   An optional PagerDuty event URL. Defaults to `https://events.pagerduty.com/v2/enqueue`. If you are using the <<action-settings, `xpack.actions.allowedHosts`>> setting, make sure the hostname is added to the allowed hosts.
 Integration Key::   A 32 character PagerDuty Integration Key for an integration on a service, also referred to as the routing key.

-[float]
-[[preconfigured-pagerduty-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:
-
-[source,text]
--
-xpack.actions.preconfigured:
-  my-pagerduty:
-    name: preconfigured-pagerduty-connector-type
-    actionTypeId: .pagerduty
-    config:
-      apiUrl: https://test.host
-    secrets:
-      routingKey: testroutingkey
--
-
-Config defines information for the connector type.
-
-`apiURL`:: A URL string that corresponds to *API URL*.
-
-Secrets defines sensitive information for the connector type.
-
-`routingKey`:: A string that corresponds to *Integration Key*.
-
 [float]
 [[pagerduty-action-configuration]]
 === Test connectors
--- a/docs/management/connectors/pre-configured-connectors.asciidoc
+++ b/docs/management/connectors/pre-configured-connectors.asciidoc
@ -108,6 +108,7 @@ Index names must start with `kibana-alert-history-` to take advantage of the pre

 * <<preconfigured-index-configuration>>
 * <<preconfigured-opsgenie-configuration>>
+* <<preconfigured-pagerduty-configuration>>
 * <<preconfigured-server-log-configuration>>
 * <<preconfigured-webhook-configuration>>

@ -151,6 +152,26 @@ xpack.actions.preconfigured:
 <1> The {opsgenie} URL.
 <2> The {opsgenie} API authentication key for HTTP basic authentication.

+[float]
+[[preconfigured-pagerduty-configuration]]
+==== PagerDuty connectors
+
+The following example creates a <<pagerduty-action-type,PagerDuty connector>>:
+
+[source,text]
+--
+xpack.actions.preconfigured:
+  my-pagerduty:
+    name: preconfigured-pagerduty-connector-type
+    actionTypeId: .pagerduty
+    config:
+      apiUrl: https://test.host <1>
+    secrets:
+      routingKey: testroutingkey <2>
+--
+<1> The PagerDuty event URL.
+<2> A 32 character PagerDuty Integration Key for an integration on a service, also referred to as the routing key.
+
 [float]
 [[preconfigured-server-log-configuration]]
 ==== Server log connectors
--- a/docs/settings/alert-action-settings.asciidoc
+++ b/docs/settings/alert-action-settings.asciidoc
@ -260,6 +260,7 @@ A configuration URL that varies by connector:
 +
 --
 * For an <<opsgenie-action-type,{opsgenie} connector>>, specifies the {opsgenie} URL. For example, `https://api.opsgenie.com` or `https://api.eu.opsgenie.com`.
+* For a <<pagerduty-action-type,PagerDuty connector>>, specifies the PagerDuty event URL. Defaults to `https://events.pagerduty.com/v2/enqueue`.

 NOTE: If you are using the `xpack.actions.allowedHosts` setting, make sure the hostname in the URL is added to the allowed hosts.
 --
@ -285,6 +286,8 @@ An API key secret that varies by connector:
 * For an <<opsgenie-action-type,{opsgenie} connector>>, specifies the {opsgenie} API authentication key for HTTP basic authentication.
 --

+`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.

 [float]
 [[alert-settings]]
--- a/x-pack/plugins/actions/docs/openapi/bundled.json
+++ b/x-pack/plugins/actions/docs/openapi/bundled.json
@ -454,6 +454,9 @@
                  {
                    "$ref": "#/components/schemas/update_connector_request_opsgenie"
                  },
+                  {
+                    "$ref": "#/components/schemas/update_connector_request_pagerduty"
+                  },
                  {
                    "$ref": "#/components/schemas/update_connector_request_resilient"
                  },
@ -1837,13 +1840,28 @@
        "title": "Connector request properties for a PagerDuty connector",
        "description": "Defines properties for connectors when type is `.pagerduty`.",
        "type": "object",
-        "additionalProperties": true
+        "properties": {
+          "apiUrl": {
+            "description": "The PagerDuty event URL.",
+            "type": "string",
+            "nullable": true,
+            "example": "https://events.pagerduty.com/v2/enqueue"
+          }
+        }
      },
      "secrets_properties_pagerduty": {
        "title": "Connector secrets properties for a PagerDuty connector",
        "description": "Defines secrets for connectors when type is `.pagerduty`.",
        "type": "object",
-        "additionalProperties": true
+        "required": [
+          "routingKey"
+        ],
+        "properties": {
+          "routingKey": {
+            "description": "A 32 character PagerDuty Integration Key for an integration on a service.\n",
+            "type": "string"
+          }
+        }
      },
      "create_connector_request_pagerduty": {
        "title": "Create PagerDuty connector request",
@ -3712,6 +3730,27 @@
          }
        }
      },
+      "update_connector_request_pagerduty": {
+        "title": "Update PagerDuty connector request",
+        "type": "object",
+        "required": [
+          "config",
+          "name",
+          "secrets"
+        ],
+        "properties": {
+          "config": {
+            "$ref": "#/components/schemas/config_properties_pagerduty"
+          },
+          "name": {
+            "type": "string",
+            "description": "The display name for the connector."
+          },
+          "secrets": {
+            "$ref": "#/components/schemas/secrets_properties_pagerduty"
+          }
+        }
+      },
      "update_connector_request_resilient": {
        "title": "Update IBM Resilient connector request",
        "type": "object",
--- a/x-pack/plugins/actions/docs/openapi/bundled.yaml
+++ b/x-pack/plugins/actions/docs/openapi/bundled.yaml
@ -242,6 +242,7 @@ paths:
                - $ref: '#/components/schemas/update_connector_request_index'
                - $ref: '#/components/schemas/update_connector_request_jira'
                - $ref: '#/components/schemas/update_connector_request_opsgenie'
+                - $ref: '#/components/schemas/update_connector_request_pagerduty'
                - $ref: '#/components/schemas/update_connector_request_resilient'
                - $ref: '#/components/schemas/update_connector_request_serverlog'
                - $ref: '#/components/schemas/update_connector_request_servicenow'
@ -1162,12 +1163,23 @@ components:
      title: Connector request properties for a PagerDuty connector
      description: Defines properties for connectors when type is `.pagerduty`.
      type: object
-      additionalProperties: true
+      properties:
+        apiUrl:
+          description: The PagerDuty event URL.
+          type: string
+          nullable: true
+          example: https://events.pagerduty.com/v2/enqueue
    secrets_properties_pagerduty:
      title: Connector secrets properties for a PagerDuty connector
      description: Defines secrets for connectors when type is `.pagerduty`.
      type: object
-      additionalProperties: true
+      required:
+        - routingKey
+      properties:
+        routingKey:
+          description: |
+            A 32 character PagerDuty Integration Key for an integration on a service.
+          type: string
    create_connector_request_pagerduty:
      title: Create PagerDuty connector request
      description: |
@ -2553,6 +2565,21 @@ components:
          description: The display name for the connector.
        secrets:
          $ref: '#/components/schemas/secrets_properties_opsgenie'
+    update_connector_request_pagerduty:
+      title: Update PagerDuty connector request
+      type: object
+      required:
+        - config
+        - name
+        - secrets
+      properties:
+        config:
+          $ref: '#/components/schemas/config_properties_pagerduty'
+        name:
+          type: string
+          description: The display name for the connector.
+        secrets:
+          $ref: '#/components/schemas/secrets_properties_pagerduty'
    update_connector_request_resilient:
      title: Update IBM Resilient connector request
      type: object
--- a/x-pack/plugins/actions/docs/openapi/components/schemas/config_properties_pagerduty.yaml
+++ b/x-pack/plugins/actions/docs/openapi/components/schemas/config_properties_pagerduty.yaml
@ -1,5 +1,9 @@
 title: Connector request properties for a PagerDuty connector
 description: Defines properties for connectors when type is `.pagerduty`.
 type: object
-additionalProperties: true
-# TO-DO: Add the properties for this connector.
+properties:
+  apiUrl:
+    description: The PagerDuty event URL.
+    type: string
+    nullable: true
+    example: https://events.pagerduty.com/v2/enqueue
--- a/x-pack/plugins/actions/docs/openapi/components/schemas/secrets_properties_pagerduty.yaml
+++ b/x-pack/plugins/actions/docs/openapi/components/schemas/secrets_properties_pagerduty.yaml
@ -1,5 +1,10 @@
 title: Connector secrets properties for a PagerDuty connector
 description: Defines secrets for connectors when type is `.pagerduty`.
 type: object
-additionalProperties: true
-# TO-DO: Add the properties for this connector.
+required:
+  - routingKey
+properties:
+  routingKey:
+    description: >
+      A 32 character PagerDuty Integration Key for an integration on a service.
+    type: string
--- a/x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@connector@{connectorid}.yaml
+++ b/x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@connector@{connectorid}.yaml
@ -164,7 +164,7 @@ put:
            - $ref: '../components/schemas/update_connector_request_index.yaml'  
            - $ref: '../components/schemas/update_connector_request_jira.yaml'
            - $ref: '../components/schemas/update_connector_request_opsgenie.yaml'
-#            - $ref: '../components/schemas/update_connector_request_pagerduty.yaml' 
+            - $ref: '../components/schemas/update_connector_request_pagerduty.yaml' 
            - $ref: '../components/schemas/update_connector_request_resilient.yaml'
            - $ref: '../components/schemas/update_connector_request_serverlog.yaml'
            - $ref: '../components/schemas/update_connector_request_servicenow.yaml'