Skip to content

Commit d370ff1

Browse files
shainaraskasshainaraskas
committed
more"
1 parent 47056c7 commit d370ff1

15 files changed

+115
-119
lines changed

‎deploy-manage/deploy/self-managed.md‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,14 @@ mapped_pages:
55

66
# Self-managed cluster [dependencies-versions]
77

8-
See [Elastic Stack Third-party Dependencices](https://artifacts.elastic.co/reports/dependencies/dependencies-current.md) for the complete list of dependencies for {{es}}.
8+
See [Elastic Stack Third-party Dependencices](https://artifacts.elastic.co/reports/dependencies/dependencies-current.md) for the complete list of dependencies for {{es}}.
9+
10+
11+
```sh
12+
{{stack-version}}
13+
```
14+
15+
{{stack-version}}
16+
17+
1. Compares the SHA of the downloaded `.tar.gz` archive and the published checksum, which should output `elasticsearch-<version>-linux-x86_64.tar.gz: OK`.
18+
2. This directory is known as `$ES_HOME`.

‎deploy-manage/deploy/self-managed/_snippets/auto-security-config.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
When you start {{es}} for the first time, the following security configuration occurs automatically:
2+
3+
* [Certificates and keys](../../../deploy-manage/security/security-certificates-keys.md#stack-security-certificates) for TLS are generated for the transport and HTTP layers.
4+
* The TLS configuration settings are written to `elasticsearch.yml`.
5+
* A password is generated for the `elastic` user.
6+
* An enrollment token is generated for {{kib}}, which is valid for 30 minutes.
7+
8+
You can then start {{kib}} and enter the enrollment token. This token automatically applies the security settings from your {{es}} cluster, authenticates to {{es}} with the built-in `kibana` service account, and writes the security configuration to `kibana.yml`.
9+
10+
::::{note}
11+
There are [some cases](../../../deploy-manage/security/security-certificates-keys.md#stack-skip-auto-configuration) where security can’t be configured automatically because the node startup process detects that the node is already part of a cluster, or that security is already configured or explicitly disabled.
12+
::::

‎deploy-manage/deploy/self-managed/_snippets/check-es-running.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
You can test that your {{es}} node is running by sending an HTTPS request to port `9200` on `localhost`:
22

33
```sh
4-
curl --cacert {{es-conf}}{{slash}}certs{{slash}}http_ca.crt -u elastic:$ELASTIC_PASSWORD https://localhost:9200 <1>
4+
curl --cacert {{es-conf}}{{slash}}certs{{slash}}http_ca.crt {{escape}} <1>
5+
-u elastic:$ELASTIC_PASSWORD https://localhost:9200 <2>
56
```
6-
7-
1. Ensure that you use `https` in your call, or the request will fail.`--cacert`
8-
: Path to the generated `http_ca.crt` certificate for the HTTP layer.
7+
1. `--cacert`: Path to the generated `http_ca.crt` certificate for the HTTP layer.
8+
2. Ensure that you use `https` in your call, or the request will fail.
99

1010

1111

deploy-manage/deploy/self-managed/_snippets/other-versions.md renamed to deploy-manage/deploy/self-managed/_snippets/es-releases.md

File renamed without changes.

‎deploy-manage/deploy/self-managed/_snippets/pw-env-var.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
The password for the `elastic` user and the enrollment token for {{kib}} are output to your terminal.
2+
3+
We recommend storing the `elastic` password as an environment variable in your shell. For example:
4+
5+
```sh
6+
{{export}}ELASTIC_PASSWORD="your_password"
7+
```
8+
9+
If you have password-protected the {{es}} keystore, you will be prompted to enter the keystore’s password. See [Secure settings](../../security/secure-settings.md) for more details.
10+
11+
To learn how to reset this password, refer to [](/deploy-manage/users-roles/cluster-or-deployment-auth/built-in-sm.md).

‎deploy-manage/deploy/self-managed/_snippets/start-security-enabled.md‎

Lines changed: 0 additions & 14 deletions
This file was deleted.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ sudo journalctl --unit elasticsearch --since "2016-10-30 18:17:16"
4747

4848
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.
4949

50-
::::{admonition} Startup timeouts with older `systemd` versions
50+
::::{admonition} Startup timeouts with older systemd versions
5151
:class: tip
5252

5353
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.

‎deploy-manage/deploy/self-managed/_snippets/targz-start.md‎

Lines changed: 1 addition & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,24 +3,7 @@ Run the following command to start {{es}} from the command line:
33
```sh
44
./bin/elasticsearch
55
```
6-
7-
When starting {{es}} for the first time, security features are enabled and configured by default. The following security configuration occurs automatically:
8-
9-
* Authentication and authorization are enabled, and a password is generated for the `elastic` built-in superuser.
10-
* Certificates and keys for TLS are generated for the transport and HTTP layer, and TLS is enabled and configured with these keys and certificates.
11-
* An enrollment token is generated for {{kib}}, which is valid for 30 minutes.
12-
13-
The password for the `elastic` user and the enrollment token for {{kib}} are output to your terminal.
14-
15-
We recommend storing the `elastic` password as an environment variable in your shell. Example:
16-
17-
```sh
18-
export ELASTIC_PASSWORD="your_password"
19-
```
20-
21-
If you have password-protected the {{es}} keystore, you will be prompted to enter the keystore’s password. See [Secure settings](../../security/secure-settings.md) for more details.
22-
23-
By default {{es}} prints its logs to the console (`stdout`) and to the `<cluster name>.log` file within the [logs directory](important-settings-configuration.md#path-settings). {{es}} logs some information while it is starting, but after it has finished initializing it will continue to run in the foreground and won’t log anything further until something happens that is worth recording. While {{es}} is running you can interact with it through its HTTP interface which is on port `9200` by default.
6+
By default, {{es}} prints its logs to the console (`stdout`) and to the `<cluster name>.log` file within the [logs directory](important-settings-configuration.md#path-settings). {{es}} logs some information while it is starting, but after it has finished initializing it will continue to run in the foreground and won’t log anything further until something happens that is worth recording. While {{es}} is running you can interact with it through its HTTP interface which is on port `9200` by default.
247

258
To stop {{es}}, press `Ctrl-C`.
269

‎deploy-manage/deploy/self-managed/_snippets/zip-windows-start.md‎

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,6 @@ Run the following command to start {{es}} from the command line:
44
.\bin\elasticsearch.bat
55
```
66

7-
When starting {{es}} for the first time, security features are enabled and configured by default. The following security configuration occurs automatically:
8-
9-
* Authentication and authorization are enabled, and a password is generated for the `elastic` built-in superuser.
10-
* Certificates and keys for TLS are generated for the transport and HTTP layer, and TLS is enabled and configured with these keys and certificates.
11-
* An enrollment token is generated for {{kib}}, which is valid for 30 minutes.
12-
13-
The password for the `elastic` user and the enrollment token for {{kib}} are output to your terminal.
14-
15-
We recommend storing the `elastic` password as an environment variable in your shell. Example:
16-
17-
```sh
18-
$ELASTIC_PASSWORD = "your_password"
19-
```
20-
21-
If you have password-protected the {{es}} keystore, you will be prompted to enter the keystore’s password. See [Secure settings](../../security/secure-settings.md) for more details.
22-
237
By default {{es}} prints its logs to the console (`STDOUT`) and to the `<cluster name>.log` file within the [logs directory](important-settings-configuration.md#path-settings). {{es}} logs some information while it is starting, but after it has finished initializing it will continue to run in the foreground and won’t log anything further until something happens that is worth recording. While {{es}} is running you can interact with it through its HTTP interface which is on port `9200` by default.
248

259
To stop {{es}}, press `Ctrl-C`.

‎deploy-manage/deploy/self-managed/install-elasticsearch-from-archive-on-linux-macos.md‎

Lines changed: 43 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ mapped_pages:
44
sub:
55
es-conf: "$ES_HOME/config"
66
slash: "/"
7+
export: "export"
8+
escape: "\\"
79
navigation_title: "Linux or MacOS"
810
---
911

@@ -14,15 +16,19 @@ navigation_title: "Linux or MacOS"
1416
:::{include} _snippets/trial.md
1517
:::
1618

17-
:::{include} _snippets/other-versions.md
19+
:::{include} _snippets/es-releases.md
1820
:::
1921

2022
::::{note}
2123
{{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)
2224
::::
2325

2426

25-
## Download and install archive for Linux [install-linux]
27+
## Step 1: Download and install the archive
28+
29+
Download and install the archive for Linux or MacOS.
30+
31+
### Linux [install-linux]
2632

2733
The Linux archive for {{es}} {{stack-version}} can be downloaded and installed as follows:
2834

@@ -34,12 +40,24 @@ tar -xzf elasticsearch-{{stack-version}}-linux-x86_64.tar.gz
3440
cd elasticsearch-{{stack-version}}/ <2>
3541
```
3642

37-
1. Compares the SHA of the downloaded `.tar.gz` archive and the published checksum, which should output `elasticsearch-{{stack-version}}-linux-x86_64.tar.gz: OK`.
43+
1. Compares the SHA of the downloaded `.tar.gz` archive and the published checksum, which should output `elasticsearch-<version>-linux-x86_64.tar.gz: OK`.
3844
2. This directory is known as `$ES_HOME`.
3945

4046

4147

42-
## Download and install archive for MacOS [install-macos]
48+
### MacOS [install-macos]
49+
50+
The MacOS archive for {{es}} {{stack-version}} can be downloaded and installed as follows:
51+
52+
```sh
53+
curl -O https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{{stack-version}}-darwin-x86_64.tar.gz
54+
curl https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{{stack-version}}-darwin-x86_64.tar.gz.sha512 | shasum -a 512 -c - <1>
55+
tar -xzf elasticsearch-{{stack-version}}-darwin-x86_64.tar.gz
56+
cd elasticsearch-{{stack-version}}/ <2>
57+
```
58+
59+
1. Compares the SHA of the downloaded `.tar.gz` archive and the published checksum, which should output `elasticsearch-<version>-darwin-x86_64.tar.gz: OK`.
60+
2. This directory is known as `$ES_HOME`.
4361

4462
::::{admonition} macOS Gatekeeper warnings
4563
:class: important
@@ -53,45 +71,47 @@ xattr -d -r com.apple.quarantine <archive-or-directory>
5371
```
5472

5573
Alternatively, you can add a security override by following the instructions in the *If you want to open an app that hasn’t been notarized or is from an unidentified developer* section of [Safely open apps on your Mac](https://support.apple.com/en-us/HT202491).
56-
5774
::::
5875

76+
## Step 2: Enable automatic creation of system indices [targz-enable-indices]
5977

60-
The MacOS archive for {{es}} {{stack-version}} can be downloaded and installed as follows:
78+
:::{include} _snippets/enable-auto-indices.md
79+
:::
6180

62-
```sh
63-
curl -O https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{{stack-version}}-darwin-x86_64.tar.gz
64-
curl https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{{stack-version}}-darwin-x86_64.tar.gz.sha512 | shasum -a 512 -c - <1>
65-
tar -xzf elasticsearch-{{stack-version}}-darwin-x86_64.tar.gz
66-
cd elasticsearch-{{stack-version}}/ <2>
67-
```
81+
## Step 3: Start {{es}} [targz-running]
6882

69-
1. Compares the SHA of the downloaded `.tar.gz` archive and the published checksum, which should output `elasticsearch-{{version}}-darwin-x86_64.tar.gz: OK`.
70-
2. This directory is known as `$ES_HOME`.
83+
You have several options for starting {{es}}
7184

72-
## Enable automatic creation of system indices [targz-enable-indices]
85+
* [Run from the command line](#command-line)
86+
* [Run the node to be enrolled in an existing cluster](#existing-cluster)
87+
* [Run as a daemon](#setup-installation-daemon)
7388

74-
:::{include} _snippets/enable-auto-indices.md
89+
### Run {{es}} from the command line [command-line]
90+
91+
:::{include} _snippets/targz-start.md
7592
:::
7693

77-
## Run {{es}} from the command line [targz-running]
94+
#### Security at startup [security-at-startup]
7895

79-
:::{include} _snippets/targz-start.md
96+
:::{include} _snippets/auto-security-config.md
97+
:::
98+
99+
:::{include} _snippets/pw-env-var.md
80100
:::
81101

82-
### Enroll nodes in an existing cluster [_enroll_nodes_in_an_existing_cluster_2]
102+
### Enroll the node in an existing cluster [existing-cluster]
83103

84104
:::{include} _snippets/enroll-nodes.md
85105
:::
86106

87-
## Check that {{es}} is running [_check_that_elasticsearch_is_running]
107+
### Run as a daemon [setup-installation-daemon]
88108

89-
:::{include} _snippets/check-es-running.md
109+
:::{include} _snippets/targz-daemon.md
90110
:::
91111

92-
## Run as a daemon [setup-installation-daemon]
112+
## Step 4: Check that {{es}} is running [_check_that_elasticsearch_is_running]
93113

94-
:::{include} _snippets/targz-daemon.md
114+
:::{include} _snippets/check-es-running.md
95115
:::
96116

97117
## Configure {{es}} on the command line [targz-configuring]

0 commit comments

Comments
 (0)