Skip to content
Merged
Show file tree
Hide file tree
Changes from 7 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
15 changes: 10 additions & 5 deletions deploy-manage/api-keys/elasticsearch-api-keys.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Several types of {{es}} API keys exist:
* **Cross-cluster** API key: allows other clusters to connect to this cluster.
* **Managed** API key: created and managed by {{kib}} to run background tasks.

To manage API keys in {{kib}}, go to **Management > Stack Management > API Keys** from the navigation menu or use the [global search field](../../explore-analyze/find-and-organize/find-apps-and-objects.md).
To manage API keys in {{kib}}, go to the **API keys** management page in the navigation menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).

![API Keys UI](/deploy-manage/images/kibana-api-keys.png "")

Expand All @@ -42,10 +42,13 @@ Two methods are available to create an API key:

Your personal API key is created with a default expiration of 90 days from the time of creation. You can manage the key from the **API Keys** page.

* To create a personal or cross-cluster API key with configurable options, go to **Management > Stack Management > API Keys** from the navigation menu or use the [global search field](../../explore-analyze/find-and-organize/find-apps-and-objects.md), and select **Create API key**.
* To create a personal or cross-cluster API key with configurable options:
1. Go to the **API keys** management page in the navigation menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
2. Select **Create API key**.

![Create API Key UI](/deploy-manage/images/kibana-create-user-api-key.png "")
![Create API Key UI](/deploy-manage/images/kibana-create-user-api-key.png "")

From the **Create API key** pane, you can configure your new key:
1. Choose to create either a user or a cross-cluster API key.
2. Optionally, set an expiry date. By default the API key will not expire, but it's a good security practice to give the key a limited lifespan.
3. Configure access:
Expand All @@ -55,7 +58,9 @@ Two methods are available to create an API key:

## Update an API key [update-api-key]

To update an API key, go to **Management > Stack Management > API Keys** from the navigation menu or use the [global search field](../../explore-analyze/find-and-organize/find-apps-and-objects.md), and then click on the name of the key. You cannot update the name or the type of an API key.
To update an API key, go to the **API keys** management page in the navigation menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md). From the **API keys** page, click on the name of the key you want to update.

You can't update the name or the type of an API key.

* For a user API key, you can update:
* The API key's access to {{es}} APIs and resources.
Expand All @@ -71,7 +76,7 @@ To update an API key, go to **Management > Stack Management > API Keys** from th

## View and delete API keys [view-api-keys]

The **API Keys** feature in {{kib}} lists your API keys, including the name, date created, and status. If an API key expires, its status changes from `Active` to `Expired`.
The **API Keys** management page in {{kib}} lists your API keys, including the name, date created, and status. If an API key expires, its status changes from `Active` to `Expired`.

If you have `manage_security` or `manage_api_key` permissions, you can view the API keys of all users, and see which API key was created by which user in which realm. If you have only the `manage_own_api_key` permission, you see only a list of your own keys.

Expand Down
4 changes: 3 additions & 1 deletion deploy-manage/kibana-reporting-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,9 @@ When security is enabled, you grant users access to {{report-features}} with [{{
4. Click **Update user**.


Granting the privilege to generate reports also grants the user the privilege to view their reports in **Stack Management > Reporting**. Users can only access their own reports.
Granting the privilege to generate reports also grants the user the privilege to view their reports in **Reporting**. Users can only access their own reports.

To view reports, go to the **Reporting** management page in the navigation menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).


::::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,5 +36,5 @@ If your license expires, your subscription level reverts to Basic and you will n

Licenses are provided as a *JSON* file and have an effective date and an expiration date. You cannot install a new license before its effective date. License updates take effect immediately and do not require restarting {{es}}.

You can update your license from **Stack Management > License Management** or through the [update license API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-post).
To update your license from {{kib}}, go to the **License Management** management page using the navigation menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md). You can also use the [update license API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-post).

6 changes: 4 additions & 2 deletions deploy-manage/manage-connectors.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@ products:

# Connectors [connector-management]

Connectors serve as a central place to store connection information for both Elastic and third-party systems. They enable the linking of actions to rules, which execute as background tasks on the {{kib}} server when rule conditions are met. This allows rules to route actions to various destinations such as log files, ticketing systems, and messaging tools. Different {{kib}} apps may have their own rule types, but they typically share connectors. The **{{stack-manage-app}} > {{connectors-ui}}** provides a central location to view and manage all connectors in the current space.
Connectors serve as a central place to store connection information for both Elastic and third-party systems. They enable the linking of actions to rules, which execute as background tasks on the {{kib}} server when rule conditions are met. This allows rules to route actions to various destinations such as log files, ticketing systems, and messaging tools. Different {{kib}} apps may have their own rule types, but they typically share connectors. The **{{connectors-ui}}** provides a central location to view and manage all connectors in the current space.

You can find the **{{connectors-ui}}** management page in the navigation menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).

::::{note}
This page is about {{kib}} connectors that integrate with services like generative AI model providers. If you’re looking for content connectors that synchronize third-party data into {{es}}, refer to [Connector clients](elasticsearch://reference/search-connectors/index.md).
Expand All @@ -33,7 +35,7 @@ If you're using {{stack}}, use the [action configuration settings](kibana://refe

## Connector list [connectors-list]

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.
In **{{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} /deploy-manage/images/kibana-connector-filter-by-type.png
:alt: Filtering the connector list by types of connectors
Expand Down
6 changes: 4 additions & 2 deletions deploy-manage/manage-spaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ products:
:screenshot:
:::

To go to **Spaces**, find **Stack Management** in the navigation menu or use the [global search bar](/explore-analyze/find-and-organize/find-apps-and-objects.md).
You can find the **Spaces** management page in the navigation menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).

For more info on working with spaces, check out:
- [Create a space](#spaces-managing)
Expand Down Expand Up @@ -127,7 +127,9 @@ serverless: unavailable

You can create a custom experience for users by configuring the {{kib}} landing page on a per-space basis. The landing page can route users to a specific dashboard, application, or saved object as they enter each space.

To configure the landing page, use the default route setting in [Stack Management > {{kib}} > Advanced settings](kibana://reference/advanced-settings.md#kibana-general-settings). For example, you might set the default route to `/app/dashboards`.
To configure the landing page, use the default route setting in the [{{kib}} advanced settings](kibana://reference/advanced-settings.md#kibana-general-settings). For example, you might set the default route to `/app/dashboards`.

You can access the **Advanced Settings** management page in the navigation menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).

:::{image} /deploy-manage/images/kibana-spaces-configure-landing-page.png
:alt: Configure space-level landing page
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -122,9 +122,10 @@ Depending on your selected installation method, you may have to provide the foll
With this authentication method, you need to create an API key to grant access to your cluster. Complete the following steps:

1. From your {{ecloud}} home page, select a deployment.
2. Go to **Stack management** > **API keys** and select **Create API key**.
3. In the flyout, enter a name for your key and select **User API key**.
4. Enable **Control security privileges** and enter the following script:
2. Go to the **API keys** management page in the navigation menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
3. Select **Create API key**.
4. In the flyout, enter a name for your key and select **User API key**.
5. Enable **Control security privileges** and enter the following script:
```json
{
"autoops": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,9 @@ metrics-elasticsearch.stack_monitoring.shard

To change the settings of each data stream, edit the `metrics-{{product}}.stack_monitoring.{{dataset}}@custom` component template that already exists. You can do this in {{kib}}:

* Navigate to **Stack Management** > **Index Management** > **Component Templates**.

* Go to the **Index Management** management page in the navigation menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
* Select **Component Templates**.
* Search for the component template.
* Select the **Edit** action.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,8 @@ You need to repeat this procedure when upgrading the {{stack}} to get the latest

You can clone index templates in {{kib}}:

* Navigate to **Stack Management** > **Index Management** > **Index Templates**.
* go to the **Index Management** management page in the navigation menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
* Select **Index Templates**,
* From the **View** dropdown, select **System templates**.
* Search for the index template.
* Select the **Clone** action.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,11 @@ When monitoring [using {{metricbeat}} 7](../stack-monitoring/collecting-monitori
* `.monitoring-{{product}}-7-mb-{{date}}`, when using {{metricbeat}} 7.
* `.monitoring-{{product}}-7-{{date}}`, when using internal collection.

The settings and mappings for these indices are determined by [legacy index templates](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-template) named `.monitoring-{{product}}`. You can retrieve these templates in {{kib}} by navigating to **Stack Management** > **Index Management** > **Index Templates**, or by using the {{es}} `_template` API:
The settings and mappings for these indices are determined by [legacy index templates](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-template) named `.monitoring-{{product}}`.

You can retrieve these templates in {{kib}}. To manage index templates, go to the **Index Management** management page in the navigation menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md), and then select **Index Templates**,

You can also use the {{es}} `_template` API:

```console
GET /_template/.monitoring-*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Some action types are subscription features, while others are free. For a compar
To review and modify existing **{{stack-monitor-app}}** rules, click **Enter setup mode** on the **Cluster overview** page. Cards with alerts configured are annotated with an indicator.

:::{tip}
Alternatively, to manage all rules, including create and delete functionality go to **{{stack-manage-app}} > {{rules-ui}}**.
Alternatively, to manage all rules, including create and delete functionality, find the **{{rules-ui}}** management page in the navigation menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
:::

1. On any card showing available alerts, select the **alerts** indicator. Use the menu to select the type of alert for which you’d like to be notified.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Logs and metrics that get sent to a dedicated monitoring {{es}} deployment [may

## Retention of logging and monitoring indices [logging-and-monitoring-retention]

When sending monitoring and logging data to a deployment, an ILM policy is pre-configured to control data retention. To view or edit the policies, open {{kib}} **Stack management > Data > Index Lifecycle Policies**.
When sending monitoring and logging data to a deployment, an ILM policy is pre-configured to control data retention. To view or edit the policies, Go to the **Index Lifecycle Policiess** management page in the navigation menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).

For monitoring indices, the retention period is configured in the `.monitoring-8-ilm-policy` index lifecycle policy.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ By default, {{kib}} polls for tasks at a rate of 10 tasks every 500 milliseconds

- As of v8.15 a new task claim strategy was introduced: `mget`. And as of v8.18, `mget` has been made the default strategy -as part of some performance improvement efforts-, with a default polling interval of 500 milliseconds. Since these changes offers a better task execution performance, It is highly recommended you to upgrade to v8.18.

- Maximum number of concurrent tasks can be changed by using `xpack.task_manager.capacity`, The default value is 10, the minimum and maximum values ​​are 5 and 50 respectively.
- Maximum number of concurrent tasks can be changed by using `xpack.task_manager.capacity`, The default value is 10, the minimum and maximum values are 5 and 50 respectively.

In practice, a {{kib}} instance will only achieve the upper bound of `1200/tpm` if the duration of task execution is below the polling rate of 500 milliseconds. But for the most part, the duration of tasks is above that threshold, it can vary greatly as {{es}} and {{kib}} usage grow and task complexity increases (such as alerts executing heavy queries across large datasets). Therefore you should find your the average execution time of your tasks to estimate the number of {{kib}} instances you need.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ With this method, you can only remove trusted environments relying exclusively o
:alt: button for deleting a trusted environment
:::

4. In {{kib}}, go to **Stack Management** > **Remote Clusters**.
5. In the list of existing remote clusters, delete the ones corresponding to the trusted environment you removed earlier.
1. Go to the **Remote Clusters** management page in the navigation menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
2. In the list of existing remote clusters, delete the ones corresponding to the trusted environment you removed earlier.


## Update a certificate-based trusted environment [ec_update_a_certificate_based_trusted_environment]
Expand Down
3 changes: 2 additions & 1 deletion deploy-manage/remote-clusters/ec-remote-cluster-ece.md
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,8 @@ On the local cluster, add the remote cluster using {{kib}} or the {{es}} API.

### Using {{kib}} [ec_using_kibana_3]

1. Open the {{kib}} main menu, and select **Stack Management > Data > Remote Clusters > Add a remote cluster**.
1. Go to the **Remote Clusters** management page in the navigation menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
2. Select **Add a remote cluster**.
2. Enable **Manually enter proxy address and server name**.
3. Fill in the following fields:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,8 @@ On the local cluster, add the remote cluster using {{kib}} or the {{es}} API.

### Using {{kib}} [ec_using_kibana_2]

1. Open the {{kib}} main menu, and select **Stack Management > Data > Remote Clusters > Add a remote cluster**.
1. Go to the **Remote Clusters** management page in the navigation menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
2. Select **Add a remote cluster**.
2. Enable **Manually enter proxy address and server name**.
3. Fill in the following fields:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,8 @@ On the local cluster, add the remote cluster using {{kib}} or the {{es}} API.

### Using {{kib}} [ec_using_kibana]

1. Open the {{kib}} main menu, and select **Stack Management > Data > Remote Clusters > Add a remote cluster**.
1. Go to the **Remote Clusters** management page in the navigation menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
2. Select **Add a remote cluster**.
2. Enable **Manually enter proxy address and server name**.
3. Fill in the following fields:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,8 @@ On the local cluster, add the remote cluster using {{kib}} or the {{es}} API.

### Using {{kib}} [ec_using_kibana_4]

1. Open the {{kib}} main menu, and select **Stack Management > Data > Remote Clusters > Add a remote cluster**.
1. Go to the **Remote Clusters** management page in the navigation menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
2. Select **Add a remote cluster**.
2. Enable **Manually enter proxy address and server name**.
3. Fill in the following fields:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ With this method, you can only remove trusted environments relying exclusively o
:alt: button for deleting a trusted environment
:::

4. In {{kib}}, go to **Stack Management** > **Remote Clusters**.
5. In the list of existing remote clusters, delete the ones corresponding to the trusted environment you removed earlier.
1. Go to the **Remote Clusters** management page in the navigation menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
2. In the list of existing remote clusters, delete the ones corresponding to the trusted environment you removed earlier.


## Update a certificate-based trusted environment [ece_update_a_certificate_based_trusted_environment]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,8 @@ On the local cluster, add the remote cluster using {{kib}} or the {{es}} API.

### Using {{kib}} [ece_using_kibana_3]

1. Open the {{kib}} main menu, and select **Stack Management > Data > Remote Clusters > Add a remote cluster**.
1. Go to the **Remote Clusters** management page in the navigation menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
2. Select **Add a remote cluster**.
2. Enable **Manually enter proxy address and server name**.
3. Fill in the following fields:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,8 @@ On the local cluster, add the remote cluster using {{kib}} or the {{es}} API.

### Using {{kib}} [ece_using_kibana_2]

1. Open the {{kib}} main menu, and select **Stack Management > Data > Remote Clusters > Add a remote cluster**.
1. Go to the **Remote Clusters** management page in the navigation menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
2. Select **Add a remote cluster**.
2. Enable **Manually enter proxy address and server name**.
3. Fill in the following fields:

Expand Down
Loading
Loading