| Info |
|---|
Available from Core of tia Version 2.1.0 |
Public Access (RELEASE TAG) :
...
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 Core as container.
Images for deployment of tia Core are stored at https://images.docker.kgs-cloud.deLogin to kgs harbour with .
| 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 Docker will prompt for user and password.
Start with docker:
...
Deploying tia Core
Deploying tia Core requires the following:
A license file. This file is provided by kgs Customer Support.
repository.cfgfile. A defaultrepository.cfgfile is attached below, which is suitable for test systems only. For repository configuration settings refer to Repository-wide settings.
| View file | ||
|---|---|---|
|
place repository.cfg to in a folder
replace <Folder> with the Folderpath that contains the repository.cfg
replace <Version> with a available version on nexus
| Code Block |
|---|
docker run -p 8080:8080 -v data_volume:/temp/ -v <Folder>/repository.cfg:/application/config/repository.cfg -d docker.kgs-software.com/tia/core/<product>:<Version> |
Example:
| Code Block |
|---|
docker run -p 8080:8080 -v data_volume:/temp/ -v C:/cmis/repository.cfg:/application/config/repository.cfg -d docker.kgs-software.com/tia/core/cmis:2.4.0 |
Configuration:
Docker command:
This parameter -v data_volume:/temp/ is only required when data are stored in /temp/. When you plan to use other storages (like S3) you no not need these parameter. For different location modify repository.cfg and the command accordingly.
...
Environmane Variables
...
CONFIGDIRECTORY
...
Directory where repository.cfg is expected. Default is “/application/config/“
...
LOGGING_LEVEL_ROOT
...
Log Level for core of tia. Default is “Debug”. Recommended for Production is “WARN” or “ERROR”.
...
LOGGING_CONFIG
...
In addition, decide about and prepare these settings depending on your requirements in order to run the container.
| Placeholder name to be replaced | Mapping to container-configuration | Explanation | ||
|---|---|---|---|---|---|
| <Name> | Give the tia Core 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 | ||
| <Config Folder> |
| The folder location on host system where the | ||
| <License Folder> |
| The location on host system where the license file resides. For more information refer to Location of the license file . | ||
| <Temp Folder> |
| Optional: Mapping container’s | ||
| <Loglevel> |
| The log level sets the verboseness of the log writing. Valid are: | ||
| <BcryptHash> |
|
Set Password for Status Webapp with bcrypt. Password “admin” for testing: $2a$10$5E1KpGIKSq6xuWmGf92bheB17V0l4fEMnVmYPqhWiazKddcx1TF/e
You can overwrite these with -e <key>=value
FAQ
...
| title | I do not want log files inside my container (from core of tia <2.6.0 ) |
|---|
| Info |
|---|
This is no longer required for tia Core 2.6.0 or higher |
Use e.g this log4j2.xml without file appender
| View file | ||
|---|---|---|
|
...
And set environment variable for the container -e LOGGING_CONFIG=/application/config/log4j2.xml
| Expand | ||
|---|---|---|
| ||
Both is available on Nexus/Harbor |
| Expand | ||
|---|---|---|
| ||
In the example repository.cfg the files are stored in /temp/meta. Make sure you map these data in a volume so that multiple started images can access the same data |
| Expand | ||
|---|---|---|
| ||
In the example repository.cfg is shared when mutiple container use the same repository.cfg. Change one and restart container so that new repository.cfg works for both. |
| Expand | ||
|---|---|---|
| ||
Tomcat is now embedded and maintained by kgs. |
| Expand | ||
|---|---|---|
| ||
Pull the new image Find the ID of the running container  Stop Container Start Container |
...
| title | Are there files or directories that need to be mapped in the container and need to be permanent with read/write access? |
|---|
Yes, but it depends on your configuration.
...
Core of tia requires a metadata directory (<repo>.configdata.filesystem.root)
...
Core of tia can require a keystore, when you configure it, make sure this file is available for all
<repo>.keystoreservice.pkcs12.name<repo>.keystoreservice.pkcs12.path
...
To login to the tia Status UI, a password is required that when being hashed must match this value. For more information refer to tia® Status UI Authentication . | |||
| 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 |
For information about the container environmental variables, refer to Reference of application-wide parameters
| Info |
|---|
When host is running Windows, pay attention to the volume mappings. The host volume path contains drive letter with colon ( Example volume mapping: |
For example deployments see: