[MSA 구축하기] 4. Eureka 클라이언트에 랜덤 포트 할당하기 (Service Discovery)

🔊 우리는 Spring Cloud를 활용하여 MSA를 구축한다.

 

Service Discovery 파트 3

 

Service Discovery의 역할을 간략하게 정리하자면,

Service Discovery란?

• 마이크로서비스의 정보(위치 등)를 등록할 수 있다.
• 외부의 요청이나 서비스가 마이크로서비스의 정보를 검색하기 위해 사용된다.

Spring Cloud에서는 Spring Cloud Netflix Eureka가 Service Discovery의 역할을 수행한다. Eureka는 Eureka Server와 Eureka Client로 구성된다.

 

Eureka 클라이언트란?

MSA를 구성하는 요소들 중 Eureka 서버에서 모니터링 및 관리를 원하는 요소를 Eureka 클라이언트 설정을 진행해서 등록할 수 있다.

 

 

🔊 이번에는, 로드밸런싱을 사용하기 위해 Eureka Client에게 랜덤 포트를 부여할 것이다.

 

❓ Service Discovery의 Eureka Client를 구축하기 위해 구글 검색을 통해 많은 블로그의 자료를 찾아봤다. 포트번호를 랜덤 포트로 설정하는 블로그 글들이 많이 있었는데 그 이유에 대해서는 명확하지 않았다. 이유를 모르고 그대로 적용할 수는 없기 때문에 왜 랜덤포트를 적용하여 구현했는지 그 이유에 대해 더 파헤쳤다. 그 결과, 로드밸런싱을 사용하기 위해 랜덤포트를 설정한다는 것을 알 수 있었다.

---

⭐ 각 애플리케이션에 랜덤 포트를 부여하는 이유?

랜덤포트의 사용 여부는 마이크로서비스가 독립적으로 사용되는지, LB(로드밸랜서)로 구성되어 사용되는지, 사용 시 문제가 되었을 때 복귀해야 하는 구조는 어떻게 되어 있는지 등에 따라 결정할 수 있다.

 

이 프로젝트에서 랜덤포트(port: 0)에 대한 설정은 LB사용을 보이기 위함이고, 포트를 고정(port: 8081)으로 설정한 상태에서 진행해도 문제는 없다.

다만, Service Discovery에서 등록된 서비스들이 포트 간의 충돌이 발생할 경우, 해당 서비스를 우회할 수 있는 포트를 지정하여 새롭게 실행하지 않고, 충돌이 발생한 서비스는 중지시켜 버리게 된다. 포트를 잘 구분하여 서비스들을 배포한다고 했을 때는 문제가 없을 수도 있다.

그런데, 서비스에서 LB를 사용하도록 되어 있다면, LB에 연결되는 다수의 동일 서비스들은 같은 형태(코드)로 작성된 애플리케이션인데, 매번 실행할 때마다 포트를 변경하는 작업을 하기에는 번거로울 수 있다. 이때 랜덤포트로 실행하며 임의의 사용가능한 포트가 할당되고, Service Discovery에 등록될 때는 서비스명으로 사용되기 때문에, 여러 개의 서비스가 연결되어 있어도 하나의 서비스명이 요청을 받아 해당 서비스들에 요청처리를 배분해 줄 수 있게 된다.

 

실제로 MSA 형태로 구성된 애플리케이션들은 컨테이너 가상화 형태로 운영되는 경우가 대부분인데, Docker나 Kubernetes에서 컨테이너를 기동 할 때는 외부와 연결되기 위한 포트를 랜덤포트로 설정(범위는 지정할 수 있습니다)되어 사용된다. 컨테이너 자체는 독립적인 IP를 가지고 있는 VM이라고 보시면 되고, 이 안에서 사용되는 포트는 어떠한 포트로 지정되어 있더라도 상관없이, 컨테이너 외부하고의 연결만 잘 되어 서비스되는 구조라고 이해하면 좋을 것 같다.

 

---

Eureka 클라이언트 랜덤 포트 지정하기

존재하는 마이크로서비스 모두에게 동일하게 설정한다.

1. user-service
2. baverage-service
3. community-service

 

일반적인 환경에서는 지정된 PORT를 사용하여 애플리케이션을 운영한다. 그러나 MSA와 같이 LB 환경을 위해 여러 서비스를 등록하거나 자동으로 서비스가 증가되어야 하는 상황에서는 random port를 이용한다. 동일한 서비스를 여러 개 실행하는 경우라면, 관리자가 매번 PORT 번호를 지정하는 것도 한계가 존재하기 때문이다.

 

 

아래의 실습을 통해 확인해 보자.

 

만약, user-service 인스턴스를 여러 개 띄운다면 아래와 같 매번 포트번호를 바꾸고 실행하기 불편하다.

 

4. Eureka 클라이언트에 랜덤 포트 할당

 yml 파일에서 port번호를 0번으로 설정하면 같은 서비스가 실행될 때마다 랜덤으로 포트 번호가 할당된다.

# application.yml

# 포트번호를 0으로 두면 포트번호가 매번 랜덤으로 할당된다.
server:
    port: 0

 

server port 설정을 랜덤 포트로 지정해 주면 실행할 때마다 spring boot가 50,000 이상인 랜덤 한 port 번호를 할당해 준다.

---

Spring Cloud Eureka 서버  실행

Status에 포트번호가 0으로 보이지만, 마우스로 이 주소에 커서를 올려놓으면 왼쪽 하단에

http://desktop-4v4j52s:51873/actuator/info  즉, 51873 포트가 랜덤으로 할당된 것을 볼 수 있다.

 

그러나, 위와 같이 설정할 경우 eureka 서버의 인스턴스 이름은 0으로 고정되어 서버를 여러 개 띄우더라도  ESKTOP-4V4J52S:user-service:0 로 인스턴스가 한 개만 등록되게 된다.

 

 

포트번호가 0인 user-service를 3개 띄웠지만  eureka 서버에는 1개로 나온다.

즉, 동일한 service application이 여러 개 실행될 때 yml에서 설정한 port인 0으로 인식이 되기 때문에 각각의 서비스를 구분하기 어렵다. 따라서, 인스턴스 id 값을 재정의 해야 한다.

---

5. 인스턴스 ID 값  재정의

random port 지정 시 서비스를 구분하기 위해 각각의 서비스를 instance-id로 구분한다.

eureka 클라이언트들의 instance-id 값을 랜덤으로 부여한다.

# application.yml

# eureka 설정
eureka:
  instance:
    # 여러 개의 프로젝트를 실행할 때 유레카 서버에서 각각의 인스턴스를 식별하기 위해 설정
    # 'random.value를 활용하여 랜덤 값을 생성해 각 인스턴스를 고유하게 식별
    instance-id: ${spring.cloud.client.hostname}:${spring.application.instance_id:${random.value}}

• eureka: instance: instance-id:
  • 프로젝트를 eureka 서버에 등록하고 유레카 서버로 접속해 보면 위와 같이 등록된 서비스를 확인할 수 있다.
  • 하지만, 같은 프로젝트를 여러 개 띄우게 되면 포트번호가 같기 때문에 여러 개 띄워지더라도 eureka 서버에 1개만 표시되는 현상이 발생한다.
  • 따라서, 실행되는 프로젝트마다 구분해 주기 위해 표기되는 instance-id 값을 변경해서 적용해 주는 설정이다.
• ${spring.cloud.client.hostname}
  • 호스트 이름 (ip 표시)
• ${spring.application.instance_id:${random.value}}
  • 인스턴스 id 값을 랜덤으로 설정

---

6. 현재까지 최종 application.yml 파일

# application.yml

# 현재 프로젝트 랜덤 포트로 지정
server:
  port: 0

# 현재 프로젝트 이름 지정
spring:
  application:
    name: user-service

# eureka 설정
eureka:
  client:
    # eureka 등록 여부
    register-with-eureka: true
    # eureka 서버로 부터 인스턴스들의 정보를 가져올 것인지 설정하는 속성
    fetch-registry: true
    # eureka 서버 주소에 마이크로서비스 정보 등록
    service-url:
      defaultZone: http://admin:1234mst@localhost:8761/eureka
  instance:
    # 여러 개의 프로젝트를 실행할 때 유레카 서버에서 각각의 인스턴스를 식별하기 위해 설정
    # 'random.value를 활용하여 랜덤 값을 생성해 각 인스턴스를 고유하게 식별
    instance-id: ${spring.cloud.client.hostname}:${spring.application.instance_id:${random.value}}

 

반응형

---

Spring Cloud Eureka 서버  실행

instance-id를 랜덤으로 부여하면 Eureka server에서 설정한 instance-id로 인스턴스가 각각 보이게 된다.

3개의 user-service를 실행시키면 각각 instance-id 가 랜덤으로 생성되어 Eureka server에서 정상작동한다.

user-service 3개 실행

 

 

---

참고 자료

https://www.inflearn.com/questions/193571/instance-id-%EB%8C%80%EC%8B%A0-port%EB%A5%BC-%EB%B3%B4%EC%97%AC%EC%A3%BC%EB%8A%94-%EB%B0%A9%EB%B2%95%EC%9D%80-%EC%97%86%EC%9D%84%EA%B9%8C%EC%9A%94

https://www.inflearn.com/questions/681124/%EA%B0%81-%EC%95%A0%ED%94%8C%EB%A6%AC%EC%BC%80%EC%9D%B4%EC%85%98%EC%97%90-%EB%9E%9C%EB%8D%A4%ED%8F%AC%ED%8A%B8%EB%A5%BC-%EB%B6%80%EC%97%AC%ED%95%98%EB%8A%94-%EC%9D%B4%EC%9C%A0

https://yarisong.tistory.com/42

https://m.blog.naver.com/qjawnswkd/222307979571

https://velog.io/@boo105/MSA-EUREKA-%EA%B5%AC%EC%B6%95%ED%95%98%EA%B8%B0

https://devhan.tistory.com/m/260

https://substantial-park-a17.notion.site/6-Eureka-057c942a7a4041bf87ab5cd3043af021