Versions Compared

Key

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

...

Note

Images that are no longer supported will be removed without further notice.

Example preparation with docker container runtime:

docker login https://images.docker.kgs-cloud.de

...

Deploying tia Core requires the following:

...

a

...

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.For more than minimal configuration, kgs recommends to create a viewer.yml file. For more information see Configuration (Vc).

Finally prepare the command to start the container based on the specific requirements according to the following table:

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.

Alternatively, only the license file may be mapped:

-v ./viewerlicense.json:/application/config/license/viewerlicense.json

-v

<config directory>

/application/config

Mapping the configuration directory to the container context.

-e

/application/config/viewer.yml

SPRING_CONFIG_ADDITIONALLOCATION

The configuration file for the tia Viewer (typically named viewer.yml). If not provided, built-in defaults will be applied.

Alternatively, for minimal installation configuration using environmental variable only is available.

For more information, see Configuration (Vc) .

-e

<Loglevel>

LOGGING_LEVEL_ROOT

The log level sets the verbosity 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.

...

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

...

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

...

  • access its health status in web browser. <http|https>://<host>:<port>/actuator/health

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

...