Skip to content

Commit 8000c6d

Browse files
doc: Document hot-reloading of security settings
1 parent c730d83 commit 8000c6d

4 files changed

Lines changed: 59 additions & 90 deletions

File tree

docs/modules/opensearch/examples/getting_started/opensearch-security-config.yaml

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

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

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,12 @@ To make the metrics accessible for all users, especially Prometheus, anonymous a
2929
----
3030
---
3131
apiVersion: v1
32-
kind: Secret
32+
kind: ConfigMap
3333
metadata:
34-
name: opensearch-security-config
35-
stringData:
34+
name: custom-opensearch-security-config
35+
annotations:
36+
restarter.stackable.tech/ignore: "true"
37+
data:
3638
config.yml: |
3739
---
3840
_meta:

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

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,31 @@ spec:
144144

145145
If this role group is not defined, it will be created by the operator.
146146

147+
[IMPORTANT]
148+
====
149+
Settings managed by the operator are hot-reloaded when changed, i.e. without pod restarts.
150+
However, if those settings are provided via ConfigMap or Secret, updates will normally trigger a restart.
151+
To prevent that restart, add the following annotation:
152+
153+
[source,yaml]
154+
----
155+
---
156+
apiVersion: v1
157+
kind: Secret
158+
metadata:
159+
name: security-config
160+
annotations:
161+
restarter.stackable.tech/ignore: "true"
162+
---
163+
apiVersion: v1
164+
kind: ConfigMap
165+
metadata:
166+
name: security-config
167+
annotations:
168+
restarter.stackable.tech/ignore: "true"
169+
----
170+
====
171+
147172
== TLS
148173

149174
TLS is also managed by the OpenSearch security plugin, therefore TLS is only available if the security plugin was not disabled.

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

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,35 @@
11
= SDP upgrade notes
22
:description: Instructions for upgrading the SDP versions.
33

4+
== Upgrade from SDP 26.3 to 26.7
5+
6+
=== Hot-reloading of security settings
7+
8+
The security settings defined in the cluster specification are now stored in a separate ConfigMap named `<cluster-name>-security-config`.
9+
If you used this name for your custom security configuration, then you must rename it.
10+
Otherwise the operator will override it.
11+
12+
The operator now supports hot-reloading of security settings.
13+
If those settings are provided via ConfigMap or Secret, then the annotation `restarter.stackable.tech/ignore: "true"` should be added to avoid restarts triggered by the restart controller:
14+
15+
[source,yaml]
16+
----
17+
---
18+
apiVersion: v1
19+
kind: Secret
20+
metadata:
21+
name: security-config
22+
annotations:
23+
restarter.stackable.tech/ignore: "true"
24+
---
25+
apiVersion: v1
26+
kind: ConfigMap
27+
metadata:
28+
name: security-config
29+
annotations:
30+
restarter.stackable.tech/ignore: "true"
31+
----
32+
433
== Upgrade from SDP 25.11 to 26.3
534

635
When upgrading the OpenSearch operator from SDP 25.11 to 26.3, you may encounter several warnings and errors in the operator logs.

0 commit comments

Comments
 (0)