Update documentation for 2.0.0 release #1345
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fabiobrz
force-pushed
the
update-doc-for-200.alpha1
branch
from
11cf019 to
ad3c45d
Compare
fabiobrz
changed the title
fabiobrz
changed the title
asoldano
approved these changes
Jan 15, 2025
gaol
reviewed
Jan 15, 2025
| @@ -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/. | |||
There was a problem hiding this comment.
maybe update the link to https://docs.docker.com/reference/dockerfile/ ?
|
|
||
| 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. |
There was a problem hiding this comment.
At end of this file, the link is broken, should it be https://github.com/arquillian/arquillian-cube/tree/main/docker/ftest-docker-compose-v2 ?
And shall we mention which docker compose version to support ? and maybe follow the compose-spec in the future ?
| |machineName | ||
| |Sets the machine name in case you are using docker-machine to manage your docker host. This parameter is mandatory when using docker-machine with more than one running machine. In case of having only one docker machine running, it is not necessary to set it since it is auto resolved by cube. | ||
|
|
||
| |machineDriver | ||
| |Sets the machine driver in case you are using _docker-machine_, _Cube_ will create a machine using this driver. This parameter is mandatory when docker-machine is not installed. | ||
| |Sets the machine driver in case you are using _docker-machine_. This parameter is mandatory when docker-machine is not installed. |
There was a problem hiding this comment.
Shall we remove the docker machine related parameters as we don't support them ?
There was a problem hiding this comment.
Done, and submitted an issue for removing the remaining references in the functional and test code: #1346
| <6> You can pass environment variables by using `env`. In this section you can set special `dockerServerIp` string which at runtime will be replaced by _Cube_ to current docker server ip. | ||
| <7> After the container is up, a list of commands can be executed within it. | ||
| <8> Port forwarding is configured using `portBinding` section. It contains a list of `exposedPort` and `port` separated by arrow (_->_). If only one port is provided, *Arquillian Cube* will expose the same port number. In this example the exposed port 8089 is mapped to 8089 and exposed port 8080 is mapped to 8081. | ||
| <9> You can extend another configuration. Any top level element and it's children from the target container-id will be copied over to this configuration, unless they have been defined here already. | ||
| <10> You can use `manual` to indicate that this container is going to be started or in the test manually using `CubeController` or started by an extension. This attribute is ingorned in case of arquillian containers (none autostart containers) or in case of a linked container that comes from a none manual container. | ||
| <11> Kills the container instead of stopping it normally. By default is false so containers are stopped. | ||
| <11> Kills the container instead of stopping it normally. By default, it is set to false, so that containers are stopped. | ||
| <12> Alternate hostname for use with the builtin DNS for https://docs.docker.com/engine/userguide/networking/#user-defined-networks[docker'suser defined networks]. |
There was a problem hiding this comment.
link might be changed to https://docs.docker.com/engine/network/#user-defined-networks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
SSIA
Short description of what this resolves:
Documentation update
Changes proposed in this pull request:
Fixes #1344