Skip to content

Commit 4ec9e81

Browse files
docs: Document the annotation "restarter.stackable.tech/ignore"
1 parent 42e15d4 commit 4ec9e81

1 file changed

Lines changed: 42 additions & 0 deletions

File tree

docs/modules/commons-operator/pages/restarter.adoc

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,3 +30,45 @@ Label:: `restarter.stackable.tech/enabled`
3030

3131
The operator can restart StatefulSets when any referenced configuration object (ConfigMap or Secret) changes.
3232
To enable this, set the `restarter.stackable.tech/enabled` label on the StatefulSet to `true`.
33+
34+
Annotation:: `restarter.stackable.tech/ignore`
35+
36+
If a resource is only used for initialization or is hot-reloaded and should not trigger a restart, add the annotation `restarter.stackable.tech/ignore: "true"` to the corresponding ConfigMap or Secret:
37+
38+
[source,yaml]
39+
----
40+
---
41+
apiVersion: apps/v1
42+
kind: StatefulSet
43+
metadata:
44+
name: statefulset-with-enabled-restarter
45+
labels:
46+
restarter.stackable.tech/enabled: "true"
47+
spec:
48+
template:
49+
spec:
50+
volumes:
51+
- name: hot-reloaded-configmap
52+
configMap:
53+
name: hot-reloaded-configmap
54+
- name: hot-reloaded-secret
55+
secret:
56+
secretName: hot-reloaded-secret
57+
...
58+
---
59+
apiVersion: v1
60+
kind: ConfigMap
61+
metadata:
62+
name: hot-reloaded-configmap
63+
annotations:
64+
restarter.stackable.tech/ignore: "true"
65+
...
66+
---
67+
apiVersion: v1
68+
kind: Secret
69+
metadata:
70+
name: hot-reloaded-secret
71+
annotations:
72+
restarter.stackable.tech/ignore: "true"
73+
...
74+
----

0 commit comments

Comments
 (0)