Merge "Make commands in install manual copy-paste-able"

contrib/devstack/README.rst

@@ -3,9 +3,9 @@
 
 2. Copy Murano integration scripts to Devstack::
 
-      $ cp lib/murano ${DEVSTACK_DIR}/lib
+      cp lib/murano ${DEVSTACK_DIR}/lib
-      $ cp lib/murano-dashboard ${DEVSTACK_DIR}/lib
+      cp lib/murano-dashboard ${DEVSTACK_DIR}/lib
-      $ cp extras.d/70-murano.sh ${DEVSTACK_DIR}/extras.d
+      cp extras.d/70-murano.sh ${DEVSTACK_DIR}/extras.d
 
 3. Create a ``localrc`` file as input to devstack.
 
@@ -21,4 +21,4 @@
 
 5. Deploy your OpenStack Cloud with Murano::
 
-   $ ./stack.sh
+      ./stack.sh

doc/source/articles/test_docs.rst

@@ -114,7 +114,7 @@ It's located in *muranodashboard/tests/functional* folder.
 There are also a number of command line options that can be used to control the test execution and generated outputs. For more details about *nosetests*, try:
 ::
 
- $ nosetests -h
+ nosetests -h
 
 
 Murano Automated Tests: Tempest Tests

doc/source/draft/admin-guide/prepare_lab.rst

@@ -57,7 +57,7 @@ Supported Operation Systems
 
 Install all the requirements on Ubuntu by running::
 
-  # apt-get install gcc python-pip python-dev \
+  sudo apt-get install gcc python-pip python-dev \
   libxml2-dev libxslt-dev libffi-dev \
   libpq-dev python-openssl mysql-client
 
@@ -83,7 +83,7 @@ Install all the requirements on Ubuntu by running::
 
 Install all the requirements on CentOS by running::
 
-  # yum install gcc python-pip python-devel libxml2-devel \
+  sudo yum install gcc python-pip python-devel libxml2-devel \
   libxslt-devel libffi-devel postgresql-devel pyOpenSSL \
   mysql
 
@@ -139,13 +139,13 @@ Steps to reproduce test:
 
    ::
 
-       ># ps aux | grep kvm
+       ps aux | grep kvm
 
 #. Make 5 copies of Windows image file:
 
    ::
 
-       ># for i in $(seq 5); do \
+       for i in $(seq 5); do \
        cp ws-2012-std.qcow2 ws-2012-std-$i.qcow2; done
 
 #. Create script start-vm.sh in the folder with .qcow2 files:
@@ -165,28 +165,28 @@ Steps to reproduce test:
 
    ::
 
-       ># ./start-vm.sh 1
+       sudo ./start-vm.sh 1
 
 #. Turn VM off. You may simply kill all KVM processes by
 
    ::
 
-       ># killall kvm
+       sudo killall kvm
 
 #. Start FIVE instances with command below (as root) and measure time
-interval between ALL VM’s launch and the moment when LAST Server Manager
+   interval between ALL VM’s launch and the moment when LAST Server Manager
-window appears. To view VM’s desktops, connect with VNC viewer to your
+   window appears. To view VM’s desktops, connect with VNC viewer to your
-host to VNC screens :1 thru :5 (ports 5901-5905):
+   host to VNC screens :1 thru :5 (ports 5901-5905):
 
    ::
 
-    ># ./start-vm.sh 5
+       sudo ./start-vm.sh 5
 
 #. Turn VMs off. You may simply kill all KVM processes by
 
    ::
 
-    ># killall kvm
+       sudo killall kvm
 
 
 Baseline Data

doc/source/draft/admin-guide/use_cli.rst

@@ -356,7 +356,7 @@ Example:
 
 .. code-block:: console
 
-  $ murano package-create -c Downloads/Folder1/Classes -r Downloads/Folder2/Resources \
+  murano package-create -c Downloads/Folder1/Classes -r Downloads/Folder2/Resources \
   -n mysql -f io.murano.MySQL -d Package -o MySQL.zip --type Library
   Application package is available at /home/Downloads/MySQL.zip
 

doc/source/draft/appendix/cli_ref.rst

@@ -16,7 +16,7 @@ For help on a specific ``murano`` command, enter:
 
 .. code-block:: console
 
-    $ murano help COMMAND
+    murano help COMMAND
 
     murano usage
     usage: murano \[--version] \[-d] \[-v] \[-k] \[--os-cacert <ca-certificate>]

doc/source/guidelines.rst

@@ -11,7 +11,7 @@ To check your code against PEP 8 run:
 
 ::
 
-    $ tox -e pep8
+    tox -e pep8
 
 
 .. seealso::
@@ -37,13 +37,13 @@ Murano repo on Python 2.7:
 
 ::
 
-    $ tox -e py27
+    tox -e py27
 
 For Python 2.6:
 
 ::
 
-    $ tox -e py26
+    tox -e py26
 
 
 Documentation Guidelines
@@ -72,7 +72,7 @@ Run the following command to build docs locally.
 
 ::
 
-    $ tox -e docs
+    tox -e docs
 
 
 .. _PEP 8: http://www.python.org/dev/peps/pep-0008/

doc/source/image_builders/linux.rst

@@ -31,18 +31,18 @@ for cloning git repositories:
 
 .. code-block:: console
 
-    $ export GITDIR=~/git
+    export GITDIR=~/git
-    $ mkdir -p $GITDIR
+    mkdir -p $GITDIR
 
 
 Clone the components required to build an image to that directory:
 
 .. code-block:: console
 
-    $ cd $GITDIR
+    cd $GITDIR
-    $ git clone git://git.openstack.org/openstack/murano
+    git clone git://git.openstack.org/openstack/murano
-    $ git clone git://git.openstack.org/openstack/murano-agent
+    git clone git://git.openstack.org/openstack/murano-agent
-    $ git clone git://git.openstack.org/openstack/diskimage-builder
+    git clone git://git.openstack.org/openstack/diskimage-builder
 
 
 Checkout a change request that allows to build an image using disk image builder
@@ -50,30 +50,30 @@ completely installed to virtual environment:
 
 .. code-block:: console
 
-    $ cd $GITDIR/diskimage-builder
+    cd $GITDIR/diskimage-builder
-    $ git fetch https://review.openstack.org/openstack/diskimage-builder refs/changes/02/168002/2 && git checkout FETCH_HEAD
+    git fetch https://review.openstack.org/openstack/diskimage-builder refs/changes/02/168002/2 && git checkout FETCH_HEAD
 
 
 Install additional packages required by disk image builder:
 
 .. code-block:: console
 
-    $ sudo apt-get install qemu-utils curl python-tox
+    sudo apt-get install qemu-utils curl python-tox
 
 
 Export paths where additional dib elements are located:
 
 .. code-block:: console
 
-    $ export ELEMENTS_PATH=$GITDIR/murano/contrib/elements:$GITDIR/murano-agent/contrib/elements
+    export ELEMENTS_PATH=$GITDIR/murano/contrib/elements:$GITDIR/murano-agent/contrib/elements
 
 
 And build Ubuntu-based image with the murano agent:
 
 .. code-block:: console
 
-    $ cd $GITDIR/diskimage-builder
+    cd $GITDIR/diskimage-builder
-    $ tox -e venv -- disk-image-create vm ubuntu murano-agent -o ../murano-agent.qcow2
+    tox -e venv -- disk-image-create vm ubuntu murano-agent -o ../murano-agent.qcow2
 
 
 If you need a Fedora based image, replace 'ubuntu' to 'fedora' in the last command.

doc/source/image_builders/upload.rst

@@ -25,7 +25,7 @@ To deploy applications with murano, virtual machine images should be uploaded in
 
 .. code-block:: console
 
-  $ glance image-create --name <NAME>  --is-public true \
+  glance image-create --name <NAME>  --is-public true \
   > --disk-format qcow2 --container-format bare \
   > --file <IMAGE_FILE> --property <IMAGE_METADATA>
 ..
@@ -52,7 +52,7 @@ where:
 
 .. code-block:: console
 
-  $ glance image-update <IMAGE_ID> --property <IMAGE_MATADATA>
+  glance image-update <IMAGE_ID> --property <IMAGE_MATADATA>
 ..
 
 *  Replace **<IMAGE_ID>** with image id from the previous command output.

doc/source/image_builders/windows.rst

@@ -50,23 +50,23 @@ Check that your hardware supports hardware virtualization.
 
 .. code-block:: console
 
-  $ kvm-ok
+  kvm-ok
-  INFO: /dev/kvm exists
+  # INFO: /dev/kvm exists
-  KVM acceleration can be used
+  # KVM acceleration can be used
 ..
 
 If your output differs, check that hardware virtualization is enabled in your BIOS settings. You also could try import KVM kernel module
 
 .. code-block:: console
 
-  $ sudo modprobe kvm-intel
+  sudo modprobe kvm-intel
 ..
 
 or
 
 .. code-block:: cosole
 
-  $ sudo modprobe kvm-amd
+  sudo modprobe kvm-amd
 ..
 
 It might be helpful to add an appropriate module name into **/etc/modules** file to auto-load it during system boot. Sometimes it is required on Ubuntu systems.
@@ -277,22 +277,22 @@ Floppy image with answer file for unattended installation is needed to automate
 
   .. code-block:: console
 
-    $ mkdir ~/flp/files
+    mkdir ~/flp/files
-    $ mkdir ~/flp/mnt
+    mkdir ~/flp/mnt
   ..
 
   .. code-block:: console
 
-    $ dd bs=512 count=2880 if=/dev/zero of=~/flp/floppy.img
+    dd bs=512 count=2880 if=/dev/zero of=~/flp/floppy.img
-    $ mkfs.msdos ~/flp/floppy.img
+    mkfs.msdos ~/flp/floppy.img
   ..
 
 * Mount the image
 
   .. code-block:: console
 
-      $ mkdir ~/flp/mnt
+      mkdir ~/flp/mnt
-      $ sudo mount -o loop ~/floppy.img ~/flp/mnt
+      sudo mount -o loop ~/floppy.img ~/flp/mnt
   ..
 
 * Download **autounattend.xml.template** file from https://github.com/openstack/murano-deployment/tree/master/contrib/windows/image-builder/share/files
@@ -303,7 +303,7 @@ Floppy image with answer file for unattended installation is needed to automate
 
   .. code-block:: console
 
-      $ cp ~/autounattend.xml.template ~/flp/mnt/autounattend.xml
+      cp ~/autounattend.xml.template ~/flp/mnt/autounattend.xml
   ..
 
 * Replace string **%_IMAGE_BUILDER_IP_%** in that file with **192.168.122.1**
@@ -312,7 +312,7 @@ Floppy image with answer file for unattended installation is needed to automate
 
   .. code-block:: console
 
-      $ sudo umount ~/flp/mnt
+      sudo umount ~/flp/mnt
   ..
 
 
@@ -330,21 +330,21 @@ Build Windows image using image builder script
 
   .. code-block:: console
 
-    $ git clone git://git.openstack.org/openstack/murano-deployment.git
+    git clone git://git.openstack.org/openstack/murano-deployment.git
   ..
 
 * Change directory to image-builder folder
 
   .. code-block:: console
 
-    $ cd murano-deployment/contrib/windows/image-builder
+    cd murano-deployment/contrib/windows/image-builder
   ..
 
 * Create folder structure for image builder
 
   .. code-block:: console
 
-    $ sudo make build-root
+    sudo make build-root
   ..
 
 * Download build prerequisites, and copy them to correct folders
@@ -357,21 +357,21 @@ Build Windows image using image builder script
 
   .. code-block:: console
 
-    $ sudo make test-build-files
+    sudo make test-build-files
   ..
 
 * Get list of available images
 
   .. code-block:: console
 
-    $ make
+    make
   ..
 
 * Run image build process (e.g. to build Windows Server 2012)
 
   .. code-block:: console
 
-    $ sudo make ws-2012-std
+    sudo make ws-2012-std
   ..
 
 * Wait until process finishes
@@ -439,7 +439,7 @@ Using CLI Tools
 
   .. code-block:: console
 
-    $ qemu-img create -f raw /var/lib/libvirt/images/ws-2012.img 40G
+    qemu-img create -f raw /var/lib/libvirt/images/ws-2012.img 40G
   ..
 
 2. Start the VM

doc/source/install/configure_network.rst

@@ -66,7 +66,7 @@ To figure out the name of the external network, perform the following command:
 
 .. code-block:: console
 
-    $ neutron net-external-list
+    neutron net-external-list
 
 During the first deploy, required networks and router with specified name will be created and set up.
 

doc/source/install/manual.rst

@@ -34,7 +34,7 @@ Ubuntu
 
 .. code-block:: console
 
-    $ sudo apt-get install python-pip python-dev \
+    sudo apt-get install python-pip python-dev \
       libmysqlclient-dev libpq-dev \
       libxml2-dev libxslt1-dev \
       libffi-dev
@@ -51,7 +51,7 @@ Fedora
 
 .. code-block:: console
 
-    $ sudo yum install gcc python-setuptools python-devel python-pip
+    sudo yum install gcc python-setuptools python-devel python-pip
 ..
 
 
@@ -60,8 +60,8 @@ CentOS
 
 .. code-block:: console
 
-    $ sudo yum install gcc python-setuptools python-devel
+    sudo yum install gcc python-setuptools python-devel
-    $ sudo easy_install pip
+    sudo easy_install pip
 ..
 
 
@@ -70,7 +70,7 @@ Install tox
 
 .. code-block:: console
 
-    $ sudo pip install tox
+    sudo pip install tox
 ..
 
 
@@ -91,12 +91,13 @@ To use MySQL database you should install it and create an empty database first:
 
 .. code-block:: console
 
-    $ apt-get install python-mysqldb mysql-server
+    apt-get install python-mysqldb mysql-server
 ..
 
 .. code-block:: console
 
-    $ mysql -u root -p
+    mysql -u root -p
+
     mysql> CREATE DATABASE murano;
     mysql> GRANT ALL PRIVILEGES ON murano.* TO 'murano'@'localhost' \
         IDENTIFIED BY 'MURANO_DBPASS';
@@ -111,15 +112,15 @@ Install the API service and Engine
 
     .. code-block:: console
 
-        $ mkdir ~/murano
+        mkdir ~/murano
     ..
 
 #.  Clone the Murano git repository to the management server.
 
     .. code-block:: console
 
-        $ cd ~/murano
+        cd ~/murano
-        $ git clone git://git.openstack.org/openstack/murano
+        git clone git://git.openstack.org/openstack/murano
     ..
 
 #.  Set up Murano config file
@@ -130,14 +131,15 @@ Install the API service and Engine
 
     .. code-block:: console
 
-        $ tox -e genconfig
+        tox -e genconfig
     ..
 
     And make a copy of it for further modifications
 
     .. code-block:: console
-        $ cd ~/murano/murano/etc/murano
+
-        $ ln -s murano.conf.sample murano.conf
+        cd ~/murano/murano/etc/murano
+        ln -s murano.conf.sample murano.conf
     ..
 
 #.  Edit ``murano.conf`` with your favorite editor. Below is an example
@@ -203,16 +205,16 @@ Install the API service and Engine
 
     .. code-block:: console
 
-        $ cd ~/murano/murano
+        cd ~/murano/murano
-        $ tox
+        tox
     ..
 
 #.  Create database tables for Murano.
 
     .. code-block:: console
 
-        $ cd ~/murano/murano
+        cd ~/murano/murano
-        $ tox -e venv -- murano-db-manage \
+        tox -e venv -- murano-db-manage \
           --config-file ./etc/murano/murano.conf upgrade
     ..
 
@@ -221,17 +223,19 @@ Install the API service and Engine
 
     .. code-block:: console
 
-        $ cd ~/murano/murano
+        cd ~/murano/murano
-        $ tox -e venv -- murano-api --config-file ./etc/murano/murano.conf
+        tox -e venv -- murano-api --config-file ./etc/murano/murano.conf
     ..
 
 #.  Import Core Murano Library.
 
     .. code-block:: console
 
-        $ cd ~/murano/murano
+        cd ~/murano/murano
-        $ pushd ./meta/io.murano; zip -r ../../io.murano.zip *; popd;
+        pushd ./meta/io.murano
-        $ tox -e venv -- murano --murano-url http://localhost:8082 \
+        zip -r ../../io.murano.zip *
+        popd
+        tox -e venv -- murano --murano-url http://localhost:8082 \
           package-import --is-public io.murano.zip
     ..
 
@@ -240,8 +244,8 @@ Install the API service and Engine
 
     .. code-block:: console
 
-        $ cd ~/murano/murano
+        cd ~/murano/murano
-        $ tox -e venv -- murano-engine --config-file ./etc/murano/murano.conf
+        tox -e venv -- murano-engine --config-file ./etc/murano/murano.conf
     ..
 
 
@@ -256,23 +260,23 @@ Install Murano Dashboard
 
     .. code-block:: console
 
-        $ cd ~/murano
+        cd ~/murano
-        $ git clone git://git.openstack.org/openstack/murano-dashboard
+        git clone git://git.openstack.org/openstack/murano-dashboard
     ..
 
 #.  Clone horizon repository
 
     .. code-block:: console
 
-        $ git clone git://git.openstack.org/openstack/horizon
+        git clone git://git.openstack.org/openstack/horizon
     ..
 
 #.  Create venv and install muranodashboard as editable module.
 
     .. code-block:: console
 
-        $ cd horizon
+        cd horizon
-        $ tox -e venv -- pip install -e ../murano-dashboard
+        tox -e venv -- pip install -e ../murano-dashboard
     ..
 
 #.  Copy muranodashboard plugin file.
@@ -281,7 +285,7 @@ Install Murano Dashboard
 
     .. code-block:: console
 
-        $ cp ../murano-dashboard/muranodashboard/local/_50_murano.py openstack_dashboard/local/enabled/
+        cp ../murano-dashboard/muranodashboard/local/_50_murano.py openstack_dashboard/local/enabled/
     ..
 
 #.  Prepare local settings.
@@ -291,7 +295,7 @@ Install Murano Dashboard
 
     .. code-block:: console
 
-        $ cp openstack_dashboard/local/local_settings.py.example openstack_dashboard/local/local_settings.py
+        cp openstack_dashboard/local/local_settings.py.example openstack_dashboard/local/local_settings.py
 
 #.  Customize local settings according to OpenStack installation.
 
@@ -344,7 +348,7 @@ Install Murano Dashboard
 
     .. code-block:: console
 
-        $ tox -e venv -- python manage.py syncdb
+        tox -e venv -- python manage.py syncdb
     ..
 
     You can reply 'no' since for development purpose separate user is not needed.
@@ -353,7 +357,7 @@ Install Murano Dashboard
 
     .. code-block:: console
 
-        $ tox -e venv -- python manage.py runserver <IP:PORT>
+        tox -e venv -- python manage.py runserver <IP:PORT>
     ..
 
     Development server will be restarted automatically on every code change.
@@ -370,8 +374,8 @@ to fill the catalog. It can be done via dashboard, but also possible via CLI:
 
     .. code-block:: console
 
-        $ cd ~/murano
+        cd ~/murano
-        $ git clone git://git.openstack.org/openstack/murano-apps
+        git clone git://git.openstack.org/openstack/murano-apps
     ..
 
 2.  Import every package you need from this repository, using the command
@@ -379,9 +383,10 @@ to fill the catalog. It can be done via dashboard, but also possible via CLI:
 
     .. code-block:: console
 
-        $ cd ~/murano/murano
+        cd ~/murano/murano
-        $ pushd ../murano-apps/Docker/Applications/%APP-NAME%/package; \
+        pushd ../murano-apps/Docker/Applications/%APP-NAME%/package
-          zip -r ~/murano/murano/app.zip *; popd;
+        zip -r ~/murano/murano/app.zip *
-        $ tox -e venv -- murano --murano-url http://localhost:8082 package-import app.zip
+        popd
+        tox -e venv -- murano --murano-url http://localhost:8082 package-import app.zip
 
 .. include:: configure_network.rst

doc/source/install/prepare.rst

@@ -120,13 +120,13 @@ Steps to reproduce test:
 
    ::
 
-       ># ps aux | grep kvm
+       ps aux | grep kvm
 
 3. Make 5 copies of Windows image file:
 
    ::
 
-       ># for i in $(seq 5); do \
+       for i in $(seq 5); do \
        cp ws-2012-std.qcow2 ws-2012-std-$i.qcow2; done
 
 4. Create script start-vm.sh in the folder with .qcow2 files:
@@ -146,28 +146,28 @@ Steps to reproduce test:
 
    ::
 
-       ># ./start-vm.sh 1
+       sudo ./start-vm.sh 1
 
 6. Turn VM off. You may simply kill all KVM processes by
 
    ::
 
-       ># killall kvm
+       sudo killall kvm
 
 7. Start FIVE instances with command below (as root) and measure time
-interval between ALL VM’s launch and the moment when LAST Server Manager
+   interval between ALL VM’s launch and the moment when LAST Server Manager
-window appears. To view VM’s desktops, connect with VNC viewer to your
+   window appears. To view VM’s desktops, connect with VNC viewer to your
-host to VNC screens :1 thru :5 (ports 5901-5905):
+   host to VNC screens :1 thru :5 (ports 5901-5905):
 
    ::
 
-    ># ./start-vm.sh 5
+       sudo ./start-vm.sh 5
 
 8. Turn VMs off. You may simply kill all KVM processes by
 
    ::
 
-    ># killall kvm
+       sudo killall kvm
 
 Baseline Data
 =============