incorrect documentation: details about proper permissions not specified or are incorrect

Bug #1581923 reported by Rahul Sharma
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack-Ansible
Fix Released
Wishlist
Travis Truman

Bug Description

I am following the link to install openstack-ansible AIO deployment using the link http://docs.openstack.org/developer/openstack-ansible/developer-docs/quickstart-aio.html

Initially, there is a reference of "apt-get dist-upgrade" with root user prompt "#".

# apt-get dist-upgrade
# reboot

Later on, the docs provide commands to clone the git code into /opt/openstack-ansible directory. However, the command prompt specified in commands is "$" which will give permission errors. You need to have root permissions to write to that path.

$ git clone https://github.com/openstack/openstack-ansible \
    /opt/openstack-ansible
$ cd /opt/openstack-ansible

The use of "#" for some commands and use of "$" for others is not specified correctly. Also, one doesn't come to know if he should run the particular command as root user or normal user. I have this concern because if we look at devstack documentation, it is always specified not to do stack or unstack with root user. Here, in ansible, no such thing is specified. The given documentation doesn't help me in clarifying my doubts, plus the wrong use of "$" makes me to think that these commands might only needs to be run as non-root user. Hence, I want to add this bug so that things can be corrected.

Tags: impacts-doc
Changed in openstack-ansible:
assignee: nobody → Travis Truman (travis-truman)
Changed in openstack-ansible:
status: New → Confirmed
importance: Undecided → Wishlist
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to openstack-ansible (master)

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

Changed in openstack-ansible:
status: Confirmed → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to openstack-ansible (master)

Reviewed: https://review.openstack.org/317609
Committed: https://git.openstack.org/cgit/openstack/openstack-ansible/commit/?id=602ddac914b3d4cf15864f2d4b4c042eab84bcb0
Submitter: Jenkins
Branch: master

commit 602ddac914b3d4cf15864f2d4b4c042eab84bcb0
Author: Travis Truman <email address hidden>
Date: Tue May 17 12:22:52 2016 -0400

    DOC - AIO build expected to be performed as root user

    This was unclear given the use of $ prompt in many of
    the shell examples.

    Closes-Bug: #1581923
    Change-Id: Ie204d572d107b7676517187938ade906599c10ee

Changed in openstack-ansible:
status: In Progress → Fix Released
Revision history for this message
Thierry Carrez (ttx) wrote : Fix included in openstack/openstack-ansible 14.0.0.0b1

This issue was fixed in the openstack/openstack-ansible 14.0.0.0b1 development milestone.

Revision history for this message
Doug Hellmann (doug-hellmann) wrote : Fix included in openstack/openstack-ansible 14.0.0.0b2

This issue was fixed in the openstack/openstack-ansible 14.0.0.0b2 development milestone.

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.