Skip to content

Commit

Permalink
[DOCS] Fix app labels
Browse files Browse the repository at this point in the history
  • Loading branch information
lcawl committed Nov 18, 2022
1 parent 31ca644 commit a9541c8
Show file tree
Hide file tree
Showing 44 changed files with 128 additions and 125 deletions.
19 changes: 9 additions & 10 deletions docs/api/actions-and-connectors.asciidoc
Original file line number Diff line number Diff line change
@@ -1,27 +1,26 @@
[[actions-and-connectors-api]]
== Action and connector APIs

Manage Actions and Connectors.

The following connector APIs are available:

* <<get-connector-api, Get connector API>> to retrieve a single connector by ID
* <<get-connector-api,Get connector API>> to retrieve a single connector by ID

* <<get-all-connectors-api, Get all connectors API>> to retrieve all connectors
* <<get-all-connectors-api,Get all connectors API>> to retrieve all connectors

* <<list-connector-types-api, List all connector types API>> to retrieve a list of all connector types
* <<list-connector-types-api,List all connector types API>> to retrieve a list of all connector types

* <<create-connector-api, Create connector API>> to create connectors
* <<create-connector-api,Create connector API>> to create connectors

* <<update-connector-api, Update connector API>> to update the attributes for an existing connector
* <<update-connector-api,Update connector API>> to update the attributes for an existing connector

* <<execute-connector-api, Execute connector API>> to execute a connector by ID
* <<execute-connector-api,Run connector API>> to execute a connector by ID

* <<delete-connector-api, Delete connector API>> to delete a connector by ID
* <<delete-connector-api,Delete connector API>> to delete a connector by ID

For deprecated APIs, refer to <<actions-and-connectors-legacy-apis>>.

For information about the actions and connectors that {kib} supports, refer to <<action-types,Action and connector types>>.
For information about the actions and connectors that {kib} supports, refer to
<<action-types>>.

include::actions-and-connectors/create.asciidoc[leveloffset=+1]
include::actions-and-connectors/delete.asciidoc[leveloffset=+1]
Expand Down
5 changes: 2 additions & 3 deletions docs/api/actions-and-connectors/create.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,8 @@ Creates a connector.

=== {api-prereq-title}

You must have `all` privileges for the *Actions and Connectors* feature in the
*Management* section of the
<<kibana-feature-privileges,{kib} feature privileges>>.
You must have `all` privileges for the *{connectors-feature}* feature in the
*Management* section of the <<kibana-feature-privileges,{kib} feature privileges>>.

[[create-connector-api-path-params]]
=== {api-path-parms-title}
Expand Down
2 changes: 1 addition & 1 deletion docs/api/actions-and-connectors/delete.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ WARNING: When you delete a connector, _it cannot be recovered_.
[discrete]
=== {api-prereq-title}

You must have `all` privileges for the *Actions and Connectors* feature in the
You must have `all` privileges for the *{connectors-feature}* feature in the
*Management* section of the
<<kibana-feature-privileges,{kib} feature privileges>>.

Expand Down
2 changes: 1 addition & 1 deletion docs/api/actions-and-connectors/execute.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Runs a connector by ID.
[[execute-connector-api-prereq]]
=== {api-prereq-title}

You must have `read` privileges for the *Actions and Connectors* feature in the
You must have `read` privileges for the *{connectors-feature}* feature in the
*Management* section of the
<<kibana-feature-privileges,{kib} feature privileges>>.

Expand Down
2 changes: 1 addition & 1 deletion docs/api/actions-and-connectors/get.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Retrieves a connector by ID.
[discrete]
=== {api-prereq-title}

You must have `read` privileges for the *Actions and Connectors* feature in the
You must have `read` privileges for the *{connectors-feature}* feature in the
*Management* section of the
<<kibana-feature-privileges,{kib} feature privileges>>.

Expand Down
2 changes: 1 addition & 1 deletion docs/api/actions-and-connectors/get_all.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Retrieves all connectors.
[discrete]
=== {api-prereq-title}

You must have `read` privileges for the *Actions and Connectors* feature in the
You must have `read` privileges for the *{connectors-feature}* feature in the
*Management* section of the
<<kibana-feature-privileges,{kib} feature privileges>>.

Expand Down
2 changes: 1 addition & 1 deletion docs/api/actions-and-connectors/update.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Updates the attributes for a connector.
[discrete]
=== {api-prereq-title}

You must have `all` privileges for the *Actions and Connectors* feature in the
You must have `all` privileges for the *{connectors-feature}* feature in the
*Management* section of the
<<kibana-feature-privileges,{kib} feature privileges>>.

Expand Down
2 changes: 1 addition & 1 deletion docs/api/alerting/create_rule.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ the `consumer` and `rule_type_id` of the rules you're creating. For example, the
*Management* > *Stack Rules* feature, *Analytics* > *Discover* and *{ml-app}*
features, *{observability}*, and *Security* features. If the rule has `actions`,
you must also have `read` privileges for the *Management* >
*Actions and Connectors* feature. For more details, refer to
*{connectors-feature}* feature. For more details, refer to
<<kibana-feature-privileges>>.

=== {api-description-title}
Expand Down
2 changes: 1 addition & 1 deletion docs/api/alerting/mute_alert.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ the `consumer` and `rule_type_id` of the rules you're creating. For example, the
*Management* > *Stack Rules* feature, *Analytics* > *Discover* and *{ml-app}*
features, *{observability}*, and *Security* features. If the rule has `actions`,
you must also have `read` privileges for the *Management* >
*Actions and Connectors* feature. For more details, refer to
*{connectors-feature}* feature. For more details, refer to
<<kibana-feature-privileges>>.

[[mute-alert-api-path-params]]
Expand Down
2 changes: 1 addition & 1 deletion docs/api/alerting/mute_all_alerts.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ the `consumer` and `rule_type_id` of the rules you're creating. For example, the
*Management* > *Stack Rules* feature, *Analytics* > *Discover* and *{ml-app}*
features, *{observability}*, and *Security* features. If the rule has `actions`,
you must also have `read` privileges for the *Management* >
*Actions and Connectors* feature. For more details, refer to
*{connectors-feature}* feature. For more details, refer to
<<kibana-feature-privileges>>.

=== {api-description-title}
Expand Down
2 changes: 1 addition & 1 deletion docs/api/alerting/unmute_alert.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ the `consumer` and `rule_type_id` of the rules you're creating. For example, the
*Management* > *Stack Rules* feature, *Analytics* > *Discover* and *{ml-app}*
features, *{observability}*, and *Security* features. If the rule has `actions`,
you must also have `read` privileges for the *Management* >
*Actions and Connectors* feature. For more details, refer to
*{connectors-feature}* feature. For more details, refer to
<<kibana-feature-privileges>>.

[[unmute-alert-api-path-params]]
Expand Down
2 changes: 1 addition & 1 deletion docs/api/alerting/unmute_all_alerts.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ the `consumer` and `rule_type_id` of the rules you're creating. For example, the
*Management* > *Stack Rules* feature, *Analytics* > *Discover* and *{ml-app}*
features, *{observability}*, and *Security* features. If the rule has `actions`,
you must also have `read` privileges for the *Management* >
*Actions and Connectors* feature. For more details, refer to
*{connectors-feature}* feature. For more details, refer to
<<kibana-feature-privileges>>.

=== {api-description-title}
Expand Down
2 changes: 1 addition & 1 deletion docs/api/alerting/update_rule.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ the `consumer` and `rule_type_id` of the rule you're updating. For example, the
*Management* > *Stack Rules* feature, *Analytics* > *Discover* and *{ml-app}*
features, *{observability}*, or *Security* features. If the rule has
`actions`, you must also have `read` privileges for the *Management* >
*Actions and Connectors* feature. For more details, refer to
*{connectors-feature}* feature. For more details, refer to
<<kibana-feature-privileges>>.

=== {api-description-title}
Expand Down
2 changes: 1 addition & 1 deletion docs/api/cases/cases-api-find-connectors.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ For the most up-to-date API details, refer to the

=== {api-prereq-title}

You must have `read` privileges for the *Actions and Connectors* feature in the
You must have `read` privileges for the *{connectors-feature}* feature in the
*Management* section of the
<<kibana-feature-privileges,{kib} feature privileges>>.

Expand Down
2 changes: 1 addition & 1 deletion docs/api/cases/cases-api-push.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ For the most up-to-date API details, refer to the

=== {api-prereq-title}

You must have `all` privileges for the *Actions and Connectors* feature in the
You must have `all` privileges for the *{connectors-feature}* feature in the
*Management* section of the
<<kibana-feature-privileges,{kib} feature privileges>>. You must also have `all`
privileges for the *Cases* feature in the *Management*, *{observability}*, or
Expand Down
3 changes: 2 additions & 1 deletion docs/apm/apm-alerts.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,8 @@ Click **Save**. The alert has been created and is now active!
[[apm-alert-manage]]
=== Manage alerts and rules

From the APM app, select **Alerts and rules** > **Manage rules** to be taken to the Kibana **Rules and Connectors** page.
From the APM app, select **Alerts and rules** > **Manage rules** to be taken to
the {kib} *{rules-ui}* page.
From this page, you can disable, mute, and delete APM alerts.

[float]
Expand Down
13 changes: 7 additions & 6 deletions docs/management/action-types.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ For a comparison of the Elastic subscription levels, go to
[[connector-management]]
=== Managing connectors

Rules use connectors to route actions to different destinations like log files, ticketing systems, and messaging tools. While each {kib} app can offer their own types of rules, they typically share connectors. The *Connectors* tab offers a central place to view and manage all the connectors in the current space.
Rules use connectors to route actions to different destinations like log files, ticketing systems, and messaging tools. While each {kib} app can offer their own types of rules, they typically share connectors. *{stack-manage-app} > {connectors-ui}* offers a central place to view and manage all the connectors in the current space.

[role="screenshot"]
image::images/connector-listing.png[Example connector listing in the {rules-ui} UI]
Expand All @@ -102,15 +102,16 @@ features. For more information, go to <<alerting-security>>.
[float]
=== Connector networking configuration

Use the <<action-settings, Action configuration settings>> to customize connector networking configurations, such as proxies, certificates, or TLS settings. You can set configurations that apply to all your connectors or use `xpack.actions.customHostSettings` to set per-host configurations.
Use the <<action-settings,action configuration settings>> to customize connector networking configurations, such as proxies, certificates, or TLS settings. You can set configurations that apply to all your connectors or use `xpack.actions.customHostSettings` to set per-host configurations.

[float]
[[connectors-list]]
=== Connector list

The *Connectors* tab lists all connectors in the current space. The search bar
can be used to find specific connectors by name and type. The *Type* dropdown
also enables you to filter to a subset of connector types.
In *{stack-manage-app} > {connectors-ui}*, you can find a list of the connectors
in the current space. You can use the search bar to find specific connectors by
name and type. The *Type* dropdown also enables you to filter to a subset of
connector types.

[role="screenshot"]
image::images/connector-filter-by-type.png[Filtering the connector list by types of connectors]
Expand Down Expand Up @@ -151,7 +152,7 @@ To import and export connectors, use the
image::images/connectors-import-banner.png[Connectors import banner, width=50%]

If a connector is missing sensitive information after the import, a **Fix**
button appears in *{rules-ui}*.
button appears in *{connectors-ui}*.

[role="screenshot"]
image::images/connectors-with-missing-secrets.png[Connectors with missing secrets]
Expand Down
8 changes: 4 additions & 4 deletions docs/management/cases/add-connectors.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ appropriate {kib} feature privileges. Refer to <<setup-cases>>.
[[create-case-connectors]]
== Create connectors

You can create connectors in *Management > {stack-manage-app} > {rules-ui}*, as
described in <<action-types>>. Alternatively, you can create them in
*Management > {stack-manage-app} > Cases*:
You can create connectors in *{stack-manage-app} > {connectors-ui}*,
as described in <<action-types>>. Alternatively, you can create them in
*{stack-manage-app} > Cases*:

. Click *Edit external connection*.
+
Expand All @@ -47,7 +47,7 @@ configuration details.
You can create additional connectors, update existing connectors, change
the default connector, and change case closure options.

. Go to *Management > {stack-manage-app} > Cases*, click *Edit external connection*.
. Go to *{stack-manage-app} > Cases*, click *Edit external connection*.

. To change whether cases are automatically closed after they are sent to an
external system, update the case closure options.
Expand Down
4 changes: 2 additions & 2 deletions docs/management/cases/setup-cases.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ privileges:
| Give full access to manage cases
a|
* `All` for the *Cases* feature under *Management*.
* `All` for the *Actions and Connectors* feature under *Management*.
* `All` for the *{connectors-feature}* feature under *Management*.

[NOTE]
====
The *Actions and Connectors* feature privilege is required to create, add,
The *{connectors-feature}* feature privilege is required to create, add,
delete, and modify case connectors and to send updates to external systems.
By default, `All` for the *Cases* feature includes authority to delete cases
Expand Down
2 changes: 1 addition & 1 deletion docs/management/connectors/action-types/email.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ A string that corresponds to *Client Secret*. Should be stored in the

[float]
[[define-email-ui]]
==== Define connector in Stack Management
==== Define connector in {stack-manage-app}

Define email connector properties.

Expand Down
2 changes: 1 addition & 1 deletion docs/management/connectors/action-types/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ A string that corresponds to *Execution time field*.

[float]
[[define-index-ui]]
==== Define connector in Stack Management
==== Define connector in {stack-manage-app}

Define Index connector properties.

Expand Down
4 changes: 2 additions & 2 deletions docs/management/connectors/action-types/jira.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The Jira connector uses the https://developer.atlassian.com/cloud/jira/platform/

Jira connectors have the following configuration properties.

Name:: The name of the connector. The name is used to identify a connector in the **Stack Management** UI connector listing, and in the connector list when configuring an action.
Name:: The name of the connector.
URL:: Jira instance URL.
Project key:: Jira project key.
Email:: The account email for HTTP Basic authentication.
Expand Down Expand Up @@ -54,7 +54,7 @@ Secrets defines sensitive information for the connector type.

[float]
[[define-jira-ui]]
==== Define connector in Stack Management
==== Define connector in {stack-manage-app}

Define Jira connector properties.

Expand Down
16 changes: 8 additions & 8 deletions docs/management/connectors/action-types/pagerduty.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Secrets defines sensitive information for the connector type.

[float]
[[define-pagerduty-ui]]
==== Define connector in Stack Management
==== Define connector in {stack-manage-app}

Define PagerDuty connector properties.

Expand Down Expand Up @@ -128,20 +128,20 @@ image::images/pagerduty-integration.png[PagerDuty Integrations tab]
[[pagerduty-in-elastic]]
*In Elastic*

. Create a PagerDuty Connector in Kibana. You can:
. Create a PagerDuty connector in Kibana. You can:
+
* Create a connector as part of creating an rule by selecting PagerDuty in the *Actions*
section of the rule configuration and selecting *Add new*.
* Alternatively, create a connector. To create a connector, open the main menu, click *Stack Management > Rules and Connectors*, select *Connectors*, click *Create connector*, then select the PagerDuty option.
* Alternatively, create a connector. To create a connector, go to *{stack-manage-app} > {connectors-ui}*, click *Create connector*, then select the PagerDuty option.

. Configure the connector by giving it a name and entering the Integration Key, optionally entering a custom API URL.
+
See <<pagerduty-in-pagerduty, In PagerDuty>> for how to obtain the endpoint and key information from PagerDuty and
<<pagerduty-connector-configuration, Connector configuration>> for more details.
See <<pagerduty-in-pagerduty,In PagerDuty>> for how to obtain the endpoint and key information from PagerDuty and
<<pagerduty-connector-configuration,Connector configuration>> for more details.

. Save the Connector.
. Save the connector.

. To create a rule, open the main menu, then click *Stack Management > Rules and Connectors* or the application of your choice.
. To create a rule, go to *{stack-manage-app} > {rules-ui}* or the application of your choice.

. Set up an action using your PagerDuty connector, by determining:
+
Expand All @@ -151,5 +151,5 @@ See <<pagerduty-in-pagerduty, In PagerDuty>> for how to obtain the endpoint and
Depending on your custom needs, assign them variables from the rule context.
To see the available context variables, click on the *Add variable* icon next
to each corresponding field. For more details on these parameters, see the
<<pagerduty-action-configuration, Actions Configuration>> and the PagerDuty
<<pagerduty-action-configuration,Actions configuration>> and the PagerDuty
https://v2.developer.pagerduty.com/v2/docs/send-an-event-events-api-v2[API v2 documentation].
4 changes: 2 additions & 2 deletions docs/management/connectors/action-types/resilient.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The IBM Resilient connector uses the https://developer.ibm.com/security/resilien

IBM Resilient connectors have the following configuration properties.

Name:: The name of the connector. The name is used to identify a connector in the **Stack Management** UI connector listing, and in the connector list when configuring an action.
Name:: The name of the connector.
URL:: IBM Resilient instance URL.
Organization ID:: IBM Resilient organization ID.
API key ID:: The authentication key ID for HTTP Basic authentication.
Expand Down Expand Up @@ -54,7 +54,7 @@ Secrets defines sensitive information for the connector type.

[float]
[[define-resilient-ui]]
==== Define connector in Stack Management
==== Define connector in {stack-manage-app}

Define IBM Resilient connector properties.

Expand Down
4 changes: 2 additions & 2 deletions docs/management/connectors/action-types/server-log.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This connector writes an entry to the {kib} server log.

Server log connectors have the following configuration properties.

Name:: The name of the connector. The name is used to identify a connector in the management UI connector listing, or in the connector list when configuring an action.
Name:: The name of the connector.

[float]
[[Preconfigured-server-log-configuration]]
Expand All @@ -28,7 +28,7 @@ Name:: The name of the connector. The name is used to identify a connector

[float]
[[define-serverlog-ui]]
==== Define connector in Stack Management
==== Define connector in {stack-manage-app}

Define Server log connector properties.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ include::servicenow.asciidoc[tag=servicenow-endpoint]

{sn-itom} connectors have the following configuration properties.

Name:: The name of the connector. The name is used to identify a connector in the **Stack Management** connector listing, and in the connector list when configuring an action.
Name:: The name of the connector.
Is OAuth:: The type of authentication to use.
URL:: {sn} instance URL.
Username:: Username for HTTP Basic authentication.
Expand Down Expand Up @@ -125,7 +125,7 @@ Secrets defines sensitive information for the connector type.

[float]
[[define-servicenow-itom-ui]]
=== Define connector in Stack Management
=== Define connector in {stack-manage-app}

Define {sn-itom} connector properties. Choose whether to use OAuth for authentication.

Expand Down
Loading

0 comments on commit a9541c8

Please sign in to comment.