Update askbot documentation

Refactor puppet resources, new askbot-staging site, update
operational commands, include virtualenv and site url config required
for google-plus authentication.

Change-Id: Ide76a4bd04c96a0b2d77435db9df3e6f68a5dc60
This commit is contained in:
Marton Kiss 2015-07-23 15:13:03 +02:00
parent 3098617708
commit 54a18039fe

View File

@ -12,10 +12,12 @@ At a Glance
:Hosts: :Hosts:
* https://ask.openstack.org * https://ask.openstack.org
* https://ask-staging.openstack.org
:Puppet: :Puppet:
* :file:`modules/askbot` * https://git.openstack.org/cgit/openstack-infra/puppet-askbot/tree/
* :file:`modules/solr` * https://github.com/vamsee/puppet-solr
* :file:`modules/openstack_project/manifests/ask.pp` * :file:`modules/openstack_project/manifests/ask.pp`
* :file:`modules/openstack_project/manifests/ask-staging.pp`
:Projects: :Projects:
* https://askbot.com * https://askbot.com
* http://lucene.apache.org/solr * http://lucene.apache.org/solr
@ -28,6 +30,12 @@ The site ask.openstack.org based on the officially released askbot pip distribut
The stable deployment is extended with a custom OpenStack theme available at The stable deployment is extended with a custom OpenStack theme available at
https://git.openstack.org/cgit/openstack-infra/askbot-theme. https://git.openstack.org/cgit/openstack-infra/askbot-theme.
The ask-staging.openstack.org site based on master branch of
https://github.com/askbot/askbot-devel repository, and deploys askbot
directly from github and consume the openstack theme from
openstack-infra/askbot-theme repository. The staging site is using
python virtualenv for proper pip dependency handling.
System Architecture System Architecture
=================== ===================
@ -107,13 +115,15 @@ Solr schema templates can be found at:
* :file:`modules/askbot/templates/solr/schema.cn.xml.erb` * :file:`modules/askbot/templates/solr/schema.cn.xml.erb`
Operational notes Operational notes
----------------- =================
The askbot website contains a ``surprisingly`` askbot based support forum, The askbot website contains a ``surprisingly`` askbot based support forum,
and a lot of operational related information is available there. Additional and a lot of operational related information is available there. Additional
maintenance commands: maintenance commands:
* activate virtualenv: ``source /usr/askbot-env/bin/activate``
* synchronize db schema: ``python manage.py syncdb`` * synchronize db schema: ``python manage.py syncdb``
* migrate database between upgrades: ``python manage.py migrate`` * migrate database between upgrades: ``python manage.py migrate``
* rebuild solr index: ``python manage.py askbot_rebuild_index -l <language-code>`` * rebuild solr index: ``python manage.py askbot_rebuild_index -l <language-code>``
* assign administrator right to a user: ``python manage.py add_admin <user-id>`` * assign administrator right to a user: ``python manage.py add_admin <user-id>``
* update site url setting in askbot database: ``update livesettings_setting set value = '<site-url>' where "group" = 'QA_SITE_SETTINGS' and key = 'APP_URL';``