Skip to content

Commit 5c9dd47

Browse files
Replace asciidocalypse links (#628)
Replace link to `asciidocalypse` with links to permanent repos. - [x] [apm-agent-android](https://github.com/elastic/apm-agent-android) - [x] [apm-agent-dotnet](https://github.com/elastic/apm-agent-dotnet) - [x] [apm-agent-go](https://github.com/elastic/apm-agent-go) - [x] [apm-agent-ios](https://github.com/elastic/apm-agent-ios) - [ ] [apm-agent-java](https://github.com/elastic/apm-agent-java) - [ ] [apm-agent-nodejs](https://github.com/elastic/apm-agent-nodejs) - [ ] [apm-agent-php](https://github.com/elastic/apm-agent-php) - [ ] [apm-agent-python](https://github.com/elastic/apm-agent-python) - [ ] [apm-agent-ruby](https://github.com/elastic/apm-agent-ruby) - [ ] [apm-agent-rum-js](https://github.com/elastic/apm-agent-rum-js) - [x] [apm-aws-lambda](https://github.com/elastic/apm-aws-lambda) - [x] [apm-k8s-attacher](https://github.com/elastic/apm-k8s-attacher) - [ ] [beats](https://github.com/elastic/beats) - [ ] [cloud-on-k8s](https://github.com/elastic/cloud-on-k8s) - [ ] [cloud](https://github.com/elastic/cloud) - [x] [curator](https://github.com/elastic/curator) - [x] [ecctl](https://github.com/elastic/ecctl) - [x] [ecs-dotnet](https://github.com/elastic/ecs-dotnet) - [x] ~~[ecs-logging-go-logrus](https://github.com/elastic/ecs-logging-go-logrus)~~ - [x] [ecs-logging-go-zap](https://github.com/elastic/ecs-logging-go-zap) - [x] ~~[ecs-logging-go-zerolog](https://github.com/elastic/ecs-logging-go-zerolog)~~ - [x] [ecs-logging-java](https://github.com/elastic/ecs-logging-java) - [x] [ecs-logging-nodejs](https://github.com/elastic/ecs-logging-nodejs) - [x] [ecs-logging-php](https://github.com/elastic/ecs-logging-php) - [x] [ecs-logging-python](https://github.com/elastic/ecs-logging-python) - [x] [ecs-logging-ruby](https://github.com/elastic/ecs-logging-ruby) - [x] [ecs-logging](https://github.com/elastic/ecs-logging) - [ ] [ecs](https://github.com/elastic/ecs) - [x] [eland](https://github.com/elastic/eland) - [x] [elastic-serverless-forwarder](https://github.com/elastic/elastic-serverless-forwarder) - [x] [elasticsearch-hadoop](https://github.com/elastic/elasticsearch-hadoop) - [x] [elasticsearch-java](https://github.com/elastic/elasticsearch-java) - [x] [elasticsearch-js](https://github.com/elastic/elasticsearch-js) - [x] [elasticsearch-net](https://github.com/elastic/elasticsearch-net) - [x] [elasticsearch-php](https://github.com/elastic/elasticsearch-php) - [x] [elasticsearch-py](https://github.com/elastic/elasticsearch-py) - [x] [elasticsearch-rs](https://github.com/elastic/elasticsearch-rs) - [x] [elasticsearch-ruby](https://github.com/elastic/elasticsearch-ruby) - [x] [elasticsearch](https://github.com/elastic/elasticsearch) - [x] ~~[go-elasticsearch](https://github.com/elastic/go-elasticsearch)~~ - [ ] [integration-docs](https://github.com/elastic/integration-docs) - [x] ~~[integrations](https://github.com/elastic/integrations)~~ - [x] [kibana](https://github.com/elastic/kibana) - [ ] [logstash-docs](https://github.com/elastic/logstash-docs) - [x] [logstash](https://github.com/elastic/logstash) - [x] [search-ui](https://github.com/elastic/search-ui) - [x] [security-docs](https://github.com/elastic/security-docs)
1 parent 5ce9353 commit 5c9dd47

File tree

787 files changed

+3765
-3743
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

787 files changed

+3765
-3743
lines changed

deploy-manage/_snippets/field-doc-sec-limitations.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
Field and document security is subject to the following limitations:
1+
Field and document security is subject to the following limitations:
22

33
### Document level security limitations
44

55
When a user’s role enables [document level security](/deploy-manage/users-roles/cluster-or-deployment-auth/controlling-access-at-document-field-level.md) for a data stream or index:
66

77
* Document level security doesn’t affect global index statistics that relevancy scoring uses. This means that scores are computed without taking the role query into account. Documents that don’t match the role query are never returned.
88
* The `has_child` and `has_parent` queries aren’t supported as query parameters in the role definition. The `has_child` and `has_parent` queries can be used in the search API with document level security enabled.
9-
* [Date math](asciidocalypse://docs/elasticsearch/docs/reference/elasticsearch/rest-apis/common-options.md#date-math) expressions cannot contain `now` in [range queries with date fields](asciidocalypse://docs/elasticsearch/docs/reference/query-languages/query-dsl-range-query.md#ranges-on-dates).
9+
* [Date math](elasticsearch://reference/elasticsearch/rest-apis/common-options.md#date-math) expressions cannot contain `now` in [range queries with date fields](elasticsearch://reference/query-languages/query-dsl-range-query.md#ranges-on-dates).
1010
* Any query that makes remote calls to fetch query data isn’t supported, including the following queries:
1111

1212
* `terms` query with terms lookup
@@ -16,9 +16,9 @@ When a user’s role enables [document level security](/deploy-manage/users-role
1616
* If suggesters are specified and document level security is enabled, the specified suggesters are ignored.
1717
* A search request cannot be profiled if document level security is enabled.
1818
* The [terms enum API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-terms-enum) does not return terms if document level security is enabled.
19-
* The [`multi_match`](asciidocalypse://docs/elasticsearch/docs/reference/query-languages/query-dsl-multi-match-query.md) query does not support specifying fields using wildcards.
19+
* The [`multi_match`](elasticsearch://reference/query-languages/query-dsl-multi-match-query.md) query does not support specifying fields using wildcards.
2020

21-
:::{note}
21+
:::{note}
2222
While document-level security prevents users from viewing restricted documents, it’s still possible to write search requests that return aggregate information about the entire index. A user whose access is restricted to specific documents in an index could still learn about field names and terms that only exist in inaccessible documents, and count how many inaccessible documents contain a given term.
2323
:::
2424

deploy-manage/cloud-organization/tools-and-apis.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Most Elastic resources can be accessed and managed through RESTful APIs. While t
1818
Elasticsearch APIs
1919
: 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.
2020

21-
To use these APIs on {{ecloud}} read our topic [Access the API console](asciidocalypse://docs/cloud/docs/reference/cloud-hosted/ec-api-console.md), and to learn about all of the available endpoints check the [Elasticsearch API reference documentation](asciidocalypse://docs/elasticsearch/docs/reference/elasticsearch/rest-apis/index.md).
21+
To use these APIs on {{ecloud}} read our topic [Access the API console](asciidocalypse://docs/cloud/docs/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).
2222

2323
Some [restrictions](../deploy/elastic-cloud/restrictions-known-problems.md#ec-restrictions-apis-elasticsearch) apply when using the Elasticsearch APIs on {{ecloud}}.
2424

@@ -37,7 +37,7 @@ Other Products
3737
* [APM event intake API Reference](/solutions/observability/apps/elastic-apm-events-intake-api.md)
3838
* [App Search API Reference](https://www.elastic.co/guide/en/app-search/current/api-reference.html)
3939
* [Elastic Security APIs](https://www.elastic.co/guide/en/security/current/security-apis.html)
40-
* [Fleet APIs](asciidocalypse://docs/docs-content/docs/reference/ingestion-tools/fleet/fleet-api-docs.md)
40+
* [Fleet APIs](/reference/ingestion-tools/fleet/fleet-api-docs.md)
4141
* [Logstash APIs](https://www.elastic.co/guide/en/logstash/current/monitoring-logstash.html)
4242
* [Workplace Search API Reference](https://www.elastic.co/guide/en/workplace-search/current/workplace-search-api-overview.html)
4343

deploy-manage/deploy/cloud-enterprise.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Refer to [](./cloud-enterprise/ece-architecture.md) for details about the ECE pl
3232
- **Air-gapped installations**: Support for off-line installations.
3333
- **Microservices architecture**: All services are containerized through Docker.
3434

35-
Check the [glossary](asciidocalypse:///docs-content/docs/reference/glossary.md) to get familiar with the terminology for ECE as well as other Elastic products and solutions.
35+
Check the [glossary](/reference/glossary/index.md) to get familiar with the terminology for ECE as well as other Elastic products and solutions.
3636

3737
## Section overview
3838

deploy-manage/deploy/cloud-enterprise/add-custom-bundles-plugins.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
mapped_pages:
2+
mapped_pages:
33
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-add-custom-bundle-plugin.html
44
navigation_title: "Custom bundles and plugins"
5-
applies_to:
5+
applies_to:
66
deployment:
77
ece:
88
---
@@ -360,7 +360,7 @@ You do not need to do this step if you are using default filename and password (
360360
}
361361
```
362362
363-
4. To use this bundle, you can refer it in the [GeoIP processor](asciidocalypse://docs/elasticsearch/docs/reference/ingestion-tools/enrich-processor/geoip-processor.md) of an ingest pipeline as `MyGeoLite2-City.mmdb` under `database_file` such as:
363+
4. To use this bundle, you can refer it in the [GeoIP processor](elasticsearch://reference/ingestion-tools/enrich-processor/geoip-processor.md) of an ingest pipeline as `MyGeoLite2-City.mmdb` under `database_file` such as:
364364
365365
```sh
366366
...

deploy-manage/deploy/cloud-enterprise/add-plugins.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Adding plugins to a deployment is as simple as selecting it from the list of ava
1616

1717
Additional plugins might be available. If a plugin is listed for your version of {{es}}, it can be used.
1818

19-
You can also [create](asciidocalypse://elasticsearch/docs/extend/create-elasticsearch-plugins.md) and add custom plugins.
19+
You can also [create](elasticsearch://extend/index.md) and add custom plugins.
2020

2121
To add plugins when creating a new deployment:
2222

@@ -32,7 +32,7 @@ To add plugins to an existing deployment:
3232

3333
1. [Log into the Cloud UI](/deploy-manage/deploy/cloud-enterprise/log-into-cloud-ui.md).
3434
2. On the **Deployments** page, select your deployment.
35-
35+
3636
Narrow the list by name, ID, or choose from several other filters. To further define the list, use a combination of filters.
3737

3838
3. From your deployment menu, go to the **Edit** page.

deploy-manage/deploy/cloud-enterprise/assign-roles-to-hosts.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,14 @@ Each Elastic Cloud Enterprise runner can take on several roles:
2626
`director`
2727
: Manages the ZooKeeper datastore. This role is typically shared with the coordinator role. In production deployments it can be separated from a coordinator.
2828

29-
::::{important}
29+
::::{important}
3030
Once the `director` role is assigned to a runner, the Zookeeper service starts on that host. The Zookeeper service continues even after the director role is removed from the runner. Therefore, if you remove the `director` role from any host that has ever had it, we highly recommend also [deleting the runner](../../maintenance/ece/delete-ece-hosts.md) and re-installing it.
3131
::::
3232

3333

3434
Each role is associated with a set of Docker containers that provide the specific functionality.
3535

36-
There are some additional roles shown in the Cloud UI, such as the [beats-runner](asciidocalypse://docs/docs-content/docs/reference/glossary/index.md#glossary-beats-runner) and [services-forwarder](asciidocalypse://docs/docs-content/docs/reference/glossary/index.md#glossary-services-forwarder) roles, that are required by Elastic Cloud Enterprise and that you cannot modify.
36+
There are some additional roles shown in the Cloud UI, such as the [beats-runner](/reference/glossary/index.md#glossary-beats-runner) and [services-forwarder](/reference/glossary/index.md#glossary-services-forwarder) roles, that are required by Elastic Cloud Enterprise and that you cannot modify.
3737

3838
To assign roles to hosts:
3939

deploy-manage/deploy/cloud-enterprise/ce-add-support-for-node-roles-autoscaling.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ The `node_roles` field defines the roles that an Elasticsearch topology element
2222
There are a number of fields that need to be added to each Elasticsearch node in order to support `node_roles`:
2323

2424
* **id**: Unique identifier of the topology element. This field, along with the `node_roles`, identifies an Elasticsearch topology element.
25-
* **node_roles**: The list of node roles. Allowable roles are: `master`, `ingest`, `ml`, `data_hot`, `data_content`, `data_warm`, `data_cold`, `data_frozen`, `remote_cluster_client`, and `transform`. For details, check [Node roles](asciidocalypse://docs/elasticsearch/docs/reference/elasticsearch/configuration-reference/node-settings.md#node-roles).
25+
* **node_roles**: The list of node roles. Allowable roles are: `master`, `ingest`, `ml`, `data_hot`, `data_content`, `data_warm`, `data_cold`, `data_frozen`, `remote_cluster_client`, and `transform`. For details, check [Node roles](elasticsearch://reference/elasticsearch/configuration-reference/node-settings.md#node-roles).
2626
* **topology_element_control**: Controls for the topology element.
2727

2828
* **min**: The absolute minimum size limit for a topology element. If the value is `0`, that means the topology element can be disabled.

deploy-manage/deploy/cloud-enterprise/ece-configure-templates-index-management.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ To configure index management when you create a deployment template:
4343
Index curation
4444
: Creates new indices on hot nodes first and moves them to warm nodes later on, based on the data views (formerly *index patterns*) you specify. Also manages replica counts for you, so that all shards of an index can fit on the right data nodes. Compared to index lifecycle management, index curation for time-based indices supports only one action, to move indices from nodes on one data configuration to another, but it is more straightforward to set up initially and all setup can be done directly from the Cloud UI.
4545

46-
If your user need to delete indices once they are no longer useful to them, they can run [Curator](asciidocalypse://docs/curator/docs/reference/index.md) on-premise to manage indices for Elasticsearch clusters hosted on Elastic Cloud Enterprise.
46+
If your user need to delete indices once they are no longer useful to them, they can run [Curator](curator://reference/index.md) on-premise to manage indices for Elasticsearch clusters hosted on Elastic Cloud Enterprise.
4747

4848
To configure index curation:
4949

deploy-manage/deploy/cloud-enterprise/ece-ha.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,11 @@ Increasing the number of zones should not be used to add more resources. The con
3535

3636
## Master nodes [ece-ece-ha-2-master-nodes]
3737

38-
Tiebreakers are used in distributed clusters to avoid cases of [split brain](https://en.wikipedia.org/wiki/Split-brain_(computing)), where an {{es}} cluster splits into multiple, autonomous parts that continue to handle requests independently of each other, at the risk of affecting cluster consistency and data loss. A split-brain scenario is avoided by making sure that a minimum number of [master-eligible nodes](asciidocalypse://docs/elasticsearch/docs/reference/elasticsearch/configuration-reference/node-settings.md#master-node) must be present in order for any part of the cluster to elect a master node and accept user requests. To prevent multiple parts of a cluster from being eligible, there must be a [quorum-based majority](/deploy-manage/distributed-architecture/discovery-cluster-formation/modules-discovery-quorums.md) of `(n/2)+1` nodes, where `n` is the number of master-eligible nodes in the cluster. The minimum number of master nodes to reach quorum in a two-node cluster is the same as for a three-node cluster: two nodes must be available.
38+
Tiebreakers are used in distributed clusters to avoid cases of [split brain](https://en.wikipedia.org/wiki/Split-brain_(computing)), where an {{es}} cluster splits into multiple, autonomous parts that continue to handle requests independently of each other, at the risk of affecting cluster consistency and data loss. A split-brain scenario is avoided by making sure that a minimum number of [master-eligible nodes](elasticsearch://reference/elasticsearch/configuration-reference/node-settings.md#master-node) must be present in order for any part of the cluster to elect a master node and accept user requests. To prevent multiple parts of a cluster from being eligible, there must be a [quorum-based majority](/deploy-manage/distributed-architecture/discovery-cluster-formation/modules-discovery-quorums.md) of `(n/2)+1` nodes, where `n` is the number of master-eligible nodes in the cluster. The minimum number of master nodes to reach quorum in a two-node cluster is the same as for a three-node cluster: two nodes must be available.
3939

4040
When you create a cluster with nodes in two availability zones when a third zone is available, ECE can create a tiebreaker in the third availability zone to help establish quorum in case of loss of an availability zone. The extra tiebreaker node that helps to provide quorum does not have to be a full-fledged and expensive node, as it does not hold data. For example: By tagging allocators hosts in ECE, can you create a cluster with eight nodes each in zones `ece-1a` and `ece-1b`, for a total of 16 nodes, and one tiebreaker node in zone `ece-1c`. This cluster can lose any of the three availability zones whilst maintaining quorum, which means that the cluster can continue to process user requests, provided that there is sufficient capacity available when an availability zone goes down.
4141

42-
By default, each node in an {{es}} cluster is a master-eligible node and a data node. In larger clusters, such as production clusters, it’s a good practice to split the roles, so that master nodes are not handling search or indexing work. When you create a cluster, you can specify to use dedicated [master-eligible nodes](asciidocalypse://docs/elasticsearch/docs/reference/elasticsearch/configuration-reference/node-settings.md#master-node), one per availability zone.
42+
By default, each node in an {{es}} cluster is a master-eligible node and a data node. In larger clusters, such as production clusters, it’s a good practice to split the roles, so that master nodes are not handling search or indexing work. When you create a cluster, you can specify to use dedicated [master-eligible nodes](elasticsearch://reference/elasticsearch/configuration-reference/node-settings.md#master-node), one per availability zone.
4343

4444
::::{warning}
4545
Clusters that only have two or fewer master-eligible node are not [highly available](/deploy-manage/production-guidance/availability-and-resilience.md) and are at risk of data loss. You must have [at least three master-eligible nodes](/deploy-manage/distributed-architecture/discovery-cluster-formation/modules-discovery-quorums.md).

0 commit comments

Comments
 (0)