Getting started

The tools you need to set up will differ based on the environment you want to set up. See the following diagram:

graph TB subgraph Source Repository end subgraph Deployment GoCD end subgraph Management Salt end subgraph Provisioning Vagrant["Vagrant (Development)"]--Machines-->Salt Docker["Docker (Test)"]--Machines-->Salt Other["Other (Production)"]--Machines-->Salt end Salt--Configuration-->GoCD Repository--Source code-->GoCD

See the subchapters for detailed instructions on each of the different tools.

Local development environments

In development environments machines are managed by Vagrant, which allows machines to be started and stopped independently or by using Vagrant groups. You're also able to add your own machines as required.

For Moodle

The default environment provides the following machines:

A Salt master to provision all of the machines
An application server running nginx and PHP-FPM, preconfigured for remote debugging with Xdebug
A database server running PostgreSQL
A mail server running MailCatcher, allowing you to see outbound email in real-time
A complete Selenium environment, consisting of a hub server, a Firefox node and a Chrome node.

For SimpleSAMLphp

The following machines are provided for testing a single sign on experience:

An Identity Provider with a built-in authentication source for simulating more complex IdPs.
An Identity Provider Proxy capable of sitting between federations.

Utilities

The following machines are provided for testing more complex configurations:

A GoCD instance for testing deployment pipelines
A nameserver running BIND for testing your DNS configuration.

Continuous integration and test environments

In this configuration, all of the roles required for a bare bones testing environment are installed in a single container. Whilst not in the spirit of containers this was a necessary compromise to be compatible with current CI implementations. As soon as we're aware of Docker Compose or similar support in one of the CI platforms we'll rework this.

Production deployments

Ubiquitous does not provide a provisioning tool configuration for production environments. Our manual installation instructions can be automated with your preferred tool.

Introduction