Skip to content

Commit 6cddbeb

Browse files
committed
OSDOCS-2279: Document managementState API for DNS
1 parent e7325db commit 6cddbeb

File tree

3 files changed

+26
-1
lines changed

3 files changed

+26
-1
lines changed
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * networking/dns-operator.adoc
4+
5+
[id="nw-dns-operator-managementState_{context}"]
6+
= Changing the DNS Operator managementState
7+
8+
DNS manages the CoreDNS component to provide a name resolution service for pods and services in the cluster. The `managementState` of the DNS Operator is set to `Managed` by default, which means that the DNS Operator is actively managing its resources. You can change it to `Unmanaged`, which means the DNS Operator is not managing its resources.
9+
10+
The following are use cases for changing the DNS Operator `managementState`:
11+
12+
* You are a developer and want to test a configuration change to see if it fixes an issue in CoreDNS. You can stop the DNS Operator from overwriting the fix by setting the `managementState` to `Unmanaged`.
13+
14+
* You are a cluster administrator and have reported an issue with CoreDNS, but need to apply a workaround until the issue is fixed. You can set the `managementState` field of the DNS Operator to `Unmanaged` to apply the workaround.
15+
16+
.Procedure
17+
18+
* Change `managementState` DNS Operator:
19+
+
20+
[source,terminal]
21+
----
22+
oc patch dns.operator.openshift.io default --type merge --patch '{"spec":{"managementState":"Unmanaged"}}'
23+
----

modules/nw-dns-operator.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// Module included in the following assemblies:
22
// * networking/dns/dns-operator.adoc
33

4-
[id="dns-operator_{context}"]
4+
[id="nw-dns-operator_{context}"]
55
= DNS Operator
66

77
The DNS Operator implements the `dns` API from the `operator.openshift.io` API

networking/dns-operator.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ service to pods, enabling DNS-based Kubernetes Service discovery in
1111

1212
include::modules/nw-dns-operator.adoc[leveloffset=+1]
1313

14+
include::modules/nw-dns-operator-managementState.adoc[leveloffset=+1]
15+
1416
include::modules/nw-controlling-dns-pod-placement.adoc[leveloffset=+1]
1517

1618
include::modules/nw-dns-view.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)