Update README.md to point to main repo
Change-Id: Id2009fb51cfc9e64140cf698c2fd545d5fa12fe0
This commit is contained in:
parent
78e2e191a1
commit
0d7eef2f07
49
README.md
49
README.md
|
@ -1,9 +1,6 @@
|
|||
# OpenStack yaodu/heat
|
||||
[![Docker Automated](https://img.shields.io/docker/automated/yaodu/heat.svg)](https://hub.docker.com/r/yaodu/heat/)
|
||||
# OpenStack LOCI-heat
|
||||
|
||||
Yaodu/heat is a set of Dockerfiles that builds lightweight deployment agnostic images for OpenStack Heat.
|
||||
|
||||
Images are built in the Docker Hub automatically on each push to the master branch to provide a continuously updated set of images based on a number of distributions. Additionally, this repo may be cloned and used to build images for OpenStack Heat either for development purposes or as part of a CI/CD workflow.
|
||||
For more information, including build instructions, please visit the [main repository](https://github.com/openstack/loci).
|
||||
|
||||
### Image Layer Info
|
||||
[![](https://images.microbadger.com/badges/version/yaodu/heat:latest.svg)](https://microbadger.com/images/yaodu/heat:latest "yaodu/heat:latest") [![](https://images.microbadger.com/badges/image/yaodu/heat:latest.svg)](https://microbadger.com/images/yaodu/heat:latest "yaodu/heat:latest")
|
||||
|
@ -11,45 +8,3 @@ Images are built in the Docker Hub automatically on each push to the master bran
|
|||
[![](https://images.microbadger.com/badges/version/yaodu/heat:ubuntu.svg)](https://microbadger.com/images/yaodu/heat:ubuntu "yaodu/heat:ubuntu") [![](https://images.microbadger.com/badges/image/yaodu/heat:ubuntu.svg)](https://microbadger.com/images/yaodu/heat:ubuntu "yaodu/heat:ubuntu")
|
||||
|
||||
[![](https://images.microbadger.com/badges/version/yaodu/heat:centos.svg)](https://microbadger.com/images/yaodu/heat:centos "yaodu/heat:centos") [![](https://images.microbadger.com/badges/image/yaodu/heat:centos.svg)](https://microbadger.com/images/yaodu/heat:centos "yaodu/heat:centos")
|
||||
|
||||
## Building locally
|
||||
It's really easy to build images locally for the distro of your choice. To build an image you only need to run:
|
||||
``` bash
|
||||
$ docker build https://github.com/yaodu/docker-heat.git \
|
||||
--file debian/Dockerfile \
|
||||
--tag yaodu/heat:latest
|
||||
```
|
||||
You can, of course, substitute `debian` with your distro of choice.
|
||||
|
||||
For more advanced building you can use docker build arguments to define:
|
||||
* The git repo containing the OpenStack project the container should contain, `GIT_REPO`
|
||||
* The git ref the container should use when building, `GIT_REF`
|
||||
* The git repo the container should use when building from a git ref, `GIT_REF_REPO`
|
||||
* The docker image name to use for the base requirements python wheels, `DOCKER_REPO`
|
||||
* The docker image tag to use for the base requirements python wheels, `DOCKER_TAG`
|
||||
* If present, rather than using a docker image containing OpenStack requirements a tarball will be used from the defined URL, `WHEELS`
|
||||
|
||||
This makes it really easy to integrate Yaodu images into your development or CI/CD workflow, for example, if you wanted to build an image from [this PS](https://review.openstack.org/#/c/213731/4) you could run:
|
||||
``` bash
|
||||
$ docker build https://github.com/yaodu/docker-heat.git \
|
||||
--file ubuntu/Dockerfile \
|
||||
--tag mydockernamespace/heat-testing:213731-4 \
|
||||
--build-arg GIT_REPO=http://git.openstack.org/openstack/heat.git \
|
||||
--build-arg GIT_REF_REPO=http://git.openstack.org/openstack/heat.git \
|
||||
--build-arg GIT_REF=refs/changes/31/213731/4
|
||||
```
|
||||
|
||||
|
||||
## Customizing
|
||||
The images should contain all the required assets for running the service. But if you wish or need to customize the `yaodu/heat` image that's great! We hope to have built the images to make this as easy and flexible as possible. To do this we recommend that you perform any required customisation in a child image using a pattern similar to:
|
||||
|
||||
``` Dockerfile
|
||||
FROM yaodu/heat:latest
|
||||
MAINTAINER you@example.com
|
||||
|
||||
RUN set -x \
|
||||
&& apt-get update \
|
||||
&& apt-get install -y --no-install-recommends \
|
||||
your-awesome-binary-package \
|
||||
&& rm -rf /var/lib/apt/lists/*
|
||||
```
|
||||
|
|
Loading…
Reference in New Issue