Skip to content

Run & Validate

Purpose

This stage configures and runs the Management Node Spring Boot application and validates that it is operating correctly. You will:

  • Configure application settings
  • Select an active Spring profile
  • Start the Management Node
  • Confirm secure connectivity and successful startup

Stage 5 - Run and Validate the Management Node

How to complete this stage

You will:

  • Configure application properties (SSL, Keycloak, database, etc.)
  • Choose either the default profile or a custom profile
  • Run the Spring Boot application
  • Validate that the application starts successfully

Approach and rationale

The Management Node is a Spring Boot application. It requires configuration for:

  • SSL keystore and truststore
  • Keycloak authentication settings
  • Database connectivity
  • Active Spring profile

The application can be run:

  • Using the default configuration
  • Using a custom profile for local development

This stage ensures that:

  • TLS is enabled
  • Keycloak integration is active
  • The application starts without error
  • The Management Node is ready for secure communication

5.1 Configure application settings

Supply configuration for the application.

Navigate to the resources directory:

cd src/main/resources/

Update application.yml with your local settings, including:

  • SSL keystore location
  • SSL truststore location
  • Keycloak client configuration
  • Database connection details
  • Any required environment variables

5.2 Run the application (default profile)

Run the application with Spring Boot:

mvn spring-boot:run

Alternative – run the application directly:

java -jar target/management-node-1.1.0.jar

5.3 Run the application with a custom profile (optional)

Users can provide a 'local' profile. Configuration set in application.yml will be used unless redefined by the local configuration. Any configuration not being overridden should still be set in the default application.yml. Choose a name for the custom profile (for example: local).

Navigate to:

cd src/main/resources/

Duplicate the default configuration file:

mv application.yml application-local.yml

Update application-local.yml with your local settings:

  • SSL keystore and truststore
  • Keycloak configuration
  • Database configuration
  • Port settings if required

Run the application with Spring Boot:

mvn spring-boot:run -Dspring-boot.run.profiles=local

Alternative – run the application directly:

java -jar target/management-node-1.0.1.jar --spring.profiles.active=local

Set the environment variable for the active profile:

export SPRING_PROFILES_ACTIVE=local

5.4 Validation application start up

Once the application starts:

  • Confirm the console logs indicate successful startup.
  • Confirm SSL is enabled.
  • Confirm the application port is listening.
  • Confirm Keycloak connectivity does not produce errors.
  • Confirm there are no keystore or truststore loading failures.

If TLS is misconfigured, the application may fail to start or report certificate errors.

If Keycloak connectivity is misconfigured, authentication errors may appear in the logs.

Operational notes
  • Ensure keystore and truststore paths are correct.
  • Ensure keystore passwords match configuration.
  • Confirm Keycloak is running before starting the application.
  • Confirm the selected Spring profile matches your configuration file.
  • If ports are already in use, update configuration accordingly.

Checkpoint

At the end of this stage:

  • The Management Node application is running.
  • TLS is enabled.
  • Keycloak integration is active.
  • No startup errors are present.
  • The application is ready for integration with Federators.

If any validation step fails, resolve configuration issues before proceeding.

Next Steps

Continue to the Reference section which describes the components, configuration surface, runtime interfaces, security model, and operational characteristics of a Management Node within the Integration Architecture (IA).