diff --git a/doc/changelog.md b/doc/changelog.md index 02d4fe8b3..8af91c06c 100644 --- a/doc/changelog.md +++ b/doc/changelog.md @@ -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) diff --git a/doc/manual.md b/doc/manual.md index 0455c87d2..ebc7a4cd1 100644 --- a/doc/manual.md +++ b/doc/manual.md @@ -597,7 +597,7 @@ specified within a `` section of the run configuration. It can contain * **from** can contain a list of `` elements which specify image names or aliases of containers whose volumes should be imported. * **bind** can contain a list of `` 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 @@ -612,7 +612,7 @@ specified within a `` section of the run configuration. It can contain ```` -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 @@ -865,10 +865,17 @@ up from the following properties, which correspond to corresponding values in the `` and `` 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 @@ -886,8 +893,6 @@ values in the `` and `` 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 diff --git a/src/main/java/org/jolokia/docker/maven/config/handler/property/ConfigKey.java b/src/main/java/org/jolokia/docker/maven/config/handler/property/ConfigKey.java index 4557b9fc0..51a51c020 100644 --- a/src/main/java/org/jolokia/docker/maven/config/handler/property/ConfigKey.java +++ b/src/main/java/org/jolokia/docker/maven/config/handler/property/ConfigKey.java @@ -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, diff --git a/src/main/java/org/jolokia/docker/maven/config/handler/property/PropertyConfigHandler.java b/src/main/java/org/jolokia/docker/maven/config/handler/property/PropertyConfigHandler.java index c5546dac6..88584d897 100644 --- a/src/main/java/org/jolokia/docker/maven/config/handler/property/PropertyConfigHandler.java +++ b/src/main/java/org/jolokia/docker/maven/config/handler/property/PropertyConfigHandler.java @@ -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))