Add Docs for Copy Goal and Sample for File/Directory Copy #1

rohanKanojia · 2021-03-27T15:13:34Z

Added Docs for docker:copy
Added a copy-from-container sample which contains profiles for
copying file and directory to localhost from container

mabrarov · 2021-03-28T08:54:28Z

samples/copy-from-container/pom.xml

@@ -0,0 +1,89 @@
+<project xmlns = "http://maven.apache.org/POM/4.0.0"


Project in "samples" directory use different formatting of this header:

Suggested change

<project xmlns = "http://maven.apache.org/POM/4.0.0"

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

<modelVersion>4.0.0</modelVersion>

<parent>

<groupId>io.fabric8.dmp.samples</groupId>

<artifactId>dmp-sample-parent</artifactId>

<version>0.34-SNAPSHOT</version>

<relativePath>../pom.xml</relativePath>

</parent>

It looks like this file doesn't follow formatting of existing POMs from the "samples" directory, where 2 space indentation is used (while this file uses 3 spaces).

mabrarov · 2021-03-28T08:58:37Z

samples/copy-from-container/pom.xml

+      <groupId>io.fabric8.dmp.samples</groupId>
+      <artifactId>dmp-sample-parent</artifactId>
+      <version>0.34-SNAPSHOT</version>
+      <relativePath>../pom.xml</relativePath>


"../pom.xm" is default value for relativePath ("http://maven.apache.org/POM/4.0.0" XML schema):

<xs:element name="relativePath" minOccurs="0" type="xs:string" default="../pom.xml"> <xs:annotation> <xs:documentation source="version">4.0.0</xs:documentation> <xs:documentation source="description"> The relative path of the parent <code>pom.xml</code> file within the check out. The default value is <code>../pom.xml</code>. ... </xs:documentation> </xs:annotation> </xs:element>

so I'd prefer to omit it. Unfortunately, it looks like all POMs in "samples" directory have this excessive item, so let's be consistence.

mabrarov · 2021-03-28T09:00:58Z

samples/copy-from-container/pom.xml

+   <artifactId>dmp-sample-copy-from-container</artifactId>
+   <profiles>
+      <profile>
+         <id>Copy-File</id>


It looks like the most of maven profiles of projects located in "sample" directory use lower-case names:

Suggested change

<id>Copy-File</id>

<id>copy-file</id>

mabrarov · 2021-03-28T09:01:20Z

samples/copy-from-container/pom.xml

+                  <artifactId>docker-maven-plugin</artifactId>
+                  <executions>
+                     <execution>
+                        <id>copy-from-container</id>


Suggested change

<id>copy-from-container</id>

<id>copy-file-from-container</id>

mabrarov · 2021-03-28T09:01:59Z

samples/copy-from-container/pom.xml

+                        <configuration>
+                           <images>
+                              <image>
+                                 <name>busybox:latest</name>


I believe we can omit default tag:

Suggested change

<name>busybox:latest</name>

<name>busybox</name>

mabrarov · 2021-03-28T09:10:43Z

samples/copy-from-container/pom.xml

+                                    <entries>
+                                       <entry>
+                                          <containerPath>/etc/hosts</containerPath>
+                                          <hostDirectory>/tmp/</hostDirectory>


We need to cover in documentation that hostDirectory can be relative path. In case hostDirectory is not an absolute path (java.io.File#isAbsolute) or is null ( is not defined), then it's considered relative path and the base directory for that relative path is the current project base directory (org.apache.maven.project.MavenProject#getBasedir). null or undefined hostDirectory is treated like an empty string, i.e. leads to usage of base directory of maven project.

For these samples - to make them less OS specific and to avoid spoiling filesystem of host OS with results of build - I'd recommend to use project's build directory as value of hostDirectory, like:

Suggested change

<hostDirectory>/tmp/</hostDirectory>

<hostDirectory>${project.build.directory}</hostDirectory>

In another example we could use relative directory, like:

Suggested change

<hostDirectory>/tmp/</hostDirectory>

<hostDirectory>target</hostDirectory>

mabrarov · 2021-03-28T09:11:34Z

samples/copy-from-container/pom.xml

+         </build>
+      </profile>
+      <profile>
+         <id>Copy-Directory</id>


Suggested change

<id>Copy-Directory</id>

<id>copy-directory</id>

mabrarov · 2021-03-28T09:11:52Z

samples/copy-from-container/pom.xml

+                                    <entries>
+                                       <entry>
+                                          <containerPath>/dev</containerPath>
+                                          <hostDirectory>/tmp/</hostDirectory>


Suggested change

<hostDirectory>/tmp/</hostDirectory>

<hostDirectory>target</hostDirectory>

mabrarov · 2021-03-28T09:21:41Z

Thank you for your help.

Here are my ideas / plans:

I definitely need help with samples and documentation, because I'm already late with my promises :) I don't want to be a blocker here.
I like this PR and going to review / test it ASAP.
I believe I will want to extend / modify changes coming with this PR - if this will happen then I plan to merge this PR and implement additional changes on top of it (don't want to lose history or authoring of changes).

mabrarov · 2021-03-28T09:24:02Z

samples/copy-from-container/README.md

+## How to Build?
+You can compile the project as usual maven command:
+```
+mvn clean install


There is no need of using install goal (spoiling local maven repository):

Suggested change

mvn clean install

mvn clean package

mabrarov · 2021-03-28T09:32:00Z

samples/copy-from-container/pom.xml

+      <relativePath>../pom.xml</relativePath>
+   </parent>
+   <modelVersion>4.0.0</modelVersion>
+   <artifactId>dmp-sample-copy-from-container</artifactId>


Let's use pom packaging

Suggested change

<artifactId>dmp-sample-copy-from-container</artifactId>

<artifactId>dmp-sample-copy-from-container</artifactId>

<packaging>pom</packaging>

to avoid warnings like:

[INFO] --- maven-jar-plugin:2.4:jar (default-jar) @ dmp-sample-copy-from-container --- [WARNING] JAR will be empty - no content was marked for inclusion!

mabrarov · 2021-03-28T09:36:58Z

samples/copy-from-container/README.md

+## Copying File from Container to Local Host
+We have a `Copy-File` profile which copies `/etc/hosts` file from container to your `/tmp` directory. It has executions set up for `start`,`copy`,`stop` goals so they will be activated when you build using the specified profile. In order to run it, use this command:
+```
+mvn clean install -PCopy-File


Suggested change

mvn clean install -PCopy-File

$ mvn clean package -P copy-file

mabrarov · 2021-03-28T09:37:17Z

samples/copy-from-container/README.md

+```
+Once command finishes successfully, try checking your `/tmp` directory to see file got created or not. If everything goes okay, you should be able to see output like this:
+```
+copy-from-container : $ ls /tmp/


Suggested change

copy-from-container : $ ls /tmp/

$ ls target

hosts

$ cat target/hosts

mabrarov · 2021-03-28T09:37:46Z

samples/copy-from-container/README.md

+```
+mvn clean install -PCopy-File
+```
+Once command finishes successfully, try checking your `/tmp` directory to see file got created or not. If everything goes okay, you should be able to see output like this:


Suggested change

Once command finishes successfully, try checking your `/tmp` directory to see file got created or not. If everything goes okay, you should be able to see output like this:

Once command finishes successfully, try checking "target" directory to see if the file got created or not. If everything goes okay, you should be able to see output like this:

mabrarov · 2021-03-28T09:46:20Z

samples/copy-from-container/pom.xml

+                        <id>copy-from-container</id>
+                        <phase>generate-resources</phase>
+                        <goals>
+                           <goal>start</goal>


This profile could use <createContainers>true</createContainers>, i.e. could demonstrate copying from temporary (created, but not started) container instead of copying from the started container (like it's done in Copy-File profile).

mabrarov · 2021-03-28T10:25:25Z

samples/copy-from-container/README.md

+ff02::2 ip6-allrouters
+172.17.0.3  80dd81263592
+```
+


We could add a note about usage of d-m-p external configuration, like:

Docker Maven Plugin external configuration can be used to define entries which need to be coped, e.g.:

$ mvn clean package -Pcopy-file \ -Ddocker.imagePropertyConfiguration=override \ -Ddocker.name=alpine \ -Ddocker.copy.entries.1.containerPath=/etc/os-release \ -Ddocker.copy.entries.1.hostDirectory=target \ -Ddocker.copy.entries.2.containerPath=/etc/hostname \ -Ddocker.copy.entries.2.hostDirectory=target ... $ ls target hostname os-release $ cat target/hostname f1387e0c6253 $ cat target/os-release NAME="Alpine Linux" ID=alpine VERSION_ID=3.13.2 PRETTY_NAME="Alpine Linux v3.13" HOME_URL="https://alpinelinux.org/" BUG_REPORT_URL="https://bugs.alpinelinux.org/"

mabrarov · 2021-03-28T13:26:09Z

src/main/asciidoc/inc/_docker-copy.adoc

@@ -0,0 +1,33 @@
+[[docker:copy]]


Without changes in other files, like "src/main/asciidoc/index.adoc", this file doesn't look being picked and included into the generated documentation.

mabrarov · 2021-03-28T20:42:27Z

samples/copy-from-container/README.md

+```
+
+## Copying Directory from Container to Local Host
+We have a `copy-directory` profile which copies `/dev` directory from container to your `/tmp` directory. It has `createContainers=true` with which plugin copies from a temporary(created, but not started) container instead of copying from the standard container. In order to run it, use this command:


/tmp directory is not used by this example anymore, does it?

mabrarov · 2021-03-30T11:49:12Z

Per requirements of d-m-p commits in PRs should be signed-off by the author. Could you please sign-off your commit(s) and update (force push) this PR?

rohanKanojia · 2021-03-30T11:52:07Z

sure, let me do that.

mabrarov · 2021-03-30T12:23:49Z

samples/copy-from-container/README.md

+Once command finishes successfully, try checking your `target` directory to see file got created or not. If everything goes okay, you should be able to see output like this:
+```
+copy-from-container : $ ls target
+dev  hosts 


hosts file looks excessive, because clean goal should remove it (if it is created by previous command - by mvn clean package -Pcopy-file):

Suggested change

dev hosts

dev

mabrarov · 2021-03-30T12:25:05Z

samples/copy-from-container/README.md

+
+This is a plain maven application used to demonstrate how to copy files or directories from container using `docker:copy` goal
+
+## How to Build?


To be honest I don't see a need in this section, because package does nothing for this sample. I'd omit it to reduce this README till essential part.

mabrarov · 2021-03-30T12:25:24Z

samples/copy-from-container/README.md

@@ -0,0 +1,64 @@
+# Docker Maven Plugin Copy Sample
+
+This is a plain maven application used to demonstrate how to copy files or directories from container using `docker:copy` goal


"maven application" -> "maven project"?

+ Added Docs for `docker:copy` + Added a `copy-from-container` sample which contains profiles for copying file and directory to localhost from container Signed-off-by: Rohan Kumar <rohaan@redhat.com>

mabrarov · 2021-03-30T12:40:41Z

samples/copy-from-container/README.md

+
+This is a plain maven project used to demonstrate how to copy files or directories from container using `docker:copy` goal
+
+## Copying File from Container to Local Host


I don't know if d-m-p has any standard for Markdown formatting, but I appreciate if we could use the following rules:

Keep one empty line before bock of code (if it's not the first line of file).

Keep one empty line before (if it's not the first line of file) and after each header.

File ends with one empty line.

Suggested change

## Copying File from Container to Local Host

## Copying File from Container to Local Host

We have a `copy-file` profile which copies `/etc/hosts` file from container to your project build directory.

It has executions set up for `start`, `copy` and `stop` goals, so they will be activated when you build using the specified profile.

In order to run it, use this command:

```

$ mvn clean package -Pcopy-file

```

Once command finishes successfully, try checking your `target` directory to see if the file got created or not.

If everything goes okay, you should be able to see output like this:

```

$ ls target

hosts

$ cat target/hosts

127.0.0.1 localhost

::1 localhost ip6-localhost ip6-loopback

fe00::0 ip6-localnet

ff00::0 ip6-mcastprefix

ff02::1 ip6-allnodes

ff02::2 ip6-allrouters

172.17.0.3 80dd81263592

```

Docker Maven Plugin external configuration can be used to define entries which need to be coped, e.g.:

```

$ mvn clean package -Pcopy-file \

-Ddocker.imagePropertyConfiguration=override \

-Ddocker.name=alpine \

-Ddocker.copy.entries.1.containerPath=/etc/os-release \

-Ddocker.copy.entries.1.hostDirectory=target \

-Ddocker.copy.entries.2.containerPath=/etc/hostname \

-Ddocker.copy.entries.2.hostDirectory=target

...

$ ls target

hostname os-release

$ cat target/hostname

f1387e0c6253

$ cat target/os-release

NAME="Alpine Linux"

ID=alpine

VERSION_ID=3.13.2

PRETTY_NAME="Alpine Linux v3.13"

HOME_URL="https://alpinelinux.org/"

BUG_REPORT_URL="https://bugs.alpinelinux.org/"

```

## Copying Directory from Container to Local Host

We have a `copy-directory` profile which copies `/dev` directory from container to your `target` directory.

It has `createContainers=true` with which plugin copies from a temporary (created, but not started) container instead of copying from the standard container (e.g. created and started by `start` goal).

In order to run it, use this command:

...

mabrarov · 2021-03-30T12:43:09Z

samples/copy-from-container/README.md

+This is a plain maven project used to demonstrate how to copy files or directories from container using `docker:copy` goal
+
+## Copying File from Container to Local Host
+We have a `copy-file` profile which copies `/etc/hosts` file from container to your project build directory. It has executions set up for `start`,`copy`,`stop` goals so they will be activated when you build using the specified profile. In order to run it, use this command:


Suggested change

We have a `copy-file` profile which copies `/etc/hosts` file from container to your project build directory. It has executions set up for `start`,`copy`,`stop` goals so they will be activated when you build using the specified profile. In order to run it, use this command:

We have a `copy-file` profile which copies `/etc/hosts` file from container to your project build directory.

It has executions set up for `start`, `copy` and `stop` goals, so they will be activated when you build using the specified profile.

In order to run it, use this command:

mabrarov · 2021-03-30T12:44:03Z

samples/copy-from-container/README.md

+```
+
+## Copying Directory from Container to Local Host
+We have a `copy-directory` profile which copies `/dev` directory from container to your `target` directory. It has `createContainers=true` with which plugin copies from a temporary(created, but not started) container instead of copying from the standard container. In order to run it, use this command:


Suggested change

We have a `copy-directory` profile which copies `/dev` directory from container to your `target` directory. It has `createContainers=true` with which plugin copies from a temporary(created, but not started) container instead of copying from the standard container. In order to run it, use this command:

We have a `copy-directory` profile which copies `/dev` directory from container to your `target` directory.

It has `createContainers=true` with which plugin copies from a temporary (created, but not started) container instead of copying from the standard container (e.g. created and started by `start` goal).

In order to run it, use this command:

mabrarov · 2021-03-30T13:22:21Z

samples/copy-from-container/pom.xml

@@ -0,0 +1,87 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"


I believe that we need to add copy-from-container module into "samples/pom.xml" POM (into the modules section), don't we?

mabrarov · 2021-03-30T15:39:28Z

@rohanKanojia,

I'm going to merge this PR into copy_mojo_docs branch, then extend / adjust documentation and samples there and then merge (fast-forward) copy_mojo_docs branch into copy_mojo branch. Please, let me know if you have concerns and thank you for driving this.

rohanKanojia · 2021-03-30T16:40:20Z

oh, Sorry I was busy with work so couldn't update your recent comments. Shall I address your comments or do you plan to fix them yourself? I'm okay with whatever way you prefer.

mabrarov · 2021-03-30T16:41:31Z

I plan to fix them myself.

rohanKanojia · 2021-03-30T16:42:55Z

ohk, I guess you can merge it then

rohanKanojia mentioned this pull request Mar 27, 2021

Copy goal for copying files from container to host fabric8io/docker-maven-plugin#1405

Merged

3 tasks

mabrarov reviewed Mar 28, 2021

View reviewed changes

rohanKanojia force-pushed the copy_mojo_docs_and_sample branch 3 times, most recently from 1bc02d8 to 107b715 Compare March 28, 2021 17:24

mabrarov reviewed Mar 28, 2021

View reviewed changes

rohanKanojia force-pushed the copy_mojo_docs_and_sample branch from 107b715 to 7851a5c Compare March 29, 2021 06:11

rohanKanojia force-pushed the copy_mojo_docs_and_sample branch from 7851a5c to 1192d5d Compare March 30, 2021 11:53

mabrarov reviewed Mar 30, 2021

View reviewed changes

Add Docs for Copy Goal and Sample for File/Directory Copy

2dce16b

+ Added Docs for `docker:copy` + Added a `copy-from-container` sample which contains profiles for copying file and directory to localhost from container Signed-off-by: Rohan Kumar <rohaan@redhat.com>

rohanKanojia force-pushed the copy_mojo_docs_and_sample branch from 1192d5d to 2dce16b Compare March 30, 2021 12:27

mabrarov reviewed Mar 30, 2021

View reviewed changes

mabrarov changed the base branch from copy_mojo to copy_mojo_docs March 30, 2021 15:37

mabrarov merged commit 544a7b2 into mabrarov:copy_mojo_docs Mar 30, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Docs for Copy Goal and Sample for File/Directory Copy #1

Add Docs for Copy Goal and Sample for File/Directory Copy #1

rohanKanojia commented Mar 27, 2021

mabrarov Mar 28, 2021 •

edited

mabrarov Mar 28, 2021

mabrarov Mar 28, 2021

mabrarov Mar 28, 2021

mabrarov Mar 28, 2021

mabrarov Mar 28, 2021

mabrarov Mar 28, 2021

mabrarov Mar 28, 2021

mabrarov Mar 28, 2021

mabrarov commented Mar 28, 2021 •

edited

mabrarov Mar 28, 2021

mabrarov Mar 28, 2021

mabrarov Mar 28, 2021

mabrarov Mar 28, 2021

mabrarov Mar 28, 2021

mabrarov Mar 28, 2021

mabrarov Mar 28, 2021

mabrarov Mar 28, 2021

mabrarov Mar 28, 2021

mabrarov commented Mar 30, 2021

rohanKanojia commented Mar 30, 2021

mabrarov Mar 30, 2021

mabrarov Mar 30, 2021 •

edited

mabrarov Mar 30, 2021

mabrarov Mar 30, 2021

mabrarov Mar 30, 2021

mabrarov Mar 30, 2021

mabrarov Mar 30, 2021

mabrarov commented Mar 30, 2021

rohanKanojia commented Mar 30, 2021

mabrarov commented Mar 30, 2021

rohanKanojia commented Mar 30, 2021

		@@ -0,0 +1,89 @@
		<project xmlns = "http://maven.apache.org/POM/4.0.0"

	<id>copy-from-container</id>
	<id>copy-file-from-container</id>

	<hostDirectory>/tmp/</hostDirectory>
	<hostDirectory>${project.build.directory}</hostDirectory>

	<hostDirectory>/tmp/</hostDirectory>
	<hostDirectory>target</hostDirectory>

	<artifactId>dmp-sample-copy-from-container</artifactId>
	<artifactId>dmp-sample-copy-from-container</artifactId>
	<packaging>pom</packaging>

	mvn clean install -PCopy-File
	$ mvn clean package -P copy-file

	Once command finishes successfully, try checking your `/tmp` directory to see file got created or not. If everything goes okay, you should be able to see output like this:
	Once command finishes successfully, try checking "target" directory to see if the file got created or not. If everything goes okay, you should be able to see output like this:


		This is a plain maven application used to demonstrate how to copy files or directories from container using `docker:copy` goal

		## How to Build?

		@@ -0,0 +1,64 @@
		# Docker Maven Plugin Copy Sample

		This is a plain maven application used to demonstrate how to copy files or directories from container using `docker:copy` goal


		This is a plain maven project used to demonstrate how to copy files or directories from container using `docker:copy` goal

		## Copying File from Container to Local Host

-## Copying File from Container to Local Host
+## Copying File from Container to Local Host
+We have a `copy-file` profile which copies `/etc/hosts` file from container to your project build directory.
+It has executions set up for `start`, `copy` and `stop` goals, so they will be activated when you build using the specified profile.
+In order to run it, use this command:
+```
+$ mvn clean package -Pcopy-file
+```
+Once command finishes successfully, try checking your `target` directory to see if the file got created or not.
+If everything goes okay, you should be able to see output like this:
+```
+$ ls target
+hosts
+$ cat target/hosts
+.0.0.1 localhost
+::1 localhost ip6-localhost ip6-loopback
+fe00::0 ip6-localnet
+ff00::0 ip6-mcastprefix
+ff02::1 ip6-allnodes
+ff02::2 ip6-allrouters
+.17.0.3  80dd81263592
+```
+Docker Maven Plugin external configuration can be used to define entries which need to be coped, e.g.:
+```
+$ mvn clean package -Pcopy-file \
+    -Ddocker.imagePropertyConfiguration=override \
+    -Ddocker.name=alpine \
+    -Ddocker.copy.entries.1.containerPath=/etc/os-release \
+    -Ddocker.copy.entries.1.hostDirectory=target \
+    -Ddocker.copy.entries.2.containerPath=/etc/hostname \
+    -Ddocker.copy.entries.2.hostDirectory=target
+...
+$ ls target
+hostname  os-release
+$ cat target/hostname
+f1387e0c6253
+$ cat target/os-release
+NAME="Alpine Linux"
+ID=alpine
+VERSION_ID=3.13.2
+PRETTY_NAME="Alpine Linux v3.13"
+HOME_URL="https://alpinelinux.org/"
+BUG_REPORT_URL="https://bugs.alpinelinux.org/"
+```
+## Copying Directory from Container to Local Host
+We have a `copy-directory` profile which copies `/dev` directory from container to your `target` directory.
+It has `createContainers=true` with which plugin copies from a temporary (created, but not started) container instead of copying from the standard container (e.g. created and started by `start` goal).
+In order to run it, use this command:
+...

		@@ -0,0 +1,87 @@
		<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

Add Docs for Copy Goal and Sample for File/Directory Copy #1

Add Docs for Copy Goal and Sample for File/Directory Copy #1

Conversation

rohanKanojia commented Mar 27, 2021

mabrarov Mar 28, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mabrarov commented Mar 28, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mabrarov commented Mar 30, 2021

rohanKanojia commented Mar 30, 2021

Choose a reason for hiding this comment

mabrarov Mar 30, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mabrarov commented Mar 30, 2021

rohanKanojia commented Mar 30, 2021

mabrarov commented Mar 30, 2021

rohanKanojia commented Mar 30, 2021

mabrarov Mar 28, 2021 •

edited

mabrarov commented Mar 28, 2021 •

edited

mabrarov Mar 30, 2021 •

edited