Updated documentation after changes to schema
Fixes
@@ -10,9 +10,10 @@ This is the general description of the image.
* `version` -- (required) Version of the image.
* `from` -- (required) Base image for your image.
* `release` -- Also called build number. This value should be bumped every time you build the image. It can be string or integer, or mix of these.
-* `description` -- Short summary of the image.
+* `description` -- Short summary of the image -- used to create the `description` label.
* `user` -- The user that should be used to launch the main process in the container.
* `workdir` -- Set the working directory.
+* `maintainer` -- Information about the image maintainer, can be any string -- used to create the `maintainer` label.
```yaml
name: "jboss-eap-7/eap70-openshift"
@@ -103,16 +104,32 @@ packages:
## Sources
-It will rarely happen that your image won't require external artifacts. In most cases you will want to add files into the image and use them in the image building process. Sources section is meant exactly for this. Dogen will fetch any artifacts specified in this section and addtiionally check their correctness by comptuting specific hash of the downloaded file and comparing it with the desired value.
+It will rarely happen that your image won't require external artifacts. In most cases you will want to add files into the image and use them in the image building process. Sources section is meant exactly for this. *Dogen will automatically fetch any artifacts* specified in this section and addtiionally check their correctness by comptuting specific hash of the downloaded file and comparing it with the desired value.
```yaml
sources:
- - url: https://github.com/rhuss/jolokia/releases/download/v1.3.6/jolokia-1.3.6-bin.tar.gz
+ - artifact: https://github.com/rhuss/jolokia/releases/download/v1.3.6/jolokia-1.3.6-bin.tar.gz
md5: 75e5b5ba0b804cd9def9f20a70af649f
```
NOTE: Supported hash algorithms are: md5, sha1 and sha256.
+For artifacts that are not publicly available Dogen provides a way to add a hint from there such artifact could be downloaded.
+
+```yaml
+sources:
+ - artifact: jboss-eap-6.4.0.zip
+ md5: 9a5d37631919a111ddf42ceda1a9f0b5
+ hint: "Artifact is available on Customer Portal: https://access.redhat.com/jbossnetwork/restricted/softwareDetail.html?softwareId=37393&product=appplatform&version=6.4&downloadType=distributions"
+```
+
+When Dogen will be executed for such artifact it'll give you all required information to get going:
+
+```
+2017-06-07 12:55:25,088 dogen INFO Artifact is available on Customer Portal: https://access.redhat.com/jbossnetwork/restricted/softwareDetail.html?softwareId=37393&product=appplatform&version=6.4&downloadType=distributions
+2017-06-07 12:55:25,088 dogen INFO Please download the 'jboss-eap-6.4.0.zip' artifact manually and save it as '/home/goldmann/jboss-eap-6-image/target/image/jboss-eap-6.4.0.zip'
+2017-06-07 12:55:25,088 dogen ERROR Artifact 'jboss-eap-6.4.0.zip' could not be fetched!
+```
## Scripts
Scipts are the *most important* section in the descriptor file. Scripts are responsible for actually building the image -- all modifications are done in scripts, we do not execute any commands in with `RUN` instrutions directly. A script can be written in any language, as long as its interpreter will be available inside of the image. It is common that scripts are written in Bash.
