Skip to content

Commit 2bbcfc8

Browse files
doc: Improve the security documentation
1 parent a16b282 commit 2bbcfc8

1 file changed

Lines changed: 9 additions & 8 deletions

File tree

docs/modules/opensearch/pages/usage-guide/security.adoc

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ When a new cluster is created, the security index is initialized from the follow
3737
* https://docs.opensearch.org/latest/security/configuration/yaml/#rolesyml[roles.yml{external-link-icon}^]:
3838
definition of roles in the security plugin
3939
* https://docs.opensearch.org/latest/security/configuration/yaml/#roles_mappingyml[roles_mapping.yml{external-link-icon}^]:
40-
Role mappings to users or backend roles
40+
role mappings to users or backend roles
4141
* https://docs.opensearch.org/latest/security/configuration/yaml/#tenantsyml[tenants.yml{external-link-icon}^]:
4242
OpenSearch Dashboards tenants
4343

@@ -65,7 +65,7 @@ spec:
6565
tenants: ...
6666
----
6767

68-
If a setting is undefined, then a default configuration is deployed with no permissions.
68+
If any setting remains undefined, a default configuration will be deployed with no permissions.
6969
Therefore, it is okay to only define some settings and leave the others unspecified.
7070

7171
A setting can be defined either inline, via Secret or ConfigMap:
@@ -129,7 +129,7 @@ spec:
129129

130130
[WARNING]
131131
====
132-
It is possible to change `managedBy` from `API` to `operator` after the cluster was created, but be aware that all changes made via the API are lost.
132+
While it is possible to change `managedBy` from `API` to `operator` after cluster creation, be cautious as this will discard all API-made changes.
133133
====
134134

135135
All settings managed by the operator are updated by the role group defined in `spec.clusterConfig.security.managingRoleGroup` which defaults to `security-config`:
@@ -180,10 +180,11 @@ Defaults to the `tls` SecretClass and can't be disabled.
180180
<3> The lifetime for autoTls certificates generated by the secret operator.
181181
Only a lifetime up to the `maxCertificateLifetime` setting in the SecretClass is applied.
182182

183-
[WARNING]
183+
[IMPORTANT]
184184
====
185185
The operator sets the configuration `plugins.security.nodes_dn` to `["CN=generated certificate for pod"]` which provides weak authentication between nodes.
186-
If you want to increase security and use certificates which identify the OpenSearch nodes specifically, you must also adapt the `plugins.security.nodes_dn` setting via configOverrides.
186+
For enhanced security, use certificates that uniquely identify the OpenSearch nodes.
187+
In this case, you must also adapt the `plugins.security.nodes_dn` setting via configOverrides.
187188
====
188189

189190
== Disabling security
@@ -203,11 +204,11 @@ spec:
203204
enabled: false
204205
----
205206

206-
All other security settings as well as the TLS settings are then ignored.
207+
Once disabled, all other security and TLS settings will be disregarded.
207208

208209
[WARNING]
209210
====
210-
If the security plugin was enabled before disabling it, then the security index is exposed to the public.
211+
If the security plugin was previously enabled, the security index will become accessible like any other indices.
211212
====
212213

213-
OpenSearch Dashboards require an enabled security plugin.
214+
OpenSearch Dashboards require the security plugin to be enabled.

0 commit comments

Comments
 (0)