Bug 1392204 - [DOCS] Verifying Installation missing webui information
Summary: [DOCS] Verifying Installation missing webui information
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Documentation
Version: 3.3.0
Hardware: Unspecified
OS: Unspecified
medium
low
Target Milestone: ---
: ---
Assignee: brice
QA Contact: Sean V. Thompson
Vikram Goyal
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2016-11-06 04:26 UTC by Sean V. Thompson
Modified: 2016-11-22 01:00 UTC (History)
4 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2016-11-22 01:00:32 UTC
Target Upstream Version:


Attachments (Terms of Use)

Description Sean V. Thompson 2016-11-06 04:26:53 UTC
Document URL: 
https://access.redhat.com/documentation/en/openshift-container-platform/3.3/single/installation-and-configuration/#quick-verifying-the-installation

Section Number and Name: 
2.5.6. Verifying the Installation

Describe the issue: 
The instructions currently tell you you how to verify the pods were deployed. It doesn't remind you where the web ui is. I spent a couple of minutes trying to remember how to get to it so I could move in to the getting started guide.

Current Documentation:
After the installation completes, verify that the master is started and nodes are registered and reporting in Ready status. On the master host, run the following as root:

# oc get nodes

NAME                        STATUS                     AGE
master.example.com          Ready,SchedulingDisabled   165d
node1.example.com           Ready                      165d
node2.example.com           Ready                      165d

Then, see What’s Next for the next steps on configuring your OpenShift Container Platform cluster.


Suggestions for improvement: 
After the installation completes, verify that the master is started and nodes are registered and reporting in Ready status. On the master host, run the following as root:

# oc get nodes

NAME                        STATUS                     AGE
master.example.com          Ready,SchedulingDisabled   165d
node1.example.com           Ready                      165d
node2.example.com           Ready                      165d

# oc get endpoints

NAME              ENDPOINTS                                      AGE
docker-registry   <none>                                         9d
kubernetes        192.168.1.X:8443,192.168.1.X:8053,192.168.1.X:8053   14d
router            192.168.1.Y:443,192.168.1.Y:1936,192.168.1.Y:80      9d

Your web console is at 192.168.1.X:8443.

Then, see What’s Next for the next steps on configuring your OpenShift Container Platform cluster.

Additional information: 
The endpoints command may not be required, but it would be nice if the instructions told you where you could find the console information.

Comment 1 brice 2016-11-07 04:17:40 UTC
Sean,

I'm not getting the same results from the commands you mention above. However, I can see the merits of having verification steps in there. I know that if you append the hostname with a :8443 in a browser you can test out to console. Would you be happy with that being the verification step indeed? Is there anything else that is required if that's the direction we go in?

Thanks!

Comment 2 Sean V. Thompson 2016-11-10 13:58:47 UTC
1. "I'm not getting the same results from the commands you mention above."
I ran that command on my master node (single master, multi node setup). If you got "oc get nodes" (already in the doc) to work then "oc get endpoints" should work.

2. "I know that if you append the hostname with a :8443 in a browser you can test out to console. Would you be happy with that being the verification step indeed?"
I would. Running "oc get nodes" is already part of the verification. I think accessing the console would be recommended.

3. "Is there anything else that is required if that's the direction we go in?"
I think whatever is customary in other documents is fine. Personally, I think it would be nice to reference a troubleshooting section. e.g., "'oc get nodes' doesn't show ready, Now what?" or "Tried accessing the console and failed. Now what?" However, it may not be feasible to create a list.

Comment 3 Sean V. Thompson 2016-11-10 14:05:54 UTC
Further clarification on #2.
By default :8443 should work. but it is configurable and someone may have changed it during the installation process. I would clarify that. 

If doing the advanced ansible install. There is a variable set in the /etc/ansible/hosts file that clarifies :XXXX. the variable is openshift_master_console_port=8443.

Comment 4 Sean V. Thompson 2016-11-10 14:06:06 UTC
Further clarification on #2.
By default :8443 should work. but it is configurable and someone may have changed it during the installation process. I would clarify that. 

If doing the advanced ansible install. There is a variable set in the /etc/ansible/hosts file that clarifies :XXXX. the variable is openshift_master_console_port=8443.

Comment 5 brice 2016-11-11 00:54:16 UTC
OK. I submitted a PR for this:

https://github.com/openshift/openshift-docs/pull/3189

Sean, I won't ask for review as this is pretty straight-forward, but if you have any comments please let me know!

Thanks!

Comment 6 openshift-github-bot 2016-11-11 04:34:57 UTC
Commit pushed to master at https://github.com/openshift/openshift-docs

https://github.com/openshift/openshift-docs/commit/f1d8709dad8c46a10f4b34e529f6793ca89c25c5
Merge pull request #3189 from bfallonf/verify_1392204

Bug 1392204 added verification steps for console


Note You need to log in before you can comment on or make changes to this bug.