diff --git a/deploy-manage/cloud-organization/tools-and-apis.md b/deploy-manage/cloud-organization/tools-and-apis.md index b39d9839a3..f6185f055b 100644 --- a/deploy-manage/cloud-organization/tools-and-apis.md +++ b/deploy-manage/cloud-organization/tools-and-apis.md @@ -1,45 +1,16 @@ --- mapped_pages: - https://www.elastic.co/guide/en/cloud/current/ec-work-with-apis.html +navigation_title: Tools and APIs --- -# Tools and APIs [ec-work-with-apis] +# Tools and APIs for your Cloud organization [ec-work-with-apis] -Most Elastic resources can be accessed and managed through RESTful APIs. While the {{ecloud}} API is used to manage your deployments and their components, the Elasticsearch and Kibana APIs provide direct access to your data and your visualizations, respectively. - -{{ecloud}} API -: You can use the {{ecloud}} API to manage your deployments and all of the resources associated with them. This includes performing deployment CRUD operations, scaling or autoscaling resources, and managing traffic filters, deployment extensions, remote clusters, and Elastic Stack versions. You can also access cost data by deployment and by organization. - - To learn more about the {{ecloud}} API, read through the [API overview](cloud://reference/cloud-hosted/ec-api-restful.md), try out some [getting started examples](cloud://reference/cloud-hosted/ec-api-examples.md), and check our [API reference documentation](https://www.elastic.co/docs/api/doc/cloud). - - Calls to the {{ecloud}} API are subject to [Rate limiting](cloud://reference/cloud-hosted/ec-api-rate-limiting.md). - - -Elasticsearch APIs -: This set of APIs allows you to interact directly with the Elasticsearch nodes in your deployment. You can ingest data, run search queries, check the health of your clusters, manage snapshots, and more. - - To use these APIs on {{ecloud}} read our topic [Access the API console](cloud://reference/cloud-hosted/ec-api-console.md), and to learn about all of the available endpoints check the [Elasticsearch API reference documentation](elasticsearch://reference/elasticsearch/rest-apis/index.md). - - Some [restrictions](../deploy/elastic-cloud/restrictions-known-problems.md#ec-restrictions-apis-elasticsearch) apply when using the Elasticsearch APIs on {{ecloud}}. - - -Kibana APIs -: Many Kibana features can be accessed through these APIs, including Kibana objects, patterns, and dashboards, as well as user roles and user sessions. You can use these APIs to configure alerts and actions, and to access health details for the Kibana Task Manager. - - The Kibana APIs cannot be accessed directly from the {{ecloud}} Console; you need to use `curl` or another HTTP tool to connect. Check the [Kibana API reference documentation](https://www.elastic.co/guide/en/kibana/current/api.html) to learn about using the APIs and for details about all available endpoints. - - Some [restrictions](../deploy/elastic-cloud/restrictions-known-problems.md#ec-restrictions-apis-kibana) apply when using these APIs with Kibana on {{ecloud}} as compared to an on-prem installation. - - -Other Products -: Most other Elastic products have APIs to support machine-to-machine operations. You can find the documentation for these at the following links: - - * [APM event intake API Reference](/solutions/observability/apps/elastic-apm-events-intake-api.md) - * [App Search API Reference](https://www.elastic.co/guide/en/app-search/current/api-reference.html) - * [Elastic Security APIs](https://www.elastic.co/guide/en/security/current/security-apis.html) - * [Fleet APIs](/reference/fleet/fleet-api-docs.md) - * [Logstash APIs](https://www.elastic.co/guide/en/logstash/current/monitoring-logstash.html) - * [Workplace Search API Reference](https://www.elastic.co/guide/en/workplace-search/current/workplace-search-api-overview.html) +You can use the [{{ecloud}} API](https://www.elastic.co/docs/api/doc/cloud/) to manage your {{ecloud}} organization, members, costs, billing, and more. +* Refer to [](/deploy-manage/api-keys/elastic-cloud-api-keys.md) to learn how to generate an API key to access this API. +* Refer to [{{ecloud}} RESTful API](cloud://reference/cloud-hosted/ec-api-restful.md) for usage information and examples. +For {{ecloud}} [service status](/deploy-manage/cloud-organization/service-status.md) updates, you can use the [Service Status API](https://status.elastic.co/api/). +For information about all of the tools and APIs that you can use to manage your {{ech}} deployments and {{serverless-full}} projects, refer to [](/deploy-manage/deploy/elastic-cloud/tools-apis.md). \ No newline at end of file diff --git a/deploy-manage/deploy/_snippets/cloud-api-console.md b/deploy-manage/deploy/_snippets/cloud-api-console.md new file mode 100644 index 0000000000..35ce4c9ebe --- /dev/null +++ b/deploy-manage/deploy/_snippets/cloud-api-console.md @@ -0,0 +1,9 @@ +With the {{es}} API console, you can interact with a specific {{es}} deployment directly from the {{ecloud}} Console or Cloud UI without having to authenticate again. This RESTful API access is limited to the specific cluster and works only for {{es}} API calls. + +You can find this console in the {{ecloud}} Console or Cloud UI when selecting a specific deployment to manage. From the {{es}} menu, select **API Console**. + +:::{note} +This API Console is different from the [Dev Tools Console](/explore-analyze/query-filter/tools/console.md) available in {{kib}}, from which you can call {{es}} and {{kib}} APIs. On the {{es}} API Console, you cannot run {{kib}} APIs. + +This API console is intended for admin purposes. Avoid running normal workload like indexing or search requests. +::: \ No newline at end of file diff --git a/deploy-manage/deploy/_snippets/core-apis.md b/deploy-manage/deploy/_snippets/core-apis.md new file mode 100644 index 0000000000..8ef9afbf9b --- /dev/null +++ b/deploy-manage/deploy/_snippets/core-apis.md @@ -0,0 +1,2 @@ +- [{{es}} APIs](https://www.elastic.co/docs/api/doc/elasticsearch/): This set of APIs allows you to interact directly with the {{es}} nodes in your deployment. You can ingest data, run search queries, check the health of your clusters, manage snapshots, and more. +- [{{kib}} APIs](https://www.elastic.co/docs/api/doc/kibana/): Many {{kib}} features can be accessed through these APIs, including {{kib}} objects, patterns, and dashboards, as well as user roles and user sessions. You can use these APIs to configure alerts and actions, and to access health details for the [{{kib}} Task Manager](/deploy-manage/distributed-architecture/kibana-tasks-management.md). \ No newline at end of file diff --git a/deploy-manage/deploy/_snippets/ecctl.md b/deploy-manage/deploy/_snippets/ecctl.md new file mode 100644 index 0000000000..43f2bfe62d --- /dev/null +++ b/deploy-manage/deploy/_snippets/ecctl.md @@ -0,0 +1,9 @@ +Elastic Cloud Control (ECCTL) is the command-line interface for {{ecloud}} APIs. It wraps typical operations commonly needed by operators within a single command line tool. + +ECCTL provides the following benefits: + +- Easier to use than the {{ecloud}} Console, Cloud UI, or using the RESTful API directly +- Helps you automate the deployment lifecycle +- Provides a foundation for integration with other tools + +Find more details in the [ECCTL documentation](ecctl://reference/index.md). \ No newline at end of file diff --git a/deploy-manage/deploy/_snippets/other-apis.md b/deploy-manage/deploy/_snippets/other-apis.md new file mode 100644 index 0000000000..4ed247dfe3 --- /dev/null +++ b/deploy-manage/deploy/_snippets/other-apis.md @@ -0,0 +1,5 @@ +Some other Elastic products have APIs to support machine-to-machine operations: + +* [APM event intake API](/solutions/observability/apps/elastic-apm-events-intake-api.md) +* [Fleet APIs](/reference/fleet/fleet-api-docs.md) +* [Logstash APIs](logstash://reference/monitoring-logstash.md) \ No newline at end of file diff --git a/deploy-manage/deploy/_snippets/tpec.md b/deploy-manage/deploy/_snippets/tpec.md new file mode 100644 index 0000000000..afae0c551c --- /dev/null +++ b/deploy-manage/deploy/_snippets/tpec.md @@ -0,0 +1,3 @@ +The {{ecloud}} Terraform provider allows you to provision and manage {{ech}} and {{ece}} deployments as code, and introduce DevOps-driven methodologies to manage and deploy the {{stack}} and solutions. + +To get started, see the [{{ecloud}} Terraform provider documentation](https://registry.terraform.io/providers/elastic/ec/latest/docs). \ No newline at end of file diff --git a/deploy-manage/deploy/cloud-enterprise/tools-apis.md b/deploy-manage/deploy/cloud-enterprise/tools-apis.md index 3860bb510a..e6512264e6 100644 --- a/deploy-manage/deploy/cloud-enterprise/tools-apis.md +++ b/deploy-manage/deploy/cloud-enterprise/tools-apis.md @@ -4,44 +4,63 @@ applies_to: ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-api-console.html +navigation_title: "Tools and APIs" --- -# Tools and APIs +# Tools and APIs for {{ece}} -% What needs to be done: Write from scratch +Review key resources that can be used to interact with and manage your {{ece}} installation and deployments. -% GitHub issue: https://github.com/elastic/docs-projects/issues/310 - ⚠️ **This page is a work in progress.** ⚠️ +## APIs -You can use these tools and APIs to interact with the following {{ece}} features: +You can use the following APIs in an {{ece}} environment. -* [{{ecloud}} Control (ecctl)](ecctl://reference/index.md): Wraps typical operations commonly needed by operators within a single command line tool. -* [ECE scripts](cloud://reference/cloud-enterprise/scripts.md): Use the `elastic-cloud-enterprise.sh` script to install {{ece}} or modify your installation. -* [ECE diagnostics tool](/troubleshoot/deployments/cloud-enterprise/run-ece-diagnostics-tool.md): Collect logs and metrics that you can send to Elastic Support for troubleshooting and investigation purposes. -* [Elasticsearch API console](#ece-api-console) +:::{tip} +Refer to [](/deploy-manage/api-keys.md) to learn how to generate API keys for your environment. +::: -**API** +### Orchestration APIs -% ECE API links and information are still pending -* [Elastic Cloud Enterprise RESTful API](cloud://reference/cloud-enterprise/restful-api.md) +You can use the [{{ece}} RESTful API](https://www.elastic.co/docs/api/doc/cloud-enterprise/) to manage both your {{stack}} deployments and the ECE platform. -## {{es}} API Console [ece-api-console] +Refer to [{{es}} API conventions](cloud://reference/cloud-enterprise/restful-api.md) to learn about headers and request body conventions, and view examples. -With the API console you can interact with a specific {{es}} deployment directly from the Cloud UI without having to authenticate again. This RESTful API access is limited to the specific cluster and works only for Elasticsearch API calls. +### APIs to interact with data and solution features -::::{important} -API console is intended for admin purposes. Avoid running normal workload like indexing or search requests. -:::: +The following APIs allow you to interact with your {{es}} cluster, its data, and the features available to you in your {{ece}} deployments. -You can find this console in Cloud UI when selecting a specific deployment to manage. From the {{es}} menu, select **API Console**. +:::{tip} +Refer to [{{es}} API conventions](elasticsearch://reference/elasticsearch/rest-apis/api-conventions.md) to learn about headers and request body conventions, and to view examples. +::: -:::{note} -This API Console is different from the [Dev Tools Console](/explore-analyze/query-filter/tools/console.md) available in {{kib}}, from which you can call {{es}} and {{kib}} APIs. On the ECE API Console, you cannot run Kibana APIs. +:::{include} /deploy-manage/deploy/_snippets/core-apis.md ::: -To learn more about what kinds of {{es}} API calls you can make from the Cloud UI, check the [Elasticsearch API Reference](elasticsearch://reference/elasticsearch/rest-apis/index.md) documentation. +:::{include} /deploy-manage/deploy/_snippets/other-apis.md +::: +## {{es}} API Console [ece-api-console] +:::{include} /deploy-manage/deploy/_snippets/cloud-api-console.md +::: +## Elastic Cloud Control: command-line interface for {{ecloud}} + +:::{include} /deploy-manage/deploy/_snippets/ecctl.md +::: + +## Provision hosted deployments with Terraform +```{applies_to} +deployment: + ess: ga +serverless: unavailable +``` + +:::{include} /deploy-manage/deploy/_snippets/tpec.md +::: +## Other tools +* [ECE scripts](cloud://reference/cloud-enterprise/scripts.md): Use these scripts to install {{ece}} or modify your installation. +* [ECE diagnostics tool](/troubleshoot/deployments/cloud-enterprise/run-ece-diagnostics-tool.md): Collect logs and metrics related to your ECE installation that you can send to Elastic Support for troubleshooting and investigation purposes. +* [{{es}} Support Diagnostic tool](/troubleshoot/elasticsearch/diagnostic.md): Captures a point-in-time snapshot of cluster statistics and most {{es}} settings for troubleshooting purposes. diff --git a/deploy-manage/deploy/cloud-on-k8s/kibana-instance-quickstart.md b/deploy-manage/deploy/cloud-on-k8s/kibana-instance-quickstart.md index 8e27c7a539..a90c7c5e60 100644 --- a/deploy-manage/deploy/cloud-on-k8s/kibana-instance-quickstart.md +++ b/deploy-manage/deploy/cloud-on-k8s/kibana-instance-quickstart.md @@ -66,7 +66,7 @@ To deploy a simple [{{kib}}](/get-started/the-stack.md#stack-components-kibana) ``` -For a full description of each `CustomResourceDefinition` (CRD), refer to the [*API Reference*](cloud-on-k8s://reference/api-docs.md) or view the CRD files in the [project repository](https://github.com/elastic/cloud-on-k8s/tree/2.16/config/crds). You can also retrieve information about a CRD from the instance. For example, describe the {{kib}} CRD specification with [`describe`](https://kubernetes.io/docs/reference/kubectl/generated/kubectl_describe/): +For a full description of each `CustomResourceDefinition` (CRD), refer to the [API reference](cloud-on-k8s://reference/api-docs.md) or view the CRD files in the [project repository](https://github.com/elastic/cloud-on-k8s/tree/2.16/config/crds). You can also retrieve information about a CRD from the instance. For example, describe the {{kib}} CRD specification with [`describe`](https://kubernetes.io/docs/reference/kubectl/generated/kubectl_describe/): ```sh kubectl describe crd kibana diff --git a/deploy-manage/deploy/cloud-on-k8s/tools-apis.md b/deploy-manage/deploy/cloud-on-k8s/tools-apis.md index 5140873548..e9ae578ed3 100644 --- a/deploy-manage/deploy/cloud-on-k8s/tools-apis.md +++ b/deploy-manage/deploy/cloud-on-k8s/tools-apis.md @@ -1,11 +1,41 @@ -# Tools and APIs +--- +applies_to: + deployment: + eck: all +navigation_title: "Tools and APIs" +--- -% What needs to be done: Write from scratch +# Tools and APIs for {{eck}} -% GitHub issue: https://github.com/elastic/docs-projects/issues/310 +Review key resources that can be used to interact with and manage your {{eck}} operator and deployments. -⚠️ **This page is a work in progress.** ⚠️ +## APIs -You can use these tools and APIs to interact with the following {{eck}} features: +You can use the following APIs in an {{eck}} environment. + +:::{tip} +Refer to [](/deploy-manage/api-keys.md) to learn how to generate API keys for your environment. +::: + +### Orchestration APIs + +You can use the [{{eck}} API](cloud-on-k8s://reference/api-docs.md) to create and manage {{stack}} components using Elastic-provided [Custom Resource Definitions (CRDs)](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#customresourcedefinitions). + + +### APIs to interact with data and solution features + +The following APIs allow you to interact with your {{es}} cluster, its data, and the features available to you in your {{eck}} deployments. + +:::{tip} +Refer to [{{es}} API conventions](elasticsearch://reference/elasticsearch/rest-apis/api-conventions.md) to learn about headers and request body conventions, and to view examples. +::: + +:::{include} /deploy-manage/deploy/_snippets/core-apis.md +::: + +:::{include} /deploy-manage/deploy/_snippets/other-apis.md +::: + +## Tools * [ECK diagnostics tool](/troubleshoot/deployments/cloud-on-k8s/run-eck-diagnostics.md): Use the `eck-diagnostics` command line tool to create a diagnostic archive to help troubleshoot issues with ECK. \ No newline at end of file diff --git a/deploy-manage/deploy/elastic-cloud/tools-apis.md b/deploy-manage/deploy/elastic-cloud/tools-apis.md index cc78d2786b..cea4cf3dd7 100644 --- a/deploy-manage/deploy/elastic-cloud/tools-apis.md +++ b/deploy-manage/deploy/elastic-cloud/tools-apis.md @@ -6,126 +6,98 @@ applies_to: mapped_urls: - https://www.elastic.co/guide/en/serverless/current/elasticsearch-http-apis.html - https://www.elastic.co/guide/en/tpec/current/index.html +navigation_title: "Tools and APIs" --- -# Tools and APIs +# Tools and APIs for {{ecloud}} -% What needs to be done: Write from scratch +Review key resources that can be used to interact with and manage your {{ecloud}} organization, {{ech}} deployments, and {{serverless-full}} projects. -% GitHub issue: https://github.com/elastic/docs-projects/issues/310 +## APIs -% Scope notes: elastic cloud control does this work for serverless/cloud together? +You can use the following APIs in an {{ecloud}} environment. -% Use migrated content from existing pages that map to this page: - -% - [ ] ./raw-migrated-files/docs-content/serverless/elasticsearch-http-apis.md -% - [ ] https://www.elastic.co/guide/en/tpec/current/index.html -% Notes: reference only, this page wasn't migrated, but you can pull from the live URL if needed. - -## REST APIs to orchestrate {{ecloud}} - -The following APIs allow you to manage your {{ecloud}} organization, users, security, billing and resources. - -:::::{tab-set} -:group: serverless-hosted - -::::{tab-item} {{serverless-short}} -:sync: serverless - -You can use the [{{serverless-full}} APIs](https://www.elastic.co/docs/api/doc/elastic-cloud-serverless) to manage your {{serverless-full}} projects, your organization, and its users. +:::{tip} +Refer to [](/deploy-manage/api-keys.md) to learn how to generate API keys for your environment. +::: -:::: -::::{tab-item} {{ech}} -:sync: hosted +### Orchestration APIs -You can use the [{{ecloud}} API](https://www.elastic.co/docs/api/doc/cloud/) to manage your hosted deployments and all of the resources associated with them. This includes performing deployment CRUD operations, scaling or autoscaling resources, and managing traffic filters, deployment extensions, remote clusters, and Elastic Stack versions. You can also access cost data by deployment and by organization. +The following REST APIs allow you to manage your {{ecloud}} organization, users, security, billing and resources. -:::: +| Area | API | Tasks | +| --- | --- | --- | +| {{ecloud}} organization

{{ech}} deployments | [{{ecloud}} API](https://www.elastic.co/docs/api/doc/cloud/) | Manage your Cloud organization, members, costs, billing, and more.

Manage your hosted deployments and all of the resources associated with them, including scaling or autoscaling resources, and managing traffic filters, deployment extensions, remote clusters, and {{stack}} versions.

Refer to [{{ecloud}} RESTful API](cloud://reference/cloud-hosted/ec-api-restful.md) for usage information and examples. | +| {{serverless-full}} projects | [{{serverless-full}} API](https://www.elastic.co/docs/api/doc/elastic-cloud-serverless) | Manage {{serverless-full}} projects. | +| {{ecloud}} services | [Service Status API](https://status.elastic.co/api/) | Programmatically ingest [service status](/deploy-manage/cloud-organization/service-status.md) updates. | -::::: -## REST APIs to interact with data and solution features +### APIs to interact with data and solution features -The following APIs allow you to interact with your {{es}} cluster, its data, and the features available to you in your hosted deployment or serverless project. +The following APIs allow you to interact with your {{es}} cluster, its data, and the features available to you in your {{ech}} deployments and {{serverless-full}} projects. Separate APIs are used for {{ech}} and {{serverless-full}}. Note that some [restrictions](/deploy-manage/deploy/elastic-cloud/restrictions-known-problems.md#ec-restrictions-apis-elasticsearch) apply when using the these APIs on {{ecloud}}. +:::{tip} +Refer to [{{es}} API conventions](elasticsearch://reference/elasticsearch/rest-apis/api-conventions.md) to learn about headers, request body conventions, and examples for {{es-serverless}} and {{es}} REST APIs. +::: + :::::{tab-set} :group: serverless-hosted ::::{tab-item} {{serverless-short}} :sync: serverless -**API references** - -The following APIs are available for {{es-serverless}} users. These links will take you to the autogenerated API reference documentation. - -- [Elasticsearch Serverless APIs](https://www.elastic.co/docs/api/doc/elasticsearch-serverless): Use these APIs to index, manage, search, and analyze your data in {{es-serverless}}. Learn how to [connect to your {{es-serverless}} endpoint](/solutions/search/get-started.md). +The following APIs are available for {{es-serverless}} users: - ::::{tip} +- [{{es}} {{serverless-short}} APIs](https://www.elastic.co/docs/api/doc/elasticsearch-serverless): Use these APIs to index, manage, search, and analyze your data in {{es-serverless}}. + Learn how to [connect to your {{es-serverless}} endpoint](/solutions/search/get-started.md). - :::: - -- [Kibana Serverless APIs](https://www.elastic.co/docs/api/doc/serverless): Use these APIs to manage resources such as connectors, data views, and saved objects for your {{serverless-full}} project. - - -**Additional API information** - -- [{{es}} API conventions](elasticsearch://reference/elasticsearch/rest-apis/api-conventions.md): Reference information about headers and request body conventions for {{es-serverless}} REST APIs. +- [{{kib}} {{serverless-short}} APIs](https://www.elastic.co/docs/api/doc/serverless): Use these APIs to manage resources such as connectors, data views, and saved objects for your {{serverless-full}} project. :::: ::::{tab-item} {{ech}} :sync: hosted -- [Elasticsearch APIs](https://www.elastic.co/docs/api/doc/elasticsearch/): This set of APIs allows you to interact directly with the Elasticsearch nodes in your deployment. You can ingest data, run search queries, check the health of your clusters, manage snapshots, and more. -- [Kibana APIs](https://www.elastic.co/docs/api/doc/kibana/): Many Kibana features can be accessed through these APIs, including Kibana objects, patterns, and dashboards, as well as user roles and user sessions. You can use these APIs to configure alerts and actions, and to access health details for the Kibana Task Manager. -:::: +The following APIs are available for {{ech}} users: +:::{include} /deploy-manage/deploy/_snippets/core-apis.md +::: +:::: ::::: -## {{ecloud}} API Console +#### APIs for optional products + +:::{include} /deploy-manage/deploy/_snippets/other-apis.md +::: + +## {{ecloud}} API console ```{applies_to} deployment: ess: ga serverless: unavailable ``` -For each deployment, an **API Console** page is available from the {{ecloud}} Console for you to execute queries using the available APIs. You can find this console when selecting a specific deployment to manage. From there, the API Console is available under the **{{es}}** page. - -:::{note} -This API Console is different from the [Dev Tools Console](/explore-analyze/query-filter/tools/console.md) available in each deployment, from which you can call {{es}} and {{kib}} APIs. On the {{ecloud}} API Console, you cannot run Kibana APIs. +:::{include} /deploy-manage/deploy/_snippets/cloud-api-console.md ::: -## ECCTL - Command-line interface for {{ecloud}} - -ecctl is the command-line interface for {{ecloud}} APIs. It wraps typical operations commonly needed by operators within a single command line tool. - -Benefits of ecctl: - -- Easier to use than the Cloud UI or using the RESTful API directly -- Helps you automate the deployment lifecycle -- Provides a foundation for integration with other tools - -Find more details in the [ecctl documentation](https://www.elastic.co/guide/en/ecctl/current/index.html). -## Monitor your deployments with AutoOps +## Elastic Cloud Control: command-line interface for {{ecloud}} ```{applies_to} deployment: ess: ga serverless: unavailable ``` -AutoOps significantly simplifies cluster management for your {{ech}} deployments with performance recommendations, resource utilization visibility, real-time issue detection and resolution paths. Find more details in [](/deploy-manage/monitor/autoops.md) +:::{include} /deploy-manage/deploy/_snippets/ecctl.md +::: -## Provision hosted deployments with Terraform +## Provision deployments with Terraform ```{applies_to} deployment: ess: ga serverless: unavailable ``` -The Elastic Cloud Terraform provider allows you to provision {{ech}} deployments on any Elastic Cloud platform, whether it’s {{ecloud}} or Elastic Cloud Enterprise. - -The provider lets you manage Elastic Cloud deployments as code, and introduce DevOps-driven methodologies to manage and deploy the Elastic Stack and solutions. - -To get started, see the [Elastic Cloud Terraform provider documentation](https://registry.terraform.io/providers/elastic/ec/latest/docs). +:::{include} /deploy-manage/deploy/_snippets/tpec.md +::: diff --git a/deploy-manage/deploy/self-managed/tools-apis.md b/deploy-manage/deploy/self-managed/tools-apis.md index 98b4472670..ab7fe87450 100644 --- a/deploy-manage/deploy/self-managed/tools-apis.md +++ b/deploy-manage/deploy/self-managed/tools-apis.md @@ -10,21 +10,26 @@ Review key resources that can be used to interact with and manage self-managed c ## APIs -* [{{es}} API](https://www.elastic.co/docs/api/doc/elasticsearch/): The core API for interacting with a self-managed {{es}} cluster, or any cluster running {{stack}}. Configure {{es}} functionality and settings, query your data, and more. +The following APIs allow you to interact with your {{es}} cluster and its data. - Refer to [REST APIs](elasticsearch://reference/elasticsearch/rest-apis/index.md) to learn about API conventions and view API usage examples. -* [{{kib}} API](https://www.elastic.co/docs/api/doc/kibana/): manage {{kib}} resources such as connectors, data views, and saved objects. +:::{include} /deploy-manage/deploy/_snippets/core-apis.md +::: :::{tip} -Learn how to [generate API keys for your self-managed cluster](/deploy-manage/api-keys/elasticsearch-api-keys.md). +Refer to [{{es}} API conventions](elasticsearch://reference/elasticsearch/rest-apis/api-conventions.md) to learn about headers and request body conventions, and to view examples. + +Refer to [](/deploy-manage/api-keys/elasticsearch-api-keys.md) to learn how to generate API keys for your cluster. +::: + +:::{include} /deploy-manage/deploy/_snippets/other-apis.md ::: ## Clients * [{{es}} clients](/reference/elasticsearch-clients/index.md): Interact with {{es}} programmatically to integrate {{es}} into your app or website. -## Other +## Tools * [{{es}} command line tools](elasticsearch://reference/elasticsearch/command-line-tools/index.md): Utilities for configuring security and performing other tasks from the command line. * [{{kib}} command line tools](kibana://reference/commands.md): Utilities for performing security and connectivity related tasks for {{kib}} from the command line. -* [Plugins](elasticsearch://reference/elasticsearch-plugins/index.md): Plugins extend core {{es}} functionality. Choose from an existing plugin, or [build your own](elasticsearch://extend/index.md). \ No newline at end of file +* [{{es}} Support Diagnostic tool](/troubleshoot/elasticsearch/diagnostic.md): Captures a point-in-time snapshot of cluster statistics and most {{es}} settings for troubleshooting purposes. \ No newline at end of file diff --git a/deploy-manage/distributed-architecture/kibana-tasks-management.md b/deploy-manage/distributed-architecture/kibana-tasks-management.md index ca1a9b8224..bc37ebc0cb 100644 --- a/deploy-manage/distributed-architecture/kibana-tasks-management.md +++ b/deploy-manage/distributed-architecture/kibana-tasks-management.md @@ -5,9 +5,9 @@ applies_to: stack: --- -# Kibana tasks management [task-manager-production-considerations] +# Kibana task management [task-manager-production-considerations] -{{kib}} Task Manager is leveraged by features such as Alerting, Actions, and Reporting to run mission critical work as persistent background tasks. These background tasks distribute work across multiple {{kib}} instances. This has three major benefits: +{{kib}} Task Manager is used by features such as Alerting, Actions, and Reporting to run mission critical work as persistent background tasks. These background tasks distribute work across multiple {{kib}} instances. This has three major benefits: * **Persistence**: All task state and scheduling is stored in {{es}}, so if you restart {{kib}}, tasks will pick up where they left off. * **Scaling**: Multiple {{kib}} instances can read from and update the same task queue in {{es}}, allowing the work load to be distributed across instances. If a {{kib}} instance no longer has capacity to run tasks, you can increase capacity by adding additional {{kib}} instances. For more information on scaling, see [Kibana task manager scaling considerations](../../deploy-manage/production-guidance/kibana-task-manager-scaling-considerations.md#task-manager-scaling-guidance). diff --git a/troubleshoot/elasticsearch/diagnostic.md b/troubleshoot/elasticsearch/diagnostic.md index 66bc5b8111..146c40d651 100644 --- a/troubleshoot/elasticsearch/diagnostic.md +++ b/troubleshoot/elasticsearch/diagnostic.md @@ -2,6 +2,10 @@ navigation_title: Diagnostics mapped_pages: - https://www.elastic.co/guide/en/elasticsearch/reference/current/diagnostic.html +applies_to: + deployment: + self: + ece: --- # Capture diagnostics [diagnostic]