Environment API components

Environment API components

Overview #

The Enviroment API component is as Spring Boot-based REST API service. It provides endpoints to create, update, delete and list the Assure Re environments.

  • The Enviroment API component stores the environment data.
  • The environment data contains name, description, runtime zip file URL, a unique HASH-value, and other details.

Installation #

As the Environment API is Spring Boot-based component, it can be run as a normal Java application using the scripts provided in delivery zip-file. This will start an embedded Tomcat server, and runs the service on it.

The Environment API can also be run as a Docker container. A Dockerfile is provided in the DXC Assure Reinsurance delivery package.

Environment variables #

DXC Assure Re Environment API service depends on various environment variables. Some of these are required, and some of these are optional.

SERVER_PORT #

This optional environment variable define the server HTTP Port.

Default value: 8085

SSL_ENABLED #

This environment variable is used to enable SSL support.

Supported values:

  • true
  • false

Default value: false

SSL_KEY_STORE #

This environment variable defines the path to the key store that holds the SSL certificate.

Default value: classpath:keystore.p12

SSL_KEY_STORE_TYPE #

This environment variable defines the type of the key store.

Default value: PKCS12

SSL_KEY_STORE_PASSWORD #

This environment variable defines the password used to access the key store.

Default value: sics5demo

SSL_KEY_PASSWORD #

This environment variable defines the password used to access the key in the key store.

Default value: sics5demo

SSL_TRUST_STORE #

This environment variable defines the trust store that holds SSL certificates.

Default value: classpath:truststore.p12

SSL_TRUST_STORE_TYPE #

This environment variable defines the type of the trust store.

Default value: PKCS12

SSL_TRUST_STORE_PASSWORD #

This environment variable defines the password used to access the trust store.

Default value: sics5demo

ADMIN_UI_ROOT_URL #

This environment variable defines the root URL of Admin Web UX component to allow for cross origin requests.

Default value: http://localhost:5173

ADMIN_UI_ROOT_URL #

This optional environment variable defines the root URL of Admin Web UX component to allow it to make cross origin requests.

Default value: http://localhost:5173

OAUTH2_ISSUER_URI #

This environment variable defines the oAuth2 issuer URI obtained from the oAuth2 authorization server.

Default value: http://localhost:8180/realms/sics

OAUTH2_TOKEN_ENDPOINT #

This environment variable defines the token endpoint used to obtain access token from OAuth2 authorization server.

Default value: http://localhost:8180/realms/sics/protocol/openid-connect/token

OAUTH2_LOGOUT_ENDPOINT #

This environment variable defines the logout endpoint of the OAuth2 authorization server to perform OIDC logout.

Default value: http://localhost:8180/realms/sics/protocol/openid-connect/logout

OAUTH2_CLIENT_ID #

This optional environment variable defines the client id of the OAuth2 authorization server.

Required to change, in case client id is different from sics-desktop-launcher

Default value: sics-desktop-launcher