stackforge/billingstack
Code Issues Proposed changes

sync both linux and mac documentation

Browse Source 
Change-Id: Id93d2035f72da036316733924f6f8b0d34ff66a9
This commit is contained in:
Luis Gervaso 2013-06-10 02:17:57 +02:00
parent 5bf614d330
commit e2b6c7c096
2 changed files with 124 additions and 83 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
doc/source/install/macos.rst
View File

@ -38,6 +38,7 @@ Common Steps
$ brew install rabbitmq $ brew install rabbitmq
.. note:: .. note::
To have launchd start rabbitmq at login: To have launchd start rabbitmq at login:
ln -sfv /usr/local/opt/rabbitmq/*.plist ~/Library/LaunchAgents ln -sfv /usr/local/opt/rabbitmq/*.plist ~/Library/LaunchAgents
Then to load rabbitmq now: Then to load rabbitmq now:
@ -45,49 +46,63 @@ Common Steps
Or, if you don't want/need launchctl, you can just run: Or, if you don't want/need launchctl, you can just run:
rabbitmq-server rabbitmq-server
Start RabbitMQ::
$ rabbitmq-server $ rabbitmq-server
RabbitMQ 3.1.1. Copyright (C) 2007-2013 VMware, Inc. RabbitMQ 3.1.1. Copyright (C) 2007-2013 VMware, Inc.
## ## Licensed under the MPL. See http://www.rabbitmq.com/ ## ## Licensed under the MPL. See http://www.rabbitmq.com/
## ## ## ##
########## Logs: /usr/local/var/log/rabbitmq/rabbit@localhost.log ########## Logs: /usr/local/var/log/rabbitmq/rabbit@localhost.log
###### ## /usr/local/var/log/rabbitmq/rabbit@localhost-sasl.log ###### ## /usr/local/var/log/rabbitmq/rabbit@localhost-sasl.log
########## ##########
Starting broker... completed with 7 plugins.
$ brew install mysql Starting broker... completed with 7 plugins.
2. Clone the BillingStack repo off of Github:: 2. Clone the BillingStack repo off of Github::
$ git clone https://github.com/billingstack/billingstack.git $ git clone https://github.com/billingstack/billingstack.git
$ cd billingstack $ cd billingstack
3. Setup virtualenv and Install BillingStack and it's dependencies:: 3. Setup virtualenv and Install BillingStack and it's dependencies
.. note:: .. note::
This is to not interfere with system packages etc. This is to not interfere with system packages etc.
::
$ pip install virtualenv $ pip install virtualenv
$ python tools/install_venv.py $ python tools/install_venv.py
$ . .venv/bin/activate $ . .venv/bin/activate
$ python setup.py develop $ python setup.py develop
.. note:: .. warning::
ValueError: unknown locale: UTF-8. To fix it you will have to set these environment variables in your ~/.profile or ~/.bashrc manually:
.profile ValueError: unknown locale: UTF-8.
To fix it you will have to set these environment variables in your ~/.profile or ~/.bashrc manually:
export LANG=en_US.UTF-8 export LANG=en_US.UTF-8
export LC_ALL=en_US.UTF-8 export LC_ALL=en_US.UTF-8
Copy sample configs to usable ones, inside the `etc` folder do:: Copy sample configs to usable ones, inside the `etc` folder do
::
$ sudo cp -r etc/billingstack /etc $ sudo cp -r etc/billingstack /etc
$ cd /etc/billingstack $ cd /etc/billingstack
$ sudo ls *.sample | while read f; do cp $f $(echo $f | sed "s/.sample$//g"); done $ sudo ls *.sample | while read f; do cp $f $(echo $f | sed "s/.sample$//g"); done
.. note:: .. note::
Change the wanted configuration settings to match your environment, the file Change the wanted configuration settings to match your environment, the file
is in the `/etc/billingstack` folder:: is in the `/etc/billingstack` folder::
::
$ vi /etc/billingstack/billingstack.conf $ vi /etc/billingstack/billingstack.conf
@ -103,15 +118,21 @@ Installing Central
1. See `Common Steps`_ before proceeding. 1. See `Common Steps`_ before proceeding.
2. Create the DB for :term:`central`:: 2. Create the DB for :term:`central`
::
$ python tools/resync_billingstack.py $ python tools/resync_billingstack.py
3. Now you might want to load sample data for the time being:: 3. Now you might want to load sample data for the time being
::
$ python tools/load_samples.py $ python tools/load_samples.py
4. Start the central service:: 4. Start the central service
::
$ billingstack-central $ billingstack-central
@ -120,8 +141,8 @@ Installing Central
2013-06-09 03:51:22 DEBUG [amqp] Open OK! 2013-06-09 03:51:22 DEBUG [amqp] Open OK!
2013-06-09 03:51:22 DEBUG [amqp] using channel_id: 1 2013-06-09 03:51:22 DEBUG [amqp] using channel_id: 1
2013-06-09 03:51:22 DEBUG [amqp] Channel open 2013-06-09 03:51:22 DEBUG [amqp] Channel open
2013-06-09 03:51:22 INFO [billingstack.openstack.common.rpc.common] Connected to AMQP server on localhost:5672 2013-06-09 03:51:22 INFO [...] Connected to AMQP server on localhost:5672
2013-06-09 03:51:22 DEBUG [billingstack.openstack.common.rpc.service] Creating Consumer connection for Service central 2013-06-09 03:51:22 DEBUG [...] Creating Consumer connection for Service central
Installing the API Installing the API
@ -135,7 +156,9 @@ Installing the API
1. See `Common Steps`_ before proceeding. 1. See `Common Steps`_ before proceeding.
2. Start the API service:: 2. Start the API service
::
$ billingstack-api $ billingstack-api

86
doc/source/install/manual.rst
View File

@ -28,33 +28,49 @@ Common Steps
.. note:: .. note::
The below operations should take place underneath your <project>/etc folder. The below operations should take place underneath your <project>/etc folder.
1. Install system package dependencies (Ubuntu):: 1. Install system package dependencies (Ubuntu)
$ apt-get install python-pip python-virtualenv ::
$ apt-get install rabbitmq-server mysql-server
$ apt-get build-dep python-lxml
2. Clone the BillingStack repo off of Github:: $ apt-get install python-pip
$ apt-get install rabbitmq-server
2. Clone the BillingStack repo off of Github
::
$ git clone https://github.com/billingstack/billingstack.git $ git clone https://github.com/billingstack/billingstack.git
$ cd billingstack $ cd billingstack
3. Setup virtualenv:: 3. Setup virtualenv and Install BillingStack and it's dependencies
.. note:: .. note::
This is to not interfere with system packages etc. This is to not interfere with system packages etc.
::
$ virtualenv --no-site-packages .venv $ pip install virtualenv
$ python tools/install_venv.py
$ . .venv/bin/activate $ . .venv/bin/activate
4. Install BillingStack and it's dependencies::
$ pip install -rtools/setup-requires -rtools/pip-requires -rtools/pip-options
$ python setup.py develop $ python setup.py develop
Copy sample configs to usable ones, inside the `etc` folder do::
$ ls *.sample | while read f; do cp $f $(echo $f | sed "s/.sample$//g"); done Copy sample configs to usable ones, inside the `etc` folder do
::
$ sudo cp -r etc/billingstack /etc
$ cd /etc/billingstack
$ sudo ls *.sample | while read f; do cp $f $(echo $f | sed "s/.sample$//g"); done
.. note::
Change the wanted configuration settings to match your environment, the file
is in the `/etc/billingstack` folder
::
$ vi /etc/billingstack/billingstack.conf
Installing Central Installing Central
@ -69,27 +85,32 @@ Installing Central
1. See `Common Steps`_ before proceeding. 1. See `Common Steps`_ before proceeding.
2. Configure the :term:`central` service:: 2. Create the DB for :term:`central`
Change the wanted configuration settings to match your environment, the file ::
is in the `etc` folder::
$ vi etc/billingstack.conf
Refer to the configuration file for details on configuring the service.
3. Create the DB for :term:`central`::
$ python tools/resync_billingstack.py $ python tools/resync_billingstack.py
4. Now you might want to load sample data for the time being:: 3. Now you might want to load sample data for the time being
$ python tools/dev_samples.py ::
5. Start the central service:: $ python tools/load_samples.py
4. Start the central service
::
$ billingstack-central $ billingstack-central
...
2013-06-09 03:51:22 DEBUG [amqp] Open OK!
2013-06-09 03:51:22 DEBUG [amqp] using channel_id: 1
2013-06-09 03:51:22 DEBUG [amqp] Channel open
2013-06-09 03:51:22 INFO [...] Connected to AMQP server on localhost:5672
2013-06-09 03:51:22 DEBUG [...] Creating Consumer connection for Service central
Installing the API Installing the API
==================== ====================
@ -102,15 +123,12 @@ Installing the API
1. See `Common Steps`_ before proceeding. 1. See `Common Steps`_ before proceeding.
2. Configure the :term:`api` service:: 2. Start the API service
Change the wanted configuration settings to match your environment, the file ::
is in the `etc` folder::
$ vi billingstack.conf
Refer to the configuration file for details on configuring the service.
3. Start the API service::
$ billingstack-api $ billingstack-api
...
2013-06-09 03:52:31 INFO [eventlet.wsgi] (2223) wsgi starting up on http://0.0.0.0:9091/