Skip to content

Commit 1d20da5

Browse files
yetanothertwmridula-s109
authored andcommitted
Adds apply_to tags to Command line tools page (elastic#134538)
* Adds apply_to tags to Command line tools page This section doesn't have the usual deployment type badges at the top. Since they are command line tools against Elasticsearch, they're not available on Elastic Cloud Hosted/Serverless. Fixes [elastic#306](elastic/docs-content-internal#306) * Adding tip + removing some of the tags * Specify all the deployments in which the tools are unavailable in the tip * Remove the stack tag * Add feedback from Edu * Adding the self-managed tag to all child pages * Specify they're not inteded for us in ECK and ECE deployments Also, I've simplified the sentence introducing the list of tools to avoid repetition.
1 parent 944357e commit 1d20da5

15 files changed

+55
-2
lines changed

docs/reference/elasticsearch/command-line-tools/certgen.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
---
22
mapped_pages:
33
- https://www.elastic.co/guide/en/elasticsearch/reference/current/certgen.html
4+
applies_to:
5+
deployment:
6+
self: ga
47
---
58

69
# elasticsearch-certgen [certgen]

docs/reference/elasticsearch/command-line-tools/certutil.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
---
22
mapped_pages:
33
- https://www.elastic.co/guide/en/elasticsearch/reference/current/certutil.html
4+
applies_to:
5+
deployment:
6+
self: ga
47
---
58

69
# elasticsearch-certutil [certutil]

docs/reference/elasticsearch/command-line-tools/create-enrollment-token.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
---
22
mapped_pages:
33
- https://www.elastic.co/guide/en/elasticsearch/reference/current/create-enrollment-token.html
4+
applies_to:
5+
deployment:
6+
self: ga
47
---
58

69
# elasticsearch-create-enrollment-token [create-enrollment-token]

docs/reference/elasticsearch/command-line-tools/elasticsearch-croneval.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
---
22
mapped_pages:
33
- https://www.elastic.co/guide/en/elasticsearch/reference/current/elasticsearch-croneval.html
4+
applies_to:
5+
deployment:
6+
self: ga
47
---
58

69
# elasticsearch-croneval [elasticsearch-croneval]

docs/reference/elasticsearch/command-line-tools/elasticsearch-keystore.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
---
22
mapped_pages:
33
- https://www.elastic.co/guide/en/elasticsearch/reference/current/elasticsearch-keystore.html
4+
applies_to:
5+
deployment:
6+
self: ga
47
---
58

69
# elasticsearch-keystore [elasticsearch-keystore]

docs/reference/elasticsearch/command-line-tools/index.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,22 @@
11
---
22
mapped_pages:
33
- https://www.elastic.co/guide/en/elasticsearch/reference/current/commands.html
4+
applies_to:
5+
deployment:
6+
self: ga
7+
products:
8+
- id: elasticsearch
49
---
510

6-
# Command line tools [commands]
11+
# Command-line tools [commands]
712

8-
{{es}} provides the following tools for configuring security and performing other tasks from the command line:
13+
{{es}} includes a set of command-line tools in its `bin` subdirectory (for example, `/usr/share/elasticsearch/bin`). These tools support tasks such as generating TLS/SSL certificates, configuring security settings and user credentials, enrolling or reconfiguring nodes, managing corrupted shards, and other node-level administrative operations that are only possible, or simpler to perform, outside the REST API.
14+
15+
:::{important}
16+
The tools are intended for use in self-managed environments and are included with all {{es}} software packages and Docker images, but are not accessible in fully managed {{ecloud}} deployments such as {{ech}} or {{serverless-full}}. Similarly, they are not designed for use in {{ece}} or {{eck}}.
17+
:::
18+
19+
The following tools are available:
920

1021
* [*elasticsearch-certgen*](/reference/elasticsearch/command-line-tools/certgen.md)
1122
* [*elasticsearch-certutil*](/reference/elasticsearch/command-line-tools/certutil.md)

docs/reference/elasticsearch/command-line-tools/node-tool.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
---
22
mapped_pages:
33
- https://www.elastic.co/guide/en/elasticsearch/reference/current/node-tool.html
4+
applies_to:
5+
deployment:
6+
self: ga
47
---
58

69
# elasticsearch-node [node-tool]

docs/reference/elasticsearch/command-line-tools/reconfigure-node.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
---
22
mapped_pages:
33
- https://www.elastic.co/guide/en/elasticsearch/reference/current/reconfigure-node.html
4+
applies_to:
5+
deployment:
6+
self: ga
47
---
58

69
# elasticsearch-reconfigure-node [reconfigure-node]

docs/reference/elasticsearch/command-line-tools/reset-password.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
---
22
mapped_pages:
33
- https://www.elastic.co/guide/en/elasticsearch/reference/current/reset-password.html
4+
applies_to:
5+
deployment:
6+
self: ga
47
---
58

69
# elasticsearch-reset-password [reset-password]

docs/reference/elasticsearch/command-line-tools/saml-metadata.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
---
22
mapped_pages:
33
- https://www.elastic.co/guide/en/elasticsearch/reference/current/saml-metadata.html
4+
applies_to:
5+
deployment:
6+
self: ga
47
---
58

69
# elasticsearch-saml-metadata [saml-metadata]

0 commit comments

Comments
 (0)