opendev/system-config
Code Issues Proposed changes

Merge "Split out drupal module"

Browse Source
This commit is contained in:
Jenkins 2015-01-28 21:12:26 +00:00 committed by Gerrit Code Review
commit d7f4c7ad96
7 changed files with 1 additions and 682 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
modules.env
View File

@ -71,6 +71,7 @@ INTEGRATION_MODULES["https://git.openstack.org/openstack-infra/puppet-github"]="
INTEGRATION_MODULES["https://git.openstack.org/openstack-infra/puppet-httpd"]="origin/master"
INTEGRATION_MODULES["https://git.openstack.org/openstack-infra/puppet-openstackid"]="origin/master"
INTEGRATION_MODULES["https://git.openstack.org/openstack-infra/puppet-redis"]="origin/master"
INTEGRATION_MODULES["https://git.openstack.org/openstack-infra/puppet-drupal"]="origin/master"
if [[ "$PUPPET_INTEGRATION_TEST" -ne "1" ]]; then
# If puppet integration tests are not being run, merge SOURCE and INTEGRATION modules

120
modules/drupal/README.md
View File

@ -1,120 +0,0 @@
# License
Copyright 2013 OpenStack Foundation
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.
# Drupal module for Puppet
This module manages Drupal on Linux distros.
## Description
## Usage
### drupal
Install and configure a Drupal site, including Apache vhost entry, MySQL
database, Pear and drush cli tool.
Example:
class { 'drupal':
site_name => 'www.example.com',
site_docroot => '/srv/vhosts/example.com',
site_mysql_host => 'localhost',
site_mysql_user => 'myuser',
site_mysql_password => 's3cretPassw0rd',
site_mysql_database => 'example',
site_vhost_root => '/srv/vhosts',
site_staging_tarball => 'example-dev.tar.gz',
site_admin_password => 'adminadmin',
site_build_reponame => 'example-master',
site_makefile => 'build-example.make',
site_repo_url => 'https://git.example.com/repo/example',
site_profile => 'standard',
site_base_url => 'http://example.com',
...
}
Build process:
- build a distribution tarball (drupal::distbuild)
- deploy a site from scratch (drupal:sitedeploy)
### drupal::distbuild
Build a distribution from a git repository, using drush make command. Check
out the git repository under site_sandbox_root and compare head commit with
latest deployed version. If version is different, clean up the
site_deploy_flagfile, and drush make building process start. The flag file
site_build_flagfile always contains the version of built repository.
Example:
distbuild { "distbuild-${site_name}":
site_sandbox_root => '/srv/sandbox',
site_staging_root => '/srv/sandbox/release',
site_repo_url => 'https://git.example.com/repo/example',
site_build_repo_name => 'example-master',
site_staging_tarball => 'example-dev.tar.gz',
site_build_flagfile => '/tmp/drupal-site-build',
site_deploy_flagfile => '/tmp/drupal-site-deploy',
site_makefile => 'build-example.make',
...
}
Directory structure:
/srv/sandbox/example-master local git repository clone
build-example.make
drupal-org-core.make
drupal-org.make
example.info
example.install
example.profile
/srv/sandbox/release distribution tarball directory
example-dev.tar.gz
Flag files:
/tmp/drupal-site-build
Holds the version of information of latest successfull build
# pack-refs with: peeled
df23bc9510ac8406c33f896f824997a79d20d27d refs/remotes/origin/master
/tmp/drupal-site-deploy
If missing, drupal:sitedeploy triggers a new deployment process.
### drupal:sitedeploy
Deploy and install a new site based on a previously built distribution
tarball, using drupal_site_deploy.sh script.
Example:
sitedeploy { "sitedeploy-${site_name}":
site_docroot => '/srv/vhosts/example.com',
site_staging_root => '/srv/sandbox/release',
site_staging_tarball => 'example-dev.tar.gz',
site_deploy_flagfile => '/tmp/drupal-site-deploy',
site_name => $site_name,
site_profile => 'standard',
site_mysql_host => 'localhost',
site_mysql_user => 'myuser',
site_mysql_password => 's3cretPassw0rd',
site_mysql_database => 'example',
site_admin_password => 'adminadmin',
site_base_url => 'http://example.com',
...
}
Directory structure:
/srv/vhosts/example.com drupal site root
/etc/drupal
example.com.config drupal site deploy script configuration

75
modules/drupal/manifests/drush.pp
View File

@ -1,75 +0,0 @@
# Copyright 2013 OpenStack Foundation
#
# 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.
#
# == Define: drush
#
# define to add drush and custom dsd extension
#
# Drush parameters:
# - drushdsdtar: drush dsd release tarball
# - basedrushdsdtar: drush dsd tar local filename
# - download_dir: download directory, local copy of release tarball lives here
define drupal::drush (
$drushdsdtar = 'https://github.com/mkissam/drush-dsd/archive/v0.10.tar.gz',
$basedrushdsdtar = 'drush-dsd-0.10.tar.gz',
$download_dir = '/srv/downloads',
) {
# pear / drush cli tool
pear::package { 'PEAR': }
pear::package { 'Console_Table': }
pear::package { 'drush':
version => '6.0.0',
repository => 'pear.drush.org',
require => [ Pear::Package['PEAR'], Pear::Package['Console_Table'] ],
}
file { '/usr/share/php/drush/commands/dsd':
ensure => directory,
owner => 'root',
group => 'root',
mode => '0755',
require => [ Pear::Package['drush'] ]
}
# If we don't already have the specified dsd tar, download it.
exec { "download:${drushdsdtar}":
command => "/usr/bin/wget ${drushdsdtar} -O ${download_dir}/${basedrushdsdtar}",
creates => "${download_dir}/${basedrushdsdtar}",
require => File[$download_dir],
}
# If drush-dsd.tar.gz isn't the same as $basedrushdsdtar, install it.
file { "${download_dir}/drush-dsd.tar.gz":
ensure => present,
source => "file://${download_dir}/${basedrushdsdtar}",
require => Exec["download:${drushdsdtar}"],
replace => true,
owner => 'root',
group => 'root',
mode => '0644',
}
# If drush-dsd just created extract to /etc/drush
exec { 'drush-dsd-initial-init':
user => 'root',
command => "/bin/tar -C /usr/share/php/drush/commands/dsd --strip 1 -xzvf ${download_dir}/drush-dsd.tar.gz;/usr/bin/drush cc all",
subscribe => File["${download_dir}/drush-dsd.tar.gz"],
refreshonly => true,
logoutput => true,
require => File['/usr/share/php/drush/commands/dsd'],
}
}

281
modules/drupal/manifests/init.pp
View File

@ -1,281 +0,0 @@
# Copyright 2013 OpenStack Foundation
#
# 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.
#
# == Class: drupal
#
# A wrapper class to support drupal project integration based on LAMP
# environment.
#
# Actions:
# - Prepare apache vhost and create mysql database (optional)
# - Install Drush tool with Drush-dsd extension
# - Fetch distribution tarball from remote repository
# - Deploy dist tarball and setup Drupal from scratch or
# upgrade an existing site.
#
# Site parameters:
# - site_name: name of the site (FQDN for example)
# - site_admin_password: password of drupal admin
# - site_docroot: root directory of drupal site
# - site_vhost_root: root directory of virtual hosts
# - site_create_database: if true, create a new database (default: false)
# - site_alias: drush site alias name
# - site_profile: installation profile to deploy
#
# SSL configuration:
# - site_ssl_enabled: true if ssl is enabled (default: false)
# - site_ssl_cert_file_contents: x509 certificate of vhost in pem format
# - site_ssl_key_file_contents: rsa key of x509 certificate in pem format
# - site_ssl_chain_file_contents: root ca's of site ssl cert
# - site_ssl_cert_file: file path of x509 certificate
# - site_ssl_key_file: file path of certificate rsa key
# - site_ssl_chain_file: file path of certificate chain
#
# Mysql connection:
# - mysql_user: mysql user of drupal site
# - mysql_password: password of site user
# - mysql_database: site database name
# - mysql_host: host of mysql server (default: localhost)
#
# Drupal configuration variables:
# - conf_cron_key: cron_key setting used for cron access
#
# Remarks:
# - the site lives in /srv/vhosts/{hostname}/slot0 or slot1 directory
# - the /srv/vhosts/{hostname}/w symlinks to slot0 or slot1 and
# points to actual site root. The upgrade process will begin in
# inactive slot so we can avoid typical WSOD issues with Drupal.
# - for temporary package/tarball download it is using the
# /srv/downloads directory.
#
class drupal (
$site_name = undef,
$site_root = undef,
$site_docroot = "${site_root}/w",
$site_mysql_host = 'localhost',
$site_mysql_user = undef,
$site_mysql_password = undef,
$site_mysql_database = undef,
$site_vhost_root = '/srv/vhosts',
$site_profile = 'standard',
$site_admin_password = undef,
$site_alias = undef,
$site_create_database = false,
$site_base_url = false,
$site_file_owner = 'root',
$site_ssl_enabled = false,
$site_ssl_cert_file_contents = undef,
$site_ssl_key_file_contents = undef,
$site_ssl_chain_file_contents = undef,
$site_ssl_cert_file = '',
$site_ssl_key_file = '',
$site_ssl_chain_file = '',
$package_repository = undef,
$package_branch = undef,
$conf_cron_key = undef,
$conf_markdown_directory = undef,
$conf_ga_account = undef,
$conf_openid_provider = undef,
) {
include apache
include pear
# ssl certificates
if $site_ssl_enabled == true {
include apache::ssl
# site x509 certificate
if $site_ssl_cert_file_contents != '' {
file { $site_ssl_cert_file:
owner => 'root',
group => 'root',
mode => '0640',
content => $site_ssl_cert_file_contents,
before => Apache::Vhost[$site_name],
}
}
# site ssl key
if $site_ssl_key_file_contents != '' {
file { $site_ssl_key_file:
owner => 'root',
group => 'root',
mode => '0640',
content => $site_ssl_key_file_contents,
before => Apache::Vhost[$site_name],
}
}
# site ca certificates file
if $site_ssl_chain_file_contents != '' {
file { $site_ssl_chain_file:
owner => 'root',
group => 'root',
mode => '0640',
content => $site_ssl_chain_file_contents,
before => Apache::Vhost[$site_name],
}
}
}
# setup apache and virtualhosts, enable mod rewrite
file { $site_vhost_root:
ensure => directory,
owner => 'root',
group => 'root',
mode => '0755',
}
apache::vhost { $site_name:
port => 80,
priority => '50',
docroot => $site_docroot,
require => Exec['init-slot-dirs'],
template => 'drupal/drupal.vhost.erb',
}
file { $site_root:
ensure => directory,
owner => 'root',
group => 'www-data',
mode => '0755',
require => Package['httpd'],
}
# Create initial symlink here to allow apache vhost creation
# so drush dsd can flip this symlink between slot0/slot1
# (won't be recreated until the symlink exists)
exec { 'init-slot-dirs':
command => "/bin/ln -s ${site_root}/slot1 ${site_docroot}",
unless => "/usr/bin/test -L ${site_docroot}",
logoutput => 'on_failure',
require => File[$site_root],
}
a2mod { 'rewrite':
ensure => present,
}
# php packages
$drupal_related_packages = [ 'unzip', 'php5-mysql', 'php5-gd', 'php5-cli',
'libapache2-mod-php5', 'mysql-client' ]
package { $drupal_related_packages:
ensure => 'installed',
require => Package['httpd'],
notify => Service['httpd'],
}
# This directory is used to download and cache tarball releases
# without proper upstream packages
file { '/srv/downloads':
ensure => directory,
owner => 'root',
group => 'root',
mode => '0755',
}
# setup drush and drush-dsd extension
drush { 'drush':
require => File['/srv/downloads'],
}
# site mysql database
if $site_create_database == true {
mysql::db { $site_mysql_database:
user => $site_mysql_user,
password => $site_mysql_password,
host => $site_mysql_host,
grant => ['all'],
notify => Distbuild["distbuild-${site_name}"],
}
}
# drush site-alias definition
file { '/etc/drush':
ensure => directory,
owner => 'root',
group => 'root',
mode => '0755',
}
file { '/etc/drush/aliases.drushrc.php':
ensure => present,
owner => 'root',
group => 'root',
mode => '0400',
content => template('drupal/aliases.drushrc.php.erb'),
replace => true,
require => [ File['/etc/drush'], Drush['drush'] ],
}
# site custom configuration
file { "${site_root}/etc":
ensure => directory,
owner => 'root',
group => 'root',
mode => '0755',
require => File[$site_root],
}
file { "${site_root}/etc/settings.php":
ensure => file,
owner => 'root',
group => 'root',
mode => '0400',
content => template('drupal/settings.php.erb'),
replace => true,
require => File["${site_root}/etc"],
}
# deploy a site from scratch when site status is 'NOT INSTALLED'
exec { "sitedeploy-${site_name}":
command => "/usr/bin/drush dsd-init @${site_alias}",
logoutput => true,
timeout => 600,
onlyif => "/usr/bin/drush dsd-status @${site_alias} | /bin/grep -c 'NOT INSTALLED'",
require => [
File['/etc/drush/aliases.drushrc.php'],
]
}
# update the site into a new slot when a remote update available
exec { "siteupdate-${site_name}":
command => "/usr/bin/drush dsd-update @${site_alias}",
logoutput => true,
timeout => 600,
onlyif => "/usr/bin/drush dsd-status @${site_alias} | /bin/grep -c 'UPDATE'",
require => [
File['/etc/drush/aliases.drushrc.php'],
Exec["sitedeploy-${site_name}"],
]
}
# setup cron job
cron { $site_name:
name => "${site_name}.cron",
command => "wget -O /dev/null -q -t 1 ${$site_base_url}/cron.php?cron_key=${$conf_cron_key}",
user => root,
minute => '*/5',
require => [
Exec["sitedeploy-${site_name}"],
]
}
}

32
modules/drupal/templates/aliases.drushrc.php.erb
View File

@ -1,32 +0,0 @@
<?php
$aliases['<%= @site_alias %>'] = array(
'root' => '<%= @site_docroot %>',
'dsd-root' => '<%= @site_root %>',
'uri' => '<%= @site_base_url %>',
'db-url' => 'mysql://<%= @site_mysql_user %>:<%= @site_mysql_password %>@<%= @site_mysql_host %>/<%= @site_mysql_database %>',
'databases' => array(
'default' => array(
'driver' => 'mysql',
'username' => '<%= @site_mysql_user %>',
'password' => '<%= @site_mysql_password %>',
'port' => '',
'host' => '<%= @site_mysql_host %>',
'database' => '<%= @site_mysql_database %>',
),
),
'file-owner' => '<%= @site_file_owner %>',
'file-group' => 'www-data',
'variables' => array(
'site_name' => '<%= @site_name %>',
),
'profile' => '<%= @site_profile %>',
'default-admin-password' => '<%= @site_admin_password %>',
'disable-features-revert' => FALSE,
'package-provider' => 'drush-dl',
'package-repository' => '<%= @package_repository %>',
'package-dist-name' => 'groups',
<% if @package_branch == 'dev' %>
'package-dev-branch' => TRUE,
<% end %>
);

154
modules/drupal/templates/drupal.vhost.erb
View File

@ -1,154 +0,0 @@
# ************************************
# Puppet Drupal 7 vhost template
# Managed by Puppet
# ************************************
NameVirtualHost <%= @vhost_name %>:80
<VirtualHost <%= @vhost_name %>:80>
<% if @site_ssl_enabled %>
ServerName <%= @srvname %>
Redirect / https://<%= @srvname %>/
</VirtualHost>
NameVirtualHost <%= @vhost_name %>:443
<VirtualHost <%= @vhost_name %>:443>
SSLEngine on
SSLProtocol All -SSLv2 -SSLv3
SSLCertificateFile <%= @site_ssl_cert_file %>
SSLCertificateKeyFile <%= @site_ssl_key_file %>
<% if @site_ssl_chain_file_contents %>
SSLCertificateChainFile <%= @site_ssl_chain_file %>
<% end %>
<% end %>
ServerName <%= @srvname %>
<% if @serveraliases.is_a? Array -%>
<% @serveraliases.each do |name| -%><%= " ServerAlias #{name}\n" %><% end -%>
<% elsif @serveraliases != '' -%>
<%= " ServerAlias #{@serveraliases}" %>
<% end -%>
DocumentRoot <%= @docroot %>
<Directory <%= @site_docroot %>>
Options FollowSymLinks MultiViews
AllowOverride None
Order allow,deny
allow from all
# Protect files and directories from prying eyes.
<FilesMatch "\.(engine|inc|info|install|make|module|profile|test|po|sh|.*sql|theme|tpl(\.php)?|xtmpl)$|^(\..*|Entries.*|Repository|Root|Tag|Template)$">
Order allow,deny
</FilesMatch>
# Make Drupal handle any 404 errors.
ErrorDocument 404 /index.php
# Set the default handler.
DirectoryIndex index.php index.html index.htm
# PHP 5, Apache 1 and 2.
<IfModule mod_php5.c>
php_flag magic_quotes_gpc off
php_flag magic_quotes_sybase off
php_flag register_globals off
php_flag session.auto_start off
php_value mbstring.http_input pass
php_value mbstring.http_output pass
php_flag mbstring.encoding_translation off
php_value max_execution_time 300
php_value memory_limit 192M
</IfModule>
# Requires mod_expires to be enabled.
<IfModule mod_expires.c>
# Enable expirations.
ExpiresActive On
# Cache all files for 2 weeks after access (A).
ExpiresDefault A1209600
<FilesMatch \.php$>
# Do not allow PHP scripts to be cached unless they explicitly send cache
# headers themselves. Otherwise all scripts would have to overwrite the
# headers set by mod_expires if they want another caching behavior. This may
# fail if an error occurs early in the bootstrap process, and it may cause
# problems if a non-Drupal PHP file is installed in a subdirectory.
ExpiresActive Off
</FilesMatch>
</IfModule>
# Various rewrite rules.
<IfModule mod_rewrite.c>
RewriteEngine on
# Block access to "hidden" directories whose names begin with a period. This
# includes directories used by version control systems such as Subversion or
# Git to store control files. Files whose names begin with a period, as well
# as the control files used by CVS, are protected by the FilesMatch directive
# above.
#
# NOTE: This only works when mod_rewrite is loaded. Without mod_rewrite, it is
# not possible to block access to entire directories from .htaccess, because
# <DirectoryMatch> is not allowed here.
#
# If you do not have mod_rewrite installed, you should remove these
# directories from your webroot or otherwise protect them from being
# downloaded.
RewriteRule "(^|/)\." - [F]
# If your site can be accessed both with and without the 'www.' prefix, you
# can use one of the following settings to redirect users to your preferred
# URL, either WITH or WITHOUT the 'www.' prefix. Choose ONLY one option:
#
# To redirect all users to access the site WITH the 'www.' prefix,
# (http://example.com/... will be redirected to http://www.example.com/...)
# uncomment the following:
# RewriteCond %{HTTP_HOST} !^www\. [NC]
# RewriteRule ^ http://www.%{HTTP_HOST}%{REQUEST_URI} [L,R=301]
#
# To redirect all users to access the site WITHOUT the 'www.' prefix,
# (http://www.example.com/... will be redirected to http://example.com/...)
# uncomment the following:
# RewriteCond %{HTTP_HOST} ^www\.(.+)$ [NC]
# RewriteRule ^ http://%1%{REQUEST_URI} [L,R=301]
# Modify the RewriteBase if you are using Drupal in a subdirectory or in a
# VirtualDocumentRoot and the rewrite rules are not working properly.
# For example if your site is at http://example.com/drupal uncomment and
# modify the following line:
# RewriteBase /drupal
#
# If your site is running in a VirtualDocumentRoot at http://example.com/,
# uncomment the following line:
# RewriteBase /
# Pass all requests not referring directly to files in the filesystem to
# index.php. Clean URLs are handled in drupal_environment_initialize().
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteCond %{REQUEST_URI} !=/favicon.ico
RewriteRule ^ index.php [L]
# Rules to correctly serve gzip compressed CSS and JS files.
# Requires both mod_rewrite and mod_headers to be enabled.
<IfModule mod_headers.c>
# Serve gzip compressed CSS files if they exist and the client accepts gzip.
RewriteCond %{HTTP:Accept-encoding} gzip
RewriteCond %{REQUEST_FILENAME}\.gz -s
RewriteRule ^(.*)\.css $1\.css\.gz [QSA]
# Serve gzip compressed JS files if they exist and the client accepts gzip.
RewriteCond %{HTTP:Accept-encoding} gzip
RewriteCond %{REQUEST_FILENAME}\.gz -s
RewriteRule ^(.*)\.js $1\.js\.gz [QSA]
# Serve correct content types, and prevent mod_deflate double gzip.
RewriteRule \.css\.gz$ - [T=text/css,E=no-gzip:1]
RewriteRule \.js\.gz$ - [T=text/javascript,E=no-gzip:1]
<FilesMatch "(\.js\.gz|\.css\.gz)$">
# Serve correct encoding type.
Header set Content-Encoding gzip
# Force proxies to cache gzipped & non-gzipped css/js files separately.
Header append Vary Accept-Encoding
</FilesMatch>
</IfModule>
</IfModule>
</Directory>
ErrorLog /var/log/apache2/<%= @name %>_error.log
LogLevel warn
CustomLog /var/log/apache2/<%= @name %>_access.log combined
ServerSignature Off
</VirtualHost>

20
modules/drupal/templates/settings.php.erb
View File

@ -1,20 +0,0 @@
<?php
/**
* @file
* Drupal configuration overrides
*
*/
<% if @conf_cron_key %>
$conf['cron_key'] = '<%= @conf_cron_key %>';
<% end %>
<% if @conf_markdown_directory %>
$conf['groups_feeds_markdown_directory'] = '<%= @conf_markdown_directory %>';
<% end %>
<% if @conf_ga_account %>
$conf['googleanalytics_account'] = '<%= @conf_ga_account %>';
<% end %>
<% if @conf_openid_provider %>
$conf['groups_openid_provider'] = '<%= @conf_openid_provider %>';
<% end %>