Incorrect documentation at Verify images install

Bug #1066822 reported by Sam Stoelinga
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
openstack-manuals
Fix Released
High
Sam Stoelinga

Bug Description

Affected release: Folsom

At http://docs.openstack.org/trunk/openstack-compute/install/apt/content/images-verifying-install.html the glance commands are incorrect.

I thought the trunk documentation should be according to Folsom, so I'm filing this as a bug.

The following commands are incorrect:
Incorrect:
glance --os-username=admin --os-password=secretword --os-tenant-name=openstackDemo --os-auth-url=http://192.168.206.130:5000/v2.0 image-create name="tty-linux-kernel" disk_format=aki container_format=aki < ttylinux-uec-amd64-12.1_2.6.35-22_1-vmlinuz
will return:
glance: error: unrecognized arguments: name=tty-linux-kernel disk_format=aki container_format=aki

Correct:
glance --os-username=admin --os-password=secretword --os-tenant-name=openstackDemo --os-auth-url=http://192.168.206.130:5000/v2.0 image-create --name="tty-linux-kernel" --disk-format=aki --container-format=aki < ttylinux-uec-amd64-12.1_2.6.35-22_1-vmlinuz

Inccorect:
glance --os-username=admin --os-password=secretword --os-tenant-name=openstackDemo --os-auth-url=http://192.168.206.130:5000/v2.0 image-create name="tty-linux-ramdisk" disk_format=ari container_format=ari < ttylinux-uec-amd64-12.1_2.6.35-22_1-loader
Same corrections needed as above.

I don't know how to change the documentation yet, but would be willing to do it, should be a good excercise.

description: updated
description: updated
tags: added: documentation
Revision history for this message
Anne Gentle (annegentle) wrote :

Sam, I can assign you if you're interested, just let me know.

Changed in openstack-manuals:
status: New → Confirmed
importance: Undecided → High
milestone: none → folsom
Revision history for this message
Tom Fifield (fifieldt) wrote :

Sam, if you're interested you can start at the HowTo - http://wiki.openstack.org/Documentation/HowTo#Detailed_Workflow_with_Github_and_Gerrit

We'd love to help you along the way, if you're interested in learning.

Revision history for this message
Sam Stoelinga (sammiestoel) wrote :

I started working on it, but I got a suggestion instead of uploading it in 3 parts, can't we just use a single qcow2 image file?
Would make it easier for the end user.
But maybe there is a specific reason for this exact image, it would make the document shorter, which I think is a good thing.

Also glance index is deprecated? glance image-list is preferred, remember seeing that before, but I'm not sure anymore, will confirm that later.

I've uploaded first version of patch, but didn't test the commands yet. Will confirm they're working tomorrow.

Changed in openstack-manuals:
assignee: nobody → Sam Stoelinga (sammiestoel)
Revision history for this message
Tom Fifield (fifieldt) wrote :
Changed in openstack-manuals:
status: Confirmed → In Progress
tags: added: glance
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to openstack-manuals (master)

Reviewed: https://review.openstack.org/14528
Committed: http://github.com/openstack/openstack-manuals/commit/025a3cca3f01d451ffbeb72a6294d9545ccdbce9
Submitter: Jenkins
Branch: master

commit 025a3cca3f01d451ffbeb72a6294d9545ccdbce9
Author: Sam Stoelinga <email address hidden>
Date: Thu Oct 18 23:43:29 2012 +0800

    Fixes incorrect glance cli commands

    Fixes bug 1066822

    Change-Id: Ic98e48897e8b463ffdaee1c3e5f4fd593f15be60

Changed in openstack-manuals:
status: In Progress → Fix Released
Revision history for this message
Anne Gentle (annegentle) wrote :

Both ideas are great - glance index is deprecated and a single image upload is much simpler, thanks!

Revision history for this message
Sam Stoelinga (sammiestoel) wrote :

Ok will open a bug or blueprint for that? Simplify and remove deprecated CLI from verify images install

Also I noticed while browsing the glance cli documentation from developer docs, that the deprecated functions are only shown:
http://docs.openstack.org/developer/glance/glance.html
As you can see they still use the add, index etc commands in those docs. Those probably require a rewrite too?

no longer affects: glance
Revision history for this message
ikke (ikke-iki) wrote :

hmmm, maybe you could also fix the last two parameters of the same command:

glance image-create --name="tty-linux" --disk-format=ami \
    --container-format=ami \
    kernel-id 6315f593-52c4-447b-8382-dde74fdbe7ad \
    ramdisk-id b36c15eb-e01d-46fe-8f92-e5e0e31f460b \
    < ttylinux-uec-amd64-12.1_2.6.35-22_1.img

glance: error: unrecognized arguments: kernel-id 6315f593-52c4-447b-8382-dde74fdbe7ad ramdisk-id b36c15eb-e01d-46fe-8f92-e5e0e31f460b

I'm now stuck there, need to continue on that later.

Revision history for this message
ikke (ikke-iki) wrote :

also tried with --kernel-id, and kernel_id and with or without equal signs, none of them do work.

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.