so much stuff

Author: shainaraskas

deploy-manage/deploy/self-managed/_snippets/cmd-line-config.md

@@ -0,0 +1,21 @@
+{{es}} loads its configuration from the following location by default:
+
+```
+{{es-conf}}{{slash}}elasticsearch.yml
+```
+
+The format of this config file is explained in [](/deploy-manage/deploy/self-managed/configure-elasticsearch.md).
+
+Any settings that can be specified in the config file can also be specified on the command line, using the `-E` syntax as follows:
+
+```sh
+.\bin\elasticsearch.bat -Ecluster.name=my_cluster -Enode.name=node_1
+```
+
+:::{note}
+Values that contain spaces must be surrounded with quotes. For instance `-Epath.logs="C:\My Logs\logs"`.
+:::
+
+:::{tip}
+Typically, any cluster-wide settings (like `cluster.name`) should be added to the `elasticsearch.yml` config file, while any node-specific settings such as `node.name` could be specified on the command line.
+::::

deploy-manage/deploy/self-managed/_snippets/etc-elasticsearch.md

@@ -1,23 +1,18 @@
 The `/etc/elasticsearch` directory contains the default runtime configuration for {{es}}. The ownership of this directory and all contained files are set to `root:elasticsearch` on package installations.
 
-The `setgid` flag applies group permissions on the `/etc/elasticsearch` directory to ensure that {{es}} can read any contained files and subdirectories. All files and subdirectories inherit the `root:elasticsearch` ownership. Running commands from this directory or any subdirectories, such as the [elasticsearch-keystore tool](../../security/secure-settings.md), requires `root:elasticsearch` permissions.
+The `setgid` flag applies group permissions on the `/etc/elasticsearch` directory to ensure that {{es}} can read any contained files and subdirectories. All files and subdirectories inherit the `root:elasticsearch` ownership. Running commands from this directory or any subdirectories, such as the [elasticsearch-keystore tool](/deploy-manage/security/secure-settings.md), requires `root:elasticsearch` permissions.
 
-{{es}} loads its configuration from the `/etc/elasticsearch/elasticsearch.yml` file by default. The format of this config file is explained in [*Configuring {{es}}*](configure-elasticsearch.md).
+{{es}} loads its configuration from the `/etc/elasticsearch/elasticsearch.yml` file by default. The format of this config file is explained in [](/deploy-manage/deploy/self-managed/configure-elasticsearch.md).
 
 The {{distro}} package also has a system configuration file (`/etc/sysconfig/elasticsearch`), which allows you to set the following parameters:
 
-`ES_JAVA_HOME`
-:   Set a custom Java path to be used.
-
-`ES_PATH_CONF`
-:   Configuration file directory (which needs to include `elasticsearch.yml`, `jvm.options`, and `log4j2.properties` files); defaults to `/etc/elasticsearch`.
-
-`ES_JAVA_OPTS`
-:   Any additional JVM system properties you may want to apply.
-
-`RESTART_ON_UPGRADE`
-:   Configure restart on package upgrade, defaults to `false`. This means you will have to restart your {{es}} instance after installing a package manually. The reason for this is to ensure, that upgrades in a cluster do not result in a continuous shard reallocation resulting in high network traffic and reducing the response times of your cluster.
+| Parameter | Description |
+| --- | --- |
+| `ES_JAVA_HOME` | Set a custom Java path to be used. |
+| `ES_PATH_CONF` | Configuration file directory (which needs to include `elasticsearch.yml`, `jvm.options`, and `log4j2.properties` files); defaults to `/etc/elasticsearch`. |
+| `ES_JAVA_OPTS` | Any additional JVM system properties you may want to apply. |
+| `RESTART_ON_UPGRADE` | Configure restart on package upgrade, defaults to `false`. This means you will have to restart your {{es}} instance after installing a package  manually. The reason for this is to ensure, that upgrades in a cluster do not result in a continuous shard reallocation resulting in high network traffic and reducing the response times of your cluster. |
 
 ::::{note}
-Distributions that use `systemd` require that system resource limits be configured via `systemd` rather than via the `/etc/sysconfig/elasticsearch` file. See [Systemd configuration](setting-system-settings.md#systemd) for more information.
+Distributions that use `systemd` require that system resource limits be configured via `systemd` rather than via the `/etc/sysconfig/elasticsearch` file. See [Systemd configuration](/deploy-manage/deploy/self-managed/setting-system-settings.md#systemd) for more information.
 ::::

deploy-manage/deploy/self-managed/_snippets/java-version.md

@@ -0,0 +1,3 @@
+::::{note}
+{{es}} includes a bundled version of [OpenJDK](https://openjdk.java.net) from the JDK maintainers (GPLv2+CE). To use your own version of Java, see the [JVM version requirements](installing-elasticsearch.md#jvm-version).
+::::

deploy-manage/deploy/self-managed/_snippets/prereqs.md

@@ -0,0 +1,4 @@
+Before you install {{es}}, do the following: 
+
+* Review the [supported operating systems](https://www.elastic.co/support/matrix). {{es}} is tested on the listed platforms, but it is possible that it will work on other platforms too.
+* Configure your operating system using the [](/deploy-manage/deploy/self-managed/important-system-configuration.md) guidelines.

deploy-manage/deploy/self-managed/_snippets/security-files.md

@@ -1,4 +1,4 @@
-When you install {{es}}, the following certificates and keys are generated in the {{es}} configuration directory, which are used to connect a {{kib}} instance to your secured {{es}} cluster and to encrypt internode communication. The files are listed here for reference.
+When you install {{es}}, the following certificates and keys are generated in the {{es}} configuration directory. These files are used to connect a {{kib}} instance to your secured {{es}} cluster and to encrypt internode communication. The files are listed here for reference.
 
 `http_ca.crt`
 :   The CA certificate that is used to sign the certificates for the HTTP layer of this {{es}} cluster.

deploy-manage/deploy/self-managed/_snippets/skip-set-kernel-params.md

@@ -1,3 +1,3 @@
 ::::{note}
-On systemd-based distributions, the installation scripts will attempt to set kernel parameters (e.g., `vm.max_map_count`); you can skip this by masking the systemd-sysctl.service unit.
+On systemd-based distributions, the installation scripts will attempt to set kernel parameters (e.g., `vm.max_map_count`). You can skip this by masking the `systemd-sysctl.service` unit.
 ::::

deploy-manage/deploy/self-managed/_snippets/start-local.md

@@ -0,0 +1,46 @@
+::::{warning}
+**DO NOT USE THESE INSTRUCTIONS FOR PRODUCTION DEPLOYMENTS**
+
+The instructions on this page are for **local development only**. Do not use this configuration for production deployments, because it is not secure. Refer to [deployment options](../../get-started/deployment-options.md) for a list of production deployment options.
+
+::::
+
+Quickly set up {{es}} and {{kib}} in Docker for local development or testing, using the [`start-local` script](https://github.com/elastic/start-local?tab=readme-ov-file#-try-elasticsearch-and-kibana-locally).
+
+This setup comes with a one-month trial license that includes all Elastic features. After the trial period, the license reverts to **Free and open - Basic**. Refer to [Elastic subscriptions](https://www.elastic.co/subscriptions) for more information.
+
+## Prerequisites [local-dev-prerequisites]
+
+* If you don’t have Docker installed, [download and install Docker Desktop](https://www.docker.com/products/docker-desktop) for your operating system.
+* If you’re using Microsoft Windows, then install [Windows Subsystem for Linux (WSL)](https://learn.microsoft.com/en-us/windows/wsl/install).
+
+## Run `start-local` script [local-dev-quick-start]
+
+To set up {{es}} and {{kib}} locally, run the `start-local` script:
+
+```sh
+curl -fsSL https://elastic.co/start-local | sh
+```
+
+This script creates an `elastic-start-local` folder containing configuration files and starts both {{es}} and {{kib}} using Docker.
+
+After running the script, you can access Elastic services at the following endpoints:
+
+* **{{es}}**: [http://localhost:9200](http://localhost:9200)
+* **{{kib}}**: [http://localhost:5601](http://localhost:5601)
+
+The script generates a random password for the `elastic` user, and an API key, stored in the `.env` file.
+
+::::{warning}
+This setup is for local testing only. HTTPS is disabled, and Basic authentication is used for {{es}}. For security, {{es}} and {{kib}} are accessible only through `localhost`.
+
+::::
+
+## Learn more [local-dev-additional-info]
+
+For more detailed information about the `start-local` setup, refer to the [README on GitHub](https://github.com/elastic/start-local). Learn about customizing the setup, logging, and more.
+
+
+## Next steps [local-dev-next-steps]
+
+Use our [quick start guides](https://www.elastic.co/guide/en/elasticsearch/reference/current/quickstart.html) to learn the basics of {{es}}.

deploy-manage/deploy/self-managed/_snippets/systemd-journal.md

@@ -0,0 +1,23 @@
+By default, the {{es}} service doesn’t log information in the `systemd` journal. To enable `journalctl` logging, the `--quiet` option must be removed from the `ExecStart` command line in the `elasticsearch.service` file.
+
+When `systemd` logging is enabled, the logging information are available using the `journalctl` commands:
+
+To tail the journal:
+
+```sh
+sudo journalctl -f
+```
+
+To list journal entries for the elasticsearch service:
+
+```sh
+sudo journalctl --unit elasticsearch
+```
+
+To list journal entries for the elasticsearch service starting from a given time:
+
+```sh
+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.

deploy-manage/deploy/self-managed/_snippets/systemd-startup-timeout.md

@@ -0,0 +1,26 @@
+::::{admonition} Startup timeouts with older systemd versions
+:class: tip
+
+By default {{es}} sets the `TimeoutStartSec` parameter to `systemd` to `900s`. If you are running at least version 238 of `systemd`, then {{es}} can automatically extend the startup timeout, and will do so repeatedly until startup is complete even if it takes longer than 900s.
+
+Versions of `systemd` prior to 238 do not support the timeout extension mechanism and will terminate the {{es}} process if it has not fully started up within the configured timeout. If this happens, {{es}} will report in its logs that it was shut down normally a short time after it started:
+
+```text
+[2022-01-31T01:22:31,077][INFO ][o.e.n.Node               ] [instance-0000000123] starting ...
+...
+[2022-01-31T01:37:15,077][INFO ][o.e.n.Node               ] [instance-0000000123] stopping ...
+```
+
+However the `systemd` logs will report that the startup timed out:
+
+```text
+Jan 31 01:22:30 debian systemd[1]: Starting {{es}}...
+Jan 31 01:37:15 debian systemd[1]: elasticsearch.service: Start operation timed out. Terminating.
+Jan 31 01:37:15 debian systemd[1]: elasticsearch.service: Main process exited, code=killed, status=15/TERM
+Jan 31 01:37:15 debian systemd[1]: elasticsearch.service: Failed with result 'timeout'.
+Jan 31 01:37:15 debian systemd[1]: Failed to start {{es}}.
+```
+
+To avoid this, upgrade your `systemd` to at least version 238. You can also temporarily work around the problem by extending the `TimeoutStartSec` parameter.
+
+::::

deploy-manage/deploy/self-managed/_snippets/systemd-startup.md

@@ -0,0 +1,6 @@
+To configure {{es}} to start automatically when the system boots up, run the following commands:
+
+```sh
+sudo /bin/systemctl daemon-reload
+sudo /bin/systemctl enable elasticsearch.service
+```