jhipster-registry

JHipster Registry / Service Discovery

Configure and manage service discovery using Consul (recommended) for automatic service registration, health checks, and centralized configuration.

When to Use

• When setting up service discovery for new microservices
• When configuring centralized application properties
• When troubleshooting service registration issues
• When setting up Feign clients for inter-service communication
• When configuring health checks

Available Operations

1. Set up Consul with Docker Compose
2. Configure service registration in each microservice
3. Store shared configuration in Consul KV
4. Set up Feign clients with service discovery
5. Monitor service health

Multi-Step Workflow

Step 1: Start Consul with Docker Compose

# docker-compose/consul.yml
consul:
  image: consul:1.15
  ports:
    - "8500:8500"
  command: agent -server -bootstrap -ui -client=0.0.0.0

docker-compose -f docker-compose/consul.yml up -d

# Verify Consul is running
curl http://localhost:8500/v1/status/leader

# Open Consul UI
# http://localhost:8500

Step 2: Configure Service Registration

Add to each microservice's application.yml:

spring:
  cloud:
    consul:
      host: consul
      port: 8500
      discovery:
        service-name: ${spring.application.name}
        health-check-path: /management/health
        health-check-interval: 15s
        instance-id: ${spring.application.name}:${random.value}
      config:
        enabled: true
        format: yaml
        default-context: application

Step 3: Store Shared Configuration in Consul KV

# config/application/data in Consul KV store
spring:
  datasource:
    type: com.zaxxer.hikari.HikariDataSource
    hikari:
      maximum-pool-size: 20

management:
  endpoints:
    web:
      exposure:
        include: health,info,prometheus

# Add config to Consul KV via CLI
consul kv put config/application/data @shared-config.yml

# Or via HTTP API
curl -X PUT -d @shared-config.yml http://localhost:8500/v1/kv/config/application/data