Skip to content

Commit

Permalink
Update docuentation for 2.0.0.Apha release
Browse files Browse the repository at this point in the history
  • Loading branch information
fabiobrz committed Jan 11, 2025
1 parent 9baa2b6 commit 11cf019
Show file tree
Hide file tree
Showing 17 changed files with 220 additions and 209 deletions.
7 changes: 4 additions & 3 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,10 @@
:icons: font
:toc: left

WARNING: 1.0.0.Alpha7 breaks incompatibility with previous versions in some cases. The major difference is that instead of using the _boot2docker_ keyword to refer to the auto resolved boot2docker ip in the _serverUri_ parameter, you should now used _dockerHost_.

IMPORTANT: 1.0.0.Alpha13 changes default format from Cube to Docker Compose. In case you are using Cube format you need to update arquillian.xml with `<property name="definitionFormat">CUBE</property>`
WARNING: 2.0.0.Alpha1 breaks incompatibility with previous versions as _boot2docker_ and _DockerMachine_ support has
been removed. This means that support for Windows and macOS is removed from 2.x.
We're in the process of evaluating whether to add such support to the 2.x stream again, or to adopt
different solutions. In such a case we'd probably release a 1.x version, which would still support such components.

ifndef::generated-doc[]
To read complete documentation visit http://arquillian.org/arquillian-cube/
Expand Down
2 changes: 1 addition & 1 deletion docs/bom.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
== Arquillian Cube BOM - Unified Dependencies

This aims to fulfill requirements of unify naming & versions.
This aims to fulfill requirements for unifying naming & versions.

=== Usage

Expand Down
16 changes: 8 additions & 8 deletions docs/build-containers.adoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
== Building containers

To build a container _Docker_ uses a file called +Dockerfile+ http://docs.docker.com/reference/builder/.
*Arquillian Cube* also supports building and running a container from a +Dockerfile+.
To build a container _Docker_ uses a file called `Dockerfile` http://docs.docker.com/reference/builder/.
*Arquillian Cube* also supports building and running a container from a `Dockerfile`.

To set that *Arquillian Cube* must build the container, the +image+ property must be changed to +buildImage+ and add the location of +Dockerfile+.
To set that *Arquillian Cube* must build the container, the `image` property must be changed to `buildImage` and add the location of `Dockerfile`.

Let's see previous example but instead of creating a container from a predefined image, we are going to build one:

Expand All @@ -23,15 +23,15 @@ Let's see previous example but instead of creating a container from a predefined
portBindings: [8089/tcp, 8080/tcp]
</property>
----
<1> +buildImage+ section is used in front of +image+. In case of both sections present in a document, +image+ section has preference over +buildImage+.
<2> +dockerfileLocation+ contains the location of +Dockerfile+ and all files required to build the container.
<1> `buildImage` section is used in front of `image`. In case of both sections present in a document, `image` section has preference over `buildImage`.
<2> `dockerfileLocation` contains the location of `Dockerfile` and all files required to build the container.
<3> Property to enable or disable the no cache attribute.
<4> Property to enable or disable the remove attribute.
<5> Property to set the dockerfile name to be used instead of the default ones.

TIP: +dockerfileLocation+ can be a directory that must contains +Dockerfile+ in root directory (in case you don't set _dockerfileName_ property), also a +tar.gz+ file or a _URL_ pointing to a +tar.gz+ file.
TIP: `dockerfileLocation` can be a directory that must contains `Dockerfile` in root directory (in case you don't set _dockerfileName_ property), also a +tar.gz+ file or a _URL_ pointing to a +tar.gz+ file.

An example of +Dockerfile+ is:
An example of `Dockerfile` is:

[source, properties]
.src/test/resources/tomcat/Dockerfile
Expand All @@ -43,4 +43,4 @@ ADD tomcat-users.xml /tomcat/conf/ # <1>
EXPOSE 8089
CMD ["/tomcat/bin/catalina.sh","run"]
----
<1> +tomcat-users.xml+ file is located at same directory as +Dockerfile+.
<1> +tomcat-users.xml+ file is located at same directory as `Dockerfile`.
6 changes: 3 additions & 3 deletions docs/compose.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ It is important to note that this is not a docker-compose implementation but onl

In case of some specific Arquillian Cube attributes like await strategy cannot be configured and the default values are going to be used.

Moreover there are some docker-compose commands that are not implemented yet due to restrictions on docker-java library. These commands are _pid_, _log_driver_ and _security_opt_. But they will be implemented as soon as docker-java library adds their support.
Moreover, there are some docker-compose commands that are not implemented yet due to restrictions on docker-java library. These commands are _pid_, _log_driver_ and _security_opt_. But they will be implemented as soon as docker-java library adds their support.

Last thing, in case you define a command that is not implemented in Arquillian Cube, this command will be ignored (no exception will be thrown), but a log line will be printed notifying this situation. Please it is really important that if this happens you open a bug so we can add support for them. Althought this warning we will try to maintain aligned with the latest docker-compose format.
Last thing, in case you define a command that is not implemented in Arquillian Cube, this command will be ignored (no exception will be thrown), but a log line will be printed notifying this situation. Please it is really important that if this happens you open a bug so we can add support for them. Although this warning we will try to maintain aligned with the latest docker-compose format.

Let's see how you can rewrite previous HelloWorld example with Tomcat to be used using docker-compose format.
Let's see how you can rewrite previous HelloWorld example with Tomcat, using docker-compose format.

First let's create a file called `envs` on root of the project which configures environment variables:

Expand Down
Loading

0 comments on commit 11cf019

Please sign in to comment.