Skip to content

harlo/UnveillanceDeploy

Repository files navigation

UnveillanceDeploy

This is a handy utility to build Docker containers dedicated to your Unveillance Annexes. Simply add your Annex project into the root folder, and either run ./build_image.sh and follow the prompts; or use ./build_image.sh /path/to/custom/config.json after creating your own config.

Requirements

You should already have python-dev and pip installed on your machine.

Setup

./setup.py

Adding a project

  1. cd UnveillanceDeploy
  2. cp /your/Unveillance/Package . or git clone git@host:your/UnveillancePackage.git
  3. if you cloned, you will also have to git submodule update --init --recursive

Configuration

You can create a config.json file with the following formats depending on the type of project (Annex or Frontend) you're building. If any of these directives are missing, you will be prompted during the build process.

Annex

{
	"secrets": {
		"uv_server_host": "localhost",				# what the Annex will report as its hostname
		"uv_uuid": "my_annex",						# the Annex's short-code or nickname
		"annex_dir": "/home/unveillance/annex"		# where the Annex should store its files
	},
	"docker": {
		"SUPER_PACKAGE": "CompassAnnex", 			# the name of the package you wish to deploy
		"USER": "unveillance", 				# unix user
		"USER_PWD" : "ohmigerd",				# user's password.  you should remember it, but it's not too important because sudoer
		"EXTRA_PORTS": "8887",						# if you require extra ports to be opened, list them here: space-separated string
		"ssh_root": "/home/unveillance/.ssh"		# where we'll put the Annex user's .ssh
	}
}

Frontend

{
	"secrets" : {
		"annex_config": "/path/to/config/file.json"
	},
	"docker" : {
		"SUPER_PACKAGE" : "CompassFrontend",
	}
}

Deploy

Annex

Run ./build_image.sh annex and follow the prompts; or use ./build_image.sh annex /path/to/custom/config.json

Your Docker image is now available and can be deployed at any time via Docker using sudo docker run -iPt compassannex:unveillance (or whatever the image turns out to be named, given your inputs).

Frontend

...TBD

About

provisioning annex server farms over docker

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published