e305f61b18
Fixed a problem with the docs not even building and cleaned up the sphinx warnings. Changed the directory structure to more closely resemble other OpenStack projects. This doesn't address any of the content yet, simply the structure and ability to build. Change-Id: I2b00b12b7664d58d44994b9d0e23a55c96379c18
129 lines
3.8 KiB
ReStructuredText
129 lines
3.8 KiB
ReStructuredText
==================
|
|
Installation Guide
|
|
==================
|
|
|
|
Tuskar source code should be pulled directly from git::
|
|
|
|
git clone https://git.openstack.org/openstack/tuskar
|
|
|
|
|
|
Dependencies
|
|
------------
|
|
|
|
Setting up a local environment for development can be done with tox::
|
|
|
|
# install prerequisites
|
|
* Ubuntu/Debian:
|
|
$ sudo apt-get install python-dev swig libssl-dev python-pip libmysqlclient-dev libxml2-dev libxslt-dev gcc
|
|
* Fedora/RHEL:
|
|
$ sudo yum install python-devel swig openssl-devel python-pip mysql-devel libxml2-devel libxslt-devel gcc
|
|
# Note that as of Fedora 19, you need to use the community
|
|
upstream for mysql, called mariadb-devel
|
|
|
|
$ sudo pip install virtualenv setuptools-git flake8 tox
|
|
|
|
You may need to downgrade tox, due to an issue described here: https://bugs.launchpad.net/openstack-ci/+bug/1274135::
|
|
|
|
$ sudo pip uninstall --yes tox virtualenv
|
|
$ sudo rm -rf /tmp/pip-build-* /usr/local/lib/python2.7/dist-packages/tox \
|
|
/usr/local/lib/python2.7/dist-packages/virtualenv \
|
|
/usr/local/bin/tox /usr/local/bin/virtualenv
|
|
$ sudo pip install -U tox==1.6.1 virtualenv==1.10.1
|
|
|
|
Now create your virtualenv::
|
|
|
|
$ cd <your_src_dir>/tuskar
|
|
$ tox -e py27
|
|
|
|
Note: if ``pip install`` fails due to an outdated setuptools, you can try to update it first::
|
|
|
|
$ sudo pip install --upgrade setuptools
|
|
|
|
|
|
Configuration
|
|
-------------
|
|
|
|
Copy the sample configuration file:
|
|
|
|
::
|
|
|
|
$ cp etc/tuskar/tuskar.conf.sample etc/tuskar/tuskar.conf
|
|
|
|
Edit the config file and uncomment the `heat_keystone` section at the bottom:
|
|
|
|
::
|
|
|
|
[heat_keystone]
|
|
|
|
username = heat
|
|
password = heat
|
|
tenant_name = admin
|
|
auth_url = http://localhost:35357/v2.0
|
|
insecure = True
|
|
|
|
Note: replace these values with credentials for our undercloud OpenStack. If
|
|
you're using `Devstack <http://devstack.org/>`_, the username and password are
|
|
printed out when `stack.sh` finishes its job.
|
|
|
|
You will need a local checkout of the tripleo-heat-templates. Uncomment the
|
|
configuration entry that is defined for this purpose: tht_local_dir should point
|
|
to your local copy of the tripleo-heat-templates::
|
|
|
|
tht_local_dir = /etc/tuskar/tripleo-heat-templates/
|
|
|
|
At tuskar startup, if the directory specified by tht_local_dir in your
|
|
tuskar.conf doesn't exist startup will fail. You can clone the templates::
|
|
|
|
(sudo) git clone https://git.openstack.org/openstack/tripleo-heat-templates /etc/tuskar/tripleo-heat-templates/
|
|
|
|
We need to initialise the database schema::
|
|
|
|
# activate the virtualenv
|
|
$ source .tox/py27/bin/activate
|
|
|
|
# if you delete tuskar.sqlite this will force creation of tables again - e.g.
|
|
# if you added a new resource table definitions etc in an existing migration
|
|
# file
|
|
$ tuskar-dbsync --config-file etc/tuskar/tuskar.conf
|
|
|
|
You can verify this was successful (in addition to seeing no error
|
|
output) with::
|
|
|
|
$ sqlite3 tuskar/openstack/common/db/tuskar.sqlite .schema
|
|
|
|
Then, launch the app::
|
|
|
|
$ tuskar-api --config-file etc/tuskar/tuskar.conf
|
|
|
|
Assuming this is your first time running with a new database, you should
|
|
populate the DB with some initial data::
|
|
|
|
$ python tools/initial_data.py
|
|
|
|
This will create four Overcloud Roles. You can then verify that everything
|
|
worked by running::
|
|
|
|
$ curl -v -X GET -H 'Accept: application/json' http://0.0.0.0:8585/v1/overcloud_roles/ | python -mjson.tool
|
|
|
|
This command should return JSON for four Overcloud Roles.
|
|
|
|
Running Tuskar API
|
|
------------------
|
|
|
|
Whenever you want to run the API again, just switch to the virtualenv and run
|
|
`tuskar-api` command:
|
|
|
|
::
|
|
|
|
$ source .tox/py27/bin/activate
|
|
$ tuskar-api --config-file etc/tuskar/tuskar.conf
|
|
|
|
|
|
Contributing
|
|
------------
|
|
|
|
For additional developer information, take a look at
|
|
`CONTRIBUTING.rst <docs/CONTRIBUTING.rst>`_
|
|
and the
|
|
`developer documentation <docs/index.rst>`_.
|