Forráskód Böngészése

Merge pull request #251 from infosiftr/more-explicit-onbuild-appropriateness-description

Add more explicit description for why "onbuild" variants exist and for when they're appropriate to use (and when it's time to "graduate")
yosifkit 10 éve
szülő
commit
1e966f691d
1 módosított fájl, 4 hozzáadás és 0 törlés
  1. 4 0
      .template-helpers/variant-onbuild.md

+ 4 - 0
.template-helpers/variant-onbuild.md

@@ -1,3 +1,7 @@
 ## `%%REPO%%: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 %%REPO%%: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).