openstack/kolla-ansible
Code Issues Proposed changes

Unify commands in documentation

Browse Source 
The deployer is expected to know the correct permissions for his
environment. Remove 'sudo' everywhere and unify commands

Change-Id: I1ca295221a57e9d8cb35293620d14c0d8c72007d
Closes-Bug: #1496566
This commit is contained in:
Sam Yaple 2015-09-28 05:47:55 +00:00
parent 7ef0b8966c
commit 7ad9619e02
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
doc/dev-quickstart.rst
View File

@ -72,20 +72,20 @@ the following requirements needed by your system:
:: ::
# Ubuntu # Ubuntu
sudo apt-get install -y python-dev python-pip libffi-dev libssl-dev apt-get install -y python-dev python-pip libffi-dev libssl-dev
# Fedora # Fedora
sudo yum install -y python-devel python-pip libffi-devel openssl-devel yum install -y python-devel python-pip libffi-devel openssl-devel
# Centos # Centos
sudo easy_install pip easy_install pip
sudo yum install -y python-devel libffi-devel openssl-devel yum install -y python-devel libffi-devel openssl-devel
To install these clients use: To install these clients use:
:: ::
sudo pip install -U python-openstackclient pip install -U python-openstackclient
Libvirt is started by default on many operating systems. Please disable libvirt Libvirt is started by default on many operating systems. Please disable libvirt
on any machines that will be deployment targets. Only one copy of libvirt may on any machines that will be deployment targets. Only one copy of libvirt may
@ -119,7 +119,7 @@ pip:
pip install -U ansible pip install -U ansible
Buildling Container Images Building Container Images
-------------------------- --------------------------
The Kolla community does not currently generate new images for each commit The Kolla community does not currently generate new images for each commit
@ -161,7 +161,7 @@ Finally, run the deploy operation:
:: ::
$ sudo ./tools/kolla-ansible deploy ./tools/kolla-ansible deploy
A bare metal system takes three minutes to deploy AIO. A virtual machine A bare metal system takes three minutes to deploy AIO. A virtual machine
deployment takes five minutes to deploy AIO. These are estimates; different deployment takes five minutes to deploy AIO. These are estimates; different
@ -175,7 +175,7 @@ executing:
:: ::
$ docker ps -a docker ps -a
If any of the containers exited, this indicates a bug in the container. Please If any of the containers exited, this indicates a bug in the container. Please
seek help by filing a bug or contacting the developers via IRC. seek help by filing a bug or contacting the developers via IRC.
@ -184,7 +184,7 @@ seek help by filing a bug or contacting the developers via IRC.
:: ::
$ docker logs <container-name> docker logs <container-name>
Note some of the containers don't log to stdout at present so the above Note some of the containers don't log to stdout at present so the above
command will provide no information. Instead they log to files command will provide no information. Instead they log to files
@ -195,7 +195,7 @@ reading the logs for nova-api:
:: ::
$ docker exec -t nova_api more /var/log/nova/nova-api.log docker exec -t nova_api more /var/log/nova/nova-api.log
Note reading the logs via an exec operation can only be done if the Note reading the logs via an exec operation can only be done if the
container is running. container is running.