sdx-compose

This repository allows you to spin up a local test environment for the sdx- suite of services.

Prerequisites

• make
• docker
• docker-compose
• git
• python3

Getting started

Make a directory called sdx e.g. /users/[your_name]/sdx.

This will contain all the files for the sdx services,

[see configuration]

Open your .bash_profile and add the line: export SDX_HOME=[LOCATION OF SDX FOLDER]

Apply these changes to your bash_profile by doing . ~/.bash_profile

Do cd $SDX_HOME and run the following:

$ git clone [email protected]:ONSdigital/sdx-compose.git
$ cd sdx-compose
$ make

This will attempt to clone the repositories into SDX_HOME and run their Dockerfile's

To git pull all the sdx repos (and to discover what branch each repo is on):

$ make update

To rebuild the services:

$ make build

Once built, you can bring the services up with:

$ make start

Once the services have started, you can access sdx-console on http://localhost. sdx-console is an easy way to test the features of SDX. The login credentials for this service are:

username: admin password: admin

Configuration

sdx-compose is not a service in itself, but requires an environment variable to build and run other services.

See the README files of each service for specific requirements they may have. Each service is defaulted as best to run in the local environment using files under env

Logging

By default, all logging runs to the console. If you wish to re-enable syslog you can do so by uncommenting the logger lines in docker-compose.yml.

If you wish to change the log levels that are visible, then adding the following to env/common.env will change it:

LOGGING_LEVEL=INFO

FTP Storage

Output files are stored locally in the pure-ftp-structure folder. To add new directories , add them here with a file called .placeholder checked into git so that git creates the folder.

Architecture

Main Surveys

DAP

SEFT

License

Copyright ©‎ 2016, Office for National Statistics (https://www.ons.gov.uk)

Released under MIT license, see LICENSE for details.