From 1f21e135d34be0d09c9cc75c63df9fdbca134b23 Mon Sep 17 00:00:00 2001 From: Anita Kuno Date: Thu, 31 May 2018 13:30:41 -0400 Subject: [PATCH] Survey Documentation This patch creates the documentation for the survey service. Co-Authored-By: Jeremy Stanley Change-Id: Ie602a952b58c5f5200518cb31218097bddd5b747 Story: 2000691 --- doc/source/survey.rst | 84 +++++++++++++++++++ doc/source/systems.rst | 1 + modules/openstack_project/manifests/survey.pp | 20 +++++ 3 files changed, 105 insertions(+) create mode 100644 doc/source/survey.rst diff --git a/doc/source/survey.rst b/doc/source/survey.rst new file mode 100644 index 0000000000..d23f046dd9 --- /dev/null +++ b/doc/source/survey.rst @@ -0,0 +1,84 @@ +:title: Survey + +.. _survey: + +Survey +###### + +Survey runs an instance of the LimeSurvey software, an open source survey +tool written in php. + +At a Glance +=========== + +:Hosts: + * https://survey.openstack.org +:Puppet: + * file:`modules/openstack_project/manifests/survey.pp` +:Projects: + * https://www.limesurvey.org/ +:Bugs: + * https://www.limesurvey.org/community/bug-tracker + +Overview +======== + +Apache is used with a Trove backend. + +Sysadmin +======== + +After initially provisioning the server, enable the Authwebserver plugin via mysqlclient: + +.. code-block:: bash + + insert into plugins (name, active) values ('Authwebserver', 1); + + insert into plugin_settings (plugin_id, plugin_settings.key, plugin_settings.value) values (1, 'strip_domain', '""'); + insert into plugin_settings (plugin_id, plugin_settings.key, plugin_settings.value) values (1, 'serverkey', '"REMOTE_USER"'); + insert into plugin_settings (plugin_id, plugin_settings.key, plugin_settings.value) values (1, 'is_default', '"1"'); + +Log in as admin to auto-create your account: +Admin sign-in: https://survey.openstack.org/admin + +Elevate your account to Superadmin via mysqlclient: + +.. code-block:: bash + + insert into permissions (entity, entity_id, uid, permission, read_p) values ("global", 0, 2, "superadmin", 1); + +(where the 2 in this example should be replaced with whatever the uid index +value is in the users table for your OpenID-autocreated account) + +Refresh your browser. When logged in via the web-ui you should now have +superadmin priviledges allowing you to set the following values: + +Configuration > Global Settings > Email Settings + + Default site admin email: infra-root@openstack.org + + Administrator name: admin + +Configuration > Global Settings > Bounce Settings + + Default site admin email: infra-root@openstack.org + +Save and Close +check admin name and email information on front page: survey.openstack.org +to confirm change + +Admin Survey User +================= + +Log in via https://survey.openstack.org/admin using OpenStackID. + +Navigate to your 'My Account' settings at: +https://survey.openstack.org/index.php/admin/user/sa/personalsettings + +Change your Email from 'autouser@test.test' to the email you would like to +use for the use of surveys. + +Change your Full Name from 'autouser' to your Full Name that survey +participants can recognize. + +Save and Close using the button in the top right hand corner. diff --git a/doc/source/systems.rst b/doc/source/systems.rst index 1f32d270eb..f20ec1f2db 100644 --- a/doc/source/systems.rst +++ b/doc/source/systems.rst @@ -47,3 +47,4 @@ Major Systems github activity asterisk + survey diff --git a/modules/openstack_project/manifests/survey.pp b/modules/openstack_project/manifests/survey.pp index e4ac0dc629..ae7790f1e2 100644 --- a/modules/openstack_project/manifests/survey.pp +++ b/modules/openstack_project/manifests/survey.pp @@ -1,3 +1,23 @@ +# Copyright 2016 Markus Opolka +# Copyright 2018 Anita Kuno +# +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. +# +# Inspiration for this patch as well as portions of it +# come from the work of Markus Opolka and his +# LimeSurvey Puppet module: +# https://github.com/martialblog/puppet-limesurvey +# class openstack_project::survey ( $vhost_name = $::fqdn, $ssl_cert_file = '/etc/ssl/certs/survey.openstack.org.pem',