Skip to content

Commit

Permalink
Provide link to detailed info about ff docker image
Browse files Browse the repository at this point in the history
  • Loading branch information
Martijn Dirkse committed Sep 13, 2024
1 parent 8989ab5 commit cf77d21
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/source/advancedDevelopment/dockerDevel/basics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ We assume in this section that you have docker and docker-compose on your develo
Starting the FF! with docker-compose
------------------------------------

Docker images are provided, suitable both for local and server use. Images are provided from the registry located at https://nexus.frankframework.org, where images will be stored for as long as possible. Specific nightly builds are made available on DockerHub ``frankframework/frankframework`` (https://hub.docker.com/r/frankframework/frankframework), but may only be available for 6 months (https://www.docker.com/blog/scaling-dockers-business-to-serve-millions-more-developers-storage). The source is available from the docker-folder in the `frankframework/frankframework` GitHub repository.
Docker images are provided, suitable both for local and server use. Images are provided from the registry located at https://nexus.frankframework.org, where images will be stored for as long as possible. Specific nightly builds are made available on DockerHub ``frankframework/frankframework`` (https://hub.docker.com/r/frankframework/frankframework), but may only be available for 6 months (https://www.docker.com/blog/scaling-dockers-business-to-serve-millions-more-developers-storage). The source is available from the docker-folder in the ``frankframework/frankframework`` GitHub repository.

It runs Linux and contains Apache Tomcat with the Frank!Framework deployed. It configures the Frank!Framework to read configurations from directory ``/opt/frank/configurations``. The Frank!Framework is served under the root context on port 8080. The following ``docker-compose.yml`` is sufficient to get started:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The previous page :ref:`advancedDevelopmentDockerDevelSingleConfig` explained on

These issues can be addressed by distributing a docker image. Developers can create it by writing a dockerfile. The dockerfile should derive from image ``frankframework/frankframework`` (if the desired application server is Apache Tomcat), which is available on Dockerhub. It should include the Frank configurations (can be plural in this case) being deployed in the ``/opt/frank/configurations`` directory. The production environment does not reference them in a volume anymore.

The maintainers of the Frank!Framework have done a lot of work to make image ``frankframework/frankframework`` reliable, and hence you are recommended not to interfere with the way it configures Apache Tomcat. For example, it is deprecated upon to provide some ``context.xml``.
The maintainers of the Frank!Framework have done a lot of work to make image ``frankframework/frankframework`` reliable, and hence you are recommended not to interfere with the way it configures Apache Tomcat. For example, it is deprecated upon to provide some ``context.xml``. Detailed information about this image and how to use it can be found here: https://github.com/frankframework/frankframework/blob/master/Docker.md.

There is a caveat here conserning external resources. If the image configures Apache Tomcat and if it should be immutable, how should external resources be configured? The application is usually deployed in multiple environments during its life cycle, for example Develop, Test, Acceptance and Production (= DTAP, see :ref:`propertiesDeploymentEnvironment`). These environments should not share resources - production data should not be available to systems being tested for example. This issue can be addressed by defining all resources for all environments in ``resources.yml``, which becomes part of the deliverable here.

Expand Down

0 comments on commit cf77d21

Please sign in to comment.