Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ We recommend using kernel 4.15.x or later on Ubuntu.
To check your kernel version, run `uname -r`.

::::{note}
Elastic Cloud Enterprise is not supported on Linux distributions that use [cgroups](https://man7.org/linux/man-pages/man7/cgroups.7.md) version 2.
Elastic Cloud Enterprise is not supported on Linux distributions that use [cgroups](https://man7.org/linux/man-pages/man7/cgroups.7.html) version 2.
::::


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ You can combine these features to deploy a production-grade Elasticsearch cluste
You can configure Elasticsearch nodes with [one or multiple roles](asciidocalypse://docs/elasticsearch/docs/reference/elasticsearch/configuration-reference/node-settings.md).

::::{tip}
You can use [YAML anchors](https://yaml.org/spec/1.2/spec.md#id2765878) to declare the configuration change once and reuse it across all the node sets.
You can use [YAML anchors](https://yaml.org/spec/1.2/spec.html#id2765878) to declare the configuration change once and reuse it across all the node sets.
::::


Expand Down
6 changes: 3 additions & 3 deletions deploy-manage/deploy/cloud-on-k8s/create-custom-images.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Providing the correct version is always required as ECK reasons about APIs and c
::::


The steps are similar for [Azure Kubernetes Service](https://docs.microsoft.com/en-us/azure/aks/tutorial-kubernetes-prepare-acr) and [AWS Elastic Container Registry](https://docs.aws.amazon.com/AmazonECR/latest/userguide/docker-basics.md#use-ecr).
The steps are similar for [Azure Kubernetes Service](https://docs.microsoft.com/en-us/azure/aks/tutorial-kubernetes-prepare-acr) and [AWS Elastic Container Registry](https://docs.aws.amazon.com/AmazonECR/latest/userguide/docker-basics.html#use-ecr).

If your custom images follow the naming convention adopted by the official images, and you only want to use your custom images, you can also simply [override the container registry](air-gapped-install.md#k8s-container-registry-override).

Expand All @@ -53,6 +53,6 @@ For more information, check the following references:
* [Elasticsearch documentation on Using custom Docker images](/deploy-manage/deploy/self-managed/install-elasticsearch-with-docker.md#_c_customized_image)
* [Google Container Registry](https://cloud.google.com/container-registry/docs/how-to)
* [Azure Container Registry](https://docs.microsoft.com/en-us/azure/container-registry/)
* [Amazon Elastic Container Registry](https://docs.aws.amazon.com/AmazonECR/latest/userguide/what-is-ecr.md)
* [OpenShift Container Platform registry](https://docs.openshift.com/container-platform/4.12/registry/index.md)
* [Amazon Elastic Container Registry](https://docs.aws.amazon.com/AmazonECR/latest/userguide/what-is-ecr.html)
* [OpenShift Container Platform registry](https://docs.openshift.com/container-platform/4.12/registry/index.html)

Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ This section shows how to run ECK on OpenShift.
1. To run the instructions on this page, you must be a `system:admin` user or a user with the privileges to create Projects, CRDs, and RBAC resources at the cluster level.
2. Set virtual memory settings on the Kubernetes nodes.

Before deploying an Elasticsearch cluster with ECK, make sure that the Kubernetes nodes in your cluster have the correct `vm.max_map_count` sysctl setting applied. By default, Pods created by ECK are likely to run with the `restricted` [Security Context Constraint](https://docs.openshift.com/container-platform/4.12/authentication/managing-security-context-constraints.md) (SCC) which restricts privileged access required to change this setting in the underlying Kubernetes nodes.
Before deploying an Elasticsearch cluster with ECK, make sure that the Kubernetes nodes in your cluster have the correct `vm.max_map_count` sysctl setting applied. By default, Pods created by ECK are likely to run with the `restricted` [Security Context Constraint](https://docs.openshift.com/container-platform/4.12/authentication/managing-security-context-constraints.html) (SCC) which restricts privileged access required to change this setting in the underlying Kubernetes nodes.

Alternatively, you can opt for setting `node.store.allow_mmap: false` at the [Elasticsearch node configuration](node-configuration.md) level. This has performance implications and is not recommended for production workloads.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ mapped_pages:
Use the following code to create an Elasticsearch cluster `elasticsearch-sample` and a "passthrough" route to access it:

::::{note}
A namespace other than the default namespaces (default, kube-system, kube-**, openshift-**, etc) is required such that default [Security Context Constraint](https://docs.openshift.com/container-platform/4.12/authentication/managing-security-context-constraints.md) (SCC) permissions are applied automatically. Elastic resources will not work properly in any of the default namespaces.
A namespace other than the default namespaces (default, kube-system, kube-**, openshift-**, etc) is required such that default [Security Context Constraint](https://docs.openshift.com/container-platform/4.12/authentication/managing-security-context-constraints.html) (SCC) permissions are applied automatically. Elastic resources will not work properly in any of the default namespaces.
::::


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ This page shows the installation steps to deploy ECK in Openshift:

3. Create a namespace to hold the Elastic resources (Elasticsearch, Kibana, APM Server, Beats, Elastic Agent, Elastic Maps Server, and Logstash):
::::{note}
A namespace other than the default namespaces (default, kube-\*, openshift-\*, etc) is required such that default [Security Context Constraint](https://docs.openshift.com/container-platform/4.12/authentication/managing-security-context-constraints.md) (SCC) permissions are applied automatically. Elastic resources will not work properly in any of the default namespaces.
A namespace other than the default namespaces (default, kube-\*, openshift-\*, etc) is required such that default [Security Context Constraint](https://docs.openshift.com/container-platform/4.12/authentication/managing-security-context-constraints.html) (SCC) permissions are applied automatically. Elastic resources will not work properly in any of the default namespaces.
::::

```sh
Expand Down
2 changes: 1 addition & 1 deletion deploy-manage/deploy/cloud-on-k8s/nodes-orchestration.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ This section covers the following topics:
NodeSets are used to specify the topology of the Elasticsearch cluster. Each NodeSet represents a group of Elasticsearch nodes that share the same Elasticsearch configuration and Kubernetes Pod configuration.

::::{tip}
You can use [YAML anchors](https://yaml.org/spec/1.2/spec.md#id2765878) to declare the configuration change once and reuse it across all the node sets.
You can use [YAML anchors](https://yaml.org/spec/1.2/spec.html#id2765878) to declare the configuration change once and reuse it across all the node sets.
::::


Expand Down
2 changes: 1 addition & 1 deletion deploy-manage/deploy/self-managed.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ mapped_pages:

# Self-managed cluster [dependencies-versions]

See [Elastic Stack Third-party Dependencices](https://artifacts.elastic.co/reports/dependencies/dependencies-current.md) for the complete list of dependencies for {{es}}.
See [Elastic Stack Third-party Dependencices](https://artifacts.elastic.co/reports/dependencies/dependencies-current.html) for the complete list of dependencies for {{es}}.
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ To resolve these problems, either remove the `noexec` option from your `/tmp` fi
If you need finer control over the location of these temporary files, you can also configure the path that JNA uses with the [JVM flag](asciidocalypse://docs/elasticsearch/docs/reference/elasticsearch/jvm-settings.md#set-jvm-options) `-Djna.tmpdir=<path>` and you can configure the path that `libffi` uses for its temporary files by setting the `LIBFFI_TMPDIR` environment variable. Future versions of {{es}} may need additional configuration, so you should prefer to set `ES_TMPDIR` wherever possible.

::::{note}
{{es}} does not remove its temporary directory. You should remove leftover temporary directories while {{es}} is not running. It is best to do this automatically, for instance on each reboot. If you are running on Linux, you can achieve this by using the [tmpfs](https://www.kernel.org/doc/html/latest/filesystems/tmpfs.md) file system.
{{es}} does not remove its temporary directory. You should remove leftover temporary directories while {{es}} is not running. It is best to do this automatically, for instance on each reboot. If you are running on Linux, you can achieve this by using the [tmpfs](https://www.kernel.org/doc/html/latest/filesystems/tmpfs.html) file system.
::::


Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ By default, {{es}} enables garbage collection (GC) logs. These are configured in

You can reconfigure JVM logging using the command line options described in [JEP 158: Unified JVM Logging](https://openjdk.java.net/jeps/158). Unless you change the default `jvm.options` file directly, the {{es}} default configuration is applied in addition to your own settings. To disable the default configuration, first disable logging by supplying the `-Xlog:disable` option, then supply your own command line options. This disables *all* JVM logging, so be sure to review the available options and enable everything that you require.

To see further options not contained in the original JEP, see [Enable Logging with the JVM Unified Logging Framework](https://docs.oracle.com/en/java/javase/13/docs/specs/man/java.md#enable-logging-with-the-jvm-unified-logging-framework).
To see further options not contained in the original JEP, see [Enable Logging with the JVM Unified Logging Framework](https://docs.oracle.com/en/java/javase/13/docs/specs/man/java.html#enable-logging-with-the-jvm-unified-logging-framework).


### Examples [_examples]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ To list journal entries for the elasticsearch service starting from a given time
sudo journalctl --unit elasticsearch --since "2016-10-30 18:17:16"
```

Check `man journalctl` or [https://www.freedesktop.org/software/systemd/man/journalctl.html](https://www.freedesktop.org/software/systemd/man/journalctl.md) for more command line options.
Check `man journalctl` or [https://www.freedesktop.org/software/systemd/man/journalctl.html](https://www.freedesktop.org/software/systemd/man/journalctl.html) for more command line options.

::::{admonition} Startup timeouts with older `systemd` versions
:class: tip
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -397,7 +397,7 @@ vm.max_map_count = 262144
By default, {{es}} runs inside the container as user `elasticsearch` using uid:gid `1000:0`.

::::{important}
One exception is [Openshift](https://docs.openshift.com/container-platform/3.6/creating_images/guidelines.md#openshift-specific-guidelines), which runs containers using an arbitrarily assigned user ID. Openshift presents persistent volumes with the gid set to `0`, which works without any adjustments.
One exception is [Openshift](https://docs.openshift.com/container-platform/3.6/creating_images/guidelines.html#openshift-specific-guidelines), which runs containers using an arbitrarily assigned user ID. Openshift presents persistent volumes with the gid set to `0`, which works without any adjustments.
::::


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ To list journal entries for the elasticsearch service starting from a given time
sudo journalctl --unit elasticsearch --since "2016-10-30 18:17:16"
```

Check `man journalctl` or [https://www.freedesktop.org/software/systemd/man/journalctl.html](https://www.freedesktop.org/software/systemd/man/journalctl.md) for more command line options.
Check `man journalctl` or [https://www.freedesktop.org/software/systemd/man/journalctl.html](https://www.freedesktop.org/software/systemd/man/journalctl.html) for more command line options.

::::{admonition} Startup timeouts with older `systemd` versions
:class: tip
Expand Down
2 changes: 1 addition & 1 deletion deploy-manage/maintenance/ece/pause-instance.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ applies_to:

If an individual instance is experiencing issues, then you can stop it by selecting **Pause instance** from its menu.

Pausing an instance immediately suspends the container without completing existing requests by running either [Docker `stop`](https://docs.docker.com/reference/cli/docker/container/stop/) or [Podman `stop`](https://docs.podman.io/en/stable/markdown/podman-stop.1.md), as applicable. The instance will then be marked as **Paused**.
Pausing an instance immediately suspends the container without completing existing requests by running either [Docker `stop`](https://docs.docker.com/reference/cli/docker/container/stop/) or [Podman `stop`](https://docs.podman.io/en/stable/markdown/podman-stop.1.html), as applicable. The instance will then be marked as **Paused**.

You can start an instance by selecting **Resume instance** from the menu.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ To list journal entries for the elasticsearch service starting from a given time
sudo journalctl --unit elasticsearch --since "2016-10-30 18:17:16"
```

Check `man journalctl` or [https://www.freedesktop.org/software/systemd/man/journalctl.html](https://www.freedesktop.org/software/systemd/man/journalctl.md) for more command line options.
Check `man journalctl` or [https://www.freedesktop.org/software/systemd/man/journalctl.html](https://www.freedesktop.org/software/systemd/man/journalctl.html) for more command line options.

::::{admonition} Startup timeouts with older `systemd` versions
:class: tip
Expand Down Expand Up @@ -240,7 +240,7 @@ To list journal entries for the elasticsearch service starting from a given time
sudo journalctl --unit elasticsearch --since "2016-10-30 18:17:16"
```

Check `man journalctl` or [https://www.freedesktop.org/software/systemd/man/journalctl.html](https://www.freedesktop.org/software/systemd/man/journalctl.md) for more command line options.
Check `man journalctl` or [https://www.freedesktop.org/software/systemd/man/journalctl.html](https://www.freedesktop.org/software/systemd/man/journalctl.html) for more command line options.

::::{admonition} Startup timeouts with older `systemd` versions
:class: tip
Expand Down
Loading