Skip to content

Commit 992a4ef

Browse files
committed
mess
1 parent de186d8 commit 992a4ef

File tree

2 files changed

+66
-31
lines changed

2 files changed

+66
-31
lines changed

docs/reference/production.asciidoc

Lines changed: 65 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -63,16 +63,18 @@ Refer to the documentation for each deployment method for detailed information a
6363
[discrete]
6464
== Cluster or deployment design
6565

66-
{es} is built to be always available and to scale with your needs. It does this using a distributed architecture. By distributing your cluster, you can keep Elastic online and responsive to requests.
66+
{es} is built to be always available and to scale with your needs. It does this using a distributed architecture. By distributing your cluster, you can keep Elastic online and responsive to requests. Consider the following elements when you design your cluster or deployment.
6767

6868
[discrete]
6969
=== Where to start
7070

7171
Many {es} options come with different performance considerations and trade-offs. The best way to determine the
72-
optimal configuration for your use case is through https://www.elastic.co/elasticon/conf/2016/sf/quantitative-cluster-sizing[testing with your own data and queries]. When you understand the shape and size of your data, as well as your use case, you can make informed decisions about how to configure your cluster.
72+
optimal configuration for your use case is through https://www.elastic.co/elasticon/conf/2016/sf/quantitative-cluster-sizing[testing with your own data and queries]. When you understand the shape and size of your data, as well as your use case, you can make informed decisions about how to configure your cluster.
73+
74+
After you understand your data, use case, and organizational priorities, you can review the guidelines in our <<how-to,Optimizations>> topics to learn how to tune your cluster to meet your needs.
7375

7476
[discrete]
75-
=== Your data retention strategy
77+
=== Data retention strategy
7678

7779
include::{es-ref-dir}/lifecycle-options.asciidoc[]
7880

@@ -81,11 +83,9 @@ You should determine how long you need to retain your data and how you will mana
8183
something about when to use which one?
8284

8385
[discrete]
84-
=== Nodes and shards
85-
86-
When you move to production, you need to introduce multiple nodes and shards to your cluster. Nodes and shards are what make Elasticsearch distributed and scalable.
86+
=== Node and shard configuration
8787

88-
The number of these nodes and shards depends on your data, your use case, and your budget. See <<how-to,Optimizations>> for more information.
88+
When you move to production, you need to introduce multiple nodes and shards to your cluster. Nodes and shards are what make Elasticsearch distributed and scalable. The size and number of these nodes and shards depends on your data, your use case, and your budget.
8989

9090
The way that you manage your nodes and shards depends on your deployment method:
9191

@@ -111,7 +111,7 @@ include::{es-ref-dir}/high-availability-overview.asciidoc[]
111111
// each of these topics needs to be reviewed to mark elements related/unrelated to each deployment type
112112

113113
[discrete]
114-
=== Optimize your cluster for your use case
114+
=== Tuning your cluster
115115

116116
{es} offers many options that allow you to configure your cluster to meet your organization's goals, requirements, and restrictions. Review these guidelines to learn how to tune your cluster to meet your needs. These guidelines cover elements from hardware provision to query optimization.
117117

@@ -126,38 +126,73 @@ include::{es-ref-dir}/high-availability-overview.asciidoc[]
126126
[discrete]
127127
== Security
128128

129-
The {stack} is composed of many moving parts. There are the {es} nodes that form the cluster, plus {ls} instances, {kib} instances, {beats} agents, and clients all communicating with the cluster. In the case of *Elastic Cloud Hosted*, *Elastic Cloud Enterprise*, or *Elastic Cloud Serverless* deployments, you also need to consider the security of the Elastic Cloud instance.
129+
The {stack} is composed of many moving parts. There are the {es} nodes that form the cluster, plus {ls} instances, {kib} instances, {beats} agents, Elastic Agents, and clients all communicating with the cluster.
130130

131+
In the case of *Elastic Cloud Hosted*, *Elastic Cloud Enterprise*, or *Elastic Cloud Serverless* deployments, you also need to consider the security of the Elastic Cloud installation or organization. You also can optionally manage deployment-level user roles from the Cloud UI.
131132

133+
Security comprises the following concerns:
132134

133-
Review the following topics
135+
* *Preventing unauthorized access* with password protection, role-based access control, and IP filtering.
136+
* *Preserving the integrity of your data* with SSL/TLS encryption.
137+
* *Maintaining an audit trail* so you know who's doing what to your cluster and the data it stores.
134138

135-
```
136-
ECE
137-
https://www.elastic.co/guide/en/cloud-enterprise/current/ece-securing-ece.html
138-
https://www.elastic.co/guide/en/cloud-enterprise/current/ece-securing-clusters.html
139-
Elastic Cloud Enterprise supports most of the security features that are part of the Elastic Stack
139+
The technologies and methods that you can use to address these concerns are different depending on your deployment method.
140140

141-
ESS
142-
https://www.elastic.co/guide/en/cloud/current/ec-security.html
143-
https://www.elastic.co/guide/en/cloud/current/ec-organizations.html
141+
Review the following topics to design your security strategy:
144142

145-
SERVERLESS
146-
https://www.elastic.co/guide/en/cloud/current/ec-organizations.html
147-
https://www.elastic.co/guide/en/serverless/current/custom-roles.html
143+
[discrete]
144+
=== Cluster and deployment security
148145

149-
ECK
150-
https://www.elastic.co/guide/en/cloud-on-k8s/current/k8s-securing-stack.html
151-
https://www.elastic.co/guide/en/cloud-on-k8s/current/k8s-fips.html
152-
```
146+
[cols="1,1,1,1",options="header"]
147+
|===
148+
| Deployment method | Documentation
149+
150+
| {serverless-docs}/intro.html[*Elastic Cloud Serverless*]
151+
| {serverless-docs}/general-manage-organization.html[Manage users and roles]<br>{cloud}/ec-saml-sso.html[Configure Elastic Cloud SAML single sign-on]<br>{serverless-docs}/custom-roles.html[Custom roles]
152+
// need to figure out if anything in https://www.elastic.co/guide/en/elasticsearch/reference/current/secure-cluster.html applies
153+
// suspect they have access to anything they can configure through kibana
154+
155+
| {cloud}/ec-getting-started-trial.html[*Elastic Cloud Hosted*]
156+
| {cloud}/ec-security.html[Securing your deployment]<br>{cloud}/ec-organizations.html[Managing your organization]
153157

154-
Enabling security protects {es} clusters by:
158+
| *Elasticsearch Add-On for Heroku*
159+
| https://www.elastic.co/guide/en/cloud-heroku/current/ech-security.html[Securing your deployment]
160+
161+
| {eck-ref}/k8s-overview.html[*Elastic Cloud on Kubernetes*]
162+
| https://www.elastic.co/guide/en/cloud-on-k8s/current/k8s-securing-stack.html
163+
164+
| {ece-ref}/Elastic-Cloud-Enterprise-overview.html[*Elastic Cloud Enterprise*]
165+
| {ece-ref}/ece-security.html[Secure your clusters]
166+
167+
| *<<elasticsearch-deployment-options,Manual on-premise>>*
168+
|
169+
|===
170+
171+
[discrete]
172+
=== Cloud layer security
173+
174+
These pages provide information about securing your Elastic Cloud Enterprise installation or Elastic Cloud organization, as well as managing access to deployments from the Cloud UI.
175+
176+
[cols="1,1,1,1",options="header"]
177+
|===
178+
| Deployment method | Documentation
179+
180+
| {cloud}/ec-getting-started-trial.html[*Elastic Cloud Hosted*]
181+
| {cloud}/ec-organizations.html[Managing your organization]
182+
183+
| {serverless-docs}/intro.html[*Elastic Cloud Serverless*]
184+
| {serverless-docs}/general-manage-organization.html[Manage users and roles]<br>{cloud}/ec-saml-sso.html[Configure Elastic Cloud SAML single sign-on]
185+
186+
| {ece-ref}/Elastic-Cloud-Enterprise-overview.html[*Elastic Cloud Enterprise*]
187+
| {ece-ref}/ece-security.html[Securing your installation]
188+
189+
|===
190+
191+
[discrete]
192+
=== Security for additional components
155193

156-
* <<preventing-unauthorized-access, Preventing unauthorized access>> with password protection, role-based access control, and IP filtering.
157-
* <<preserving-data-integrity, Preserving the integrity of your data>> with SSL/TLS encryption.
158-
* <<maintaining-audit-trail, Maintaining an audit trail>> so you know who's doing what to your cluster and the data it stores.
194+
<<security-clients-integrations,Securing clients and integrations>>
159195

160-
<<secure-cluster,Learn about securing an Elasticsearch cluster>>.
161196

162197
[discrete]
163198
== Monitoring

docs/reference/security/index.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
The {stack} is composed of many moving parts. There are the {es}
88
nodes that form the cluster, plus {ls} instances, {kib} instances, {beats}
9-
agents, and clients all communicating with the cluster. To keep your cluster
9+
agents, Elastic Agents, and clients all communicating with the cluster. To keep your cluster
1010
safe, adhere to the <<es-security-principles,{es} security principles>>.
1111

1212
The first principle is to run {es} with security enabled. Configuring security

0 commit comments

Comments
 (0)