Skip to content

Commit

Permalink
Update documentation and renamed exportBase
Browse files Browse the repository at this point in the history
Renamed `exportBase` to `exportBaseDir` (#164) and added missing
properties to documentation.
  • Loading branch information
rhuss committed May 13, 2015
1 parent 58d441f commit ef9a3de
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 10 deletions.
5 changes: 5 additions & 0 deletions doc/changelog.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# ChangeLog

* **0.11.4**
- Fixed documentation for available properties
- Changed property `docker.assembly.exportBase` to `docker.assembly.exportBaseDir` (#164)
- Changed default behaviour of `exportBaseDir` (true if no base image used with `from`, false otherwise)

* **0.11.3**
- Add support for removeVolumes in `docker:stop` configuration (#120)
- Add support for setting a custom maintainer in images (#117)
Expand Down
17 changes: 11 additions & 6 deletions doc/manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -597,7 +597,7 @@ specified within a `<volumes>` section of the run configuration. It can contain
* **from** can contain a list of `<image>` elements which specify
image names or aliases of containers whose volumes should be imported.
* **bind** can contain a list of `<volume>` specifications (or 'host mounts). Use `/path` to create and
expose a new volume in the containaer, `/host_path:/container_path` to mount a host path into the
expose a new volume in the container, `/host_path:/container_path` to mount a host path into the
container and `/host_path:/container_path:ro` to bind it read-only.

````xml
Expand All @@ -612,7 +612,7 @@ specified within a `<volumes>` section of the run configuration. It can contain
</volumes>
````

In this example the container mounts from the host `/logs` as `/logs` on the container, and `/opt/host_export` from
In this example the container creates a new volume named `/logs` on the container and mounts `/opt/host_export` from
the host as `/opt/container_import` on the container. In addition all exported volumes from the container which has
been created from the image `jolokia/docker-demo` are mounted directly into the container (with the same name as
the exporting container exposes these directories). The image must be also configured for this plugin. Instead of
Expand Down Expand Up @@ -865,10 +865,17 @@ up from the following properties, which correspond to corresponding
values in the `<build>` and `<run>` sections.

* **docker.alias** Alias name
* **docker.assemblyDescriptor** Path to the assembly descriptor when
* **docker.assembly.baseDir** Directory name for the exported artifacts as
described in an assembly (which is `/maven` by default).
* **docker.assembly.descriptor** Path to the assembly descriptor when
building an image
* **docker.assemblyDescriptorRef** Name of a predefined assembly to
* **docker.assembly.descriptorRef** Name of a predefined assembly to
use.
* **docker.assembly.exportBaseDir** If `true` export base directory
* **docker.assembly.ignorePermissions** If set to `true` existing file permissions are ignored
when creating the assembly archive
* **docker.assembly.dockerFileDir** specifies a directory containing an external Dockerfile
that will be used to create the image
* **docker.bind.idx** Sets a list of paths to bind/expose in the container
* **docker.capAdd.idx** List of kernel capabilities to add to the container
* **docker.capDrop.idx** List of kernel capabilities to remove from the container
Expand All @@ -886,8 +893,6 @@ values in the `<build>` and `<run>` sections.
* **docker.envPropertyFile** specifies the path to a property file whose properties are
used as environment variables. The environment variables takes precedence over any other environment
variables specified.
* **docker.exportDir** Directory name for the exported artifacts as
described in an assembly (which is `/maven` by default).
* **docker.extraHosts.idx** List of `host:ip` to add to `/etc/hosts`
* **docker.from** Base image for building an image
* **docker.hostname** Container hostname
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,17 +24,17 @@
public enum ConfigKey {

ALIAS,
ASSEMBLY_BASEDIR,
ASSEMBLY_BASEDIR("assembly.baseDir"),
ASSEMBLY_DESCRIPTOR("assembly.descriptor"),
ASSEMBLY_DESCRIPTOR_REF("assembly.descriptorRef"),
ASSEMBLY_EXPORT_BASEDIR("assembly.exportBase"),
ASSEMBLY_EXPORT_BASEDIR("assembly.exportBaseDir"),
ASSEMBLY_IGNORE_PERMISSIONS("assembly.ignorePermissions"),
ASSEMBLY_DOCKER_FILE_DIR("assembly.dockerFileDir"),
ASSEMBLY_USER("assembly.user"),
BIND,
CAP_ADD,
CAP_DROP,
COMMAND,
DOCKER_FILE_DIR,
DOMAINNAME,
DNS,
DNS_SEARCH,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ private AssemblyConfiguration extractAssembly(String prefix, Properties properti
.basedir(withPrefix(prefix, ASSEMBLY_BASEDIR, properties))
.descriptor(withPrefix(prefix, ASSEMBLY_DESCRIPTOR, properties))
.descriptorRef(withPrefix(prefix, ASSEMBLY_DESCRIPTOR_REF, properties))
.dockerFileDir(withPrefix(prefix, DOCKER_FILE_DIR, properties))
.dockerFileDir(withPrefix(prefix, ASSEMBLY_DOCKER_FILE_DIR, properties))
.exportBasedir(booleanWithPrefix(prefix, ASSEMBLY_EXPORT_BASEDIR, properties))
.ignorePermissions(booleanWithPrefix(prefix, ASSEMBLY_IGNORE_PERMISSIONS, properties))
.user(withPrefix(prefix, ASSEMBLY_USER, properties))
Expand Down

0 comments on commit ef9a3de

Please sign in to comment.