Magnum quickstart doc has bad example output

Bug #1586123 reported by Stephen Watson
6
This bug affects 1 person
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-bc16-4daf-9aac-9e830c7da3f7 |
| status_reason | Stack CREATE completed successfully |
| created_at | 2015-09-22T20:02:39+00:00 |
| updated_at | 2015-09-22T20:05:00+00:00 |
| bay_create_timeout | 0 |
| api_address | 192.168.19.84:8080 |
| baymodel_id | 194a4b7e-0125-4956-8660-7551469ae1ed |
| node_count | 1 |
| node_addresses | [u'192.168.19.86'] |
| master_count | 1 |
| discovery_url | https://discovery.etcd.io/373452625d4f52263904584b9d3616b1 |
| name | k8sbay |
+--------------------+------------------------------------------------------------+

Actual output:
+--------------------+------------------------------------------------------------+
| Property | Value |
+--------------------+------------------------------------------------------------+
| status | UPDATE_COMPLETE |
| uuid | cff82cd0-189c-4ede-a9cb-2c0af6997709 |
| stack_id | e43cd2db-8ead-4590-a1a5-0702899ffc59 |
| status_reason | Stack UPDATE completed successfully |
| created_at | 2016-05-26T17:45:57+00:00 |
| updated_at | 2016-05-26T17:50:02+00:00 |
| bay_create_timeout | 0 |
| api_address | https://172.24.4.4:6443 |
| baymodel_id | e73298e7-e621-4d42-b35b-7a1952b97158 |
| 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://discovery.etcd.io/4caaa65f297d4d49ef0a085a7aecf8e0 |
| 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.

Revision history for this message
Stephen Watson (stephen-watson) wrote :

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.

Revision history for this message
hongbin (hongbin034) wrote :

@Stephen,

Thanks for reporting the bug. I agree with you that the quickstart guide is not perfect and some information is outdated. Please feel free to submit a patch to improve it if you interest to do that, or I can find another contributors to address it.

Changed in magnum:
status: New → Triaged
importance: Undecided → Medium
Revision history for this message
Stephen Watson (stephen-watson) wrote :

After verifying that the behavior didn't seem to change I'll go ahead and make a commit for this bug.

Some additional finds:
* The BAY_HEAT_NAME=... command uses the deprecated "heat stack-list" instead of "openstack stack list"
* The guide also uses "heat resource-list NAME" instead of "openstack stack resource list"

I'll fix these as well in the same commit

Changed in magnum:
assignee: nobody → Stephen Watson (stephen-watson)
status: Triaged → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to magnum (master)

Fix proposed to branch: master
Review: https://review.openstack.org/323556

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to magnum (master)

Reviewed: https://review.openstack.org/323556
Committed: https://git.openstack.org/cgit/openstack/magnum/commit/?id=12da197e1f8271a9f90f97e8b8a46bac42e24e9c
Submitter: Jenkins
Branch: master

commit 12da197e1f8271a9f90f97e8b8a46bac42e24e9c
Author: Stephen Watson <email address hidden>
Date: Thu May 26 13:03:42 2016 -0700

    Fix Kubernetes-related deprecation in quickstart

    Using the built docs for Magnum and following the quickstart guide
    for "Using Kubernetes Bay" as-is, the "magnum bay-show k8sbay"
    command is missing rows of text from current output on a devstack.
    Additionally, fix 2 references to deprecated heat commands, and
    udpate them to relevant openstack commands.

    Closes-Bug: #1586123
    Change-Id: Id6a40963d4c02eab06e9519d28f68f9345dc80ec

Changed in magnum:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/magnum 3.0.0

This issue was fixed in the openstack/magnum 3.0.0 release.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.