Skip to content

Commit

Permalink
Small fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
Martijn Dirkse committed Oct 25, 2024
1 parent aed74af commit 1606c9e
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 11 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,3 @@ To understand the material of this section, knowledge on earlier sections of the
httpInterfaces
internalNetwork
secrets

.. WARNING::

The following topics, and more, will be added:

* Keeping secrets using parameters.
6 changes: 3 additions & 3 deletions docs/source/deploying/deploying.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ The Frank!Framework is a Java web application that has to be served by an applic
* The DTAP stage (Development, Test, Acceptance, Production) and property ``instance.name``.
* Configuring databases and queues.
* Configuring users, passwords and roles.
* Providing credentials for the Frank!Framework that it needs to contact third-party applications.
* Providing credentials to the Frank!Framework that it needs to contact third-party applications.
* The way Frank configurations can be found (already handled in a Docker image provided by Frank developers).

.. WARNING::

The information in this chapter is not complete yet. Not all subject listed here are covered yet.
The information in this chapter is not complete yet. Not all subject listed here are covered.

This manual does not explain how to use an application server. Instead, it explains how to do the configurations listed above. The maintainers of the Frank!Framework have created a Docker image that holds the Frank!Framework deployed on Apache Tomcat, see https://github.com/frankframework/frankframework/blob/master/Docker.md. Frank developers can derive their image from this image to add Frank configurations.

Expand All @@ -26,7 +26,7 @@ Here is the table of contents of this chapter:
.. toctree::
:maxdepth: 3

dtapAndProperties
dtapAndInstanceName
requiringAuthorization
overviewSecurityRoles
credentials
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ The instance name and the DTAP stage

This section describes two basic properties you have to set as a system administrator: ``instance.name`` and ``dtap.stage``. Property ``instance.name`` is a name for the set of configurations that is hosted on a single server or on a group of servers running in parallel. The Frank!Framework uses this name in many ways, so it is important that you provide it.

Property ``dtap.stage`` is about the life cycle of a Frank config. During this life cycle, a Frank is typically deployed on different servers (or server groups). During its development, the config lives on the development environment (D). When the developers consider releasing, they bring their work to another environment, the test environment (T). When the tests are successful, the Frank config is released to the customer. The customer should do acceptance tests on a dedicate environment (A). Only after acceptance testing succeeds, the work should go to production (P). These four letters form the famous DTAP acronym. The Frank!Framework uses an extra (fifth) stage: ``LOC``, the local development computer of a single developer. Please note that ``instance.name`` is usually the same for each DTAP stage.
Property ``dtap.stage`` is about the life cycle of a Frank config. During this life cycle, a Frank is typically deployed on different servers (or server groups). During its development, the config lives on the development environment (D). When the developers consider releasing, they bring their work to another environment, the test environment (T). When the tests are successful, the Frank config is released to the customer. The customer should do acceptance tests on a dedicated environment (A). Only after acceptance testing succeeds, the work should go to production (P). These four letters form the famous DTAP acronym. The Frank!Framework uses an extra (fifth) stage: ``LOC``, the local development computer of a single developer. Please note that ``instance.name`` is usually the same for each DTAP stage.

As a system administrator, you have to set the DTAP stage by setting the system property ``dtap.stage``. The allowed values are ``LOC``, ``DEV``, ``TST``, ``ACC`` and ``PRD``.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/deploying/requiringAuthorization.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This section assumes that authorization has been set up for you. Frank developer
YAML authorization
------------------

This mechanism expects that users, passwords and roles are in a YAML file that you provide. If you use a Docker image derived from the Frank!Framework on Tomcat Docker image, then the file is expected at ``opt/frank/resources/localUsers.yml``. Here is an example:
This mechanism expects that users, passwords and roles are in a YAML file that you provide. If you use a Docker image derived from the Frank!Framework on Tomcat Docker image, then the file is expected at ``/opt/frank/resources/localUsers.yml``. Here is an example:

.. code-block:: none
Expand Down

0 comments on commit 1606c9e

Please sign in to comment.