ghoscht/arion
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

README.md: Add examples and answers

Browse source
This commit is contained in:
Robert Hensing 2018-12-18 13:27:40 +01:00
parent bcc0f6e948
commit 9297411d40
1 changed files with 38 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

44
README.md
View file

@ -29,18 +29,50 @@ want to either build images or manage garbage collection roots if you
control the deployment host. Either of these has yet to be control the deployment host. Either of these has yet to be
implemented. implemented.
# How do I use Arion? # Install
The command line inherits most `docker-compose` commands. These Have [Nix](https://nixos.org/nix/) and Docker installed.
examples assume you're in this repo's `examples/` directory.
TODO examples git clone git@github.com:hercules-ci/arion.git
nix-env -iA arion -f .
# Do I need to use Hercules CI? # Example of usage
The command line inherits most `docker-compose` commands.
git clone git@github.com:nix-community/todomvc-nix.git
cd todomvc-nix/deploy/arion
arion up
# "FAQ"
### Do I need to use Hercules CI?
Nope, it's just Nix and Docker Compose under the hood. Nope, it's just Nix and Docker Compose under the hood.
# Why "Arion"?
### Does Arion support Docker images?
Yes, you can still specify a docker image. For example:
postgres = {
service.image = "postgres:10";
service.volumes = [ "${toString ./.}/postgres-data:/var/lib/postgresql/data" ];
service.environment.POSTGRES_PASSWORD = "mydefaultpass";
};
### What about garbage collection?
Arion removes the need for garbage collecting docker images,
delegating this task to Nix.
Arion creates a garbage collection root and cleans it up after
completing the command. This means that `arion up` without `-d` is
safe with respect to garbage collection. A deployment that is more
serious than local development must leave a GC root on the deployment
host. This use case is not supported as of now.
### Why "Arion"?
Arion comes from Greek mythology. Poseidon, the god of ~Docker~ the Arion comes from Greek mythology. Poseidon, the god of ~Docker~ the
seas had his eye on Demeter. Demeter tried to trick him by disguising seas had his eye on Demeter. Demeter tried to trick him by disguising