AMT Control Center Config File

The YAML cc-config.yaml file is used to configure the AMT Control Center. Each key and setting found in this file is described below.

Base Configuration

Secure Storage

The settings for the Secure Storage provider, which relate to the database settings further down.

Authentication

In the sample config file, the client name is "rest" – this can be named anything, as long as it is unique when defining multiple clients.

Control Center Node

Settings for the Control Center REST server.

Control Center Managed AMT Applications

Add and configure the applications that the Control Center manages.

Database Configuration

The Database configuration section. First, the database kind needs to be defined. Use 'systemDatabase' for the Control Center and 'transactionDatabase' for Transactions.

All of the database settings can be stored in the key vault. A dollar sign $ prefixing a value denotes the use of a key stored in the key vault file.

Sample File

---
####################################################################################################
#
# CONTROL-CENTER CONFIGURATION
# General Control-Center related configuration items.
#
####################################################################################################
version: v1
name: AMT Control Center Java Configuration Template
environment: DEV
####################################################################################################
#
# SECURE STORAGE
# Settings related to the secure storage provider. This ties into the database settings later on.
#
####################################################################################################
secureStorage:
  # Secure Storage can be configured in a couple of different ways.
  # See the Secure Storage Wiki page for more information.
  vaultType: Simple
  vaultConfiguration:
    vaultFilePath: C:/AMT/cc-secrets.txt
####################################################################################################
#
# AUTHENTICATION CONFIGURATION SECTION
# Settings related to the external authentication provider.
# Defaults are added for a simple KeyCloak setup, if another authentication provider is required,
# then you need to add the correct issuerURL & clientID.
#
####################################################################################################
authentication:
  type: OIDC
  clients:
    rest:
      settings:
        issuerURL: http://localhost:8080/realms/AMTRealm
        clientID: AMT
        #claimUserRoles: amt # "oauth". When using OAuth, claimRolesKey and rolemapping needs to be configured
          #claimRolesKey: # Key to roles in OAth token. For Azure e.g. it is "groups",
                          # where for keycloak it is "resource_access;AMT;roles", it is 3 layers deep, using ; separates the keys.
      #roleMapping:
      #role1: amt_role1
####################################################################################################
#
# SERVER CERTIFICATE CONFIGURATION
# Paths to the server key and certificate (file or classpath resource).
# If not set, the default key and certificate will be loaded from the classpath (/certs/server1.key and /certs/server1.pem)
#
####################################################################################################
serverCertificate:
  # Can be a file path or classpath resource.
####################################################################################################
#
# CONTROL-CENTER NODE
# Settings related to the Control-Center REST server.
#
####################################################################################################
node:
  host: 0.0.0.0
  restPort: 9001
  httpOnly: false # Will disable TLS if set to true.
####################################################################################################
#
# SUPPORTED APPLICATIONS
# Configure any application that the Control-Center will be managing.
#
####################################################################################################
applications:
  smoketest:
    host: localhost
    gRPCPort: 8080
    httpOnly: false # Will disable TLS if set to true.
####################################################################################################
#
# SYSTEM DATABASE CONFIGURATION
# Settings related to the system database. Values can be keys for the configured key vault
# from the Secure Storage section up above.
#
####################################################################################################
systemDatabase:
  type: POSTGRES
  settings:
    name: amtsystem
    schema: amtsystem
    username: amtsystem
    password: amtsystem
    driverClassname: org.postgresql.Driver
    url: jdbc:postgresql://localhost/amtsystem
    hibernateDialect: org.hibernate.dialect.PostgreSQLDialect
    # Uncomment these if you want to override the default values.
    #hibernateShowSql: false
    #connectionPoolSize: 200
    #lockTimeoutSeconds: 20
    #lockTimeoutReportsProgramsSeconds: 5
    #sqlCommandTimeout: 30
####################################################################################################
#
# TRANSACTION DATABASE CONFIGURATION (ENABLE & USE WHEN CONFIGURING A TRANSACTION DATABASE)
# Settings related to the transaction database. Values can be keys for the configured key vault
# from the Secure Storage section up above.
#
####################################################################################################
#transactionDatabase:
#  type: POSTGRES
#  settings:
#    name: amtsystransaction              <Create name>
#    schema: amtsystransaction            <Create schema>
#    username: amtsystransactionUser      <username from secrets file>
#    password: amtsystransactionPassword  <password from secrets file>
#    driverClassname: org.postgresql.Driver
#    url: jdbc:postgresql://localhost/amtsystransaction
#    hibernateDialect: org.hibernate.dialect.PostgreSQLDialect
#    # Uncomment these if you want to override the default values.
#    #hibernateShowSql: false
#    #connectionPoolSize: 200
#    #lockTimeoutSeconds: 20
#    #lockTimeoutReportsProgramsSeconds: 5
#    #sqlCommandTimeout: 30
...