README.md 11 KB
Newer Older
BAIRE Anthony's avatar
BAIRE Anthony committed
1
2
3
4
5
6
7
8
9
10
ALLGO containers
================

Overview
--------

A minimal deployment of allgo consists of 4 docker images:

- **allgo/rails**: the rails application server 
- **allgo/mysql**: the mysql database server
BAIRE Anthony's avatar
BAIRE Anthony committed
11
- **allgo/controller**: the manager for user docker containers
BAIRE Anthony's avatar
BAIRE Anthony committed
12
- **allgo/ssh**: the ssh frontend (giving access to the sandboxes)
13
14
- **allgo/toolbox**: an image containing a set of commands (scp, vi, nano,
  less, ...) to be mounted in the user sandboxes
BAIRE Anthony's avatar
BAIRE Anthony committed
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

These images may be deployed multiple times to implement multiple independent
environments (eg: production, qualification, ...).

Additionally there are two images that are meant to be deployed only once (they
may serve multiple environments)

- **allgo/registry**: the docker registry
- **allgo/nginx**: the frontal http server

There is an extra image used only in development:

- **allgo/smtpsink**: a SMTP server that catches and stores all incoming messages into a single mailbox

Each environment has its own docker network. The nginx container is connected
to all these networks to that it can connect to the rails servers.


CAMPION Sebastien's avatar
CAMPION Sebastien committed
33
License 
CAMPION Sebastien's avatar
CAMPION Sebastien committed
34
35
36
37
38
39
-------

GNU AFFERO GENERAL PUBLIC LICENSE
https://www.gnu.org/licenses/agpl-3.0.html


BAIRE Anthony's avatar
BAIRE Anthony committed
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
Conventions
-----------

All docker images use the following conventions.

### External volumes

They data is stored in:

  - `/vol/rw` for persistent data
  - `/vol/ro` for persistent data in read-only access
  - `/vol/cache` for cache data (persistent data that may be destroyed at any time without any consequence)
  - `/vol/log` for the logs

These paths are expected to be mounted as external volumes, either separately (typical for a production deployment) or with a single mount at `/vol` (typical for a development environment). The owner of external volumes must be the same as the uid used for the app inside the container.

### Admin scripts

Each container may contain a set of scripts for admin purpose (especially for managing the content of external volumes)

  - `/dk/container_init` initialise the content of the external volumes (eg: create and seed a database, write a default config, ...)
  - `/dk/image_upgrade` apply security upgrades to the image. This command is expected to exit with 0 if successful and to output something on stdout/stderr when something was upgraded an nothing if nothing was upgraded (thus if the output is empty, it is not necessary to commit a new image). 



Development environment
-----------------------

BAIRE Anthony's avatar
BAIRE Anthony committed
68
The development environment is managed with docker-compose. There are 2 important files:
BAIRE Anthony's avatar
BAIRE Anthony committed
69
70
71
72

 - `docker-compose.yml` the docker-compose configuration
 - `bootstrap` the bootstrap script

BAIRE Anthony's avatar
BAIRE Anthony committed
73
It provides 8 containers:
BAIRE Anthony's avatar
BAIRE Anthony committed
74

BAIRE Anthony's avatar
BAIRE Anthony committed
75
 - `dev-controller`
BAIRE Anthony's avatar
BAIRE Anthony committed
76
77
 - `dev-mysql`
 - `dev-nginx`
BAIRE Anthony's avatar
BAIRE Anthony committed
78
79
 - `dev-docker`
 - `dev-reddit`
BAIRE Anthony's avatar
BAIRE Anthony committed
80
81
82
83
84
85
86
87
88
 - `dev-registry`
 - `dev-smtpsink`
 - `dev-ssh`

All external volumes are stored in `/data/dev/` (the path is absolute because
it is tricky to use a relative path with the allgo/docker image).

For convenience, all containers not running as root (rails, mysql, registry)
have their user overridden to the UID:GID of the developer running
BAIRE Anthony's avatar
BAIRE Anthony committed
89
docker-compose. This is managed with the `DOCKERUSER` environment variable set
90
91
92
[in the `.env`
file](https://docs.docker.com/compose/environment-variables/#the-env-file) by
`prepare.sh`.
BAIRE Anthony's avatar
BAIRE Anthony committed
93
94

For convenience (again), there is an extra external volumes for `dev-rails`,
BAIRE Anthony's avatar
BAIRE Anthony committed
95
`dev-controller` and `dev-ssh` so that the source directory of the app is mounted
BAIRE Anthony's avatar
BAIRE Anthony committed
96
97
98
99
100
101
102
103
104
105
106
107
inside `/opt/` (in fact it overrides the actual application files provided by
the docker image). The purpose is to avoid rebuilding a new docker image for
each development iteration. 


### Getting started

The sources are located in two repositories:

 - *rails-allgo*: the rails application repository
 - *allgo*: the deployment repository

108

BAIRE Anthony's avatar
BAIRE Anthony committed
109
110
111
112
To set up the development environment, run: 

 1. get the sources
 	<pre>
BAIRE Anthony's avatar
BAIRE Anthony committed
113
	git clone git@gitlab.inria.fr:allgo/allgo.git
BAIRE Anthony's avatar
BAIRE Anthony committed
114
115
116
117
118
119
	cd allgo
	</pre>

 2. *(as root)* create `/data/dev` and make it owned by the developer
	<pre>
	sudo mkdir -p    /data/dev
Charles Deltel's avatar
Charles Deltel committed
120
	sudo chown USER: /data/dev
BAIRE Anthony's avatar
BAIRE Anthony committed
121
122
	</pre>

123
 3. bootstrap the environment
BAIRE Anthony's avatar
BAIRE Anthony committed
124
125
126
127
128
129
130
131
132
133
134
135
136
 	<pre>
	./bootstrap
	</pre>
	This command will run the `/dk/init_container` in every container that
	needs it, then start the container.

	The first run takes a very long time because all images are built from
	scratch (especially the rails image which builds ruby source).
	You have enough time for a coffee break.

	**Note** by default `bootstrap` works on all containers. It is possible
	to give an explicit list of containers instead. Example:
	<pre>
137
		./bootstrap dev-mysql dev-django
BAIRE Anthony's avatar
BAIRE Anthony committed
138
139
	</pre>

140
 4. for convenience, you may want to alias `docker-compose` as `fig` (because
BAIRE Anthony's avatar
BAIRE Anthony committed
141
142
143
144
145
146
     `fig` is much faster to type than `docker-compose` and you will have to
     type it a lot). Somewhere in your `.bashrc` you should add:
	<pre>
	alias fig=docker-compose
	</pre>

147
148
149
150
151
 5. after bootstrap, in development the db is initialised with three users (all with the password `allgo`):
    - `admin@localhost` which is superuser
    - `devel@localhost` which is the owner of a webapp named `sleep`
    - `guest@localhost`

BAIRE Anthony's avatar
BAIRE Anthony committed
152
153
154
155

### Common commands

The official doc for docker-compose is available at: [https://docs.docker.com/compose/
156
](https://docs.docker.com/compose/)
BAIRE Anthony's avatar
BAIRE Anthony committed
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195

 - start all containers (in the background)
	<pre>
	fig up -d
	</pre>

 - start all containers (in the foreground, i.e interactively, when you hit Ctrl-C all containers are stop)
	<pre>
	fig up -d
	</pre>

 - soft cleanup (stop and remove all containers)
	<pre>
	fig down
	</pre>

 - hard cleanup (remove images too)
 	<pre>
	fig down --rmi local
	</pre>

 - restart a container
	<pre>
	fig restart dev-rails
	</pre>

 - restart a container using a new docker image (if the image has been rebuilt since the last start)
 	<pre>
	fig up dev-rails
	</pre>

 - rebuild an image
 	<pre>
	fig build dev-railf
	</pre> 

 - **Note:** most commands work on every container by default (eg: up down
   start stop restart ...) they can be use on an individual container too:
   	<pre>
BAIRE Anthony's avatar
BAIRE Anthony committed
196
	fig restart dev-controller dev-rails
BAIRE Anthony's avatar
BAIRE Anthony committed
197
198
199
200
	</pre>

 - run a container with an arbitrary command (eg: to have access to the rails console)
 	<pre>
BAIRE Anthony's avatar
BAIRE Anthony committed
201
	fig run --rm dev-rails bash
BAIRE Anthony's avatar
BAIRE Anthony committed
202
203
204
205
206
207
208
209
210
211
212
213
214
215
	</pre>

	**Note:** containers created by `fig run` have the same parameters as
	the referenced containers but their name is different (eg:
	*allgo_dev-ssh_run_1*), which means that this container is not
	reachable by the others (this may be an issue for example if you want
	to run the mysqld server manually: `fig run dev-mysql mysqld` -> this
	container won't be reachable by the ssh and rails containers)

 - follow the output of all containers:
 	<pre>
	fig logs --tail=1 --follow
	</pre>

216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262

### Troubleshooting

#### Fedora OS: docker.sock usable by root user only

The docker socket `/run/docker.sock` for interacting with the docker daemon is
owned by `root:root` with `0600` permissions. Only the root user can use it

To use it as an ordinary user, create the `docker` group, then the docker
engine will automatically make its socket owned by `root:docker`. Users who are
members of the docker group will be able to use it. 

To do so you must run the following commands :

<pre>sudo groupadd docker</pre>

Edit the group to add the relevant users to the `docker` group (add them at the
end of the line starting with `docker:`, separated by commas)

<pre>sudo vigr</pre>

Re-open your session (to be effectively in the docker group)


#### **dev-mysql** initialisation fails

The `prepare.sh` script (also sourced by the `./bootstrap` script) creates the
`/data/dev/*/` with the ownership set to the calling user. **Be sure not to run
it as root**, otherwise it will be owned by root and you may have errors like:

	mkdir: cannot create directory ‘/vol/rw’: Permission denied
	mkdir: cannot create directory ‘/vol/log’: Permission denied

If somehow you skipped this step, you can reset the ownership to the current user:

	sudo chown    USER: /data/dev
	sudo chown -R USER: /data/dev/{registry,mysql,rails}

If you are completely lost, you can just restart the initialisation from scratch:

	fig down
	sudo rm -rf /data/dev
	. prepare.sh
	./bootstrap
 


BAIRE Anthony's avatar
BAIRE Anthony committed
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
Production environment
----------------------

- TODO unicorn/nginx integration
- TODO use capistrano too ?


Images design
-------------


## registry

Hosts docker registry with a nginx configured as a reverse proxy. It listens to 4 ports:

 - :8000 (*production*) access limited to `/v2/allgo/prod/`
 - :8001 (*qualification*) access limited to `/v2/allgo/qualif/`
 - :8002 (*development*)  access limited to `/v2/allgo/dev`
 - :5000 (*legacy production*) access limited to `/v2/allgo`(which is mapped to `/v2/allgo/prod/`)

## mysql

Hosts a mysql server listening on port 3306 with two databases: `allgo` and
`allgo_test` and two users: `allgo` and `ssh`.

 - `allgo` has read/write access to both databases
 - `ssh` has read only access to `allgo`


## rails

BAIRE Anthony's avatar
BAIRE Anthony committed
294
Hosts four daemons for running allgo:
BAIRE Anthony's avatar
BAIRE Anthony committed
295

BAIRE Anthony's avatar
BAIRE Anthony committed
296
 - the unicorn server (runnning the rails application)
BAIRE Anthony's avatar
BAIRE Anthony committed
297
298
 - the sidekiq queue manager
 - the redis db server
BAIRE Anthony's avatar
BAIRE Anthony committed
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 - a nginx frontend for buffering the HTTP requests/responses

This container is managed with supervisor, the `supervisorctl` command allows
starting/stopping the daemons individually.

### Running the rails server manually


 - run the `dev-rails` container and open a shell:
	<pre>
	fig up -d
	docker exec -t -i  dev-rails bash
	</pre>

 - then, inside the container, run:
	<pre>
	supervisorctl stop rails
	rails server
	</pre>
BAIRE Anthony's avatar
BAIRE Anthony committed
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372


## ssh

Hosts the ssh front server for accessing the sandboxes (`ssh
WEBAPP@sid.allgo.irisa.fr`). Each allgo webapp is mapped to a system user
(using Glibc NSS) starting at uid 2000.

- `/etc/passwd` and `/etc/group` are overriden so as to contain only the two users (*root* and *sshd*) and one group (*nogroup*) required to run the ssh server
- Extra users are obtained from the mysql database (using libnss-mysql-bg) and mapped as follows:
	<pre>
	name  = webapps.docker_name
	uid   = webapps.id
	gid   = 65534 (nogroup)
	gecos = webapps.name
	shell = /bin/allgo-shell
  	</pre>
- The ssh server is configured to accept key-based authentication only. The
  list of public keys is obtained from the (using an AuthorizedKeysCommand).

- The forced shell (`allgo-shell`) connects to the webapp sandbox (if running).

- The connection to the sandbox is made though a unix socket and a set of pipes
  in the filesystem.

## docker

Hosts the *docker-allgo-proxy* which manages all docker operations (run, stop,
rm, commit, pull, push, ...) on behalf of the rails container.

Technically speaking this container had root privileges since it has access to
the docker socket.

The proxy script enforces restrictions (according to the current environment: eg prod/qualif/dev) on:

 - the registry (for pulling/pushing)
 - the paths of external volumes 
 - the container names (*ENV*-user-*XXXX*)

## nginx

Hosts the frontal nginx server, its purpose is to:
- give access to one or more allgo instances
- manage TLS encryption

## smtpsink

Hosts a SMTP server (port 25) and an IMAP server (port 143) for
development/qualification

Its purpose is to channel all outgoing mail (received on port 25) into a single
mailbox.

The mailbox is accessible with IMAP as user *sink* (password *sink*).