From d491ae9ccb8dd7e202e1885a63a86c05eeb719fe Mon Sep 17 00:00:00 2001 From: Darrell Mozingo Date: Wed, 25 May 2016 11:01:21 +0800 Subject: [PATCH] Update README.md Formatting & small example correction. --- README.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 7271d858c1..dd51c992a1 100644 --- a/README.md +++ b/README.md @@ -564,12 +564,10 @@ end The `docker_image` resource properties mostly corresponds to the [Docker Remote API](https://docs.docker.com/reference/api/docker_remote_api_v1.20/#2-2-images) as driven by the [Swipley docker-api Ruby gem](https://github.com/swipely/docker-api) -A `docker_image`'s full identifier is a string in the form "\ +A `docker_image`'s full identifier is a string in the form "\:\". There is some nuance around naming using the public +registry vs a private one. -:\". There is some nuance around naming using the public -registry vs a private one. - -- `repo` - aka `image_name` - The first half of a Docker image's identity. This is a string in the form: `registry:port/owner/image_name`. If the `registry:port` portion is left off, Docker will implicitly use the Docker public registry. "Official Images" omit the owner part. This means a repo id can look as short as `busybox`, `alpine`, or `centos`, to refer to official images on the public registry, and as long as `my.computers.biz:5043:/what/ever` to refer to custom images on an private registry. Often you'll see something like `someara/chef` to refer to private images on the public registry. - Defaults to resource name. +- `repo` - aka `image_name` - The first half of a Docker image's identity. This is a string in the form: `registry:port/owner/image_name`. If the `registry:port` portion is left off, Docker will implicitly use the Docker public registry. "Official Images" omit the owner part. This means a repo id can look as short as `busybox`, `alpine`, or `centos`, to refer to official images on the public registry, and as long as `my.computers.biz:5043/what/ever` to refer to custom images on an private registry. Often you'll see something like `someara/chef` to refer to private images on the public registry. - Defaults to resource name. - `tag` - The second half of a Docker image's identity. - Defaults to `latest` - `source` - Path to input for the `:import`, `:build` and `:build_if_missing` actions. For building, this can be a Dockerfile, a tarball containing a Dockerfile in its root, or a directory containing a Dockerfile. For import, this should be a tarball containing Docker formatted image, as generated with `:save`. - `destination` - Path for output from the `:save` action.