diff --git a/hack/infrastructure/README.md b/hack/infrastructure/README.md index 126792a6b0..a3641f6dc8 100644 --- a/hack/infrastructure/README.md +++ b/hack/infrastructure/README.md @@ -1,5 +1,81 @@ # Docker project infrastructure -This directory holds all information about the technical infrastructure of the docker project; servers, dns, email, and all the corresponding tools and configuration. +This is an overview of the Docker infrastructure. -Obviously credentials should not be stored in this repo, but how to obtain and use them should be documented here. +**Note: obviously, credentials should not be stored in this repository.** +However, when there are credentials, we should list how to obtain them +(e.g. who has them). + + +## Providers + +This should be the list of all the entities providing some kind of +infrastructure service to the Docker project (either for free, +or paid by dotCloud). + + +Provider | Service +--------------|------------------------------------------------- +AWS | packages (S3 bucket), dotCloud PAAS, dev-env, ci +CloudFlare | cdn +Digital Ocean | ci +dotCloud PAAS | website, index, registry, ssl, blog +DynECT | dns (docker.io) +GitHub | repository +Linode | dev-env +Mailgun | outgoing e-mail +ReadTheDocs | docs + +*Ordered-by: lexicographic* + + +## URLs + +This should be the list of all the infrastructure-related URLs +and which service is handling them. + +URL | Service +--------------------------------------------|--------------------------------- + http://blog.docker.io/ | blog +*http://cdn-registry-1.docker.io/ | registry (pull) + http://debug.docker.io/ | debug tool + http://docs.docker.io/ | docsproxy (proxy to readthedocs) + http://docker-ci.dotcloud.com/ | ci + http://docker.io/ | redirect to www.docker.io (dynect) + http://docker.readthedocs.org/ | docs +*http://get.docker.io/ | packages + https://github.com/dotcloud/docker | repository +*https://index.docker.io/ | index + http://registry-1.docker.io/ | registry (push) + http://staging-docker-ci.dotcloud.com/ | ci +*http://test.docker.io/ | packages +*http://www.docker.io/ | website + +*Ordered-by: lexicographic* + +**Note:** an asterisk in front of the URL means that it is cached by CloudFlare. + + +## Services + +This should be the list of all services referenced above. + +Service | Maintainer(s) | How to update | Source +--------------------|--------------------|------------------|------- +blog | @jbarbier | dotcloud push | https://github.com/dotcloud/blog.docker.io +cdn | @jpetazzo @samalba | cloudflare panel | N/A +ci | @mzdaniel | See [docker-ci] | See [docker-ci] +docs | @metalivedev | github webhook | docker repo +docsproxy | @dhrp | dotcloud push | https://github.com/dotcloud/docker-docs-dotcloud-proxy +index | @kencochrane | dotcloud push | private +packages | @jpetazzo | hack/release | docker repo +registry | @samalba | dotcloud push | https://github.com/dotcloud/docker-registry +repository (github) | N/A | N/A | N/A +ssl (dotcloud) | @jpetazzo | dotcloud ops | N/A +ssl (cloudflare) | @jpetazzo | cloudflare panel | N/A +website | @dhrp | dotcloud push | https://github.com/dotcloud/www.docker.io + +*Ordered-by: lexicographic* + + +[docker-ci]: docker-ci.rst diff --git a/hack/infrastructure/overview.md b/hack/infrastructure/overview.md deleted file mode 100644 index 592c9b0b22..0000000000 --- a/hack/infrastructure/overview.md +++ /dev/null @@ -1,103 +0,0 @@ -# Docker Server Overview -This is an overview of the Docker infrastructure - -## Docker Git Repo -The Docker source code lives on github.com under the dotCloud account. -https://github.com/dotcloud/docker - -## DNS -We are using dyn.com for our DNS server for the docker.io domain. -It is using the dotCloud account. - -### DNS Redirect -We have a DNS redirect in dyn.com that will automatically redirect -docker.io to www.docker.io - -## email -Email is sent via dotCloud account on MailGun.com - -## CDN -We are using a CDN in front of some of the docker.io domains to help improve -proformance. The CDN is Cloudflare, using a Pro account. - -*This is currently disabled due to an issue with slow performance during pull -in some regions of the world.* - -### CDN Domains -- www.docker.io -- test.docker.io -- registry-1.docker.io -- debug.docker.io -- cdn-registry-1.docker.io - -## edge-docker.dotcloud.com -All of the Docker applications that live on dotCloud go through their own -load balancer, and this is where SSL is terminated as well. - -## www.docker.io -This is hosted under the docker account on dotCloud's PaaS. - -### Source Code -The source code for the website lives here: -https://github.com/dotcloud/www.docker.io - -## Docker Registry -The registry is where the image data is store. - -### URL: -- registry-1.docker.io -- cdn-registry-1.docker.io - -There are two urls, one is behind a CDN the other isn't this is because when -you pull, you pull from the CDN url, to help with pull speeds. We don't push -through the CDN as well, because it doesn't help us, so we bypass it. - -### Data Store: -The data store for the registry is using Amazon S3 in a bucket under the docker -aws account. - -### Source Code -The source code for the registry lives here: https://github.com/dotcloud/docker-registry - -### Hosted: -Hosted on the Docker account on dotCloud's PaaS - -## index.docker.io -This is the docker index, it stores all of the meta information about the -docker images, but all data is stored in the registry. - -### Source Code: -Not available - -### Hosted: -Hosted on the Docker account on dotCloud's PaaS - -## blog.docker.io -This is a wordpress based Docker blog. - -### URL: -http://blog.docker.io - -### Source Code: -https://github.com/dotcloud/blog.docker.io - -## docs.docker.io -This is where all of the documentation for docker lives. - -### Hosted: -This website is hosted on ReadTheDocs.org. - -### Updates -These docs get automatically updated when the Docker repo on github has -new commits. It does this via a webhook. - -### Proxy: -This is a simple dotcloud app, with its main and only purpose to forward -http (and https) requests to docker.readthedocs.org. - -https://github.com/dotcloud/docker-docs-dotcloud-proxy - -## get.docker.io -This is the docker repository where we store images - -TODO: need more here. jerome?