amideb / eureka-spring-cloud-k8s-microservices-deployment Goto Github PK

Deploying Eureka Service Discovery and API Gateway in Kubernetes can be tricky because Eureka's service discovery mechanism isn't natively designed for Kubernetes' DNS-based service discovery. However, you can still make it work by configuring Eureka and your services appropriately.

Here’s a step-by-step guide to deploy Eureka Service Discovery and an API Gateway in Kubernetes:

1. Create Eureka Server Docker Image: Create a Dockerfile for your Eureka server application:

   FROM openjdk:8-jdk-alpine
   VOLUME /tmp
   ADD target/eureka-server.jar eureka-server.jar
   ENTRYPOINT ["java","-jar","/eureka-server.jar"]

2. Build and Push the Docker Image:

   docker build -t your-docker-repo/eureka-server .
   docker push your-docker-repo/eureka-server

3. Create Kubernetes Deployment and Service for Eureka Server:

   apiVersion: apps/v1
   kind: Deployment
   metadata:
     name: eureka-server
   spec:
     replicas: 1
     selector:
       matchLabels:
         app: eureka-server
     template:
       metadata:
         labels:
           app: eureka-server
       spec:
         containers:
         - name: eureka-server
           image: your-docker-repo/eureka-server
           ports:
           - containerPort: 8761
   ---
   apiVersion: v1
   kind: Service
   metadata:
     name: eureka-server
   spec:
     ports:
     - port: 8761
       targetPort: 8761
     selector:
       app: eureka-server

1. Configure Eureka Client: In your application.yml or application.properties of the client services, configure Eureka to use the Kubernetes service name for the Eureka server:

   eureka:
     client:
       serviceUrl:
         defaultZone: http://eureka-server:8761/eureka/
     instance:
       preferIpAddress: true
       leaseRenewalIntervalInSeconds: 5
       leaseExpirationDurationInSeconds: 10
       instanceId: ${spring.cloud.client.hostname}:${spring.application.name}:${spring.application.instance_id:${random.value}}

2. Create Docker Images for Your Services: Create Dockerfiles, build, and push Docker images for your API Gateway and other microservices similarly to how you did for the Eureka server.

3. Create Kubernetes Deployments and Services for Client Services: Example for an API Gateway:

   apiVersion: apps/v1
   kind: Deployment
   metadata:
     name: api-gateway
   spec:
     replicas: 1
     selector:
       matchLabels:
         app: api-gateway
     template:
       metadata:
         labels:
           app: api-gateway
       spec:
         containers:
         - name: api-gateway
           image: your-docker-repo/api-gateway
           ports:
           - containerPort: 8080
   ---
   apiVersion: v1
   kind: Service
   metadata:
     name: api-gateway
   spec:
     ports:
     - port: 8080
       targetPort: 8080
     selector:
       app: api-gateway

1. Health Checks: Ensure that your services have appropriate health checks so that Eureka considers them as healthy and available.

2. Network Policies and DNS Resolution: Ensure that your Kubernetes cluster is configured correctly to allow inter-service communication. You can use tools like kubectl exec to test DNS resolution within your cluster.

1. Logs: Check the logs of your services to ensure they are registering with Eureka successfully.

   kubectl logs -f deployment/eureka-server
   kubectl logs -f deployment/api-gateway

2. Eureka Dashboard: Access the Eureka dashboard to see registered services. If it’s not showing expected services, check your configurations and service logs for any errors.

   kubectl port-forward service/eureka-server 8761:8761

   Access the dashboard at http://localhost:8761.

By following these steps, you should be able to deploy Eureka Service Discovery and an API Gateway in a Kubernetes environment successfully.