Building Guest Images for OpenStack Trove in trove
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
OpenStack DBaaS (Trove) |
In Progress
|
Undecided
|
Tyler Bishop |
Bug Description
The Trove documentation for building images with disk image builder is not sufficient for first time users. Much of it is spent documenting disk image builder, for which there is ample documentation already:
https:/
The parts in the document relating to disk image builder and Trove are vague AT BEST.
I draw your attention to this section:
#######
This command will create a guest image usable by Trove:
# assign a suitable value for each of these environment
# variables that change the way the elements behave.
export HOST_USERNAME
export HOST_SCP_USERNAME
export GUEST_USERNAME
export CONTROLLER_IP
export TROVESTACK_SCRIPTS
export SERVICE_TYPE
export PATH_TROVE
export ESCAPED_PATH_TROVE
export SSH_DIR
export GUEST_LOGDIR
export ESCAPED_
export DIB_CLOUD_
export DATASTORE_
export BRANCH_OVERRIDE
# you typically do not have to change these variables
export ELEMENTS_
export ELEMENTS_
export ELEMENTS_
export DIB_APT_
export DIB_CLOUD_
local QEMU_IMG_
# run disk-image-create that actually causes the image to be built
$disk-image-create -a amd64 -o "${VM}" \
-x ${QEMU_IMG_OPTIONS} ${DISTRO} ${EXTRA_ELEMENTS} vm \
cloud-
#######
The document never explains what these variables are other than to provide a 'suitable value'
Perhaps if the documentation provided an actual example instead of empty variables we might then be at least guess. it's like - you had one job
This bug tracker is for errors with the documentation, use the following as a template and remove or add fields as you see fit. Convert [ ] into [x] to check boxes:
- [x] This doc is inaccurate in this way: vital information is missing, empty examples, mostly about disk image builder.
- [ ] This is a doc addition request.
- [ ] I have a fix to the document that I can paste below including example: input and output.
If you have a troubleshooting or support issue, use the following resources:
- Ask OpenStack: http://
- The mailing list: http://
- IRC: 'openstack' channel on Freenode
-------
Release: 10.0.0.0b2.dev15 on 2018-07-03 09:08
SHA: f025cf78d0e227c
Source: https:/
URL: https:/
I hear you. I'm working through some of this right now and will submit a set of working defaults that people can at least start with..