{"action":"created","comment":{"url":"https://api.github.com/repos/openshift/openshift-docs/pulls/comments/119101295","pull_request_review_id":39899085,"id":119101295,"diff_hunk":"@@ -115,3 +115,54 @@ A client with *cluster-admin* access available (for any user, but only the\n current master) should be able to diagnose the status of infrastructure such as\n nodes, registry, and router. In each case, running `oc adm diagnostics` looks\n for the client configuration in its standard location and uses it if available.\n+\n+[[additional-cluster-health-checks]]\n+== Additional Diagnostic Checks via Ansible\n+\n+Some additional diagnostic checks are available through the https://hub.docker.com/r/openshift/openshift-ansible[openshift-ansible]\n+Docker image.\n+\n+These checks belong to a diagnostic task meant to be run against the Ansible inventory file for a deployed OpenShift cluster.\n+They can report common OpenShift-specific problems for the current deployment.\n+\n+To disable specific checks, include the variable `openshift_disable_check` with a\n+comma-delimited list of check names in your inventory file. For example:\n+\n+----\n+openshift_disable_check=ovs_version,etcd_volume\n+----\n+\n+The following table describes available health checks that can be run on a deployed OpenShift cluster.\n+\n+[[diagnostic-checks]]\n+.Diagnostic Checks\n+[options=\"header\"]\n+|===\n+\n+|Check Name |Purpose\n+\n+|`*ovs_version*`\n+|This check ensures that a host has the correct version of Open vSwitch installed for the currently deployed version of OpenShift.\n+\n+|`*kibana*`, `*curator*`, `*elasticsearch*`, `*fluentd*`\n+|This set of checks verifies that `Elasticsearch`, `Fluentd`, and `Curator` pods have been deployed and are in a `running` state, and that a connection can be established between the control host and the exposed `Kibana` URL.\n+These checks will only run if the `openshift_hosted_logging_deploy` inventory variable is set to `true`, to ensure that they are executed in a deployment where a logging stack has been deployed.\n+\n+|`*etcd_imagedata_size*`\n+|This check measures the total size of OpenShift image data in an Etcd cluster. Fails if the calculated size exceeds a user-defined limit. If no limit is specified, this check will fail if the size of OpenShift image data amounts to `50%`\n+or more of the currently used space in the Etcd cluster.\n+\n+A user-defined limit may be set by passing the variable `etcd_max_image_data_size_bytes=10000` to the `openshift_health_checker` role.\n+\n+|`*etcd_volume*`\n+|This check ensures that the volume usage for an Etcd cluster is below a maximum user-specified threshold. If no maximum threshold value is specified, it is defaulted to `90%` of the total volume size.\n+\n+A user-defined limit may be set by passing the variable `etcd_device_usage_threshold_percent=90` to the `openshift_health_checker` role.\n+\n+|`*docker_storage*`\n+|Only runs on checks that depend on Docker (nodes and containerized installations). Checks that total thinpool usage for the logical volume does not exceed a user defined limit.","path":"admin_guide/diagnostics_tool.adoc","position":49,"original_position":49,"commit_id":"4268b600046fbf66297f971856fd39e065f48461","original_commit_id":"4268b600046fbf66297f971856fd39e065f48461","user":{"login":"sosiouxme","id":29690,"avatar_url":"https://avatars2.githubusercontent.com/u/29690?v=3","gravatar_id":"","url":"https://api.github.com/users/sosiouxme","html_url":"https://github.com/sosiouxme","followers_url":"https://api.github.com/users/sosiouxme/followers","following_url":"https://api.github.com/users/sosiouxme/following{/other_user}","gists_url":"https://api.github.com/users/sosiouxme/gists{/gist_id}","starred_url":"https://api.github.com/users/sosiouxme/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/sosiouxme/subscriptions","organizations_url":"https://api.github.com/users/sosiouxme/orgs","repos_url":"https://api.github.com/users/sosiouxme/repos","events_url":"https://api.github.com/users/sosiouxme/events{/privacy}","received_events_url":"https://api.github.com/users/sosiouxme/received_events","type":"User","site_admin":false},"body":"\"Only runs on hosts...\"\r\n\r\n\"Checks that Docker's total...\"","created_at":"2017-05-30T13:41:28Z","updated_at":"2017-05-30T13:46:23Z","html_url":"https://github.com/openshift/openshift-docs/pull/4452#discussion_r119101295","pull_request_url":"https://api.github.com/repos/openshift/openshift-docs/pulls/4452","_links":{"self":{"href":"https://api.github.com/repos/openshift/openshift-docs/pulls/comments/119101295"},"html":{"href":"https://github.com/openshift/openshift-docs/pull/4452#discussion_r119101295"},"pull_request":{"href":"https://api.github.com/repos/openshift/openshift-docs/pulls/4452"}}},"pull_request":{"url":"https://api.github.com/repos/openshift/openshift-docs/pulls/4452","id":121590043,"html_url":"https://github.com/openshift/openshift-docs/pull/4452","diff_url":"https://github.com/openshift/openshift-docs/pull/4452.diff","patch_url":"https://github.com/openshift/openshift-docs/pull/4452.patch","issue_url":"https://api.github.com/repos/openshift/openshift-docs/issues/4452","number":4452,"state":"open","locked":false,"title":"add \"Configuring Cluster Preflight Checks\" sub-section","user":{"login":"juanvallejo","id":3902875,"avatar_url":"https://avatars1.githubusercontent.com/u/3902875?v=3","gravatar_id":"","url":"https://api.github.com/users/juanvallejo","html_url":"https://github.com/juanvallejo","followers_url":"https://api.github.com/users/juanvallejo/followers","following_url":"https://api.github.com/users/juanvallejo/following{/other_user}","gists_url":"https://api.github.com/users/juanvallejo/gists{/gist_id}","starred_url":"https://api.github.com/users/juanvallejo/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/juanvallejo/subscriptions","organizations_url":"https://api.github.com/users/juanvallejo/orgs","repos_url":"https://api.github.com/users/juanvallejo/repos","events_url":"https://api.github.com/users/juanvallejo/events{/privacy}","received_events_url":"https://api.github.com/users/juanvallejo/received_events","type":"User","site_admin":false},"body":"Related trello card: https://trello.com/c/dxXLsKYz\r\n\r\nDocuments the use of diagnostic tools. Adds subsections explaining preflight and non-preflight cluster health checks.\r\n\r\nTODO\r\n- [x] add section for `health` checks under [Diagnostic Tool](https://docs.openshift.com/container-platform/3.5/admin_guide/diagnostics_tool.html)\r\n\r\ncc @adellape @brenton @sosiouxme ","created_at":"2017-05-19T21:58:39Z","updated_at":"2017-05-30T13:46:23Z","closed_at":null,"merged_at":null,"merge_commit_sha":"05ada4c84467ac8786a73af4f7e7f0e58336e045","assignee":{"login":"adellape","id":3442316,"avatar_url":"https://avatars2.githubusercontent.com/u/3442316?v=3","gravatar_id":"","url":"https://api.github.com/users/adellape","html_url":"https://github.com/adellape","followers_url":"https://api.github.com/users/adellape/followers","following_url":"https://api.github.com/users/adellape/following{/other_user}","gists_url":"https://api.github.com/users/adellape/gists{/gist_id}","starred_url":"https://api.github.com/users/adellape/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/adellape/subscriptions","organizations_url":"https://api.github.com/users/adellape/orgs","repos_url":"https://api.github.com/users/adellape/repos","events_url":"https://api.github.com/users/adellape/events{/privacy}","received_events_url":"https://api.github.com/users/adellape/received_events","type":"User","site_admin":false},"assignees":[{"login":"adellape","id":3442316,"avatar_url":"https://avatars2.githubusercontent.com/u/3442316?v=3","gravatar_id":"","url":"https://api.github.com/users/adellape","html_url":"https://github.com/adellape","followers_url":"https://api.github.com/users/adellape/followers","following_url":"https://api.github.com/users/adellape/following{/other_user}","gists_url":"https://api.github.com/users/adellape/gists{/gist_id}","starred_url":"https://api.github.com/users/adellape/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/adellape/subscriptions","organizations_url":"https://api.github.com/users/adellape/orgs","repos_url":"https://api.github.com/users/adellape/repos","events_url":"https://api.github.com/users/adellape/events{/privacy}","received_events_url":"https://api.github.com/users/adellape/received_events","type":"User","site_admin":false}],"requested_reviewers":[],"milestone":null,"commits_url":"https://api.github.com/repos/openshift/openshift-docs/pulls/4452/commits","review_comments_url":"https://api.github.com/repos/openshift/openshift-docs/pulls/4452/comments","review_comment_url":"https://api.github.com/repos/openshift/openshift-docs/pulls/comments{/number}","comments_url":"https://api.github.com/repos/openshift/openshift-docs/issues/4452/comments","statuses_url":"https://api.github.com/repos/openshift/openshift-docs/statuses/4268b600046fbf66297f971856fd39e065f48461","head":{"label":"juanvallejo:jvallejo/add-configuring-cluster-preflight-checks","ref":"jvallejo/add-configuring-cluster-preflight-checks","sha":"4268b600046fbf66297f971856fd39e065f48461","user":{"login":"juanvallejo","id":3902875,"avatar_url":"https://avatars1.githubusercontent.com/u/3902875?v=3","gravatar_id":"","url":"https://api.github.com/users/juanvallejo","html_url":"https://github.com/juanvallejo","followers_url":"https://api.github.com/users/juanvallejo/followers","following_url":"https://api.github.com/users/juanvallejo/following{/other_user}","gists_url":"https://api.github.com/users/juanvallejo/gists{/gist_id}","starred_url":"https://api.github.com/users/juanvallejo/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/juanvallejo/subscriptions","organizations_url":"https://api.github.com/users/juanvallejo/orgs","repos_url":"https://api.github.com/users/juanvallejo/repos","events_url":"https://api.github.com/users/juanvallejo/events{/privacy}","received_events_url":"https://api.github.com/users/juanvallejo/received_events","type":"User","site_admin":false},"repo":{"id":91723336,"name":"openshift-docs","full_name":"juanvallejo/openshift-docs","owner":{"login":"juanvallejo","id":3902875,"avatar_url":"https://avatars1.githubusercontent.com/u/3902875?v=3","gravatar_id":"","url":"https://api.github.com/users/juanvallejo","html_url":"https://github.com/juanvallejo","followers_url":"https://api.github.com/users/juanvallejo/followers","following_url":"https://api.github.com/users/juanvallejo/following{/other_user}","gists_url":"https://api.github.com/users/juanvallejo/gists{/gist_id}","starred_url":"https://api.github.com/users/juanvallejo/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/juanvallejo/subscriptions","organizations_url":"https://api.github.com/users/juanvallejo/orgs","repos_url":"https://api.github.com/users/juanvallejo/repos","events_url":"https://api.github.com/users/juanvallejo/events{/privacy}","received_events_url":"https://api.github.com/users/juanvallejo/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/juanvallejo/openshift-docs","description":"OpenShift Documentation","fork":true,"url":"https://api.github.com/repos/juanvallejo/openshift-docs","forks_url":"https://api.github.com/repos/juanvallejo/openshift-docs/forks","keys_url":"https://api.github.com/repos/juanvallejo/openshift-docs/keys{/key_id}","collaborators_url":"https://api.github.com/repos/juanvallejo/openshift-docs/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/juanvallejo/openshift-docs/teams","hooks_url":"https://api.github.com/repos/juanvallejo/openshift-docs/hooks","issue_events_url":"https://api.github.com/repos/juanvallejo/openshift-docs/issues/events{/number}","events_url":"https://api.github.com/repos/juanvallejo/openshift-docs/events","assignees_url":"https://api.github.com/repos/juanvallejo/openshift-docs/assignees{/user}","branches_url":"https://api.github.com/repos/juanvallejo/openshift-docs/branches{/branch}","tags_url":"https://api.github.com/repos/juanvallejo/openshift-docs/tags","blobs_url":"https://api.github.com/repos/juanvallejo/openshift-docs/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/juanvallejo/openshift-docs/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/juanvallejo/openshift-docs/git/refs{/sha}","trees_url":"https://api.github.com/repos/juanvallejo/openshift-docs/git/trees{/sha}","statuses_url":"https://api.github.com/repos/juanvallejo/openshift-docs/statuses/{sha}","languages_url":"https://api.github.com/repos/juanvallejo/openshift-docs/languages","stargazers_url":"https://api.github.com/repos/juanvallejo/openshift-docs/stargazers","contributors_url":"https://api.github.com/repos/juanvallejo/openshift-docs/contributors","subscribers_url":"https://api.github.com/repos/juanvallejo/openshift-docs/subscribers","subscription_url":"https://api.github.com/repos/juanvallejo/openshift-docs/subscription","commits_url":"https://api.github.com/repos/juanvallejo/openshift-docs/commits{/sha}","git_commits_url":"https://api.github.com/repos/juanvallejo/openshift-docs/git/commits{/sha}","comments_url":"https://api.github.com/repos/juanvallejo/openshift-docs/comments{/number}","issue_comment_url":"https://api.github.com/repos/juanvallejo/openshift-docs/issues/comments{/number}","contents_url":"https://api.github.com/repos/juanvallejo/openshift-docs/contents/{+path}","compare_url":"https://api.github.com/repos/juanvallejo/openshift-docs/compare/{base}...{head}","merges_url":"https://api.github.com/repos/juanvallejo/openshift-docs/merges","archive_url":"https://api.github.com/repos/juanvallejo/openshift-docs/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/juanvallejo/openshift-docs/downloads","issues_url":"https://api.github.com/repos/juanvallejo/openshift-docs/issues{/number}","pulls_url":"https://api.github.com/repos/juanvallejo/openshift-docs/pulls{/number}","milestones_url":"https://api.github.com/repos/juanvallejo/openshift-docs/milestones{/number}","notifications_url":"https://api.github.com/repos/juanvallejo/openshift-docs/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/juanvallejo/openshift-docs/labels{/name}","releases_url":"https://api.github.com/repos/juanvallejo/openshift-docs/releases{/id}","deployments_url":"https://api.github.com/repos/juanvallejo/openshift-docs/deployments","created_at":"2017-05-18T18:01:48Z","updated_at":"2017-05-18T18:01:51Z","pushed_at":"2017-05-23T22:25:02Z","git_url":"git://github.com/juanvallejo/openshift-docs.git","ssh_url":"git@github.com:juanvallejo/openshift-docs.git","clone_url":"https://github.com/juanvallejo/openshift-docs.git","svn_url":"https://github.com/juanvallejo/openshift-docs","homepage":"https://docs.openshift.org/latest/welcome/index.html","size":38751,"stargazers_count":0,"watchers_count":0,"language":"HTML","has_issues":false,"has_projects":true,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":0,"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"openshift:master","ref":"master","sha":"080aaa12adf6393c5f377f80265eb84ca1c344bc","user":{"login":"openshift","id":792337,"avatar_url":"https://avatars0.githubusercontent.com/u/792337?v=3","gravatar_id":"","url":"https://api.github.com/users/openshift","html_url":"https://github.com/openshift","followers_url":"https://api.github.com/users/openshift/followers","following_url":"https://api.github.com/users/openshift/following{/other_user}","gists_url":"https://api.github.com/users/openshift/gists{/gist_id}","starred_url":"https://api.github.com/users/openshift/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/openshift/subscriptions","organizations_url":"https://api.github.com/users/openshift/orgs","repos_url":"https://api.github.com/users/openshift/repos","events_url":"https://api.github.com/users/openshift/events{/privacy}","received_events_url":"https://api.github.com/users/openshift/received_events","type":"Organization","site_admin":false},"repo":{"id":21740844,"name":"openshift-docs","full_name":"openshift/openshift-docs","owner":{"login":"openshift","id":792337,"avatar_url":"https://avatars0.githubusercontent.com/u/792337?v=3","gravatar_id":"","url":"https://api.github.com/users/openshift","html_url":"https://github.com/openshift","followers_url":"https://api.github.com/users/openshift/followers","following_url":"https://api.github.com/users/openshift/following{/other_user}","gists_url":"https://api.github.com/users/openshift/gists{/gist_id}","starred_url":"https://api.github.com/users/openshift/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/openshift/subscriptions","organizations_url":"https://api.github.com/users/openshift/orgs","repos_url":"https://api.github.com/users/openshift/repos","events_url":"https://api.github.com/users/openshift/events{/privacy}","received_events_url":"https://api.github.com/users/openshift/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/openshift/openshift-docs","description":"OpenShift Documentation","fork":false,"url":"https://api.github.com/repos/openshift/openshift-docs","forks_url":"https://api.github.com/repos/openshift/openshift-docs/forks","keys_url":"https://api.github.com/repos/openshift/openshift-docs/keys{/key_id}","collaborators_url":"https://api.github.com/repos/openshift/openshift-docs/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/openshift/openshift-docs/teams","hooks_url":"https://api.github.com/repos/openshift/openshift-docs/hooks","issue_events_url":"https://api.github.com/repos/openshift/openshift-docs/issues/events{/number}","events_url":"https://api.github.com/repos/openshift/openshift-docs/events","assignees_url":"https://api.github.com/repos/openshift/openshift-docs/assignees{/user}","branches_url":"https://api.github.com/repos/openshift/openshift-docs/branches{/branch}","tags_url":"https://api.github.com/repos/openshift/openshift-docs/tags","blobs_url":"https://api.github.com/repos/openshift/openshift-docs/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/openshift/openshift-docs/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/openshift/openshift-docs/git/refs{/sha}","trees_url":"https://api.github.com/repos/openshift/openshift-docs/git/trees{/sha}","statuses_url":"https://api.github.com/repos/openshift/openshift-docs/statuses/{sha}","languages_url":"https://api.github.com/repos/openshift/openshift-docs/languages","stargazers_url":"https://api.github.com/repos/openshift/openshift-docs/stargazers","contributors_url":"https://api.github.com/repos/openshift/openshift-docs/contributors","subscribers_url":"https://api.github.com/repos/openshift/openshift-docs/subscribers","subscription_url":"https://api.github.com/repos/openshift/openshift-docs/subscription","commits_url":"https://api.github.com/repos/openshift/openshift-docs/commits{/sha}","git_commits_url":"https://api.github.com/repos/openshift/openshift-docs/git/commits{/sha}","comments_url":"https://api.github.com/repos/openshift/openshift-docs/comments{/number}","issue_comment_url":"https://api.github.com/repos/openshift/openshift-docs/issues/comments{/number}","contents_url":"https://api.github.com/repos/openshift/openshift-docs/contents/{+path}","compare_url":"https://api.github.com/repos/openshift/openshift-docs/compare/{base}...{head}","merges_url":"https://api.github.com/repos/openshift/openshift-docs/merges","archive_url":"https://api.github.com/repos/openshift/openshift-docs/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/openshift/openshift-docs/downloads","issues_url":"https://api.github.com/repos/openshift/openshift-docs/issues{/number}","pulls_url":"https://api.github.com/repos/openshift/openshift-docs/pulls{/number}","milestones_url":"https://api.github.com/repos/openshift/openshift-docs/milestones{/number}","notifications_url":"https://api.github.com/repos/openshift/openshift-docs/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/openshift/openshift-docs/labels{/name}","releases_url":"https://api.github.com/repos/openshift/openshift-docs/releases{/id}","deployments_url":"https://api.github.com/repos/openshift/openshift-docs/deployments","created_at":"2014-07-11T15:14:42Z","updated_at":"2017-05-26T11:25:00Z","pushed_at":"2017-05-30T13:15:35Z","git_url":"git://github.com/openshift/openshift-docs.git","ssh_url":"git@github.com:openshift/openshift-docs.git","clone_url":"https://github.com/openshift/openshift-docs.git","svn_url":"https://github.com/openshift/openshift-docs","homepage":"https://docs.openshift.org/latest/welcome/index.html","size":39061,"stargazers_count":91,"watchers_count":91,"language":"HTML","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":355,"mirror_url":null,"open_issues_count":237,"forks":355,"open_issues":237,"watchers":91,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/openshift/openshift-docs/pulls/4452"},"html":{"href":"https://github.com/openshift/openshift-docs/pull/4452"},"issue":{"href":"https://api.github.com/repos/openshift/openshift-docs/issues/4452"},"comments":{"href":"https://api.github.com/repos/openshift/openshift-docs/issues/4452/comments"},"review_comments":{"href":"https://api.github.com/repos/openshift/openshift-docs/pulls/4452/comments"},"review_comment":{"href":"https://api.github.com/repos/openshift/openshift-docs/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/openshift/openshift-docs/pulls/4452/commits"},"statuses":{"href":"https://api.github.com/repos/openshift/openshift-docs/statuses/4268b600046fbf66297f971856fd39e065f48461"}}}}
{"actor":{"display_login":"sosiouxme"}}