Skip to content
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

Merged
merged 1 commit into from
Mar 27, 2024

Conversation

ahardin-rh
Copy link
Contributor

@ahardin-rh ahardin-rh commented Mar 20, 2024

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:

  • QE has approved this change.

@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Mar 20, 2024
@openshift-ci-robot
Copy link

openshift-ci-robot commented Mar 20, 2024

@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:

Version(s):
4.15+

Issue:
(https://issues.redhat.com/browse/OSDOCS-8651

Link to docs preview:

QE review:

  • QE has approved this change.

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.

@openshift-ci openshift-ci bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 20, 2024
@ahardin-rh ahardin-rh changed the title [WIP}OSDOCS-8651: Edits from content audit [WIP]OSDOCS-8651: Edits from content audit Mar 20, 2024
@ahardin-rh ahardin-rh added this to the Continuous Release milestone Mar 20, 2024
@openshift-ci openshift-ci bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Mar 20, 2024
@ahardin-rh ahardin-rh added branch/enterprise-4.15 branch/enterprise-4.16 and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Mar 20, 2024
@ocpdocs-previewbot
Copy link

ocpdocs-previewbot commented Mar 20, 2024

🤖 Wed Mar 27 15:01:01 - Prow CI generated the docs preview:
https://73505--ocpdocs-pr.netlify.app

@openshift-ci openshift-ci bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Mar 21, 2024
@openshift-ci-robot
Copy link

openshift-ci-robot commented Mar 22, 2024

@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:

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:

  • QE has approved this change.

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 ahardin-rh self-assigned this Mar 22, 2024
@ahardin-rh ahardin-rh changed the title [WIP]OSDOCS-8651: Edits from content audit OSDOCS-8651: Edits from content audit Mar 22, 2024
@openshift-ci openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 22, 2024
@ahardin-rh
Copy link
Contributor Author

@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!

@ahardin-rh ahardin-rh added the peer-review-needed Signifies that the peer review team needs to review this PR label Mar 22, 2024
@candita
Copy link

candita commented Mar 22, 2024

/assign

@openshift-ci-robot
Copy link

openshift-ci-robot commented Mar 22, 2024

@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:

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:

  • QE has approved this change.

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.

@kcarmichael08 kcarmichael08 added peer-review-in-progress Signifies that the peer review team is reviewing this PR and removed peer-review-needed Signifies that the peer review team needs to review this PR labels Mar 22, 2024
Copy link
Contributor

@kcarmichael08 kcarmichael08 left a 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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

oc get configmap/dns-default -n openshift-dns -o yaml
----
+
You should see entries that look like this for the changes made above:
Copy link
Contributor

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.

@@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

does "ingress" need capitalization?

<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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<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.


[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:
Copy link
Contributor

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:
Copy link
Contributor

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:

https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#commands-with-jq

Copy link
Contributor Author

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!

Copy link

@melvinjoseph86 melvinjoseph86 Mar 27, 2024

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}'

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! All updated.


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:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
. View the status of the DNS Operator:
* View the status of the DNS Operator:

[source,terminal]
----
$ oc describe clusteroperators/dns
----
+
Though the messages and spelling might vary from release to release, the expected status output looks like:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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:

----
+
`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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`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.

@@ -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.
Copy link
Contributor

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. :)

@kcarmichael08 kcarmichael08 added the peer-review-done Signifies that the peer review team has reviewed this PR label Mar 22, 2024
@kcarmichael08 kcarmichael08 removed the peer-review-in-progress Signifies that the peer review team is reviewing this PR label Mar 22, 2024
@ahardin-rh
Copy link
Contributor Author

@kcarmichael08 Thank you for the excellent review feedback! 🚀 Updated. Just waiting for guidance on reworking the jq commands, if possible.

@melvinjoseph86
Copy link

/label qe-approved

@openshift-ci openshift-ci bot added the qe-approved Signifies that QE has signed off on this PR label Mar 27, 2024
@openshift-ci-robot
Copy link

openshift-ci-robot commented Mar 27, 2024

@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:

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:

  • QE has approved this change.

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.

@openshift-ci-robot
Copy link

openshift-ci-robot commented Mar 27, 2024

@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:

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:

  • QE has approved this change.

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.

Copy link

openshift-ci bot commented Mar 27, 2024

@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.

@ahardin-rh ahardin-rh merged commit 8bcfc5d into openshift:main Mar 27, 2024
2 checks passed
@ahardin-rh
Copy link
Contributor Author

/cherrypick enterprise-4.15

@ahardin-rh
Copy link
Contributor Author

/cherrypick enterprise-4.16

@openshift-cherrypick-robot

@ahardin-rh: #73505 failed to apply on top of branch "enterprise-4.15":

Applying: OSDOCS-8651: Edits from content audit
.git/rebase-apply/patch:538: trailing whitespace.
$ oc get dns.operator.openshift.io default -ojsonpath='{.spec.managementState}' 
warning: 1 line adds whitespace errors.
Using index info to reconstruct a base tree...
M	modules/nw-dns-view.adoc
Falling back to patching base and 3-way merge...
Auto-merging modules/nw-dns-view.adoc
CONFLICT (content): Merge conflict in modules/nw-dns-view.adoc
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 OSDOCS-8651: Edits from content audit
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".

In response to this:

/cherrypick enterprise-4.15

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.

@openshift-cherrypick-robot

@ahardin-rh: #73505 failed to apply on top of branch "enterprise-4.16":

Applying: OSDOCS-8651: Edits from content audit
.git/rebase-apply/patch:538: trailing whitespace.
$ oc get dns.operator.openshift.io default -ojsonpath='{.spec.managementState}' 
warning: 1 line adds whitespace errors.
Using index info to reconstruct a base tree...
M	modules/nw-dns-view.adoc
Falling back to patching base and 3-way merge...
Auto-merging modules/nw-dns-view.adoc
CONFLICT (content): Merge conflict in modules/nw-dns-view.adoc
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 OSDOCS-8651: Edits from content audit
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".

In response to this:

/cherrypick enterprise-4.16

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.

@candita
Copy link

candita commented Mar 27, 2024

/assign @gcs278

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
branch/enterprise-4.15 branch/enterprise-4.16 jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. peer-review-done Signifies that the peer review team has reviewed this PR qe-approved Signifies that QE has signed off on this PR size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

9 participants