You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-**High availability & resilience**: Ensures uptime through multiple Availability Zones, data replication, and automated restore and snapshot.
29
29
-**Centralized monitoring & logging**: Provides insights into cluster performance, resource usage, and logs.
30
-
-**Single Sign-On (SSO) & role-based access aontrol (RBAC)**: Allows organizations to manage access and security policies.
30
+
-**Single Sign-On (SSO) & role-based access control (RBAC)**: Allows organizations to manage access and security policies.
31
31
-**API & UI management**: Offers a web interface and API to create and manage clusters easily.
32
32
-**Air-gapped installations**: Support for off-line installations.
33
33
-**Microservices architecture**: All services are containerized through Docker.
@@ -71,4 +71,4 @@ To learn about other deployment options, refer to [](../deploy.md).
71
71
72
72
## Supported versions [ece-supported-versions]
73
73
74
-
Refer to the [Elastic Support Matrix](https://www.elastic.co/support/matrix#elastic-cloud-enterprise) for more information about supported Operating Systems, Docker, and Podman versions.
74
+
Refer to the [Elastic Support Matrix](https://www.elastic.co/support/matrix#elastic-cloud-enterprise) for more information about supported Operating Systems, Docker, and Podman versions.
You can use these tools and APIs to interact with the following {{ece}} features:
10
+
11
+
*[{{ecloud}} Control (ecctl)](asciidocalypse://docs/ecctl/docs/reference/cloud/ecctl/index.md): Wraps typical operations commonly needed by operators within a single command line tool.
12
+
*[ECE scripts](asciidocalypse://docs/cloud/docs/reference/cloud/cloud-enterprise/scripts.md): Use the `elastic-cloud-enterprise.sh` script to install {{ece}} or modify your installation.
13
+
*[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.
You can use these tools and APIs to interact with the following {{eck}} features:
10
+
11
+
*[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.
% Notes: reference only, this page wasn't migrated, but you can pull from the live URL if needed.
24
24
25
-
26
25
## REST APIs to orchestrate {{ecloud}}
27
26
28
27
The following APIs allow you to manage your {{ecloud}} organization, users, security, billing and resources.
@@ -61,13 +60,17 @@ Note that some [restrictions](/deploy-manage/deploy/elastic-cloud/restrictions-k
61
60
The following APIs are available for {{es-serverless}} users. These links will take you to the autogenerated API reference documentation.
62
61
63
62
-[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).
63
+
64
+
::::{tip}
65
+
Learn how to [connect to your {{es-serverless}} endpoint](/solutions/search/get-started.md).
66
+
::::
67
+
64
68
-[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.
65
69
66
70
67
71
**Additional API information**
68
72
69
-
-[{{es}} API conventions](https://www.elastic.co/guide/en/serverless/current/elasticsearch-api-conventions.html): Reference information about headers and request body conventions for {{es-serverless}} REST APIs.
70
-
-[Management API conventions](https://www.elastic.co/guide/en/serverless/current/elasticsearch-kibana-api-conventions.html): Reference information about request header conventions for {{serverless-full}} REST APIs.
73
+
-[{{es}} API conventions](asciidocalypse://docs/elasticsearch/docs/reference/elasticsearch/rest-apis/api-conventions.md): Reference information about headers and request body conventions for {{es-serverless}} REST APIs.
71
74
::::
72
75
73
76
::::{tab-item} {{ech}}
@@ -125,4 +128,4 @@ The Elastic Cloud Terraform provider allows you to provision {{ech}} deployments
125
128
126
129
The provider lets you manage Elastic Cloud deployments as code, and introduce DevOps-driven methodologies to manage and deploy the Elastic Stack and solutions.
127
130
128
-
To get started, see the [Elastic Cloud Terraform provider documentation](https://registry.terraform.io/providers/elastic/ec/latest/docs).
131
+
To get started, see the [Elastic Cloud Terraform provider documentation](https://registry.terraform.io/providers/elastic/ec/latest/docs).
-[Elastic Cloud on Kubernetes (ECK)](/deploy-manage/deploy/cloud-on-k8s.md)
41
52
- ECK deployment versions (for example, 3.0.0)
53
+
-**Serverless project types**
54
+
- Security
55
+
- Elasticsearch
56
+
- Observability
57
+
58
+
### Important tips when reading the docs
59
+
60
+
- Always check feature lifecycle state for your specific deployment type and version
61
+
- Pay attention to Elastic Stack version requirements
62
+
- Note that Serverless features may vary by project type
63
+
64
+
### Availability badges in the docs
65
+
66
+
Our documentation uses badges to help you quickly identify where and when features are available for your specific environment.
67
+
68
+
Badges can appear in two places:
69
+
1.**Page headers**: Shows the overall availability across all deployment types
70
+
2.**Section headers**: Indicates specific availability for content in that section
71
+
72
+
### How to read the badges
73
+
74
+
Here are some examples to help you understand how to read the availability badges.
75
+
76
+
#### Example #1: Stack only feature
77
+
78
+
```yaml {applies_to}
79
+
stack: ga 9.1
80
+
```
81
+
- **Deployment type**: Elastic Stack
82
+
- **Version**: 9.1
83
+
- **Lifecycle**: Generally Available (GA) — default state
84
+
85
+
#### Example #2: Serverless-only feature with project differences
86
+
87
+
```yaml {applies_to}
88
+
serverless:
89
+
security: beta
90
+
elasticsearch: ga
91
+
```
92
+
- **Deployment type**: Serverless
93
+
- **Lifecycle**:
94
+
- Beta for Security projects
95
+
- Generally Available for Elasticsearch projects
96
+
97
+
#### Example #3: Discontinued feature on one deployment type
42
98
43
-
When reading the Elastic documentation be sure to:
99
+
```yaml {applies_to}
100
+
deployment:
101
+
ece: discontinued 4.1.0
102
+
```
103
+
- **Deployment type**: Elastic Cloud Enterprise
104
+
- **Lifecycle**: Discontinued
105
+
- **Version**: 4.1.0
44
106
45
-
- Check feature availability for your deployment type and version
46
-
- Note stack version requirements
47
-
- Be aware that Serverless features may vary by project type
107
+
:::{tip}
108
+
For contributors and those interested in the technical details, see the [Elastic docs syntax guide](https://elastic.github.io/docs-builder/syntax/applies/) for more information on how these badges are implemented.
0 commit comments