Vehicle Service Configuration - SGIVU Config Repository

The Vehicle Service (sgivu-vehicle) manages the vehicle catalog, including vehicle data, images, and media storage using AWS S3.

Service Overview

Port

8083

Database

PostgreSQL

Storage

AWS S3

Role

Vehicle Catalog

Key Features

Vehicle catalog management (CRUD operations)
Image and media storage with AWS S3
Multipart file upload support (up to 100MB)
Database migration with Flyway
RESTful API with OpenAPI documentation
Internal service authentication
CORS configuration for frontend access

Base Configuration

Server Settings

server:
  port: ${PORT:8083}

JPA Configuration

spring:
  jpa:
    open-in-view: false

Disabling open-in-view enforces explicit transaction boundaries and prevents lazy loading issues.

File Upload Configuration

Multipart Settings

spring:
  servlet:
    multipart:
      max-file-size: 10MB
      max-request-size: 100MB

Upload Limits

max-file-size: 10MB: Individual file size limit
max-request-size: 100MB: Total request size (supports multiple files)
Allows batch upload of vehicle images
Prevents memory exhaustion from large uploads

Ensure your reverse proxy (nginx, gateway) also allows these request sizes, or uploads will fail before reaching the service.

Local Storage Destination

spring:
  destination:
    folder: ./src/main/resources/static/images/vehicles

This local folder is used for temporary storage or development. Production uses S3 exclusively.

AWS S3 Configuration

S3 Settings

aws:
  s3:
    vehicles-bucket: ${AWS_VEHICLES_BUCKET}
    allowed-origins: ${AWS_S3_ALLOWED_ORIGINS:http://localhost:4200,https://localhost:4200}
  access:
    key: ${AWS_ACCESS_KEY}
  secret:
    key: ${AWS_SECRET_KEY}
  region: ${AWS_REGION}

AWS Configuration Details

vehicles-bucket: S3 bucket name for vehicle images
allowed-origins: CORS origins for S3 pre-signed URLs
access.key: AWS access key ID
secret.key: AWS secret access key
region: AWS region (e.g., us-east-1, eu-west-1)

Never commit AWS credentials to source control. Use environment variables or AWS IAM roles (recommended).

S3 Bucket Policy

Your S3 bucket should have:

Public read access for vehicle images (or use pre-signed URLs)
CORS configuration matching allowed-origins
Lifecycle policies for managing old images

Example S3 CORS Configuration

[
  {
    "AllowedHeaders": ["*"],
    "AllowedMethods": ["GET", "PUT", "POST", "DELETE"],
    "AllowedOrigins": [
      "http://localhost:4200",
      "https://your-production-domain.com"
    ],
    "ExposeHeaders": ["ETag"]
  }
]

Database Configuration

Flyway Migration

spring:
  flyway:
    enabled: true
    locations: classpath:db/migration
    baseline-on-migrate: ${FLYWAY_BASELINE_ON_MIGRATE:false}
    baseline-version: 0
    validate-on-migrate: true

Development
Production

spring:
  datasource:
    url: jdbc:postgresql://${DEV_VEHICLE_DB_HOST:host.docker.internal}:${DEV_VEHICLE_DB_PORT:5432}/${DEV_VEHICLE_DB_NAME}
    username: ${DEV_VEHICLE_DB_USERNAME}
    password: ${DEV_VEHICLE_DB_PASSWORD}
    driver-class-name: org.postgresql.Driver
  jpa:
    hibernate:
      ddl-auto: validate
    show-sql: true
    properties:
      hibernate:
        format_sql: true
  flyway:
    baseline-on-migrate: true
    clean-disabled: true

Development enables SQL logging and allows baseline migration.

spring:
  datasource:
    url: jdbc:postgresql://${PROD_VEHICLE_DB_HOST}:${PROD_VEHICLE_DB_PORT}/${PROD_VEHICLE_DB_NAME}
    username: ${PROD_VEHICLE_DB_USERNAME}
    password: ${PROD_VEHICLE_DB_PASSWORD}
    driver-class-name: org.postgresql.Driver
  jpa:
    hibernate:
      ddl-auto: validate
  flyway:
    clean-disabled: true
    baseline-on-migrate: ${FLYWAY_BASELINE_ON_MIGRATE:false}

Production disables SQL logging and prevents Flyway clean.

Service Integration

Eureka Registration

eureka:
  instance:
    instance-id: ${spring.cloud.client.hostname}:${spring.application.name}:${random.value}
  client:
    service-url:
      defaultZone: ${EUREKA_URL:http://sgivu-discovery:8761/eureka}

Service Discovery Map

services:
  map:
    sgivu-auth:
      name: sgivu-auth
      url: ${SGIVU_AUTH_URL:http://sgivu-auth:9000}

Internal Service Authentication

service:
  internal:
    secret-key: "${SERVICE_INTERNAL_SECRET_KEY}"

The Purchase-Sale Service uses this secret to query vehicle data.

Observability

Actuator Endpoints

Development
Production

management:
  endpoints:
    web:
      exposure:
        include: "*"
  endpoint:
    health:
      show-details: always

management:
  endpoints:
    web:
      exposure:
        include: health, info, prometheus
  endpoint:
    health:
      show-details: never

Distributed Tracing

management:
  tracing:
    sampling:
      probability: 0.1
  zipkin:
    tracing:
      endpoint: http://sgivu-zipkin:9411/api/v2/spans

Logging

logging:
  level:
    root: INFO
    software:
      amazon:
        awssdk: info

AWS SDK Logging

The AWS SDK logger is set to info level to:

Show important S3 operations
Avoid verbose DEBUG logs
Maintain visibility into AWS API calls

API Documentation

springdoc:
  swagger-ui:
    url: /docs/vehicle/v3/api-docs
    configUrl: /docs/vehicle/v3/api-docs/swagger-config

Production

openapi:
  server:
    url: ${OPENAPI_SERVER_URL}

Required Environment Variables

All Environments

Variable	Description	Example
`SERVICE_INTERNAL_SECRET_KEY`	Shared secret for internal APIs	`your-secret-key`
`AWS_VEHICLES_BUCKET`	S3 bucket name	`sgivu-vehicles`
`AWS_ACCESS_KEY`	AWS access key ID	`AKIAIOSFODNN7EXAMPLE`
`AWS_SECRET_KEY`	AWS secret access key	`wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY`
`AWS_REGION`	AWS region	`us-east-1`

For production, use AWS IAM roles instead of access keys when running in EC2/ECS.

Development

Variable	Description	Default
`DEV_VEHICLE_DB_HOST`	Database host	`host.docker.internal`
`DEV_VEHICLE_DB_PORT`	Database port	`5432`
`DEV_VEHICLE_DB_NAME`	Database name	Required
`DEV_VEHICLE_DB_USERNAME`	Database username	Required
`DEV_VEHICLE_DB_PASSWORD`	Database password	Required

Production

Variable	Description
`PROD_VEHICLE_DB_HOST`	Database host
`PROD_VEHICLE_DB_PORT`	Database port
`PROD_VEHICLE_DB_NAME`	Database name
`PROD_VEHICLE_DB_USERNAME`	Database username
`PROD_VEHICLE_DB_PASSWORD`	Database password
`OPENAPI_SERVER_URL`	Public API docs URL

Optional

Variable	Description	Default
`PORT`	Service port	`8083`
`EUREKA_URL`	Eureka server URL	`http://sgivu-discovery:8761/eureka`
`AWS_S3_ALLOWED_ORIGINS`	CORS origins	`http://localhost:4200,https://localhost:4200`

API Endpoints

Typical Vehicle Service endpoints:

GET    /api/vehicles              - List vehicles
GET    /api/vehicles/{id}         - Get vehicle by ID
POST   /api/vehicles              - Create vehicle
PUT    /api/vehicles/{id}         - Update vehicle
DELETE /api/vehicles/{id}         - Delete vehicle
POST   /api/vehicles/{id}/images  - Upload images
DELETE /api/vehicles/{id}/images/{imageId} - Delete image

All endpoints require authentication through the gateway.

Vehicle Data Model

Typical vehicle entity includes:

Basic info (make, model, year, VIN)
Specifications (engine, transmission, color)
Pricing and availability
Image URLs (stored in S3)
Created/updated timestamps

S3 Integration Patterns

Upload Flow

Client uploads images via POST /api/vehicles/{id}/images
Service receives multipart file
Service uploads to S3 with unique key
S3 URL stored in database
Response includes image URL

Pre-signed URLs

For secure direct uploads:

// Generate pre-signed URL
GeneratePresignedUrlRequest request = new GeneratePresignedUrlRequest(
    bucketName, objectKey)
    .withMethod(HttpMethod.PUT)
    .withExpiration(expiration);
URL url = s3Client.generatePresignedUrl(request);

Image Deletion

When deleting a vehicle or image:

Delete database record
Delete S3 object
Handle failures gracefully (eventual consistency)

Consider implementing soft deletes and periodic cleanup jobs for orphaned S3 objects.

Security Considerations

S3 Bucket Security

Use least privilege IAM policies
Enable S3 bucket versioning
Configure server-side encryption (SSE-S3 or SSE-KMS)
Enable access logging
Block public access unless necessary

File Upload Security

Validate file types (only allow images)
Scan for malware
Generate unique file names (prevent overwrite)
Limit file sizes

Performance Optimization

S3 Performance

Use CloudFront CDN for image delivery
Implement caching strategies
Compress images before upload
Use S3 Transfer Acceleration for large files

Database Performance

Index search columns (make, model, year)
Use pagination for list endpoints
Cache frequently accessed vehicles

Configuration Files

sgivu-vehicle.yml - Base configuration
sgivu-vehicle-dev.yml - Development overrides
sgivu-vehicle-prod.yml - Production overrides

Purchase-Sale

Retrieves vehicle data

Auth Service

Token validation

Gateway

API routing

Overview

Getting Started

Service Configuration

Environment Management

Operations

​Service Overview

Port

Database

Storage

Role

​Key Features

​Base Configuration

​Server Settings

​JPA Configuration

​File Upload Configuration

​Multipart Settings

​Local Storage Destination

​AWS S3 Configuration

​S3 Settings

​S3 Bucket Policy

​Example S3 CORS Configuration

​Database Configuration

​Flyway Migration

​Service Integration

​Eureka Registration

​Service Discovery Map

​Internal Service Authentication

​Observability

​Actuator Endpoints

​Distributed Tracing

​Logging

​API Documentation

​Required Environment Variables

​All Environments

​Development

​Production

​Optional

​API Endpoints

​Vehicle Data Model

​S3 Integration Patterns

​Upload Flow

​Pre-signed URLs

​Image Deletion

​Security Considerations

​S3 Bucket Security

​File Upload Security

​Performance Optimization

​S3 Performance

​Database Performance

​Configuration Files

​Related Services

Purchase-Sale

Auth Service

Gateway

Build docs developers (and LLMs) love

Service Overview

Key Features

Base Configuration

Server Settings

JPA Configuration

File Upload Configuration

Multipart Settings

Local Storage Destination

AWS S3 Configuration

S3 Settings

S3 Bucket Policy

Example S3 CORS Configuration

Database Configuration

Flyway Migration

Service Integration

Eureka Registration

Service Discovery Map

Internal Service Authentication

Observability

Actuator Endpoints

Distributed Tracing

Logging

API Documentation

Required Environment Variables

All Environments

Development

Production

Optional

API Endpoints

Vehicle Data Model

S3 Integration Patterns

Upload Flow

Pre-signed URLs

Image Deletion

Security Considerations

S3 Bucket Security

File Upload Security

Performance Optimization

S3 Performance

Database Performance

Configuration Files

Related Services