kotovalexarian-likes-github
/
moby--moby
mirror of https://github.com/moby/moby.git
1
0
Fork 0
Code Releases Activity

Merge pull request #12644 from psftw/official-repos-rewrite 

Rewrite Official Repos page.
This commit is contained in:
moxiegirl 2015-04-28 08:57:29 -07:00
parent 6113eab174 8f52eb7b82
commit dde5ff2872
8 changed files with 103 additions and 186 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/mkdocs.yml
View File

@ -77,7 +77,7 @@ pages:
- ['docker-hub/accounts.md', 'Docker Hub', 'Accounts'] - ['docker-hub/accounts.md', 'Docker Hub', 'Accounts']
- ['docker-hub/repos.md', 'Docker Hub', 'Repositories'] - ['docker-hub/repos.md', 'Docker Hub', 'Repositories']
- ['docker-hub/builds.md', 'Docker Hub', 'Automated Builds'] - ['docker-hub/builds.md', 'Docker Hub', 'Automated Builds']
- ['docker-hub/official_repos.md', 'Docker Hub', 'Official repo guidelines'] - ['docker-hub/official_repos.md', 'Docker Hub', 'Official Repositories']
# Docker Hub Enterprise: # Docker Hub Enterprise:
- ['docker-hub-enterprise/index.md', 'Docker Hub Enterprise', 'Overview' ] - ['docker-hub-enterprise/index.md', 'Docker Hub Enterprise', 'Overview' ]

2
docs/sources/articles/baseimages.md
View File

@ -65,4 +65,4 @@ There are lots more resources available to help you write your 'Dockerfile`.
* There's a [complete guide to all the instructions](/reference/builder/) available for use in a `Dockerfile` in the reference section. * There's a [complete guide to all the instructions](/reference/builder/) available for use in a `Dockerfile` in the reference section.
* To help you write a clear, readable, maintainable `Dockerfile`, we've also * To help you write a clear, readable, maintainable `Dockerfile`, we've also
written a [`Dockerfile` Best Practices guide](/articles/dockerfile_best-practices). written a [`Dockerfile` Best Practices guide](/articles/dockerfile_best-practices).
* If you're working on an Official Repo, be sure to check out the [Official Repo Guidelines](/docker-hub/official_repos/). * If your goal is to create a new Official Repository, be sure to read up on Docker's [Official Repositories](/docker-hub/official_repos/).

4
docs/sources/articles/dockerfile_best-practices.md
View File

@ -419,9 +419,9 @@ fail catastrophically if the new build's context is missing the resource being
added. Adding a separate tag, as recommended above, will help mitigate this by added. Adding a separate tag, as recommended above, will help mitigate this by
allowing the `Dockerfile` author to make a choice. allowing the `Dockerfile` author to make a choice.
## Examples for official repositories ## Examples for Official Repositories
These Official Repos have exemplary `Dockerfile`s: These Official Repositories have exemplary `Dockerfile`s:
* [Go](https://registry.hub.docker.com/_/golang/) * [Go](https://registry.hub.docker.com/_/golang/)
* [Perl](https://registry.hub.docker.com/_/perl/) * [Perl](https://registry.hub.docker.com/_/perl/)

245
docs/sources/docker-hub/official_repos.md
View File

@ -1,189 +1,106 @@
page_title: Guidelines for official repositories on Docker Hub page_title: Official Repositories on Docker Hub
page_description: Guidelines for Official Repositories on Docker Hub page_description: Guidelines for Official Repositories on Docker Hub
page_keywords: Docker, docker, registry, accounts, plans, Dockerfile, Docker Hub, docs, official, image, documentation page_keywords: Docker, docker, registry, accounts, plans, Dockerfile, Docker Hub, docs, official, image, documentation
# Guidelines for creating and documenting official repositories # Official Repositories on Docker Hub
## Introduction The Docker [Official Repositories](http://registry.hub.docker.com/official) are
a curated set of Docker repositories that are promoted on Docker Hub and
supported by Docker, Inc. They are designed to:
You’ve been given the job of creating an image for an Official Repository * Provide essential base OS repositories (for example,
hosted on [Docker Hub Registry](https://registry.hub.docker.com/). These are [`ubuntu`](https://registry.hub.docker.com/_/ubuntu/),
our guidelines for getting that task done. Even if you’re not [`centos`](https://registry.hub.docker.com/_/centos/)) that serve as the
planning to create an Official Repo, you can think of these guidelines as best starting point for the majority of users.
practices for image creation generally.
This document consists of two major sections: * Provide drop-in solutions for popular programming language runtimes, data
stores, and other services, similar to what a Platform-as-a-Service (PAAS)
would offer.
* A list of expected files, resources and supporting items for your image, * Exemplify [`Dockerfile` best practices](/articles/dockerfile_best-practices)
along with best practices for creating those items and provide clear documentation to serve as a reference for other `Dockerfile`
* Examples embodying those practices authors.
## Expected files and resources * Ensure that security updates are applied in a timely manner. This is
particularly important as many Official Repositories are some of the most
popular on Docker Hub.
### A Git repository * Provide a channel for software vendors to redistribute up-to-date and
supported versions of their products. Organization accounts on Docker Hub can
also serve this purpose, without the careful review or restrictions on what
can be published.
Your image needs to live in a Git repository, preferably on GitHub. (If you’d Docker, Inc. sponsors a dedicated team that is responsible for reviewing and
like to use a different provider, please [contact us](mailto:feedback@docker.com) publishing all Official Repositories content. This team works in collaboration
directly.) Docker **strongly** recommends that this repo be publicly with upstream software maintainers, security experts, and the broader Docker
accessible. community.
If the repo is private or has otherwise limited access, you must provide a While it is preferrable to have upstream software authors maintaining their
means of at least “read-only” access for both general users and for the corresponding Official Repositories, this is not a strict requirement. Creating
docker-library maintainers, who need access for review and building purposes. and maintaining images for Official Repositories is a public process. It takes
place openly on GitHub where participation is encouraged. Anyone can provide
feedback, contribute code, suggest process changes, or even propose a new
Official Repository.
### A Dockerfile ## Should I use Official Repositories?
Complete information on `Dockerfile`s can be found in the [Reference section](https://docs.docker.com/reference/builder/). New Docker users are encouraged to use the Official Repositories in their
We also have a page discussing [best practices for writing `Dockerfile`s](/articles/dockerfile_best-practices). projects. These repositories have clear documentation, promote best practices,
Your `Dockerfile` should adhere to the following: and are designed for the most common use cases. Advanced users are encouraged to
review the Official Repositories as part of their `Dockerfile` learning process.
* It must be written either by using `FROM scratch` or be based on another, A common rationale for diverging from Official Repositories is to optimize for
established Official Image. image size. For instance, many of the programming language stack images contain
* It must follow `Dockerfile` best practices. These are discussed on the a complete build toolchain to support installation of modules that depend on
[best practices page](/articles/dockerfile_best-practices). In addition, optimized code. An advanced user could build a custom image with just the
Docker engineer Michael Crosby has some good tips for `Dockerfiles` in necessary pre-compiled libraries to save space.
this [blog post](http://crosbymichael.com/dockerfile-best-practices-take-2.html).
While [`ONBUILD` triggers](https://docs.docker.com/reference/builder/#onbuild) A number of language stacks such as
are not required, if you choose to use them you should: [`python`](https://registry.hub.docker.com/_/python/) and
[`ruby`](https://registry.hub.docker.com/_/ruby/) have `-slim` tag variants
designed to fill the need for optimization. Even when these "slim" variants are
insufficient, it is still recommended to inherit from an Official Repository
base OS image to leverage the ongoing maintenance work, rather than duplicating
these efforts.
* Build both `ONBUILD` and non-`ONBUILD` images, with the `ONBUILD` image ## How can I get involved?
built `FROM` the non-`ONBUILD` image.
* The `ONBUILD` image should be specifically tagged, for example, `ruby:
latest`and `ruby:onbuild`, or `ruby:2` and `ruby:2-onbuild`
### A short description All Official Repositories contain a **User Feedback** section in their
documentation which covers the details for that specific repository. In most
cases, the GitHub repository which contains the Dockerfiles for an Official
Repository also has an active issue tracker. General feedback and support
questions should be directed to `#docker-library` on Freenode IRC.
Include a brief description of your image (in plaintext). Only one description ## How do I create a new Official Repository?
is required; you don’t need additional descriptions for each tag. The file
should also:
* Be named `README-short.txt` From a high level, an Official Repository starts out as a proposal in the form
* Reside in the repo for the “latest” tag of a set of GitHub pull requests. You'll find detailed and objective proposal
* Not exceed 100 characters requirements in the following GitHub repositories:
### A logo * [docker-library/official-images](https://github.com/docker-library/official-images)
Include a logo of your company or the product (png format preferred). Only one * [docker-library/docs](https://github.com/docker-library/docs)
logo is required; you don’t need additional logo files for each tag. The logo
file should have the following characteristics:
* Be named `logo.png` The Official Repositories team, with help from community contributors, formally
* Should reside in the repo for the “latest” tag review each proposal and provide feedback to the author. This initial review
* Should fit inside a 200px square, maximized in one dimension (preferably the process may require a bit of back and forth before the proposal is accepted.
width)
* Square or wide (landscape) is preferred over tall (portrait), but exceptions
can be made based on the logo needed
### A long description There are also subjective considerations during the review process. These
subjective concerns boil down to the basic question: "is this image generally
useful?" For example, the [`python`](https://registry.hub.docker.com/_/python/)
Official Repository is "generally useful" to the large Python developer
community, whereas an obscure text adventure game written in Python last week is
not.
Include a comprehensive description of your image (in Markdown format, GitHub When a new proposal is accepted, the author becomes responsibile for keeping
flavor preferred). Only one description is required; you don’t need additional their images up-to-date and responding to user feedback. The Official
descriptions for each tag. The file should also: Repositories team becomes responsibile for publishing the images and
documentation on Docker Hub. Updates to the Official Repository follow the same
pull request process, though with less review. The Official Repositories team
ultimately acts as a gatekeeper for all changes, which helps mitigate the risk
of quality and security issues from being introduced.
* Be named `README.md` > **Note**: If you are interested in proposing an Official Repository, but would
* Reside in the repo for the “latest” tag > like to discuss it with Docker, Inc. privately first, please send your
* Be no longer than absolutely necessary, while still addressing all the > inquiries to partners@docker.com. There is no fast-track or pay-for-status
content requirements > option.
In terms of content, the long description must include the following sections:
* Overview & links
* How-to/usage
* Issues & contributions
#### Overview and links
This section should provide:
* an overview of the software contained in the image, similar to the
introduction in a Wikipedia entry
* a selection of links to outside resources that help to describe the software
* a *mandatory* link to the `Dockerfile`
#### How-to/usage
A section that describes how to run and use the image, including common use
cases and example `Dockerfile`s (if applicable). Try to provide clear, step-by-
step instructions wherever possible.
##### Issues and contributions
In this section, point users to any resources that can help them contribute to
the project. Include contribution guidelines and any specific instructions
related to your development practices. Include a link to
[Docker’s resources for contributors](https://docs.docker.com/contributing/contributing/).
Be sure to include contact info, handles, etc. for official maintainers.
Also include information letting users know where they can go for help and how
they can file issues with the repo. Point them to any specific IRC channels,
issue trackers, contacts, additional “how-to” information or other resources.
### License
Include a file, `LICENSE`, of any applicable license. Docker recommends using
the license of the software contained in the image, provided it allows Docker,
Inc. to legally build and distribute the image. Otherwise, Docker recommends
adopting the [Expat license](http://directory.fsf.org/wiki/License:Expat)
(a.k.a., the MIT or X11 license).
## Examples
Below are sample short and long description files for an imaginary image
containing Ruby on Rails.
### Short description
`README-short.txt`
`Ruby on Rails is an open-source application framework written in Ruby. It emphasizes best practices such as convention over configuration, active record pattern, and the model-view-controller pattern.`
### Long description
`README.md`
```markdown
# What is Ruby on Rails
Ruby on Rails, often simply referred to as Rails, is an open source web application framework which runs via the Ruby programming language. It is a full-stack framework: it allows creating pages and applications that gather information from the web server, talk to or query the database, and render templates out of the box. As a result, Rails features a routing system that is independent of the web server.
> [wikipedia.org/wiki/Ruby_on_Rails](https://en.wikipedia.org/wiki/Ruby_on_Rails)
# How to use this image
## Create a `Dockerfile` in your rails app project
FROM rails:onbuild
Put this file in the root of your app, next to the `Gemfile`.
This image includes multiple `ONBUILD` triggers so that should be all that you need for most applications. The build will `ADD . /usr/src/app`, `RUN bundle install`, `EXPOSE 3000`, and set the default command to `rails server`.
Then build and run the Docker image.
docker build -t my-rails-app .
docker run --name some-rails-app -d my-rails-app
Test it by visiting `http://container-ip:3000` in a browser. On the other hand, if you need access outside the host on port 8080:
docker run --name some-rails-app -p 8080:3000 -d my-rails-app
Then go to `http://localhost:8080` or `http://host-ip:8080` in a browser.
```
For more examples, take a look at these repos:
* [Go](https://github.com/docker-library/golang)
* [PostgreSQL](https://github.com/docker-library/postgres)
* [Buildpack-deps](https://github.com/docker-library/buildpack-deps)
* ["Hello World" minimal container](https://github.com/docker-library/hello-world)
* [Node](https://github.com/docker-library/node)
## Submit your repo
Once you've checked off everything in these guidelines, and are confident your
image is ready for primetime, please contact us at
[partners@docker.com](mailto:partners@docker.com) to have your project
considered for the Official Repos program.

12
docs/sources/docker-hub/repos.md
View File

@ -51,10 +51,10 @@ private to public.
You can also collaborate on Docker Hub with organizations and groups. You can also collaborate on Docker Hub with organizations and groups.
You can read more about that [here](accounts/). You can read more about that [here](accounts/).
## Official repositories ## Official Repositories
The Docker Hub contains a number of [official The Docker Hub contains a number of [Official
repositories](http://registry.hub.docker.com/official). These are Repositories](http://registry.hub.docker.com/official). These are
certified repositories from vendors and contributors to Docker. They certified repositories from vendors and contributors to Docker. They
contain Docker images from vendors like Canonical, Oracle, and Red Hat contain Docker images from vendors like Canonical, Oracle, and Red Hat
that you can use to build applications and services. that you can use to build applications and services.
@ -63,9 +63,9 @@ If you use Official Repositories you know you're using a supported,
optimized and up-to-date image to power your applications. optimized and up-to-date image to power your applications.
> **Note:** > **Note:**
> If you would like to contribute an official repository for your > If you would like to contribute an Official Repository for your
> organization, product or team you can see more information > organization, see [Official Repositories on Docker
> [here](https://github.com/docker/stackbrew). > Hub](/docker-hub/official_repos) for more information.
## Private repositories ## Private repositories

2
docs/sources/terms/repository.md
View File

@ -29,7 +29,7 @@ A Fully Qualified Image Name (FQIN) can be made up of 3 parts:
If you create a new repository which you want to share, you will need to If you create a new repository which you want to share, you will need to
set at least the `user_name`, as the `default` blank `user_name` prefix is set at least the `user_name`, as the `default` blank `user_name` prefix is
reserved for official Docker images. reserved for [Official Repositories](/docker-hub/official_repos).
For more information see [*Working with For more information see [*Working with
Repositories*](/userguide/dockerrepos/#working-with-the-repository) Repositories*](/userguide/dockerrepos/#working-with-the-repository)

10
docs/sources/userguide/dockerimages.md
View File

@ -131,11 +131,11 @@ term `sinatra`.
We can see we've returned a lot of images that use the term `sinatra`. We've We can see we've returned a lot of images that use the term `sinatra`. We've
returned a list of image names, descriptions, Stars (which measure the social returned a list of image names, descriptions, Stars (which measure the social
popularity of images - if a user likes an image then they can "star" it), and popularity of images - if a user likes an image then they can "star" it), and
the Official and Automated build statuses. Official repositories are built and the Official and Automated build statuses.
maintained by the [Stackbrew](https://github.com/docker/stackbrew) project, [Official Repositories](/docker-hub/official_repos) are a carefully curated set
and Automated repositories are [Automated Builds]( of Docker repositories supported by Docker, Inc. Automated repositories are
/userguide/dockerrepos/#automated-builds) that allow you to validate the source [Automated Builds](/userguide/dockerrepos/#automated-builds) that allow you to
and content of an image. validate the source and content of an image.
We've reviewed the images available to use and we decided to use the We've reviewed the images available to use and we decided to use the
`training/sinatra` image. So far we've seen two types of images repositories, `training/sinatra` image. So far we've seen two types of images repositories,

12
docs/sources/userguide/dockerrepos.md
View File

@ -51,12 +51,12 @@ name, user name, or description:
tianon/centos CentOS 5 and 6, created using rinse instea... 21 tianon/centos CentOS 5 and 6, created using rinse instea... 21
... ...
There you can see two example results: `centos` and There you can see two example results: `centos` and `tianon/centos`. The second
`tianon/centos`. The second result shows that it comes from result shows that it comes from the public repository of a user, named
the public repository of a user, named `tianon/`, while the first result, `tianon/`, while the first result, `centos`, doesn't explicitly list a
`centos`, doesn't explicitly list a repository which means that it comes from the repository which means that it comes from the trusted top-level namespace for
trusted top-level namespace. The `/` character separates a user's [Official Repositories](/docker-hub/official_repos). The `/` character separates
repository from the image name. a user's repository from the image name.
Once you've found the image you want, you can download it with `docker pull <imagename>`: Once you've found the image you want, you can download it with `docker pull <imagename>`: