Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
438 changes: 1 addition & 437 deletions docs/docset.yml

Large diffs are not rendered by default.

File renamed without changes
File renamed without changes
8 changes: 4 additions & 4 deletions docs/extend/interpreting-ci-failures.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Clicking the link next to the check in the conversation tab of a pull request wi

To view the results of a job execution in Buildkite, either click the link in the comment left by `@elasticmachine` or search for the `kibana-ci` check in the list at the bottom of the PR. This link will take you to the top-level page for the specific job execution that failed.

:::{image} ../images/job_view.png
:::{image} images/job_view.png
:alt: Buildkite pipeline view showing a few test failures
:::

Expand All @@ -34,7 +34,7 @@ To view the results of a job execution in Buildkite, either click the link in th

The logs in Pipeline Steps contain `Info` level logging. To debug Functional UI tests it’s usually helpful to see the debug logging. You can go to the test failure details by clicking on the **logs** (1).

:::{image} ../images/test_results.png
:::{image} images/test_results.png
:alt: Buildkite build screenshot
:::

Expand Down Expand Up @@ -69,13 +69,13 @@ Just above the `✖ fail:` line, there is a line `info Taking screenshot ...` wh

Clicking the `[Download]` link for that png shows this image:

:::{image} ../images/a11y_screenshot.png
:::{image} images/a11y_screenshot.png
:alt: Kibana spaces page meets a11y validations a11y test for click on create space page.png
:::

If we use a running Kibana instance and inspect elements, we find that the `createSpace` data-test-subj attribute is on this button in the Spaces page in Stack Management:

:::{image} ../images/inspect_element.png
:::{image} images/inspect_element.png
:alt: Kibana screenshot of Spaces page with developer tools open
:::

Expand Down
4 changes: 2 additions & 2 deletions docs/extend/kibana-debugging.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ With an application as varied and complex as Kibana has become, it’s not pract

For example, say you implement a brand new feature, plugin or service but don’t quite know how it will impact Kibana’s performance as a whole. APM allows us to not only spot that something is slow, but also hints at why it might be performing slowly. For example, if a function is slow on specific types of inputs, we can see where the time is spent by viewing the trace for that function call in the APM UI.

:::{image} ../images/apm_example_trace.png
:::{image} images/apm_example_trace.png
:alt: apm example trace
:::

Expand Down Expand Up @@ -103,7 +103,7 @@ The easiest and recommended way of running Kibana with the APM agent locally is

9. After Kibana starts up, navigate to the APM app, where you should see some transactions.

:::{image} ../images/apm_ui_transactions.png
:::{image} images/apm_ui_transactions.png
:alt: apm ui transactions
:::

Expand Down
2 changes: 1 addition & 1 deletion docs/extend/kibana-expressions-plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ filters
[/source]
```

:::{image} ../images/expressions_plugin.png
:::{image} images/expressions_plugin.png
:alt: Rendered metric
:class: screenshot
:::
Expand Down
2 changes: 1 addition & 1 deletion docs/extend/kibana-navigation.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ You’d notice that you were navigated to **Dashboard** app with the **same stat

Historically {{kib}} Analyze groups apps achieve that behavior relying on state in the URL. If you’d have a closer look on a link in the navigation, you’d notice that state is stored inside that link, and it also gets updated whenever relevant state changes happen:

![State is stored inside the navigation link](../images/state_inside_the_link.png "")
![State is stored inside the navigation link](images/state_inside_the_link.png "")

This is where [separation](#query-params) into `_a` and `_g` query params comes into play. What is considered a **global** state gets constantly updated in those navigation links. In the example above it was a time filter. This is backed by [KbnUrlTracker](https://github.com/elastic/kibana/tree/master/src/platform/plugins/shared/kibana_utils/public/state_management/url/kbn_url_tracker.ts#L57) util. You can use it to achieve similar behavior.

Expand Down
34 changes: 17 additions & 17 deletions docs/extend/sharing-saved-objects.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ From 8.7.0, as a step towards *zero downtime upgrades*, plugins are no longer al

[Saved objects](/extend/saved-objects-service.md) (hereinafter "objects") are used to store all sorts of things in {{kib}}, from Dashboards to Index Patterns to Machine Learning Jobs. The effort to make objects shareable can be summarized in a single picture:

:::{image} ../images/sharing-saved-objects-overview.png
:::{image} images/sharing-saved-objects-overview.png
:alt: Sharing Saved Objects overview
:::

Expand Down Expand Up @@ -57,7 +57,7 @@ External plugins can also convert their objects, but [they don’t have to do so

If you’re still reading this page, you’re probably developing a {{kib}} plugin that registers an object type, and you want to know what steps you need to take to prepare for the 8.0 release and mitigate any breaking changes! Depending on how you are using saved objects, you may need to take up to 5 steps, which are detailed in separate sections below. Refer to this flowchart:

:::{image} ../images/sharing-saved-objects-phase-1-dev-flowchart.png
:::{image} images/sharing-saved-objects-phase-1-dev-flowchart.png
:alt: Sharing Saved Objects phase 1 - developer flowchart
:::

Expand All @@ -81,7 +81,7 @@ If you answered "Yes" to [Question 1](#sharing-saved-objects-q1), you need to ma

The image below shows two different examples of object links from a "case" object to an "action" object. The top shows the incorrect way to link to another object, and the bottom shows the correct way.

:::{image} ../images/sharing-saved-objects-step-1.png
:::{image} images/sharing-saved-objects-step-1.png
:alt: Sharing Saved Objects step 1
:::

Expand Down Expand Up @@ -124,7 +124,7 @@ Reminder, don’t forget to add unit tests and integration tests!
[TBC: QUOTE]
A deep link is a URL to a page that shows a specific object. End-users may bookmark these URLs or schedule reports with them, so it is critical to ensure that these URLs continue working. The image below shows an example of a deep link to a Canvas workpad object:

:::{image} ../images/sharing-saved-objects-q2.png
:::{image} images/sharing-saved-objects-q2.png
:alt: Sharing Saved Objects deep link example
:::

Expand Down Expand Up @@ -180,7 +180,7 @@ The Spaces plugin API exposes React components and functions that you should use

Your page should change [according to the outcome](#sharing-saved-objects-faq-resolve-outcomes):

:::{image} ../images/sharing-saved-objects-step-3.png
:::{image} images/sharing-saved-objects-step-3.png
:alt: Sharing Saved Objects resolve outcomes overview
:::

Expand Down Expand Up @@ -309,7 +309,7 @@ The previous steps can be backported to the 7.x branch, but this step — th

When you register your object, you need to change the `namespaceType` and also add a `convertToMultiNamespaceTypeVersion` field. This special field will trigger the actual conversion that will take place during the Core migration upgrade process when a user installs the Kibana 8.0 release:

:::{image} ../images/sharing-saved-objects-step-4.png
:::{image} images/sharing-saved-objects-step-4.png
:alt: Sharing Saved Objects conversion code
:::

Expand Down Expand Up @@ -339,7 +339,7 @@ If you answered "Yes" to [Question 3](#sharing-saved-objects-q3), you need to ta

To mitigate this, you need to add a "no-op" ESO migration that will be applied immediately after the object is converted during the 8.0 upgrade process. This will decrypt the object using its old ID and then re-encrypt it using its new ID:

:::{image} ../images/sharing-saved-objects-step-5.png
:::{image} images/sharing-saved-objects-step-5.png
:alt: Sharing Saved Objects ESO migration
:::

Expand All @@ -354,7 +354,7 @@ Reminder, don’t forget to add unit tests and integration tests!

This section covers switching a share-capable object type into a shareable one *or* creating a new shareable saved object type. Refer to this flowchart:

:::{image} ../images/sharing-saved-objects-phase-2-dev-flowchart.png
:::{image} images/sharing-saved-objects-phase-2-dev-flowchart.png
:alt: Sharing Saved Objects phase 2 - developer flowchart
:::

Expand All @@ -363,7 +363,7 @@ This section covers switching a share-capable object type into a shareable one *
[TBC: QUOTE]
When you register your object, you need to set the proper `namespaceType`. If you have an existing object type that is "share-capable", you can simply change it:

:::{image} ../images/sharing-saved-objects-step-6.png
:::{image} images/sharing-saved-objects-step-6.png
:alt: Sharing Saved Objects registration (shareable)
:::

Expand All @@ -388,7 +388,7 @@ const warningMessage =

The [Data Views page](docs-content://explore-analyze/find-and-organize/data-views.md) in [Stack Management](docs-content://deploy-manage/index.md) uses a [similar approach](https://github.com/elastic/kibana/blob/master/src/platform/plugins/shared/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx) to show a warning in its delete confirmation modal:

:::{image} ../images/sharing-saved-objects-step-7.png
:::{image} images/sharing-saved-objects-step-7.png
:alt: Sharing Saved Objects deletion warning
:::

Expand Down Expand Up @@ -490,13 +490,13 @@ A developer can easily flip a switch to make a share-capable object into a share

This is because of how isolated objects are serialized to raw Elasticsearch documents. Each raw document ID today contains its space ID (*namespace*) as a prefix. When objects are copied or imported to other spaces, they keep the same object ID, they just have a different prefix when they are serialized to Elasticsearch. This has resulted in a situation where many Kibana installations have saved objects in different spaces with the same object ID:

:::{image} ../images/sharing-saved-objects-faq-changing-object-ids-1.png
:::{image} images/sharing-saved-objects-faq-changing-object-ids-1.png
:alt: Sharing Saved Objects object ID diagram (before conversion)
:::

Once an object is converted, we need to remove this prefix. Because of limitations with our migration process, we cannot actively check if this would result in a conflict. Therefore, we decided to pre-emptively regenerate the object ID for every object in a non-Default space to ensure that every object ID becomes globally unique:

:::{image} ../images/sharing-saved-objects-faq-changing-object-ids-2.png
:::{image} images/sharing-saved-objects-faq-changing-object-ids-2.png
:alt: Sharing Saved Objects object ID diagram (after conversion)
:::

Expand All @@ -510,13 +510,13 @@ As mentioned in [Question 2](#sharing-saved-objects-q2), some URLs may contain m

* Embeddables should use `spacesApi.ui.components.getEmbeddableLegacyUrlConflict` to render conflict errors:

:::{image} ../images/sharing-saved-objects-faq-multiple-deep-link-objects-1.png
:::{image} images/sharing-saved-objects-faq-multiple-deep-link-objects-1.png
:alt: Sharing Saved Objects embeddable legacy URL conflict
:::

Viewing details shows the user how to disable the alias and fix the problem using the [_disable_legacy_url_aliases API](https://www.elastic.co/docs/api/doc/kibana/v8/group/endpoint-spaces):

:::{image} ../images/sharing-saved-objects-faq-multiple-deep-link-objects-2.png
:::{image} images/sharing-saved-objects-faq-multiple-deep-link-objects-2.png
:alt: Sharing Saved Objects embeddable legacy URL conflict (showing details)
:::

Expand Down Expand Up @@ -545,7 +545,7 @@ The `resolve()` function checks both if an object with the given ID exists, *and

When you resolve an object with its current ID, the outcome is an `'exactMatch'`:

:::{image} ../images/sharing-saved-objects-faq-resolve-outcomes-1.png
:::{image} images/sharing-saved-objects-faq-resolve-outcomes-1.png
:alt: Sharing Saved Objects resolve outcome 1 (exactMatch)
:::

Expand All @@ -555,7 +555,7 @@ This can happen in the Default space *and* in non-Default spaces.

When you resolve an object with its old ID (the ID of its alias), the outcome is an `'aliasMatch'`:

:::{image} ../images/sharing-saved-objects-faq-resolve-outcomes-2.png
:::{image} images/sharing-saved-objects-faq-resolve-outcomes-2.png
:alt: Sharing Saved Objects resolve outcome 2 (aliasMatch)
:::

Expand All @@ -565,7 +565,7 @@ This outcome can only happen in non-Default spaces.

The third outcome is an edge case that is a combination of the others. If you resolve an object ID and two objects are found — one as an exact match, the other as an alias match — the outcome is a `'conflict'`:

:::{image} ../images/sharing-saved-objects-faq-resolve-outcomes-3.png
:::{image} images/sharing-saved-objects-faq-resolve-outcomes-3.png
:alt: Sharing Saved Objects resolve outcome 3 (conflict)
:::

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/advanced-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The `Advanced Settings` {{kib}} privilege is required to access **Advanced Setti

When you have insufficient privileges to edit advanced settings, the edit options are not visible, and the following indicator is displayed:

:::{image} ../images/settings-read-only-badge.png
:::{image} images/settings-read-only-badge.png
:alt: Example of Advanced Settings Management's read only access indicator in Kibana's header
:class: screenshot
:::
Expand Down
12 changes: 6 additions & 6 deletions docs/reference/connectors-kibana.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Some connector types are paid commercial features, while others are free. For a

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.

:::{image} ../images/connector-listing.png
:::{image} images/connector-listing.png
:alt: Example connector listing in the {{rules-ui}} UI
:class: screenshot
:::
Expand All @@ -66,14 +66,14 @@ Use the [action configuration settings](/reference/configuration-reference/alert

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.

:::{image} ../images/connector-filter-by-type.png
:::{image} images/connector-filter-by-type.png
:alt: Filtering the connector list by types of connectors
:class: screenshot
:::

You can delete individual connectors using the trash icon. Alternatively, select multiple connectors and delete them in bulk using the **Delete** button.

:::{image} ../images/connector-delete.png
:::{image} images/connector-delete.png
:alt: Deleting connectors individually or in bulk
:class: screenshot
:::
Expand All @@ -89,7 +89,7 @@ You can delete a connector even if there are still actions referencing it. When

New connectors can be created with the **Create connector** button, which guides you to select the type of connector and configure its properties.

:::{image} ../images/connector-select-type.png
:::{image} images/connector-select-type.png
:alt: Connector select type
:class: screenshot
:::
Expand All @@ -108,14 +108,14 @@ You can also manage connectors as resources with the [Elasticstack provider](htt

To import and export connectors, use the [Saved Objects Management UI](docs-content://explore-analyze/find-and-organize/saved-objects.md).

:::{image} ../images/connectors-import-banner.png
:::{image} images/connectors-import-banner.png
:alt: Connectors import banner
:class: screenshot
:::

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

:::{image} ../images/connectors-with-missing-secrets.png
:::{image} images/connectors-with-missing-secrets.png
:alt: Connectors with missing secrets
:class: screenshot
:::
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/connectors-kibana/bedrock-action-type.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The {{bedrock}} connector uses [axios](https://github.com/axios/axios) to send a

You can create connectors in **{{stack-manage-app}} > {{connectors-ui}}**. For example:

:::{image} ../../images/bedrock-connector.png
:::{image} ../images/bedrock-connector.png
:alt: {{bedrock}} connector
:class: screenshot
:::
Expand Down Expand Up @@ -44,7 +44,7 @@ Secret

You can test connectors as you’re creating or editing the connector in {{kib}}. For example:

:::{image} ../../images/bedrock-params.png
:::{image} ../images/bedrock-params.png
:alt: {{bedrock}} params test
:class: screenshot
:::
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/connectors-kibana/cases-action-type.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ To use this connector you must have `All` {{kib}} privileges for the **Cases** f

You cannot manage this connector in **{{stack-manage-app}} > {{connectors-ui}}** or by using APIs. You also cannot create a Cases [preconfigured connector](/reference/connectors-kibana/pre-configured-connectors.md). It is available only when you’re creating a rule in {{kib}}. For example:

:::{image} ../../images/cases-action.png
:::{image} ../images/cases-action.png
:alt: Add a cases action while creating a rule in {{kib}} {{rules-ui}}
:class: screenshot
:::
Expand Down
10 changes: 5 additions & 5 deletions docs/reference/connectors-kibana/cases-webhook-action-type.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,28 +14,28 @@ The {{webhook-cm}} connector uses [axios](https://github.com/axios/axios) to sen

You can create connectors in **{{stack-manage-app}} > {{connectors-ui}}** or as needed when you’re creating a rule. In the first step, you must provide a name for the connector and its authentication details. For example:

:::{image} ../../images/cases-webhook-connector.png
:::{image} ../images/cases-webhook-connector.png
:alt: Set authentication details in the {{webhook-cm}} connector
:class: screenshot
:::

In the second step, you must provide the information necessary to create cases in the external system. For example:

:::{image} ../../images/cases-webhook-connector-create-case.png
:::{image} ../images/cases-webhook-connector-create-case.png
:alt: Add case creation details in the {{webhook-cm}} connector
:class: screenshot
:::

In the third step, you must provide information related to retrieving case details from the external system. For example:

:::{image} ../../images/cases-webhook-connector-get-case.png
:::{image} ../images/cases-webhook-connector-get-case.png
:alt: Add case retrieval details in the {{webhook-cm}} connector
:class: screenshot
:::

In the fourth step, you must provide information necessary to update cases in the external system. You can also optionally provide information to add comments to cases. For example:

:::{image} ../../images/cases-webhook-connector-comments.png
:::{image} ../images/cases-webhook-connector-comments.png
:alt: Add case update and comment details in the {{webhook-cm}} connector
:class: screenshot
:::
Expand Down Expand Up @@ -168,7 +168,7 @@ Update case URL

You can test connectors as you’re creating or editing the connector in {{kib}}. For example:

:::{image} ../../images/cases-webhook-test.png
:::{image} ../images/cases-webhook-test.png
:alt: {{webhook-cm}} params test
:class: screenshot
:::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ To use this connector, you must have authority to run {{endpoint-sec}} connector

You can create connectors in **{{stack-manage-app}} > {{connectors-ui}}**. For example:

:::{image} ../../images/crowdstrike-connector.png
:::{image} ../images/crowdstrike-connector.png
:alt: CrowdStrike connector
:class: screenshot
:::
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/connectors-kibana/d3security-action-type.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ To create this connector, you must first configure a webhook key in your D3 SOAR

You can create connectors in **{{stack-manage-app}} > {{connectors-ui}}**. For example:

:::{image} ../../images/d3security-connector.png
:::{image} ../images/d3security-connector.png
:alt: D3 Security connector
:class: screenshot
:::
Expand All @@ -40,7 +40,7 @@ Token

You can test connectors as you’re creating or editing the connector in {{kib}}. For example:

:::{image} ../../images/d3security-params-test.png
:::{image} ../images/d3security-params-test.png
:alt: D3 Security params test
:class: screenshot
:::
Expand Down
Loading