Browse code

Try a different presentation of infrastructure documentation.

Jérôme Petazzoni authored on 2013/10/11 10:22:23
Showing 2 changed files
... ...
@@ -1,5 +1,81 @@
1 1
 # Docker project infrastructure
2 2
 
3
-This directory holds all information about the technical infrastructure of the docker project; servers, dns, email, and all the corresponding tools and configuration.
3
+This is an overview of the Docker infrastructure.
4 4
 
5
-Obviously credentials should not be stored in this repo, but how to obtain and use them should be documented here.
5
+**Note: obviously, credentials should not be stored in this repository.**
6
+However, when there are credentials, we should list how to obtain them
7
+(e.g. who has them).
8
+
9
+
10
+## Providers
11
+
12
+This should be the list of all the entities providing some kind of
13
+infrastructure service to the Docker project (either for free,
14
+or paid by dotCloud).
15
+
16
+
17
+Provider      | Service
18
+--------------|-------------------------------------------------
19
+AWS           | packages (S3 bucket), dotCloud PAAS, dev-env, ci
20
+CloudFlare    | cdn
21
+Digital Ocean | ci
22
+dotCloud PAAS | website, index, registry, ssl, blog
23
+DynECT        | dns (docker.io)            
24
+GitHub        | repository
25
+Linode        | dev-env
26
+Mailgun       | outgoing e-mail            
27
+ReadTheDocs   | docs
28
+
29
+*Ordered-by: lexicographic*
30
+
31
+
32
+## URLs
33
+
34
+This should be the list of all the infrastructure-related URLs
35
+and which service is handling them.
36
+
37
+URL                                         | Service
38
+--------------------------------------------|---------------------------------
39
+ http://blog.docker.io/                     | blog
40
+*http://cdn-registry-1.docker.io/           | registry (pull)
41
+ http://debug.docker.io/                    | debug tool
42
+ http://docs.docker.io/                     | docsproxy (proxy to readthedocs)
43
+ http://docker-ci.dotcloud.com/             | ci
44
+ http://docker.io/                          | redirect to www.docker.io (dynect)
45
+ http://docker.readthedocs.org/             | docs
46
+*http://get.docker.io/                      | packages
47
+ https://github.com/dotcloud/docker         | repository
48
+*https://index.docker.io/                   | index
49
+ http://registry-1.docker.io/               | registry (push)
50
+ http://staging-docker-ci.dotcloud.com/     | ci
51
+*http://test.docker.io/                     | packages
52
+*http://www.docker.io/                      | website
53
+
54
+*Ordered-by: lexicographic*
55
+
56
+**Note:** an asterisk in front of the URL means that it is cached by CloudFlare.
57
+
58
+
59
+## Services
60
+
61
+This should be the list of all services referenced above.
62
+
63
+Service             | Maintainer(s)      | How to update    | Source
64
+--------------------|--------------------|------------------|-------
65
+blog                | @jbarbier          | dotcloud push    | https://github.com/dotcloud/blog.docker.io
66
+cdn                 | @jpetazzo @samalba | cloudflare panel | N/A
67
+ci                  | @mzdaniel          | See [docker-ci]  | See [docker-ci]
68
+docs                | @metalivedev       | github webhook   | docker repo
69
+docsproxy           | @dhrp              | dotcloud push    | https://github.com/dotcloud/docker-docs-dotcloud-proxy
70
+index               | @kencochrane       | dotcloud push    | private
71
+packages            | @jpetazzo          | hack/release     | docker repo
72
+registry            | @samalba           | dotcloud push    | https://github.com/dotcloud/docker-registry
73
+repository (github) | N/A                | N/A              | N/A
74
+ssl (dotcloud)      | @jpetazzo          | dotcloud ops     | N/A
75
+ssl (cloudflare)    | @jpetazzo          | cloudflare panel | N/A
76
+website             | @dhrp              | dotcloud push    | https://github.com/dotcloud/www.docker.io
77
+
78
+*Ordered-by: lexicographic*
79
+
80
+
81
+[docker-ci]: docker-ci.rst
6 82
deleted file mode 100644
... ...
@@ -1,103 +0,0 @@
1
-# Docker Server Overview
2
-This is an overview of the Docker infrastructure
3
-
4
-## Docker Git Repo
5
-The Docker source code lives on github.com under the dotCloud account.
6
-https://github.com/dotcloud/docker
7
-
8
-## DNS
9
-We are using dyn.com for our DNS server for the docker.io domain. 
10
-It is using the dotCloud account.
11
-
12
-### DNS Redirect
13
-We have a DNS redirect in dyn.com that will automatically redirect 
14
-docker.io to www.docker.io
15
-
16
-## email
17
-Email is sent via  dotCloud account on MailGun.com
18
-
19
-## CDN
20
-We are using a CDN in front of some of the docker.io domains to help improve
21
-proformance. The CDN is Cloudflare, using a Pro account. 
22
-
23
-*This is currently disabled due to an issue with slow performance during pull
24
-in some regions of the world.*
25
-
26
-### CDN Domains
27
-- www.docker.io
28
-- test.docker.io
29
-- registry-1.docker.io
30
-- debug.docker.io
31
-- cdn-registry-1.docker.io
32
-
33
-## edge-docker.dotcloud.com
34
-All of the Docker applications that live on dotCloud go through their own
35
-load balancer, and this is where SSL is terminated as well.
36
-
37
-## www.docker.io
38
-This is hosted under the docker account on dotCloud's PaaS. 
39
-
40
-### Source Code
41
-The source code for the website lives here:
42
-https://github.com/dotcloud/www.docker.io
43
-
44
-## Docker Registry
45
-The registry is where the image data is store.
46
-
47
-### URL:
48
-- registry-1.docker.io
49
-- cdn-registry-1.docker.io
50
-
51
-There are two urls, one is behind a CDN the other isn't this is because when
52
-you pull, you pull from the CDN url, to help with pull speeds. We don't push
53
-through the CDN as well, because it doesn't help us, so we bypass it.
54
-
55
-### Data Store:
56
-The data store for the registry is using Amazon S3 in a bucket under the docker
57
-aws account.
58
-
59
-### Source Code
60
-The source code for the registry lives here: https://github.com/dotcloud/docker-registry
61
-
62
-### Hosted:
63
-Hosted on the Docker account on dotCloud's PaaS
64
-
65
-## index.docker.io
66
-This is the docker index, it stores all of the meta information about the 
67
-docker images, but all data is stored in the registry.
68
-
69
-### Source Code:
70
-Not available
71
-
72
-### Hosted:
73
-Hosted on the Docker account on dotCloud's PaaS
74
-
75
-## blog.docker.io
76
-This is a wordpress based Docker blog.
77
-
78
-### URL:
79
-http://blog.docker.io
80
-
81
-### Source Code:
82
-https://github.com/dotcloud/blog.docker.io
83
-
84
-## docs.docker.io
85
-This is where all of the documentation for docker lives.
86
-
87
-### Hosted:
88
-This website is hosted on ReadTheDocs.org.
89
-
90
-### Updates
91
-These docs get automatically updated when the Docker repo on github has
92
-new commits. It does this via a webhook.
93
-
94
-### Proxy:
95
-This is a simple dotcloud app, with its main and only purpose to forward
96
-http (and https) requests to docker.readthedocs.org.
97
-
98
-https://github.com/dotcloud/docker-docs-dotcloud-proxy
99
-
100
-## get.docker.io
101
-This is the docker repository where we store images
102
-
103
-TODO: need more here. jerome?