-
Notifications
You must be signed in to change notification settings - Fork 1.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
OSDOCS-8651: Edits from content audit #73505
Conversation
@ahardin-rh: This pull request references OSDOCS-8651 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.16.0" version, but no target version was set. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
🤖 Wed Mar 27 15:01:01 - Prow CI generated the docs preview: |
6d63105
to
60a0549
Compare
60a0549
to
2a43572
Compare
@ahardin-rh: This pull request references OSDOCS-8651 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.16.0" version, but no target version was set. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
@candita Thank you again for your awesome feedback. I implemented the updates as you noted. Can you please scan these changes to see if I missed anything? @melvinjoseph86 Can you please provide QE ack? These edits are for clarity and an improved customer experience. Thank you! |
/assign |
@ahardin-rh: This pull request references OSDOCS-8651 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.16.0" version, but no target version was set. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some minor style and wording suggestions. This looks really good!
|
||
As a cluster administrator, you can use a custom node selector to configure the daemon set for CoreDNS to run or not run on certain nodes. | ||
Though not a common operation, you might find a need to control which nodes have CoreDNS pods assigned and running. For example, if the cluster administrator has configured security policies that can prohibit communication between pairs of nodes, that would necessitate restricting the set of nodes on which the daemonset for CoreDNS runs. If DNS pods are running on some nodes in the cluster and the nodes where DNS pods are not running have network connectivity to nodes where DNS pods are running, DNS service will be available to all pods. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Though not a common operation, you might find a need to control which nodes have CoreDNS pods assigned and running. For example, if the cluster administrator has configured security policies that can prohibit communication between pairs of nodes, that would necessitate restricting the set of nodes on which the daemonset for CoreDNS runs. If DNS pods are running on some nodes in the cluster and the nodes where DNS pods are not running have network connectivity to nodes where DNS pods are running, DNS service will be available to all pods. | |
You might find a need to control which nodes have CoreDNS pods assigned and running, although this is not a common operation. For example, if the cluster administrator has configured security policies that can prohibit communication between pairs of nodes, that would necessitate restricting the set of nodes on which the daemonset for CoreDNS runs. If DNS pods are running on some nodes in the cluster and the nodes where DNS pods are not running have network connectivity to nodes where DNS pods are running, DNS service will be available to all pods. |
suggest changing a bit, your call
modules/nw-dns-cache-tuning.adoc
Outdated
oc get configmap/dns-default -n openshift-dns -o yaml | ||
---- | ||
+ | ||
You should see entries that look like this for the changes made above: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since you used .
for the first step, this should also be a numbered step (for example, "Verify that you see entries that look like the following example:"). Otherwise, use an asterisk for the first step.
IBM Style recommends not using "above, below, etc." to refer to locations in the doc.
modules/nw-dns-forward.adoc
Outdated
@@ -8,7 +8,7 @@ | |||
|
|||
You can use DNS forwarding to override the default forwarding configuration in the `/etc/resolv.conf` file in the following ways: | |||
|
|||
* Specify name servers for every zone. If the forwarded zone is the Ingress domain managed by {product-title}, then the upstream name server must be authorized for the domain. | |||
* Specify name servers (`spec.servers`) for every zone. If the forwarded zone is the Ingress domain managed by {product-title}, then the upstream name server must be authorized for the domain. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
does "ingress" need capitalization?
modules/nw-dns-forward.adoc
Outdated
<6> Determines the order in which upstream servers listed in `upstreams` are selected for querying. You can specify one of these values: `Random`, `RoundRobin`, or `Sequential`. The default value is `Sequential`. | ||
<7> When omitted, the platform chooses a default, normally the protocol of the original client request. Set to `TCP` to specify that the platform should use TCP for all upstream DNS requests, even if the client request uses UDP. | ||
<8> Used to configure the transport type, server name, and optional custom CA or CA bundle to use when forwarding DNS requests to an upstream resolver. | ||
<9> You can specify two types of `upstreams` - `SystemResolvConf` or `Network`. `SystemResolvConf` configures the upstream to use `/etc/resolv.conf` and `Network` defines a `Networkresolver`. You can specify one or both. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
<9> You can specify two types of `upstreams` - `SystemResolvConf` or `Network`. `SystemResolvConf` configures the upstream to use `/etc/resolv.conf` and `Network` defines a `Networkresolver`. You can specify one or both. | |
<9> You can specify two types of `upstreams`: `SystemResolvConf` or `Network`. `SystemResolvConf` configures the upstream to use `/etc/resolv.conf` and `Network` defines a `Networkresolver`. You can specify one or both. |
modules/nw-dns-loglevel.adoc
Outdated
|
||
[NOTE] | ||
==== | ||
The errors plugin is always enabled. The following `logLevel` settings report different error responses: | ||
The CoreDNS error log level is always enabled. The following log Level settings report different error responses: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should level be lower case?
+ | ||
[source,terminal] | ||
---- | ||
oc patch dns.operator.openshift.io default --type merge --patch '{"spec":{"managementState":"Unmanaged"}}' | ||
---- | ||
|
||
. Review `managementState` of the DNS Operator using the `jq` command line JSON parser: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I saw this discussed recently - not sure if this is applicable to these docs or not, but I'll mention it just in case:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@candita It looks like we avoid jq commands, when possible. Can you please suggest an alternative? Thanks!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ahardin-rh you can use this instead
'''Review managementState
of the DNS Operator using the jsonpath
command line JSON parser:'''
oc get dns.operator.openshift.io default -ojsonpath='{.spec.managementState}'
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you! All updated.
modules/nw-dns-operator-status.adoc
Outdated
|
||
You can inspect the status and view the details of the DNS Operator | ||
using the `oc describe` command. | ||
|
||
.Procedure | ||
|
||
View the status of the DNS Operator: | ||
. View the status of the DNS Operator: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
. View the status of the DNS Operator: | |
* View the status of the DNS Operator: |
modules/nw-dns-operator-status.adoc
Outdated
[source,terminal] | ||
---- | ||
$ oc describe clusteroperators/dns | ||
---- | ||
+ | ||
Though the messages and spelling might vary from release to release, the expected status output looks like: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Though the messages and spelling might vary from release to release, the expected status output looks like: | |
Though the messages and spelling might vary in a specific release, the expected status output looks like: |
modules/nw-dns-operator.adoc
Outdated
---- | ||
+ | ||
`AVAILABLE`, `PROGRESSING` and `DEGRADED` provide information about the status of the operator. `AVAILABLE` is `True` when at least 1 pod from the CoreDNS daemon set reports an `Available` status condition. | ||
`AVAILABLE`, `PROGRESSING` and `DEGRADED` provide information about the status of the operator. `AVAILABLE` is `True` when at least 1 pod from the CoreDNS daemon set reports an `Available` status condition, and the DNS service has a cluster IP address. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
`AVAILABLE`, `PROGRESSING` and `DEGRADED` provide information about the status of the operator. `AVAILABLE` is `True` when at least 1 pod from the CoreDNS daemon set reports an `Available` status condition, and the DNS service has a cluster IP address. | |
`AVAILABLE`, `PROGRESSING`, and `DEGRADED` provide information about the status of the Operator. `AVAILABLE` is `True` when at least 1 pod from the CoreDNS daemon set reports an `Available` status condition, and the DNS service has a cluster IP address. |
modules/nw-dns-operatorloglevel.adoc
Outdated
@@ -5,7 +5,7 @@ | |||
[id="nw-dns-operatorloglevel_{context}"] | |||
= Setting the CoreDNS Operator log level | |||
|
|||
Cluster administrators can configure the Operator log level to more quickly track down OpenShift DNS issues. The valid values for `operatorLogLevel` are `Normal`, `Debug`, and `Trace`. `Trace` has the most detailed information. The default `operatorlogLevel` is `Normal`. There are seven logging levels for issues: Trace, Debug, Info, Warning, Error, Fatal and Panic. After the logging level is set, log entries with that severity or anything above it will be logged. | |||
Log levels for CoreDNS and CoreDNS Operator are set in different manners. Cluster administrators can configure the Operator log level to more quickly track down OpenShift DNS issues. The valid values for `operatorLogLevel` are `Normal`, `Debug`, and `Trace`. `Trace` has the most detailed information. The default `operatorlogLevel` is `Normal`. There are seven logging levels for Operator issues: Trace, Debug, Info, Warning, Error, Fatal, and Panic. After the logging level is set, log entries with that severity or anything above it will be logged. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For some reason "in different manners" seems awkward - maybe "by using different methods"? It might just be me, so ignore if so. :)
2a43572
to
53891a2
Compare
@kcarmichael08 Thank you for the excellent review feedback! 🚀 Updated. Just waiting for guidance on reworking the jq commands, if possible. |
/label qe-approved |
@ahardin-rh: This pull request references OSDOCS-8651 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.16.0" version, but no target version was set. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
@ahardin-rh: This pull request references OSDOCS-8651 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.16.0" version, but no target version was set. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
53891a2
to
3214b39
Compare
@ahardin-rh: all tests passed! Full PR test history. Your PR dashboard. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here. |
/cherrypick enterprise-4.15 |
/cherrypick enterprise-4.16 |
@ahardin-rh: #73505 failed to apply on top of branch "enterprise-4.15":
In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
@ahardin-rh: #73505 failed to apply on top of branch "enterprise-4.16":
In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
/assign @gcs278 |
Version(s):
4.15+
Issue:
https://issues.redhat.com/browse/OSDOCS-8651
Link to docs preview:
https://73505--ocpdocs-pr.netlify.app/openshift-enterprise/latest/networking/dns-operator
QE review: