Skip to content

Commit 4fe35e9

Browse files
committed
getting closer
1 parent aba29a1 commit 4fe35e9

28 files changed

+220
-190
lines changed
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
If you're deploying the {{stack}} in a self-managed cluster, then install the {{stack}} products you want to use in the following order:
2+
3+
* {{es}}
4+
* {{kib}}
5+
* [Logstash](logstash://reference/index.md)
6+
* [{{agent}}](/reference/ingestion-tools/fleet.md) or [Beats](asciidocalypse://docs/beats/docs/reference/index.md)
7+
* [APM](/solutions/observability/apps/application-performance-monitoring-apm.md)
8+
* [Elasticsearch Hadoop](elasticsearch-hadoop://reference/index.md)
9+
10+
Installing in this order ensures that the components each product depends on are in place.
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
When installing the {{stack}}, you must use the same version across the entire stack. For example, if you are using {{es}} {{stack-version}}, you install Beats {{stack-version}}, APM Server {{stack-version}}, Elasticsearch Hadoop {{stack-version}}, {{kib}} {{stack-version}}, and Logstash {{stack-version}}.
2+
3+
If you’re upgrading an existing installation, see [](/deploy-manage/upgrade.md) for information about how to ensure compatibility with {{stack-version}}.

deploy-manage/deploy/cloud-enterprise/configure-host-ubuntu.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ You can specify `--log-opt max-size` and `--log-opt max-file` to define the Dock
238238
239239
1. Update `/etc/systemd/system/docker.service.d/docker.conf`. If the file path and file do not exist, create them first.
240240
241-
```sh
241+
```ini
242242
[Unit]
243243
Description=Docker Service
244244
After=multi-user.target

deploy-manage/deploy/self-managed.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ mapped_pages:
33
- https://www.elastic.co/guide/en/elasticsearch/reference/current/dependencies-versions.html
44
sub:
55
stack-version: "9.0.0"
6+
applies_to:
7+
deployment:
8+
self:
69
---
710

811
# Self-managed cluster
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
In production, we recommend you run {{es}} on a dedicated host or as a primary service. Several {{es}} features, such as automatic JVM heap sizing, assume that {{es}} is the only resource-intensive application on the host or container. For example, you might run {{metricbeat}} alongside {{es}} for cluster statistics, but a resource-heavy {{ls}} deployment should be on its own host.

deploy-manage/deploy/self-managed/_snippets/enroll-nodes.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,6 @@ To enroll new nodes in your cluster, create an enrollment token with the `elasti
2626
config{{slash}}certs
2727
```
2828

29-
3. Repeat the previous step for any new nodes that you want to enroll.
29+
3. Repeat the previous step for any new nodes that you want to enroll.
30+
31+
For more information about discovery and shard allocation, refer to [Discovery and cluster formation](../distributed-architecture/discovery-cluster-formation.md) and [Cluster-level shard allocation and routing settings](elasticsearch://reference/elasticsearch/configuration-reference/cluster-level-shard-allocation-routing-settings.md).

deploy-manage/deploy/self-managed/access-kibana.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,14 @@ Access {{kib}} through the web application on port 5601.
1515
3. Go to the home page, then click **{{kib}}**.
1616
4. To make the {{kib}} page your landing page, click **Make this my landing page**.
1717

18+
## Grant other users access to {{kib}}
19+
20+
{{kib}} leverages {{es}} authentication and authorization technologies to secure access.
21+
22+
To learn about authentication options, refer to [](/deploy-manage/users-roles/cluster-or-deployment-auth/user-authentication.md).
23+
24+
To learn how to enable authentication providers for {{kib}}, refer to [](/deploy-manage/users-roles/cluster-or-deployment-auth/kibana-authentication.md).
25+
1826
## Resources
1927

2028
* [Troubleshoot: Check {{kib}} server status](/troubleshoot/kibana/access.md)

deploy-manage/deploy/self-managed/configure-kibana.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,10 @@ Environment variables can be injected into configuration using `${MY_ENV_VAR}` s
2626

2727
## Available settings
2828

29-
For a complete list of settings that you can apply to {{kib}}, refer to [{{kib}} configuration reference](kibana:///reference/configuration-reference.md).
29+
For a complete list of settings that you can apply to {{kib}}, refer to [{{kib}} configuration reference](kibana:///reference/configuration-reference.md).
30+
31+
32+
* Link to areas to configure SSL certificates to encrypt client browsers communications (HTTPS) --> This is a bit unclear and difficult as the HTTPS endpoint configuration in Kibana appears in Elasticsearch documentation.
33+
* Link to "Secure access to Kibana" elastic.co/guide/en/kibana/current/tutorial-secure-access-to-kibana.html
34+
* Link to Use Kibana in production (with load balancers): elastic.co/guide/en/kibana/current/production.html
35+
* Link to doc about using more than 1 Kibana instance? (not sure if it exists though)

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

Lines changed: 85 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,105 @@
11
---
22
mapped_urls:
3-
- https://www.elastic.co/guide/en/elasticsearch/reference/current/elasticsearch-intro-deploy.html
43
- https://www.elastic.co/guide/en/elasticsearch/reference/current/setup.html
54
- https://www.elastic.co/guide/en/elastic-stack/current/installing-elastic-stack.html
5+
- https://www.elastic.co/guide/en/elasticsearch/reference/current/install-elasticsearch.html
6+
- https://www.elastic.co/guide/en/elasticsearch/reference/current/configuring-stack-security.html
7+
sub:
8+
stack-version: "9.0.0"
9+
applies_to:
10+
deployment:
11+
self:
612
---
713

814
# Deploy an {{es}} cluster
915

10-
% What needs to be done: Refine
16+
% Doesn't exist
17+
% * [/raw-migrated-files/stack-docs/elastic-stack/installing-elastic-stack.md](/raw-migrated-files/stack-docs/elastic-stack/installing-elastic-stack.md)
1118

12-
% GitHub issue: https://github.com/elastic/docs-projects/issues/340
1319

14-
% Scope notes: Work with the previous content to explain the different options to install {{es}} and Kibana, remove the references to cloud based installation. cover ES + kibana - install of other stack components should be taken care of in that content set hints about install order (First ES then Kib). Add an introduction also to the installation methods (locally, production, multiple OSs).
20+
This section includes information on how to set up {{es}} and get it running, including:
1521

16-
% Use migrated content from existing pages that map to this page:
22+
* [Configuring your system to support {{es}}](/deploy-manage/deploy/self-managed/important-system-configuration.md), and the [bootstrap checks](/deploy-manage/deploy/self-managed/bootstrap-checks.md) that are run at startup to verify these configurations
23+
* Downloading, installing, and starting {{es}} using each [supported installation method](#installation-methods)
1724

18-
% - [ ] ./raw-migrated-files/elasticsearch/elasticsearch-reference/elasticsearch-intro-deploy.md
19-
% - [ ] ./raw-migrated-files/elasticsearch/elasticsearch-reference/setup.md
20-
% - [ ] ./raw-migrated-files/stack-docs/elastic-stack/installing-elastic-stack.md
21-
% Notes: 1-5
25+
To quickly set up {{es}} and {{kib}} in Docker for local development or testing, jump to [](/deploy-manage/deploy/self-managed/local-development-installation-quickstart.md).
2226

23-
$$$dedicated-host$$$
27+
## Installation methods
2428

25-
**This page is a work in progress.** The documentation team is working to combine content pulled from the following pages:
29+
If you want to install and manage {{es}} yourself, you can:
2630

27-
* [/raw-migrated-files/elasticsearch/elasticsearch-reference/elasticsearch-intro-deploy.md]
28-
* [/raw-migrated-files/elasticsearch/elasticsearch-reference/setup.md](/raw-migrated-files/elasticsearch/elasticsearch-reference/setup.md)
31+
* Run {{es}} using a [Linux, MacOS, or Windows install package](/deploy-manage/deploy/self-managed/installing-elasticsearch.md#elasticsearch-install-packages).
32+
* Run {{es}} in a [Docker container](/deploy-manage/deploy/self-managed/installing-elasticsearch.md#elasticsearch-docker-images).
2933

30-
% Doesn't exist
31-
% * [/raw-migrated-files/stack-docs/elastic-stack/installing-elastic-stack.md](/raw-migrated-files/stack-docs/elastic-stack/installing-elastic-stack.md)
34+
::::{tip}
35+
To try out {{stack}} on your own machine, we recommend using Docker and running both {{es}} and {{kib}}. For more information, see [](/deploy-manage/deploy/self-managed/local-development-installation-quickstart.md). This setup is not suitable for production use.
36+
::::
37+
38+
::::{admonition} Use dedicated hosts
39+
:::{include} _snippets/dedicated-hosts.md
40+
:::
41+
::::
42+
43+
### {{es}} install packages [elasticsearch-install-packages]
44+
45+
{{es}} is provided in the following package formats.
46+
47+
Each linked guide provides the following details:
48+
49+
* Download and installation instructions
50+
* Information on enrolling a newly installed node in an existing cluster
51+
* Instructions on starting {{es}} manually and, if applicable, as a service or daemon
52+
* Instructions on connecting clients to your new cluster
53+
* Archive or package contents information
54+
* Security certificate and key information
55+
56+
Before you start, make sure that you [configure your system](/deploy-manage/deploy/self-managed/important-system-configuration.md).
57+
58+
| Format | Description | Instructions |
59+
| --- | --- | --- |
60+
| Linux and MacOS `tar.gz` archives | The `tar.gz` archives are available for installation on any Linux distribution and MacOS. | [Install {{es}} from archive on Linux or MacOS](/deploy-manage/deploy/self-managed/install-elasticsearch-from-archive-on-linux-macos.md) |
61+
| Windows `.zip` archive | The `zip` archive is suitable for installation on Windows. | [Install {{es}} with `.zip` on Windows](/deploy-manage/deploy/self-managed/install-elasticsearch-with-zip-on-windows.md) |
62+
| `deb` | The `deb` package is suitable for Debian, Ubuntu, and other Debian-based systems. Debian packages can be downloaded from the {{es}} website or from our Debian repository. | [Install {{es}} with Debian Package](/deploy-manage/deploy/self-managed/install-elasticsearch-with-debian-package.md) |
63+
| `rpm` | The `rpm` package is suitable for installation on Red Hat, Centos, SLES, OpenSuSE and other RPM-based systems. RPM packages can be downloaded from the {{es}} website or from our RPM repository. | [Install {{es}} with RPM](/deploy-manage/deploy/self-managed/install-elasticsearch-with-rpm.md) |
64+
65+
### {{es}} container images [elasticsearch-docker-images]
66+
67+
You can also run {{es}} inside a docket container image. Docker container images may be downloaded from the Elastic Docker Registry.
68+
69+
[Install {{es}} with Docker](/deploy-manage/deploy/self-managed/install-elasticsearch-with-docker.md)
70+
71+
## Version compatibility
72+
73+
:::{include} /deploy-manage/deploy/_snippets/stack-version-compatibility.md
74+
:::
75+
76+
## Installation order
77+
78+
:::{include} /deploy-manage/deploy/_snippets/installation-order.md
79+
:::
80+
81+
## Supported operating systems and JVMs [supported-platforms]
82+
83+
The matrix of officially supported operating systems and JVMs is available in the [Elastic Support Matrix](https://elastic.co/support/matrix). {{es}} is tested on the listed platforms, but it is possible that it will work on other platforms too.
84+
85+
### Java (JVM) Version [jvm-version]
86+
87+
{{es}} is built using Java, and includes a bundled version of [OpenJDK](https://openjdk.java.net) within each distribution. We strongly recommend using the bundled JVM in all installations of {{es}}.
88+
89+
The bundled JVM is treated the same as any other dependency of {{es}} in terms of support and maintenance. This means that Elastic takes responsibility for keeping it up to date, and reacts to security issues and bug reports as needed to address vulnerabilities and other bugs in {{es}}. Elastic’s support of the bundled JVM is subject to Elastic’s [support policy](https://www.elastic.co/support_policy) and [end-of-life schedule](https://www.elastic.co/support/eol) and is independent of the support policy and end-of-life schedule offered by the original supplier of the JVM. Elastic does not support using the bundled JVM for purposes other than running {{es}}.
90+
91+
::::{tip}
92+
{{es}} uses only a subset of the features offered by the JVM. Bugs and security issues in the bundled JVM often relate to features that {{es}} does not use. Such issues do not apply to {{es}}. Elastic analyzes reports of security vulnerabilities in all its dependencies, including in the bundled JVM, and will issue an [Elastic Security Advisory](https://www.elastic.co/community/security) if such an advisory is needed.
93+
::::
94+
95+
96+
If you decide to run {{es}} using a version of Java that is different from the bundled one, prefer to use the latest release of a [LTS version of Java](https://www.oracle.com/technetwork/java/eol-135779.html) which is [listed in the support matrix](https://elastic.co/support/matrix). Although such a configuration is supported, if you encounter a security issue or other bug in your chosen JVM then Elastic may not be able to help unless the issue is also present in the bundled JVM. Instead, you must seek assistance directly from the supplier of your chosen JVM. You must also take responsibility for reacting to security and bug announcements from the supplier of your chosen JVM. {{es}} may not perform optimally if using a JVM other than the bundled one. {{es}} is closely coupled to certain OpenJDK-specific features, so it may not work correctly with JVMs that are not OpenJDK. {{es}} will refuse to start if you attempt to use a known-bad JVM version.
97+
98+
To use your own version of Java, set the `ES_JAVA_HOME` environment variable to the path to your own JVM installation. The bundled JVM is located within the `jdk` subdirectory of the {{es}} home directory. You may remove this directory if using your own JVM.
3299

100+
:::{warning}
101+
Don’t use third-party Java agents that attach to the JVM. These agents can reduce {{es}} performance, including freezing or crashing nodes.
102+
:::
33103

34104
## Third-party dependencies [dependencies-versions]
35105

deploy-manage/deploy/self-managed/important-settings-configuration.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,10 +53,10 @@ path:
5353
logs: "C:\\Elastic\\Elasticsearch\\logs"
5454
```
5555
::::::
56+
:::::::
5657
5758
{{es}} offers a deprecated setting that allows you to specify multiple paths in `path.data`. To learn about this setting, and how to migrate away from it, refer to [Multiple data paths](asciidocalypse://docs/elasticsearch/docs/reference/elasticsearch/index-settings/path.md#multiple-data-paths).
5859

59-
:::::::
6060
::::{warning}
6161
* Don’t modify anything within the data directory or run processes that might interfere with its contents.
6262

@@ -65,8 +65,6 @@ path:
6565
* Don’t run virus scanners on the data directory. A virus scanner can prevent {{es}} from working correctly and may modify the contents of the data directory. The data directory contains no executables so a virus scan will only find false positives.
6666
::::
6767

68-
Elasticsearch offers a deprecated setting that allows you to specify multiple paths in `path.data`. To learn about this setting, and how to migrate away from it, refer to [Multiple data paths](elasticsearch://reference/elasticsearch/index-settings/path.md#multiple-data-paths).
69-
7068

7169
## Cluster name setting [_cluster_name_setting]
7270

0 commit comments

Comments
 (0)