Preparing container runtime
Deploying software as containers requires a container runtime. This documentation provides the required information. It also provides examples for docker container runtime.
Installation of docker or another container runtime following Open Container Initiative (OCI) standard is prerequisite for deploying tia Viewer as container.
Images for deployment of tia Core are stored at https://images.docker.kgs-cloud.de .
An account is required. It is provided for licensed installations via kgs Customer Support.
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
Docker will prompt for user and password.
Deploying tia Viewer
Deploying tia Core requires a license file. This file is provided by kgs.
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> | Give the tia Viewer container a custom name. This name is also the application context name. Hint: You can start multiple instances of the same containers with different ports and different names. | |
| <Hostport> |
| <Hostport>: Listener port on host that forwards to the listener port in the container, which is configured by |
| <License Folder> |
| 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:
|
| <config directory> |
| Mapping the configuration directory to the container context. |
|
|
| The configuration file for the tia Viewer (typically named Alternatively, for minimal installation configuration using environmental variable only is available. For more information, see Configuration (Vc) . |
| <Loglevel> |
| The log level sets the verbosity of the log writing. Valid are: |
| Run as daemon in background | ||
<Image> | Referencing the image as last parameter in the The image is referenced like this:
with <Product>: The tia Core product to be deployed: <Version>: The version of tia Core to be deployed. kgs recommends to use the latest available version.For this use |
Template of docker run command for copy & paste:
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>
Example:
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
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.
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.
<http|https>://<host>:<port>/actuator/healthcustomize SAP to use the viewer: SAP Customizing (V)
Configure https:
see https://kgs-software.atlassian.net/wiki/x/EgA1wg