Versions Compared

Old Version 6

changes.mady.by.user Stefan Franz

Saved on

compared with

New Version 7

changes.mady.by.user Stefan Franz

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • configurations in environment or in a yaml. TODO: Link for the configuration Page, see Configuration (Vc) for configuration and examples.

  • license file. This file is provided by kgs.

In addition, decide about and prepare these settings depending on your requirements in order to run the container.

Docker parameter

Placeholder name to be replaced

Mapping to container-configuration

Explanation

--name

<Name>

Give the tia Viewer container a custom name. This name is also the application context name.

Info

Hint: You can start multiple instances of the same containers with different ports and different names.

-p

<Hostport>

SERVER_PORT

<Hostport>: Listener port on host that forwards to the listener port in the container, which is configured by server.port application-wide setting (default: 8080).

-v

<License Folder>

/application/config/license/

The location on host system where the license file resides. For more information refer to Location of the license file .

-e

<Loglevel>

LOGGING_LEVEL_ROOT

The log level sets the verboseness of the log writing. Valid are: OFF; ERROR; WARN; INFO orDEBUG.It is recommended to use ERROR or WARN in production environments and WARN or INFO in test systems. Set DEBUG level only when being ask be kgs Customer Support. For more information on logging refer to Logging .

-d

Run as daemon in background

<Image>

Referencing the image as last parameter in the docker command.

The image is referenced like this:

images.docker.kgs-cloud.de/tia-viewer/<Product:<Version>

with

<Product>: The tia Core product to be deployed: archivelink-oidc.

<Version>: The version of tia Core to be deployed. kgs recommends to use the latest available version.For this use latest.

Template of docker run command for copy & paste:

Code Block
docker run --name <Name> -p <Hostport>:<Containerport>  -v <License Folder>:/application/config/license/  -e LOGGING_LEVEL_ROOT=<Loglevel>  -d <Image>

Example:

Code Block
docker run --name viewer-AL -p 8080:8080   -v ./tiacore/license:/application/config/license/ -e LOGGING_LEVEL_ROOT=INFO  -d images.docker.kgs-cloud.de/tia-viewer/archivelink-oidc:latest

Explanation of docker command:

The parameter -p maps ports, and -v volumes (directories or files) between host and container. -e sets environmental variables in the container.

Using -v allows to store data like configuration permanently at host, edit, maintain it there, even when the container is started, destroyed and restarted again.

Info

Hint: When host is running Windows, the path may contain drive letter with colon ( : ) and backslashes ( \ ). Use quotation marks and double the backslash to allow correct interpretation.

E.g.: -v "G:\\host\\location":/container/location

For information about the environmental variables set, refer to Reference of application-wide parameters .

When the tia Core container is running,

  • access its health status in web browser. TODO: actuator health einfügen

  • customize SAP to use the viewer: SAP Customizing (V)