Skip to content

Commit ef950de

Browse files
authored
Tools pages for all deployment types (elastic#947)
1 parent 785d1c3 commit ef950de

File tree

13 files changed

+170
-141
lines changed

13 files changed

+170
-141
lines changed
Lines changed: 7 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,16 @@
11
---
22
mapped_pages:
33
- https://www.elastic.co/guide/en/cloud/current/ec-work-with-apis.html
4+
navigation_title: Tools and APIs
45
---
56

6-
# Tools and APIs [ec-work-with-apis]
7+
# Tools and APIs for your Cloud organization [ec-work-with-apis]
78

8-
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.
9-
10-
{{ecloud}} API
11-
: 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.
12-
13-
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).
14-
15-
Calls to the {{ecloud}} API are subject to [Rate limiting](cloud://reference/cloud-hosted/ec-api-rate-limiting.md).
16-
17-
18-
Elasticsearch APIs
19-
: 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.
20-
21-
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).
22-
23-
Some [restrictions](../deploy/elastic-cloud/restrictions-known-problems.md#ec-restrictions-apis-elasticsearch) apply when using the Elasticsearch APIs on {{ecloud}}.
24-
25-
26-
Kibana APIs
27-
: 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.
28-
29-
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.
30-
31-
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.
32-
33-
34-
Other Products
35-
: Most other Elastic products have APIs to support machine-to-machine operations. You can find the documentation for these at the following links:
36-
37-
* [APM event intake API Reference](/solutions/observability/apps/elastic-apm-events-intake-api.md)
38-
* [App Search API Reference](https://www.elastic.co/guide/en/app-search/current/api-reference.html)
39-
* [Elastic Security APIs](https://www.elastic.co/guide/en/security/current/security-apis.html)
40-
* [Fleet APIs](/reference/fleet/fleet-api-docs.md)
41-
* [Logstash APIs](https://www.elastic.co/guide/en/logstash/current/monitoring-logstash.html)
42-
* [Workplace Search API Reference](https://www.elastic.co/guide/en/workplace-search/current/workplace-search-api-overview.html)
9+
You can use the [{{ecloud}} API](https://www.elastic.co/docs/api/doc/cloud/) to manage your {{ecloud}} organization, members, costs, billing, and more.
4310

11+
* Refer to [](/deploy-manage/api-keys/elastic-cloud-api-keys.md) to learn how to generate an API key to access this API.
12+
* Refer to [{{ecloud}} RESTful API](cloud://reference/cloud-hosted/ec-api-restful.md) for usage information and examples.
4413

14+
For {{ecloud}} [service status](/deploy-manage/cloud-organization/service-status.md) updates, you can use the [Service Status API](https://status.elastic.co/api/).
4515

16+
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).
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
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.
2+
3+
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**.
4+
5+
:::{note}
6+
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.
7+
8+
This API console is intended for admin purposes. Avoid running normal workload like indexing or search requests.
9+
:::
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
- [{{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.
2+
- [{{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).
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
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.
2+
3+
ECCTL provides the following benefits:
4+
5+
- Easier to use than the {{ecloud}} Console, Cloud UI, or using the RESTful API directly
6+
- Helps you automate the deployment lifecycle
7+
- Provides a foundation for integration with other tools
8+
9+
Find more details in the [ECCTL documentation](ecctl://reference/index.md).
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Some other Elastic products have APIs to support machine-to-machine operations:
2+
3+
* [APM event intake API](/solutions/observability/apps/elastic-apm-events-intake-api.md)
4+
* [Fleet APIs](/reference/fleet/fleet-api-docs.md)
5+
* [Logstash APIs](logstash://reference/monitoring-logstash.md)
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
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.
2+
3+
To get started, see the [{{ecloud}} Terraform provider documentation](https://registry.terraform.io/providers/elastic/ec/latest/docs).

deploy-manage/deploy/cloud-enterprise/tools-apis.md

Lines changed: 40 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,44 +4,63 @@ applies_to:
44
ece: all
55
mapped_pages:
66
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-api-console.html
7+
navigation_title: "Tools and APIs"
78
---
8-
# Tools and APIs
9+
# Tools and APIs for {{ece}}
910

10-
% What needs to be done: Write from scratch
11+
Review key resources that can be used to interact with and manage your {{ece}} installation and deployments.
1112

12-
% GitHub issue: https://github.com/elastic/docs-projects/issues/310
1313

14-
⚠️ **This page is a work in progress.** ⚠️
14+
## APIs
1515

16-
You can use these tools and APIs to interact with the following {{ece}} features:
16+
You can use the following APIs in an {{ece}} environment.
1717

18-
* [{{ecloud}} Control (ecctl)](ecctl://reference/index.md): Wraps typical operations commonly needed by operators within a single command line tool.
19-
* [ECE scripts](cloud://reference/cloud-enterprise/scripts.md): Use the `elastic-cloud-enterprise.sh` script to install {{ece}} or modify your installation.
20-
* [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.
21-
* [Elasticsearch API console](#ece-api-console)
18+
:::{tip}
19+
Refer to [](/deploy-manage/api-keys.md) to learn how to generate API keys for your environment.
20+
:::
2221

23-
**API**
22+
### Orchestration APIs
2423

25-
% ECE API links and information are still pending
26-
* [Elastic Cloud Enterprise RESTful API](cloud://reference/cloud-enterprise/restful-api.md)
24+
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.
2725

28-
## {{es}} API Console [ece-api-console]
26+
Refer to [{{es}} API conventions](cloud://reference/cloud-enterprise/restful-api.md) to learn about headers and request body conventions, and view examples.
2927

30-
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.
28+
### APIs to interact with data and solution features
3129

32-
::::{important}
33-
API console is intended for admin purposes. Avoid running normal workload like indexing or search requests.
34-
::::
30+
The following APIs allow you to interact with your {{es}} cluster, its data, and the features available to you in your {{ece}} deployments.
3531

36-
You can find this console in Cloud UI when selecting a specific deployment to manage. From the {{es}} menu, select **API Console**.
32+
:::{tip}
33+
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.
34+
:::
3735

38-
:::{note}
39-
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.
36+
:::{include} /deploy-manage/deploy/_snippets/core-apis.md
4037
:::
4138

42-
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.
39+
:::{include} /deploy-manage/deploy/_snippets/other-apis.md
40+
:::
4341

42+
## {{es}} API Console [ece-api-console]
4443

44+
:::{include} /deploy-manage/deploy/_snippets/cloud-api-console.md
45+
:::
4546

47+
## Elastic Cloud Control: command-line interface for {{ecloud}}
48+
49+
:::{include} /deploy-manage/deploy/_snippets/ecctl.md
50+
:::
51+
52+
## Provision hosted deployments with Terraform
53+
```{applies_to}
54+
deployment:
55+
ess: ga
56+
serverless: unavailable
57+
```
58+
59+
:::{include} /deploy-manage/deploy/_snippets/tpec.md
60+
:::
4661

62+
## Other tools
4763

64+
* [ECE scripts](cloud://reference/cloud-enterprise/scripts.md): Use these scripts to install {{ece}} or modify your installation.
65+
* [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.
66+
* [{{es}} Support Diagnostic tool](/troubleshoot/elasticsearch/diagnostic.md): Captures a point-in-time snapshot of cluster statistics and most {{es}} settings for troubleshooting purposes.

deploy-manage/deploy/cloud-on-k8s/kibana-instance-quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ To deploy a simple [{{kib}}](/get-started/the-stack.md#stack-components-kibana)
6666
```
6767

6868

69-
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/):
69+
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/):
7070

7171
```sh
7272
kubectl describe crd kibana
Lines changed: 35 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,41 @@
1-
# Tools and APIs
1+
---
2+
applies_to:
3+
deployment:
4+
eck: all
5+
navigation_title: "Tools and APIs"
6+
---
27

3-
% What needs to be done: Write from scratch
8+
# Tools and APIs for {{eck}}
49

5-
% GitHub issue: https://github.com/elastic/docs-projects/issues/310
10+
Review key resources that can be used to interact with and manage your {{eck}} operator and deployments.
611

7-
⚠️ **This page is a work in progress.** ⚠️
12+
## APIs
813

9-
You can use these tools and APIs to interact with the following {{eck}} features:
14+
You can use the following APIs in an {{eck}} environment.
15+
16+
:::{tip}
17+
Refer to [](/deploy-manage/api-keys.md) to learn how to generate API keys for your environment.
18+
:::
19+
20+
### Orchestration APIs
21+
22+
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).
23+
24+
25+
### APIs to interact with data and solution features
26+
27+
The following APIs allow you to interact with your {{es}} cluster, its data, and the features available to you in your {{eck}} deployments.
28+
29+
:::{tip}
30+
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.
31+
:::
32+
33+
:::{include} /deploy-manage/deploy/_snippets/core-apis.md
34+
:::
35+
36+
:::{include} /deploy-manage/deploy/_snippets/other-apis.md
37+
:::
38+
39+
## Tools
1040

1141
* [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.

0 commit comments

Comments
 (0)