Skip to content

Latest commit

 

History

History
72 lines (49 loc) · 2.26 KB

README.md

File metadata and controls

72 lines (49 loc) · 2.26 KB
Raw

Spring Boot Demo Application

This is a Spring Boot demo application designed to interact with an OAuth2 authentication service. The application demonstrates the use of environment variables for configuration, custom metrics for monitoring, and containerization using Docker. It is integrated with GitHub Actions for CI/CD, which includes building, versioning, and deploying Docker images to Docker Hub.

Features

OAuth2 Authentication:

The application retrieves an OAuth2 token from a specified authentication service using credentials provided via environment variables.

Custom Metrics:

Custom metrics are integrated using Micrometer and Prometheus for monitoring application performance and status.

Environment Configuration:

Environment variables are used to configure client ID, API key, username, password, and the authentication URL, ensuring that sensitive information is not hardcoded.

Containerization with Docker:

The application is containerized using Docker, making it easy to deploy and run in different environments.

Usage

Environment Variables:

The application uses the following environment variables:

  • OAUTH2_CLIENT_ID: Client ID for OAuth2 authentication.
  • OAUTH2_API_KEY: API key for OAuth2 authentication.
  • OAUTH2_USERNAME: Username for OAuth2 authentication.
  • OAUTH2_PASSWORD: Password for OAuth2 authentication.
  • OAUTH2_URL: URL of the OAuth2 authentication service.
  • OAUTH_RETRY_INTERVAL: Interval for the AUthService to retry backend calls (in seconds)

Prerequisites

  • Java 17
  • Maven
  • Docker

Building the Project

  1. Clone the repository:

    git clone <repository-url>
cd springboot-app

  2. Build the application using Maven:

    mvn clean package

  3. Build the Docker image:

    docker build -t springboot-demo .

Running the Application

Run the Docker container with the necessary environment variables:

docker run -e OAUTH2_CLIENT_ID=<your-client-id> \
           -e OAUTH2_API_KEY=<your-api-key> \
           -e OAUTH2_USERNAME=<your-username> \
           -e OAUTH2_PASSWORD=<your-password> \
           -e OAUTH2_URL=<your-oauth-url> \
           -e OAUTH_RETRY_INTERVAL=<your-retry-interval> \
           <your-docker-image>