Docker Library Bot 10 лет назад
Родитель
Сommit
e44c9c4605
1 измененных файлов с 18 добавлено и 1 удалено
  1. 18 1
      clojure/README.md

+ 18 - 1
clojure/README.md

@@ -1,6 +1,7 @@
 # Supported tags and respective `Dockerfile` links
 
--	[`latest`, `lein-2.5.1` (*Dockerfile*)](https://github.com/Quantisan/docker-clojure/blob/6854a9966b9d6953e4a3a9547d670a0787b23ea8/Dockerfile)
+-	[`latest`, `lein-2.5.1` (*Dockerfile*)](https://github.com/Quantisan/docker-clojure/blob/bb413b92f25c48ac48db93ec236459765be8a618/Dockerfile)
+-	[`onbuild`, `lein-2.5.1-onbuild` (*onbuild/Dockerfile*)](https://github.com/Quantisan/docker-clojure/blob/bb413b92f25c48ac48db93ec236459765be8a618/onbuild/Dockerfile)
 
 For more information about this image and its history, please see the [relevant manifest file (`library/clojure`)](https://github.com/docker-library/official-images/blob/master/library/clojure) in the [`docker-library/official-images` GitHub repo](https://github.com/docker-library/official-images).
 
@@ -51,6 +52,22 @@ If you have an existing Lein/Clojure project, it's fairly straightforward to com
 
 This will build your project into a jar file located in your project's `target/uberjar` directory.
 
+# Image Variants
+
+The `clojure` images come in many flavors, each designed for a specific use case.
+
+## `clojure:<version>`
+
+This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
+
+## `clojure:onbuild`
+
+This image makes building derivative images easier. For most use cases, creating a `Dockerfile` in the base of your project directory with the line `FROM clojure:onbuild` will be enough to create a stand-alone image for your project.
+
+While the `onbuild` variant is really useful for "getting off the ground running" (zero to Dockerized in a short period of time), it's not recommended for long-term usage within a project due to the lack of control over *when* the `ONBUILD` triggers fire (see also [`docker/docker#5714`](https://github.com/docker/docker/issues/5714), [`docker/docker#8240`](https://github.com/docker/docker/issues/8240), [`docker/docker#11917`](https://github.com/docker/docker/issues/11917)).
+
+Once you've got a handle on how your project functions within Docker, you'll probably want to adjust your `Dockerfile` to inherit from a non-`onbuild` variant and copy the commands from the `onbuild` variant `Dockerfile` (moving the `ONBUILD` lines to the end and removing the `ONBUILD` keywords) into your own file so that you have tighter control over them and more transparency for yourself and others looking at your `Dockerfile` as to what it does. This also makes it easier to add additional requirements as time goes on (such as installing more packages before performing the previously-`ONBUILD` steps).
+
 # License
 
 View [license information](http://clojure.org/license) for the software contained in this image.