Magnum quickstart doc has bad example output
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
Magnum |
Fix Released
|
Medium
|
Stephen Watson |
Bug Description
Using the built docs for Magnum and following the quick start guide for "Using Kubernetes Bay" as-is, the "magnum bay-show k8sbay" command is missing rows of text from actual output on a devstack.
QuickStart example output:
+------
| Property | Value |
+------
| status | CREATE_COMPLETE |
| uuid | 481685d2-
| status_reason | Stack CREATE completed successfully |
| created_at | 2015-09-
| updated_at | 2015-09-
| bay_create_timeout | 0 |
| api_address | 192.168.19.84:8080 |
| baymodel_id | 194a4b7e-
| node_count | 1 |
| node_addresses | [u'192.168.19.86'] |
| master_count | 1 |
| discovery_url | https:/
| name | k8sbay |
+------
Actual output:
+------
| Property | Value |
+------
| status | UPDATE_COMPLETE |
| uuid | cff82cd0-
| stack_id | e43cd2db-
| status_reason | Stack UPDATE completed successfully |
| created_at | 2016-05-
| updated_at | 2016-05-
| bay_create_timeout | 0 |
| api_address | https:/
| baymodel_id | e73298e7-
| master_addresses | ['172.24.4.6'] |
| node_count | 2 |
| node_addresses | ['172.24.4.5', '172.24.4.7'] |
| master_count | 1 |
| discovery_url | https:/
| name | k8sbay |
+------
NOTE: node_count is 2 because I updated it, but the issue persists even with default node_count of 1
The example output lacks the master_addresses text seen from actual output.
On re-visiting this situation it seems the doc might need updating to match reality in general. Specifically, after this example output, the quick start guide says "The output here indicates the redis-master is running on the bay host with IP address 192.168.19.86".
The guide then uses an ssh connection to what it calls the master address and runs a docker command on it.
Clearly there's a mismatch at this point between the guide and current behavior since real output calls out a master_address that is separate from the other listed node_addresses whereas the guide uses the single provided address as the master.