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
[docs] Fix various syntax and rendering errors (#1233)
Fixes various syntax and rendering errors that might include:
* Fixing broken images
* Hardcoding book-level substitution values
* Fixing incorrectly closed blocks (admonitions, tab sets, code blocks,
dropdowns etc.)
* Fixing poorly migrated complex tables
* Fixing poorly migrated lists
* Fixing poorly migrated tab sets
* Removing inline text formatting from directive titles where they won't
be rendered (for example, inline `code` formatting in dropdown titles)
* Specifying if a version is trying to communicate if a feature was
added, deprecated, or coming (for example, during migration
`deprecated:[8.15.0]` became `[8.15.0]`, which doesn't give any
information about _what_ happened in 8.15.0)
* Fixing nested dropdowns / definition lists
* Fixing poorly migrated footnotes
* Updating references to prerelease `9.0.0` versions (using a repo-level
substitution until there is a solution to
elastic/docs-builder#737)
Copy file name to clipboardExpand all lines: deploy-manage/cloud-organization/billing/billing-models.md
+4-4
Original file line number
Diff line number
Diff line change
@@ -71,13 +71,13 @@ Based on these four key concepts, the prepaid consumption lifecycle is as follow
71
71
1. You purchase credits expressed in ECU, typically at a discount.
72
72
2. You begin using {{ecloud}} resources.
73
73
3. At every billing cycle (which takes place on the first of each month), the previous month's usage, expressed in ECU, is deducted from your ECU balance.
74
-
4. If your ECU balance is depleted before the credit expiration date, you are invoiced for on-demand usage in arrears at list price. On-demand usage is expressed in ECU, and is converted to currency amounts for invoicing purposes.¹
74
+
4. If your ECU balance is depleted before the credit expiration date, you are invoiced for on-demand usage in arrears at list price. On-demand usage is expressed in ECU, and is converted to currency amounts for invoicing purposes.[^1^](#footnote-1)
75
75
5. At the end of the contract period, any credits remaining in your balance are forfeited.
76
-
6. During the contract period, you can purchase additional credits at any time (as an add-on). This can be done with the same discount as the original purchase. Credits purchased through an add-on have the same expiration as the original purchase.²
76
+
6. During the contract period, you can purchase additional credits at any time (as an add-on). This can be done with the same discount as the original purchase. Credits purchased through an add-on have the same expiration as the original purchase.[^2^](#footnote-2)
77
77
78
-
¹ When you renew your contract or commit to a multi-year contract, any on-demand usage incurred in the years other than the last are billed with the same discount as the original purchase.
78
+
^1^ $$$footnote-1$$$ When you renew your contract or commit to a multi-year contract, any on-demand usage incurred in the years other than the last are billed with the same discount as the original purchase.
79
79
80
-
² Purchasing credits through early renewals, or through add-ons with different expiration dates will be available in the near future.
80
+
^2^ $$$footnote-2$$$ Purchasing credits through early renewals, or through add-ons with different expiration dates will be available in the near future.
81
81
82
82
::::{note}
83
83
Existing annual+overages customers will be able to switch to prepaid consumption when they renew or sign a new contract. Existing manual burndown customers will be migrated gradually to prepaid consumption in the near future. Exceptions apply.
Copy file name to clipboardExpand all lines: deploy-manage/deploy/cloud-enterprise/ce-add-support-for-node-roles-autoscaling.md
+7-7
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,7 @@ There are a number of fields that need to be added to each {{es}} node in order
30
30
31
31
The following example is based on the `default` system owned deployment template that already supports `node_roles`. This template will be used as a reference for the next sections:
32
32
33
-
::::{dropdown} Reference example with support for `node_roles`
33
+
::::{dropdown} Reference example with support for node_roles
34
34
:name: ece-node-roles-support-example
35
35
36
36
```json
@@ -363,7 +363,7 @@ It is recommended to add the `id` field to each {{es}} topology element in the d
363
363
364
364
The existing template contains three {{es}} topology elements and two resources (`elasticsearch` and `kibana`).
365
365
366
-
::::{dropdown} Custom example without support for `node_roles`
366
+
::::{dropdown} Custom example without support for node_roles
367
367
```json
368
368
{
369
369
...
@@ -471,7 +471,7 @@ Then, it is only necessary to add the four {{es}} topology elements (`warm`, `co
471
471
472
472
After adding support for `node_roles`, the resulting deployment template should look similar to the following:
473
473
474
-
::::{dropdown} Custom example with support for `node_roles`
474
+
::::{dropdown} Custom example with support for node_roles
475
475
:name: example-with-support-for-node-roles
476
476
477
477
```json
@@ -772,7 +772,7 @@ These fields represent the default settings for the deployment. However, autosca
772
772
773
773
Similar to the `node_roles` example, the following one is also based on the `default` deployment template that already supports `node_roles` and autoscaling. This template will be used as a reference for the next sections:
774
774
775
-
::::{dropdown} Reference example with support for `node_roles` and autoscaling
775
+
::::{dropdown} Reference example with support for node_roles and autoscaling
776
776
```json
777
777
{
778
778
...
@@ -1102,7 +1102,7 @@ To update a custom deployment template:
1102
1102
1103
1103
After adding support for autoscaling to the [example](#ece-node-roles-support-example) presented in the previous section, the resulting deployment template should look similar to the following:
1104
1104
1105
-
::::{dropdown} Custom example with support for `node_roles` and autoscaling
1105
+
::::{dropdown} Custom example with support for node_roles and autoscaling
1106
1106
```json
1107
1107
{
1108
1108
...
@@ -1780,7 +1780,7 @@ After the migration plan has finished, we recommend following the [Migrate index
1780
1780
1781
1781
The following is an example of a deployment plan that does not contain `node_roles`:
1782
1782
1783
-
::::{dropdown} Example deployment plan with `node_type`
1783
+
::::{dropdown} Example deployment plan with node_type
1784
1784
```json
1785
1785
{
1786
1786
"name": "Example deployment",
@@ -1924,7 +1924,7 @@ The following is an example of a deployment plan that does not contain `node_rol
1924
1924
1925
1925
After adding support for`node_roles` to the example deployment plan, the resulting plan should look similar to the following:
1926
1926
1927
-
::::{dropdown} Example deployment plan with `node_roles`
1927
+
::::{dropdown} Example deployment plan with node_roles
Copy file name to clipboardExpand all lines: deploy-manage/deploy/cloud-enterprise/enable-custom-endpoint-aliases.md
+7-7
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ mapped_pages:
10
10
11
11
Custom endpoint aliases allow users to replace the UUID for each application with a human readable string. Platform administrators must enable this feature to allow deployment managers to create and modify aliases for their deployments.
12
12
13
-
::::{note}
13
+
::::{note}
14
14
You need to update your proxy certificates to support this feature.
15
15
::::
16
16
@@ -20,16 +20,16 @@ After installing or upgrading to version 2.10 or later:
20
20
1.[Login to the Cloud UI](log-into-cloud-ui.md)
21
21
2.[Update your proxy certificate(s)](../../security/secure-your-elastic-cloud-enterprise-installation/manage-security-certificates.md). In addition to currently configured domains, additional SAN entries must be configured for each application-specific subdomain:
22
22
23
-
::::{note}
23
+
::::{note}
24
24
If you are not using wildcard certificates, you need to repeat this process for each deployment to account for specific aliases.
25
25
::::
26
26
27
27
28
-
* For {{es}}, the certificate needs to allow for ***.es.<your-domain>**
29
-
* For {{kib}}, the certificate needs to allow for ***.kb.<your-domain>**
30
-
* For APM, the certificate needs to allow for ***.apm.<your-domain>**
31
-
* For Fleet, the certificate needs to allow for ***.fleet.<your-domain>**
32
-
* For Universal Profiling, the certificate needs to allow for ***.profiling.<your-domain>** and ***.symbols.<your-domain>**
28
+
* For {{es}}, the certificate needs to allow for **\*.es.<your-domain>**
29
+
* For {{kib}}, the certificate needs to allow for **\*.kb.<your-domain>**
30
+
* For APM, the certificate needs to allow for **\*.apm.<your-domain>**
31
+
* For Fleet, the certificate needs to allow for **\*.fleet.<your-domain>**
32
+
* For Universal Profiling, the certificate needs to allow for **\*.profiling.<your-domain>** and **\*.symbols.<your-domain>**
33
33
34
34
3. In the **Platform** menu, select **Settings**.
35
35
4. Under the **Enable custom endpoint alias naming**, toggle the setting to allow platform administrators and deployment managers to choose a simplified, unique URL for the endpoint.
Following is the full list of available packs containing {{stack}} versions. Note that Enterprise Search was introduced with ECE 2.6.0 and requires that version or higher.
47
47
48
-
::::{dropdown} **Expand to view the full list**
48
+
::::{dropdown} Expand to view the full list
49
49
| Required downloads | Minimum required ECE version |
50
50
| --- | --- |
51
51
|[{{es}}, {{kib}}, and APM stack pack: 9.0.0](https://download.elastic.co/cloud-enterprise/versions/9.0.0.zip)| ECE 4.0.0 |
Copy file name to clipboardExpand all lines: deploy-manage/deploy/cloud-on-k8s/advanced-configuration.md
+5-1
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,11 @@ This section covers the following topics:
17
17
18
18
## Use APM Agent central configuration [k8s-apm-agent-central-configuration]
19
19
20
-
[APM Agent configuration management](/solutions/observability/apm/apm-agent-central-configuration.md)[7.5.1] allows you to configure your APM Agents centrally from the {{kib}} APM app. To use this feature, the APM Server needs to be configured with connection details of the {{kib}} instance. If {{kib}} is managed by ECK, you can simply add a `kibanaRef` attribute to the APM Server specification:
20
+
:::{admonition} Added in 7.5.1
21
+
APM Agent central configuration was added in 7.5.1.
22
+
:::
23
+
24
+
[APM Agent configuration management](/solutions/observability/apm/apm-agent-central-configuration.md) allows you to configure your APM Agents centrally from the {{kib}} APM app. To use this feature, the APM Server needs to be configured with connection details of the {{kib}} instance. If {{kib}} is managed by ECK, you can simply add a `kibanaRef` attribute to the APM Server specification:
Copy file name to clipboardExpand all lines: deploy-manage/deploy/cloud-on-k8s/configuration-logstash.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -174,14 +174,14 @@ Logstash persistent queues (PQs) and dead letter queues (DLQs) are not currently
174
174
175
175
## Defining data volumes for Logstash [k8s-logstash-volumes]
176
176
177
-
[2.9.0]
177
+
:::{admonition} Added in 2.9.0
178
+
This was added in 2.9.0.
179
+
:::
178
180
179
181
::::{warning}
180
182
Volume support for Logstash is a breaking change to earlier versions of ECK and requires you to recreate your Logstash resources.
181
183
::::
182
184
183
-
184
-
185
185
## Specifying the volume claim settings [k8s-volume-claim-settings]
186
186
187
187
A PersistentVolume called `logstash-data` is created by default. It maps to `/usr/share/logstash/data` for persistent storage, which is typically used for storage from plugins.
Copy file name to clipboardExpand all lines: deploy-manage/deploy/elastic-cloud/azure-native-isv-service.md
+5-5
Original file line number
Diff line number
Diff line change
@@ -303,13 +303,13 @@ $$$azure-integration-whats-included$$$What is included in my {{ecloud}} deployme
303
303
$$$azure-integration-how-to-access$$$How can I access my {{ecloud}} deployment?
304
304
: Navigate to the deployment overview page in Azure:
305
305
306
-
1. Select a deployment to open the deployment overview page.
306
+
Select a deployment to open the deployment overview page.
307
307
308
-
You now have a few options to access your deployment:
308
+
Then you have a few options to access your deployment:
309
309
310
-
* **{{es}} endpoint** - the URL for the {{es}} cluster itself
311
-
* **{{kib}} endpoint** - the UI for the {{stack}}, a great way for new users to get started
312
-
* **{{ecloud}}** - Open the **Advanced Settings** link to access the deployment in the {{ecloud}} console, to change the size of the deployment or upgrade it.
310
+
* **{{es}} endpoint** - the URL for the {{es}} cluster itself
311
+
* **{{kib}} endpoint** - the UI for the {{stack}}, a great way for new users to get started
312
+
* **{{ecloud}}** - Open the **Advanced Settings** link to access the deployment in the {{ecloud}} console, to change the size of the deployment or upgrade it.
313
313
314
314
315
315
$$$azure-integration-modify-deployment$$$How can I modify my {{ecloud}} deployment?
Copy file name to clipboardExpand all lines: deploy-manage/deploy/elastic-cloud/project-settings.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -61,7 +61,7 @@ For {{elastic-sec}} projects, edit the **Project features** to select a feature
61
61
| Feature tier | Description and add-ons |
62
62
| :--- | :--- |
63
63
| **Security Analytics Essentials** | Standard security analytics, detections, investigations, and collaborations. Allows these add-ons:<br><br>* **Endpoint Protection Essentials**: endpoint protections with {{elastic-defend}}.<br>* **Cloud Protection Essentials**: Cloud native security features.<br> |
64
-
| **Security Analytics Complete** | Everything in **Security Analytics Essentials*** plus advanced features such as entity analytics, threat intelligence, and more. Allows these add-ons:<br><br>* **Endpoint Protection Complete**: Everything in **Endpoint Protection Essentials** plus advanced endpoint detection and response features.<br>* **Cloud Protection Complete**: Everything in **Cloud Protection Essentials** plus advanced cloud security features.<br> |
64
+
| **Security Analytics Complete** | Everything in **Security Analytics Essentials** plus advanced features such as entity analytics, threat intelligence, and more. Allows these add-ons:<br><br>* **Endpoint Protection Complete**: Everything in **Endpoint Protection Essentials** plus advanced endpoint detection and response features.<br>* **Cloud Protection Complete**: Everything in **Cloud Protection Essentials** plus advanced cloud security features.<br> |
65
65
66
66
### Downgrading the feature tier [elasticsearch-manage-project-downgrading-the-feature-tier]
Copy file name to clipboardExpand all lines: deploy-manage/distributed-architecture/discovery-cluster-formation/modules-discovery-voting.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -58,7 +58,7 @@ It is important that the bootstrap configuration identifies exactly which nodes
58
58
If the bootstrap configuration is not set correctly, when you start a brand-new cluster there is a risk that you will accidentally form two separate clusters instead of one. This situation can lead to data loss: you might start using both clusters before you notice that anything has gone wrong and it is impossible to merge them together later.
59
59
60
60
::::{note}
61
-
To illustrate the problem with configuring each node to expect a certain cluster size, imagine starting up a three-node cluster in which each node knows that it is going to be part of a three-node cluster. A majority of three nodes is two, so normally the first two nodes to discover each other form a cluster and the third node joins them a short time later. However, imagine that four nodes were erroneously started instead of three. In this case, there are enough nodes to form two separate clusters. Of course if each node is started manually then it’s unlikely that too many nodes are started. If you’re using an automated orchestrator, however, it’s certainly possible to get into this situation-- particularly if the orchestrator is not resilient to failures such as network partitions.
61
+
To illustrate the problem with configuring each node to expect a certain cluster size, imagine starting up a three-node cluster in which each node knows that it is going to be part of a three-node cluster. A majority of three nodes is two, so normally the first two nodes to discover each other form a cluster and the third node joins them a short time later. However, imagine that four nodes were erroneously started instead of three. In this case, there are enough nodes to form two separate clusters. Of course if each node is started manually then it’s unlikely that too many nodes are started. If you’re using an automated orchestrator, however, it’s certainly possible to get into this situation—particularly if the orchestrator is not resilient to failures such as network partitions.
62
62
::::
63
63
64
64
The initial quorum is only required the very first time a whole cluster starts up. New nodes joining an established cluster can safely obtain all the information they need from the elected master. Nodes that have previously been part of a cluster will have stored to disk all the information that is required when they restart.
Copy file name to clipboardExpand all lines: deploy-manage/monitor/autoops/ec-autoops-faq.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ $$$faq-autoops-monitoring$$$Does AutoOps monitor the entire {{stack}}?
20
20
: AutoOps is currently limited to {{es}} (not {{kib}}, Logstash and Beats).
21
21
22
22
$$$faq-autoops-supported-versions$$$What versions of {{es}} are supported for {{ech}}?
23
-
: AutoOps supports {es} versions according to the [supported {{stack}} versions](https://www.elastic.co/support/eol).
23
+
: AutoOps supports {{es}} versions according to the [supported {{stack}} versions](https://www.elastic.co/support/eol).
24
24
25
25
$$$faq-autoops-license$$$How is AutoOps currently licensed?
26
26
: AutoOps current feature set is available to {{ech}} customers at all subscription tiers. For more information refer to the [subscription page](https://www.elastic.co/subscriptions/cloud).
@@ -18,7 +18,7 @@ If you are planning to ingest your logs using {{es}} or another tool, we recomme
18
18
You can't configure these settings in an {{ech}} deployment.
19
19
:::
20
20
21
-
The {{kib}} logging system has three main components: *loggers*, *appenders* and *layouts*.
21
+
The {{kib}} logging system has three main components: *loggers*, *appenders* and *layouts*.
22
22
23
23
***Loggers** define what logging settings should be applied to a particular logger.
24
24
*[Appenders](#logging-appenders) define where log messages are displayed (for example, stdout or console) and stored (for example, file on the disk).
@@ -70,7 +70,7 @@ The following conversions are provided out of the box:
70
70
71
71
***message**: Outputs the application supplied message associated with the logging event.
72
72
73
-
***meta**: Outputs the entries of `meta` object data in ***json** format, if one is present in the event. Example of `%meta` output:
73
+
***meta**: Outputs the entries of `meta` object data in **json** format, if one is present in the event. Example of `%meta` output:
74
74
75
75
```bash
76
76
// Meta{from: 'v7', to: 'v8'}
@@ -391,7 +391,7 @@ logging:
391
391
level: debug
392
392
```
393
393
394
-
## Logging configuration using the CLI [logging-cli-migration]
394
+
## Logging configuration using the CLI [logging-cli-migration]
395
395
396
396
You can specify your logging configuration using the CLI. For convenience, the `--verbose` and `--silent` flags exist as shortcuts and will continue to be supported beyond v7.
Copy file name to clipboardExpand all lines: deploy-manage/remote-clusters/ec-remote-cluster-self-managed.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -132,7 +132,7 @@ A deployment can be configured to trust all or specific deployments in any envir
132
132
Trust management will not work properly in clusters without an `otherName` value specified, as is the case by default in an out-of-the-box [{{es}} installation](../deploy/self-managed/installing-elasticsearch.md). To have the {{es}} certutil generate new certificates with the `otherName` attribute, use the file input with the `cn` attribute as in the example below.
133
133
::::
134
134
135
-
5.. Provide a name for the trusted environment. That name will appear in the trust summary of your deployment’s **Security** page.
135
+
5. Provide a name for the trusted environment. That name will appear in the trust summary of your deployment’s **Security** page.
136
136
6. Select **Create trust** to complete the configuration.
137
137
7. Configure the self-managed cluster to trust this deployment, so that both deployments are configured to trust each other:
0 commit comments