Feedback for diagnostics tool topic #8741

bfallonf · 2018-04-16T04:31:58Z

From #8644

cc @rlopez133

Will verify over email.

bfallonf · 2018-04-18T04:39:58Z

Thumbs up given.

@openshift/team-documentation PTAL

kalexand-rh

This is mostly picks and style issues. Take what's useful!

kalexand-rh · 2018-04-18T14:30:09Z

admin_guide/diagnostics_tool.adoc

+* As enterprise RPMs
+
+Each method implies a different configuration and environment. To minimize
+environment assumptions, the diagnostics were included with the `openshift`


s/the diagnostics were/diagnostics are

kalexand-rh · 2018-04-18T14:30:34Z

admin_guide/diagnostics_tool.adoc

-You can run one or multiple specific diagnostics by name, or run specific
-diagnostics by name as you work to address issues. For example:
+Using the diagnostics tool, you can run one or multiple specific diagnostics by
+name, or run specific diagnostics by name as you work to address issues. For


s/name,/name

kalexand-rh · 2018-04-18T14:31:20Z

admin_guide/diagnostics_tool.adoc


-Diagnostics look for configuration files in standard locations:
+Diagnostics verifies that the configuration files reside in their standard


s/verifies/verify (or /Diagnostics verifies/The diagnostic tool verifies)

kalexand-rh · 2018-04-18T14:32:16Z

admin_guide/diagnostics_tool.adoc

-Non-standard locations can be specified with flags (respectively,
-`--config`, `--master-config`, and `--node-config`). If a configuration file
-is not found or specified, related diagnostics are skipped.
+Non-standard locations can be specified with the `--config`, `--master-config`,


s/Non-standard locations can be specified/You can specify configuration file locations

kalexand-rh · 2018-04-18T14:32:55Z

admin_guide/diagnostics_tool.adoc

-is not found or specified, related diagnostics are skipped.
+Non-standard locations can be specified with the `--config`, `--master-config`,
+and `--node-config` options. If a configuration file is not found or specified,
+related diagnostics are skipped.


s/are skipped/do not run

kalexand-rh · 2018-04-18T15:13:31Z

admin_guide/diagnostics_tool.adoc

-To do so, specify your cluster's inventory file and the *_health.yml_* playbook
-when running the following `docker run` command as a non-root user that has
-privileges to run containers:
+Specify your cluster's inventory file and the *_health.yml_* playbook when


Could we just say
As a non-root user that has privileges to run containers, run the following command:

kalexand-rh · 2018-04-18T15:14:05Z

admin_guide/diagnostics_tool.adoc

-copy of the SSH key (or directory) is recommended.
+[IMPORTANT]
+====
+These volume mount specifications could have unexpected consequences. For


s/could/can

kalexand-rh · 2018-04-18T15:14:22Z

admin_guide/diagnostics_tool.adoc

+[IMPORTANT]
+====
+These volume mount specifications could have unexpected consequences. For
+example, if you mount (and therefore relabel) the *_$HOME/.ssh_* directory,


s/mount (and therefore relabel)/ mount, and therefore relabel,

kalexand-rh · 2018-04-18T15:15:07Z

admin_guide/diagnostics_tool.adoc

+These volume mount specifications could have unexpected consequences. For
+example, if you mount (and therefore relabel) the *_$HOME/.ssh_* directory,
+*sshd* becomes unable to access the public keys to allow remote login. To avoid
+altering the original file labels, mounting a copy of the SSH key (or directory)


s/mounting a copy of the SSH key (or directory) is recommended./ mount a copy of the SSH key or directory.

kalexand-rh · 2018-04-18T15:23:50Z

admin_guide/diagnostics_tool.adoc

-example, this would allow you to use an SSH configuration to match keys with
-hosts or modify other connection parameters. It would also allow you to provide
-a *_known_hosts_* file and have SSH validate host keys, which is disabled by the
+You might mount an entire *_.ssh_* directory for various reasons. For example,


I think this is part of the previous note.

Despite the risks of mounting an entire .ssh directory, mounting the directory offers benefits:

You can use an SSH configuration to match keys with hosts or modify other connection parameters.

You can provide a known_hosts file and have SSH validate host keys. This behavior is disabled by the
default configuration. To use it, add -e ANSIBLE_HOST_KEY_CHECKING=True to the docker run command.

bfallonf · 2018-07-17T03:37:13Z

/cherrypick enterprise-3.10

openshift-cherrypick-robot · 2018-07-17T03:37:19Z

@bfallonf: new pull request created: #10846

In response to this:

/cherrypick enterprise-3.10

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.

bfallonf · 2018-07-17T03:37:35Z

/cherrypick enterprise-3.9

openshift-cherrypick-robot · 2018-07-17T03:37:41Z

@bfallonf: new pull request created: #10847

In response to this:

/cherrypick enterprise-3.9

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.

bfallonf · 2018-07-17T03:37:48Z

/cherrypick enterprise-3.7

openshift-cherrypick-robot · 2018-07-17T03:37:55Z

@bfallonf: new pull request created: #10848

In response to this:

/cherrypick enterprise-3.7

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.

bfallonf · 2018-07-17T03:38:35Z

/cherrypick enterprise-3.6

openshift-cherrypick-robot · 2018-07-17T03:38:38Z

@bfallonf: #8741 failed to apply on top of branch "enterprise-3.6":

.git/rebase-apply/patch:154: trailing whitespace.
to the existing cluster configuration. 
warning: 1 line adds whitespace errors.
error: Failed to merge in the changes.
Using index info to reconstruct a base tree...
M	admin_guide/diagnostics_tool.adoc
Falling back to patching base and 3-way merge...
Auto-merging admin_guide/diagnostics_tool.adoc
CONFLICT (content): Merge conflict in admin_guide/diagnostics_tool.adoc
Patch failed at 0001 feedback for diagnostics tool topic

In response to this:

/cherrypick enterprise-3.6

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-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Apr 16, 2018

bfallonf force-pushed the rl_day2_feedback branch from 62c18ab to 624012b Compare April 16, 2018 04:40

bfallonf added the peer-review-needed Signifies that the peer review team needs to review this PR label Apr 18, 2018

bfallonf added this to the Next Release milestone Apr 18, 2018

kalexand-rh reviewed Apr 18, 2018

View reviewed changes

kalexand-rh added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-needed Signifies that the peer review team needs to review this PR labels Apr 18, 2018

openshift-bot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jul 16, 2018

feedback for diagnostics tool topic

7dd507f

bfallonf force-pushed the rl_day2_feedback branch from 624012b to 7dd507f Compare July 17, 2018 03:32

openshift-bot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jul 17, 2018

bfallonf merged commit a500fe2 into openshift:master Jul 17, 2018

openshift-cherrypick-robot mentioned this pull request Jul 17, 2018

[enterprise-3.10] Feedback for diagnostics tool topic #10846

Merged

openshift-cherrypick-robot mentioned this pull request Jul 17, 2018

[enterprise-3.9] Feedback for diagnostics tool topic #10847

Merged

openshift-cherrypick-robot mentioned this pull request Jul 17, 2018

[enterprise-3.7] Feedback for diagnostics tool topic #10848

Merged

bfallonf mentioned this pull request Jul 17, 2018

feedback for diagnostics tool topic #10849

Merged

bfallonf deleted the rl_day2_feedback branch July 17, 2018 04:14

bfallonf mentioned this pull request Jul 19, 2018

fixing grammar future tense to present tense, removing pronouns #8644

Closed


		Diagnostics look for configuration files in standard locations:
		Diagnostics verifies that the configuration files reside in their standard

Feedback for diagnostics tool topic #8741

Feedback for diagnostics tool topic #8741

Uh oh!

Conversation

bfallonf commented Apr 16, 2018

Uh oh!

bfallonf commented Apr 18, 2018

Uh oh!

kalexand-rh left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kalexand-rh Apr 18, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bfallonf commented Jul 17, 2018

Uh oh!

openshift-cherrypick-robot commented Jul 17, 2018

Uh oh!

bfallonf commented Jul 17, 2018

Uh oh!

openshift-cherrypick-robot commented Jul 17, 2018

Uh oh!

bfallonf commented Jul 17, 2018

Uh oh!

openshift-cherrypick-robot commented Jul 17, 2018

Uh oh!

bfallonf commented Jul 17, 2018

Uh oh!

openshift-cherrypick-robot commented Jul 17, 2018

Uh oh!

Uh oh!

kalexand-rh Apr 18, 2018 •

edited

Loading