aboutsummaryrefslogtreecommitdiff
path: root/docs/image-building.md
diff options
context:
space:
mode:
authorSteven Dake <stdake@cisco.com>2015-08-20 23:00:55 -0700
committerSteven Dake <stdake@cisco.com>2015-08-21 02:10:31 -0700
commitbbcf22cc1298dd0ad4f0826c9e1186298c64569e (patch)
tree6131834f0daf42c2ded83809859e9b9bc424aa7f /docs/image-building.md
parent129f1d06a141c75643336399181ea157fb0dd82a (diff)
downloadkolla-bbcf22cc1298dd0ad4f0826c9e1186298c64569e.tar.gz
kolla-bbcf22cc1298dd0ad4f0826c9e1186298c64569e.zip
Prepare for MD to RST conversion
Sphinx and OpenStack documentation standards require the use of RST formatted documentation. In order to get out docs integrated into docs.openstack.org, the following steps must be taken: 1. we need to first convert the documentation to RST 2. sphinx support must be added to the repository 3. project-config must be updated with a publish-docs job The ability to pubish to docs.openstack.org is a privilege only available to Big Tent projects. As a result, we should be taking advantage of this to help spread the word on our implementation. Note the documentation was converted with a tool called pandoc the syntax of which was: pandoc -f markdown -t rst file.md > z mv z file.rst In order for git to preserve history the files have to be git mv'ed in one commit followed by the pandoc operation in a separate commit. Change-Id: Iba2a70b989e8305da03e8204a9b130d457b00cf0
Diffstat (limited to 'docs/image-building.md')
-rw-r--r--docs/image-building.md77
1 files changed, 0 insertions, 77 deletions
diff --git a/docs/image-building.md b/docs/image-building.md
deleted file mode 100644
index a67f3da08..000000000
--- a/docs/image-building.md
+++ /dev/null
@@ -1,77 +0,0 @@
-# Image building
-
-The `tools/build-docker-image` script in this repository is
-responsible for building docker images. It is symlinked as `./build`
-inside each Docker image directory.
-
-When creating new image directories, you can run the
-`tools/update-build-links` scripts to install the `build` symlink
-(this script will install the symlink anywhere it find a file named
-`Dockerfile`).
-
-## Workflow
-
-In general, you will build images like this:
-
- $ cd docker/keystone
- $ ./build
-
-By default, the above command would build
-`kollaglue/centos-rdo-keystone:CID`, where `CID` is the current short
-commit ID. That is, given:
-
- $ git rev-parse HEAD
- 76a16029006a2f5d3b79f1198d81acb6653110e9
-
-The above command would generate
-`kollaglue/centos-rdo-keystone:76a1602`. This tagging is meant to
-prevent developers from stepping on each other or on release images
-during the development process.
-
-To push the image after building, add `--push`:
-
- $ ./build --push
-
-To use these images, you must specify the tag in your `docker run`
-commands:
-
- $ docker run kollaglue/centos-rdo-keystone:76a1602
-
-## Building releases
-
-To build into the `latest` tag, add `--release`:
-
- $ ./build --release
-
-Or to build and push:
-
- $ ./build --push --release
-
-## Build all images at once
-
-The `build-all-docker-images` script in the tools directory is a wrapper for
-the `build-docker-image` that builds all images, as the name suggests, in the
-correct order. It responds to the same options as `build-docker-image` with the
-additional `--from` and `--to` options that allows building only images that
-have changed between the specified git revisions.
-
-For example, to build all images contained in docker directory and push new release:
-
- $ tools/build-all-docker-images --release --push
-
-To build only images modified in test-branch along with their children:
-
- $ tools/build-all-docker-images --from master --to test-branch
-
-## Configuration
-
-The `build-docker-image` script will look for a file named `.buildconf`
-in the image directory and in the top level of the repository. You
-can use this to set defaults, such as:
-
- NAMESPACE=larsks
- PREFIX=fedora-rdo-
-
-This setting would cause images to be tagged into the `larsks/`
-namespace and use Fedora as base image instead of the default CentOS.
-