diff options
| -rw-r--r-- | .envrc | 2 | ||||
| -rw-r--r-- | README.md | 1 | ||||
| -rw-r--r-- | README.org | 49 | ||||
| -rw-r--r-- | guix.scm | 1 |
4 files changed, 50 insertions, 3 deletions
@@ -10,4 +10,4 @@ export GUILE_LOAD_COMPILED_PATH="$GNU_GUIX_PATH" export GUIX_PACKAGE_PATH="$GUILE_LOAD_PATH" -use guix -l guix.scm +use guix --fallback -l guix.scm diff --git a/README.md b/README.md deleted file mode 100644 index 57bd849..0000000 --- a/README.md +++ /dev/null @@ -1 +0,0 @@ -# GOV.UK Mini Environment Admin diff --git a/README.org b/README.org new file mode 100644 index 0000000..6b27836 --- /dev/null +++ b/README.org @@ -0,0 +1,49 @@ +The GOV.UK Mini Environment Admin application can manage mini GOV.UK +environments, deployed mostly on a single machine or system style +container. + +A GOV.UK environment is a connected collection of the various +services. A complete environment would include all the publishing and +admin applications, as well as all the other services. When creating a +mini environment, you can choose to omit some services if they are +unnecessary or undesired. + +It is possible to create mini environments on the local machine +(through using libvirt), or create them on rented infrastructure (from +Amazon Web Services (AWS)). + +* User Documentation + + + +* Developer Documentation + +The GOV.UK Mini Environment Admin is a Ruby on Rails web application +for managing mini environments. Terraform is used for the low level +management of the environments, and this is connected to the web +application through the use of the Que qweuing library, and terraform +Ruby library. + +** Components + +*** Web appliciation + +The web application is responsible for: + + - User authenticating via the GDS:SSO Ruby library, which uses the + GOV.UK Signon service. + - Providing a easy to deploy mini environments through the Terraform + configuration. + - Storing the Terraform state, which Terraform fetches and updates + using a Rest API. + +All the persistent state is stored in a PostgreSQL database. + +*** Queue workers + +The queuing system uses the Ruby Que library, which stores the state +in the PostgreSQL databae. The queues are where Terraform is run. + +*** Terraform configuration + +The Terraform configuration is split up by provider (libvirt or AWS). @@ -3,7 +3,6 @@ (gnu packages ruby) (gnu packages databases) (gnu packages rails) - (gnu packages rails-wip) (gds packages govuk ruby)) (define govuk-mini-environment-admin |