...
Installation of docker or another container runtime following Open Container Initiative (OCI) standard is prerequisite for deploying tia tia® Viewer as container.
Images for deployment of tia tia® Viewer Core are stored at https://images.docker.kgs-cloud.de.
| Info |
|---|
An account is required. It is provided for licensed installations via kgs Customer Support. |
| 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
Docker will prompt for user and password.
Deploying
...
tia® Viewer
Deploying tia® Viewer Core requires a license file. This file is provided by kgs.
...
Configuration is possible using environment variables for simple test systems, or using a YAML file (e.g. viewer.yml) which is recommended for more complex deployments. For more information see tia Core requires the following:
...
configurations in environment or in a yaml. TODO: Link for the configuration Page
Viewer Core 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.
| |||
| <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. Alternatively, only the license file may be mapped:
| ||
| <config directory> |
| Mapping the configuration directory to the container context. | ||
|
|
| The YAML configuration file for the tia® Viewer (typically named Alternatively, for minimal installation configuration using environmental variable only is available. For more information, see tia Viewer Core 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:
| 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> |
Example:
| 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 |
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 ( E.g.: |
For information about configuration of tia® Viewer Core by environmental variables see tia Viewer Core Configuration (Vc) .
When the tia Viewer Core® container is running,
access its health status in web browser.
<http|https>://<host>:<port>/actuator/healthcustomize SAP to use the tia® Viewer Core: SAP Customizing (Vc)