From a24165b9b7dd05a104cc10176e54fa9b5bb91812 Mon Sep 17 00:00:00 2001 From: Sol Jerome Date: Wed, 2 May 2012 08:28:02 -0500 Subject: doc: Fix reports installation docs (reported by calvinx on IRC) Signed-off-by: Sol Jerome --- doc/appendix/guides/web-reports-install.txt | 144 ++++------------------------ doc/reports/dynamic.txt | 2 - 2 files changed, 16 insertions(+), 130 deletions(-) (limited to 'doc') diff --git a/doc/appendix/guides/web-reports-install.txt b/doc/appendix/guides/web-reports-install.txt index f6a588692..c03682974 100644 --- a/doc/appendix/guides/web-reports-install.txt +++ b/doc/appendix/guides/web-reports-install.txt @@ -11,125 +11,17 @@ Dynamic (web) Reports installation ================================== -The first step is to install the needed software components like the -Django framework and the database (SQlite2). All packages for Fedora -are in the Fedora Package Collection or in EPEL_ for CentOS/RHEL:: - - [root@system01 ~]# yum -y install Django python-simplejson python-sqlite2 - -Of course is a web server needed as well:: - - [root@system01 ~]# yum -y install httpd mod_python - -The same packages are needed for Ubuntu systems:: - - [root@system01 ~]# aptitude install python-django apache2 libapache2-mod-python - -Now we need to create the sqlite database. Use the following command on -Fedora, CentOS, or RHEL.:: - - [root@system01 ~]# python /usr/lib/python2.4/site-packages/Bcfg2/Server/Reports/manage.py syncdb - Creating table auth_permission - Creating table auth_group - Creating table auth_user - Creating table auth_message - Creating table django_content_type - Creating table django_session - Creating table django_site - Creating table django_admin_log - Creating table reports_client - Creating table reports_ping - Creating table reports_interaction - Creating table reports_reason - Creating table reports_entries - Creating table reports_entries_interactions - Creating table reports_performance - Creating table reports_internaldatabaseversion - - You just installed Django's auth system, which means you don't have any superusers defined. - Would you like to create one now? (yes/no): no - Installing index for auth.Permission model - Installing index for auth.Message model - Installing index for admin.LogEntry model - Installing index for reports.Client model - Installing index for reports.Ping model - Installing index for reports.Interaction model - Installing index for reports.Entries model - Installing index for reports.Entries_interactions model - -.. note:: There are different versions of Python available. If you are - unsure about your installed version use the following line instead of - the line above.:: - - [root@system01 ~]# PYVER=`python -c 'import sys;print(sys.version[0:3])'`; python /usr/lib/python$PYVER/site-packages/Bcfg2/site-packages/Bcfg2/Server/Reports/manage.py syncdb - -The path on Ubuntu systems is different. Please use the same path as shown -in the following command to execute the script on an Ubuntu machine in -the next steps:: - - [root@system01 ~]# python /usr/share/pyshared/Bcfg2/Server/Reports/manage.py syncdb - Creating table auth_permission - Creating table auth_group - Creating table auth_user - Creating table auth_message - Creating table django_content_type - Creating table django_session - Creating table django_site - Creating table django_admin_log - Creating table reports_client - Creating table reports_ping - Creating table reports_interaction - Creating table reports_reason - Creating table reports_entries - Creating table reports_entries_interactions - Creating table reports_performance - Creating table reports_internaldatabaseversion - - You just installed Django's auth system, which means you don't have any superusers defined. - Would you like to create one now? (yes/no): no - Installing index for auth.Permission model - Installing index for auth.Message model - Installing index for admin.LogEntry model - Installing index for reports.Client model - Installing index for reports.Ping model - Installing index for reports.Interaction model - Installing index for reports.Entries model - Installing index for reports.Entries_interactions model - -The server should be tested to make sure that there are no mistakes:: - - [root@system01 ~]# python /usr/lib/python2.6/site-packages/Bcfg2/Server/Reports/manage.py testserver - Creating test database... - Creating table auth_permission - Creating table auth_group - Creating table auth_user - Creating table auth_message - Creating table django_content_type - Creating table django_session - Creating table django_site - Creating table django_admin_log - Creating table reports_client - Creating table reports_ping - Creating table reports_interaction - Creating table reports_reason - Creating table reports_entries - Creating table reports_entries_interactions - Creating table reports_performance - Creating table reports_internaldatabaseversion - Installing index for auth.Permission model - Installing index for auth.Message model - Installing index for admin.LogEntry model - Installing index for reports.Client model - Installing index for reports.Ping model - Installing index for reports.Interaction model - Installing index for reports.Entries model - Installing index for reports.Entries_interactions model - Validating models... - 0 errors found - - Django version 1.1.1, using settings 'Reports.settings' - Development server is running at http://127.0.0.1:8000/ - Quit the server with CONTROL-C. +You need to install the bcfg2-web package that is available for your +particular distribution. All packages for Fedora are in the Fedora +Package Collection. + +You can find packages for CentOS and RHEL in EPEL_:: + + [root@system01 ~]# yum -y install bcfg2-web + +The same packages are needed for Debian/Ubuntu systems:: + + [root@system01 ~]# aptitude install bcfg2-web Add DBStats to the plugins line of ``bcfg2.conf``. The resulting **[server]** section should look something like this:: @@ -138,6 +30,10 @@ Add DBStats to the plugins line of ``bcfg2.conf``. The resulting repository = /var/lib/bcfg2 plugins = Base,Bundler,Cfg,...,DBStats +You then need to initialize the DBStats reporting database:: + + [root@system01 ~]# bcfg2-admin reports init + Start/restart the Bcfg2 server:: [root@system01 ~]# /etc/init.d/bcfg2-server restart @@ -146,16 +42,8 @@ Run the Bcfg2 client in order to populate the statistics database (this run should take a bit longer since you are uploading the client statistics to the database). -Download the static reports content:: - - [root@system01 ~]# git clone git://git.mcs.anl.gov/bcfg2 - [root@system01 ~]# cd /var/www/ - [root@system01 ~]# mv /path/to/bcfg2/checkout/reports ./ - -Configure Apache using :ref:`dynamic-http-install` as a guide - Copy server/statistics sections of ``bcfg2.conf`` to -``/etc/bcfg2-web.conf`` (make sure it is world-readable). You should +``/etc/bcfg2-web.conf`` (make sure it is world-readable). You should then have something like this:: [server] diff --git a/doc/reports/dynamic.txt b/doc/reports/dynamic.txt index 07763922c..8267bffe3 100644 --- a/doc/reports/dynamic.txt +++ b/doc/reports/dynamic.txt @@ -6,8 +6,6 @@ Bcfg2 Dynamic Reporting System ============================== -.. versionadded:: 0.8.2 - Installation ============ -- cgit v1.2.3-1-g7c22 From 9f31e17f1420dca584aed5b141fbc03eed284b48 Mon Sep 17 00:00:00 2001 From: "Chris St. Pierre" Date: Tue, 10 Apr 2012 17:00:36 -0400 Subject: merged b82a107... removed obsolete docs about import_gpg_keys --- doc/server/plugins/generators/packages.txt | 17 ++++------------- 1 file changed, 4 insertions(+), 13 deletions(-) (limited to 'doc') diff --git a/doc/server/plugins/generators/packages.txt b/doc/server/plugins/generators/packages.txt index 276b73093..900162aaa 100644 --- a/doc/server/plugins/generators/packages.txt +++ b/doc/server/plugins/generators/packages.txt @@ -51,7 +51,7 @@ member clients. | Yum | yum | | +--------+----------+--------------+ -.. note:: +.. note:: .. versionadded:: 1.2.0 @@ -567,7 +567,7 @@ You can also view the sources applicable to a client:: Type: yum URL: http://mirror.example.com/centos-6-x86_64-updates GPG Key(s): http://mirror.example.com/centos-6-x86_64-updates/RPM-GPG-KEY-CentOS-6 - + Name: centos-6-x86_64-os Type: yum URL: http://mirror.example.com/centos-6-x86_64-os @@ -662,17 +662,8 @@ It understands the following directives: * ``gpg_keypath``: The path on the client RPM GPG keys will be copied to before they are imported on the client. Default is "/etc/pki/rpm-gpg". -* ``import_gpg_keys``: The RPM release of an RPM GPG key cannot be - reliably and automatically determined without importing the key into - the server's key chain. If ``import_gpg_keys`` is "false" (the - default), the release of automatically-generated RPM GPG key entries - in the specification will be set to "any", which disables - verification of the release. (Version will still be verified.) In - practice, this is unlikely to be an issue, as the RPM version of a - GPG key is the key's fingerprint, and collisions are rare. If you - do encounter a GPG key version collision, you will need to set this - to "true", whereupon Packages will import the keys into the server's - key chain. Python RPM libraries must be installed for this to work. +* ``version``: Set the version attribute used when binding + Packages. Default is ``auto``. [yum] section ------------- -- cgit v1.2.3-1-g7c22