Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jeff1evesque/drupal-demonstration

Drupal 7: automated build implementing vagrant, puppet, and selinux
https://github.com/jeff1evesque/drupal-demonstration

Last synced: 2 months ago
JSON representation

Drupal 7: automated build implementing vagrant, puppet, and selinux

Host: GitHub
URL: https://github.com/jeff1evesque/drupal-demonstration
Owner: jeff1evesque
License: other
Created: 2014-10-09T23:39:30.000Z (about 10 years ago)
Default Branch: master
Last Pushed: 2017-12-09T23:59:20.000Z (about 7 years ago)
Last Synced: 2024-10-12T02:47:48.911Z (3 months ago)
Language: PHP
Homepage:
Size: 4.99 MB
Stars: 6
Watchers: 3
Forks: 2
Open Issues: 42
Metadata Files:
- Readme: README.md
- Contributing: contributing.md
- License: license.md

Awesome Lists containing this project

README

# Drupal Demonstration [![Build Status](https://travis-ci.org/jeff1evesque/drupal-demonstration.svg?branch=master)](https://travis-ci.org/jeff1evesque/drupal-demonstration)

This repository is a simple demonstration of a virtualized environment
([vagrant](https://www.vagrantup.com/) + [virtualbox](https://www.virtualbox.org/)),
tailored for [drupal](https://www.drupal.org/), within a [Centos 7x](https://www.centos.org/)
operating system. Specifically, a custom vagrant [base box](https://www.vagrantup.com/docs/boxes/base.html),
has been created, from [minimal iso](http://isoredirect.centos.org/centos/7/isos/x86_64/CentOS-7-x86_64-Minimal-1511.iso),
with a custom selinux [policy module](https://github.com/mitchellh/vagrant/issues/6970)
enabled. This allows the corresponding drupal website, within the specified
[document root](https://httpd.apache.org/docs/2.2/mod/core.html#documentroot),
to be served up. The exact [details](https://atlas.hashicorp.com/jeff1evesque/boxes/centos7x)
of the vagrant box, can be located via the corresponding [atlas repository](https://atlas.hashicorp.com/jeff1evesque).

## Contributing

Please adhere to [`contributing.md`](https://github.com/jeff1evesque/drupal-demonstration/blob/master/contributing.md)
, when contributing code. Pull requests that deviate from the
[`contributing.md`](https://github.com/jeff1evesque/drupal-demonstration/blob/master/contributing.md)
, could be [labelled](https://github.com/jeff1evesque/drupal-demonstration/labels)
as `invalid`, and closed (without merging to master). These best practices
will ensure integrity, when revisions of code, or issues need to be reviewed.

## Preconfiguration

This project implements puppet's [r10k](https://github.com/puppetlabs/r10k)
module via vagrant's [plugin](https://github.com/jantman/vagrant-r10k). A
requirement of this implementation includes a `Puppetfile` (already defined),
which includes the following syntax:

```ruby
#!/usr/bin/env ruby
## Install Module: vcsrepo
mod 'vcsrepo',
:git => '[email protected]:puppetlabs/puppetlabs-vcsrepo.git',
:ref => '1.3.0'
...
```

Specifically, this implements the ssh syntax `[email protected]:account/repo.git`,
unlike the following alternatives:

- `https://github.com/account/repo.git`
- `git://github.com/account/repo.git`

This allows r10k to clone the corresponding puppet module(s), without a
deterrence of [DDoS](https://en.wikipedia.org/wiki/Denial-of-service_attack).
However, to implement the above syntax, ssh keys need to be generated, and
properly assigned locally, as well as on the github account.

The following steps through how to implement the ssh keys with respect to
github:

```bash
$ cd ~/.ssh/
$ ssh-keygen -t rsa -b 4096 -C "[email protected]"
Enter file in which to save the key (/Users/you/.ssh/id_rsa): [Press enter]
Enter passphrase (empty for no passphrase): [Type a passphrase]
Enter same passphrase again: [Type passphrase again]
$ ssh-agent -s
Agent pid 59566
$ ssh-add ~/.ssh/id_rsa
$ pbcopy < ~/.ssh/id_rsa.pub
```

**Note:** it is recommended to simply press enter, to keep default values
when asked *Enter file in which to save the key*. Also, if `ssh-agent -s`
alternative for git bash doesn't work, then `eval $(ssh-agent -s)` for other
terminal prompts should work.

Then, at the top of any github page (after login), click `Settings > SSH keys >
Add SSH Keys`, then paste the above copied key into the `Key` field, and click
*Add key*. Finally, to test the ssh connection, enter the following within
the same terminal window used for the above commands:

```bash
$ ssh -T [email protected]
The authenticity of host 'github.com (207.97.227.239)' can't be established.
RSA key fingerprint is 16:27:ac:a5:76:28:2d:36:63:1b:56:4d:eb:df:a6:48.
Are you sure you want to continue connecting (yes/no)? yes
Warning: Permanently added 'github.com,192.30.252.130' (RSA) to the list of
known hosts.
Hi jeff1evesque! You've successfully authenticated, but GitHub does not provide
shell access.
```

## Configuration

Fork this project in your GitHub account. Then, clone your repository, with
one of the following approaches:

- [simple clone](https://github.com/jeff1evesque/drupal-demonstration/blob/master/README.md#simple-clone):
clone the remote master branch.
- [commit hash](https://github.com/jeff1evesque/drupal-demonstration/blob/master/README.md#commit-hash):
clone the remote master branch, then checkout a specific commit hash.
- [release tag](https://github.com/jeff1evesque/drupal-demonstration/blob/master/README.md#release-tag):
clone the remote branch, associated with the desired release tag.

Then, remember to customize [`install.pp`](https://github.com/jeff1evesque/drupal-demonstration/blob/master/puppet/environment/development/modules/drupal/manifests/install.pp):

```puppet
...
$drupal_user = 'admin'
$drupal_pass = 'password'
$site_name = 'sample'
$site_email = '[email protected]'
$locale_val = 'us'
...
```

The above snippet will ensure a drupal `admin` user, with a defined `password`,
upon a successful drupal [installation](https://github.com/jeff1evesque/drupal-demonstration#installation).
Similarly, the additional variables can be trivially defined.

### Simple clone

**Note:** `[destination-directory]` corresponds to the desired directory path,
where the project repository resides. `[account]` corresponds to the git
username, where the repository is being cloned from. If the original
repository was forked, then use your git username, otherwise, use
`jeff1evesque`.

### Commit hash

```bash
cd /[destination-directory]
sudo git clone https://[account]@github.com/[account]/drupal-demonstration.git
cd drupal-demonstration
git remote add upstream https://github.com/[account]/drupal-demonstration.git
# stop vagrant
vagrant halt
# ensure diffs don't prevent checkout, then checkout hash
git checkout -- .
git checkout [hash]
```

**Note:** the hashes associated with a release, can be found under the
corresponding tag value, on the [release](https://github.com/jeff1evesque/drupal-demonstration/releases)
page.

### Release tag

```bash
cd /[destination-directory]
# clone release tag: master branch does not exist
sudo git clone -b [release-tag] --single-branch --depth 1 https://github.com/[account]/drupal-demonstration.git [destination-directory]
git remote add upstream https://github.com/[account]/drupal-demonstration.git
# create master branch from remote master
cd drupal-demonstration
git checkout -b master
git pull upstream master
# return to release tag branch
git checkout [release-tag]
```

**Note:** `[release-tag]` corresponds to the [release tag](https://github.com/jeff1evesque/drupal-demonstration/tags)
value, used to distinguish between releases.

## Installation

In order to proceed with the installation for this project, two dependencies
need to be installed:

- [Vagrant](https://www.vagrantup.com/)
- [Virtualbox](https://www.virtualbox.org/) (with extension pack)

Once the necessary dependencies have been installed, execute the following
command to build the virtual environment:

```bash
cd /path/to/drupal-demonstration/
vagrant up
```

Depending on the network speed, the build can take between 10-15 minutes. So,
grab a cup of coffee, and perhaps enjoy a danish while the virtual machine
builds. Remember, the application is intended to run on localhost, where the
[`Vagrantfile`](https://github.com/jeff1evesque/drupal-demonstration/blob/master/Vagrantfile)
defines the exact port-forward on the host machine.

**Note:** a more complete refresher on virtualization, can be found within the
vagrant [wiki page](https://github.com/jeff1evesque/drupal-demonstration/wiki/Vagrant).

The following lines, indicate the application is accessible via
`https://localhost:6586`, on the host machine, since ssl has been configured:

```bash
...
## Create a forwarded port mapping which allows access to a specific port
# within the machine from a port on the host machine.
config.vm.network "forwarded_port", guest: 80, host: 6585
config.vm.network "forwarded_port", guest: 443, host: 6686
...
```

**Note:** general convention implements port `443` for ssl.

When the `vagrant up` build succeeds, the corresponding drupal installation
[`sample`](https://github.com/jeff1evesque/drupal-demonstration/tree/master/webroot/profiles/sample)
profile, will have enabled corresponding drupal modules, and themes.
Additionally the database can be accessed via the following accounts:

- mariadb root: `root`
- mariadb user: `authenticated`
- mariadb pass (for both): `password`

## Testing / Execution

### phpMyAdmin

This project includes a fully functional [phpMyAdmin](https://www.phpmyadmin.net/) implementation,
which can be accessed as follows:

- [https://localhost:6686/phpMyAdmin](https://localhost:6686/phpMyAdmin)

The corresponding user / password, is the same as our drupal mariadb implementation:

- mariadb user: `authenticated`
- mariadb pass: `password`

### SSH

The following user / password, have been created:

- `root`: `vagrant-admin`
- `provisioner`: `vagrant-provision`

In addition, the ssh key-pair implements the passphrase:

- `passphrase`

### Drush

Several preconfigured drush scripts have been defined:

- `drush/core_update.py`: update drupal core, without rewriting `webroot/.htaccess`, and `webroot/robots.txt`.

To run one of the above drush scripts:

```bash
$ vagrant ssh
==> default: The machine you're attempting to SSH into is configured to use
==> default: password-based authentication. Vagrant can't script entering the
==> default: password for you. If you're prompted for a password, please enter
==> default: the same password you have configured in the Vagrantfile.
Enter passphrase for key '/path/to/.ssh/id_rsa':
[email protected]'s password:
Last login: Tue Feb xx xx:xx:xx xxxx from gateway
[provisioner@drupal-demonstration ~]$ cd /vagrant/drush
[provisioner@drupal-demonstration ~]$ python [script].py
```