Spring-Cloud-Netflix-Eureka

by S.M Lee

Note:

필수 선행 요소

Monolithic Architecture에 대한 이해

Microservice Architecture에 대한 이해

Docker Container에 대한 이해(Container에 대한 이해, Dockerfile 작성법, Container Network 등)

이 글은 위 선행 요소들에 대한 이해가 충분하다 가정하고 쓰여진 글입니다.

전 세계에서 Microservice Architecture를 가장 잘 운영하는 기업으로 평가받는 Netflix에서는 MSA구축을 편하게 할 많은 기술과 다양한 이슈에 대한 해결책을 제공한다. 특히 Netflix OSS(Open Source Software)를 공개하고 있다. 여기에는 MSA를 구성하는데 필수적으로 고려해야 할 다양한 Component들이 포함되어 있다.

Spring Cloud는 분산시스템(ex. Microservice Architecture)을 구축할 때 공통적으로 발생하는 대표적인 문제에 대한 솔루션을 제공한다. 그리고 Spring Cloud에서는 위에서 설명한 Netflix OSS를 사용할 수 있도록 Spring Cloud Netflix를 제공하고 있다.

결론적으로 MSA구축에 필요한 라이브러리 집합인 Netflix OSS를 Spring Cloud 프로젝트에서 사용할 수 있다.

MSA와 관련 된 Netflix OSS Component

Eureka - Service Discovery & Registry

Hystrix-Circuit Breaker

Zuul-API Gateway

Ribbon-Client Side Loadbalancer

대표적인 4가지 Component중 여기서는 Eureka에 대해 알아보고 이를 docker image로 생성한다.

Netflix Eureka - Service Discovery & Registry

Eureka란 말 그대로 Service Discovery & Registry이다. Microservice Architecture에서는 기존의 Legacy한 Monolithic Architecture와는 달리 작은 Service 단위로 시스템을 구축 한다.
Service 단위로 시스템이 구축되다 보니 MSA에서는 이 Service들은 어떠한 Registry에 등록하고, 이 Registry를 기반으로 다른 서비스를 찾는 Service Discovery & Registry라는 개념이 필요하다.
Netflix에서는 Eureka라는 Service Discovery & Registry를 제공하고 있고, 우리는 잘 파악해서 사용하면 된다.

그래서 Eureka는 어떻게 이루어져 있을까?

Eureka는 크게 Eureka Server와 Eureka Client로 나뉘어 진다. Microsericie Architecture 시스템에서의 모든 service들은 Eureka Client로 만들어지게 된다. 그리고 Eureka Client(각 service)들은 자신을 Eureka Server(Registry)에 등록한다. Eureka Client는 자신을 Eureka Server에 등록하고 hostname, ip address, port 등 자신의 meta data를 Eureka Server(Registry)에 전송한다.

이 meta data는 Eureka Server(Registry)에 저장되는 것이다. 그리고 등록된 Eureka Client는 이 Registry에 저장된 다른 Eureka Client의 정보를 사용할 수 있다. 이 부분은 아마 계속 진행하다보면 이해가 될 것이다.

그리고 Eureka Server는 각 Client로 부터 30초마다(default) heartbeat(Eureka Client가 살아있음을 알리는)를 수신하게 된다. Client로 부터 heartbeat가 오지 않으면 Eureka Server는 Client가 죽은 것으로 판단하고 Registry에서 제거하게 된다. 또한 Eureka Server는 모든 Client에게 Registry의 정보를 전달해주고, Client는 자신의 localStorage에 정보를 저장한다.

정리해보자면 각 Eureka Client가 자신의 정보를 Eureka Server에 보내고, Eureka Server는 각 Eureka Client에게 업데이트 된 정보를 전달해주는 체계를 가지는 것이다.

이는 다수의 서비스가 지속적으로가능하게 하며, 각 Eureka Client는 Eureka Server로 부터 받은정보를 일정 시간동안 보유하고 있어 다른 서비스의 연결에 문제가 되지 않는다.

여기서는 Eureka란 무엇인지, 어떻게 구성되어있는지, 그리고 Eureka의 개념에 대해 간단하게 설명했지만, Eureka의 활용도는 무궁무진하며 Service Discovery & Registry란 개념은 다음 장에서 설명하게 될 Netflix의 다른 component인 Hystrix, Ribbon, Zuul과 결합되어 질 때 활용도가 매우 높아진다.

그러나 이 부분을 지금 다루기엔 무리가 있으므로 차차 설명 하겠다..

이제 Eureka Server를 구축해보자

Spring Cloud Neflix Eureka - Server

Development and Testing Environment

Cent OS 7.4, Linux Mint 18.3 Sylvia

Jdk 1.8.0_171

apache-maven 3.5.2

Eureka Server는 Spring Boot Application으로 구축된다. Eclipse에 STS를 설치하여 Spring Boot 개발 환경을 세팅해도 되고, Maven Project 혹은 Gradle project를 생성해도 무방하며 자신의 입맛에 맛는 방법을 선택하여 구축하면 된다.

Building an Application with Spring Boot => https://spring.io/guides/gs/spring-boot/
Spring Boot with Docker => https://spring.io/guides/gs/spring-boot-docker/

구글링을 하다보면 Spring Cloud Netflix의 여러 component에 대한 dependency를 찾을 수 있다. 그러나 전부 제 각각이고, spring boot나 spring cloud dependencies version에 따라 dependency를 찾지 못할 수도 있다. Maven Repository에서 사용가능한 version을 찾아서 사용해도 되긴 하나, spring-boot-starter-parent를 상속받아 사용하면 spring boot의 dependency 관리 지원을 받을 수 있다.

후에 spring cloud netflix component들의 dependency 설정시 어떠한 자료에서는 spring-cloud-starter-~ (ex. spring-cloud-starter-eureka-server)라는 dependency를 사용하고 또 다른 자료에서는 spring-cloud-starter-netflix-~ (ex. spring-cloud-starter-netflix-eureka-server)를 사용할 것이다. 이 둘에 대한 차이는 없으나, spring-cloud-starter-netflix~ 를 사용하기를 권장한다.

자세한 명세는 Spring Cloud Edgware Release Notes => https://github.com/spring-projects/spring-cloud/wiki/Spring-Cloud-Edgware-Release-Notes 에서 확인하면 된다.

version

우리가 Eureka Server 구축에 사용할 version은 다음과 같다.

spring-boot-starter-parent - 2.0.1.RELEASE
spring-cloud-dependencies -> Finchley.M9 (https://spring.io/blog/2018/03/23/spring-cloud-finchley-m9-has-been-released)
java - 1.8
dockerfile-maven-plugin -> 1.3.6 (4번은 mvn dockerfile:build 명령어를 통해 docker container image를 생성할 수 있는 plugin이다. 이것을 사용해도 되고 뒤에서 나올 다른 방법을 사용해도 된다.)

directory tree

우리가 진행하게 될 디렉토리 구조를 살펴보면 이러한 형태를 취할 것이다. 나아가면서 참고하면 된다.

.
├── Dockerfile
├── mvnw
├── mvnw.cmd
├── pom.xml
├── src/main/java/com/example/demo
|        |                      └── EurekaServerApplication.java
|        |
│        └── resources
│           ├── application.yml
│           └── bootstrap.yml
└── target
      ├── classes
      ├── eureka-server-0.1.0.jar
      ├── eureka-server-0.1.0.jar.original
      ├── generated-sources ...

이제 Eureka Server를 구축해보자.

1. Dependency

Eureka Server를 구축하기 위해 pom.xml에 다음을 추가하자

pom.xml

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.1.RELEASE</version>
        <!-- spring-boot-starter-parent 2.0.1.RELEASE -->
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
                <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
                <java.version>1.8</java.version>
        <docker.image.prefix>phantasmicmeans</docker.image.prefix>
        <!-- docker image 생성시 dockerhub에 image를 push 하기 위해 자신의 dockerhub id를 입력한다 -->
    </properties>

    <dependencyManagement>
        <dependencies>
                <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>Finchley.M9</version> <!--spring-cloud-dependencies version -->
                <type>pom</type>
                <scope>import</scope>
                </dependency>
        </dependencies>
    </dependencyManagement>

    <dependencies>
        <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
        </dependency>
        <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <!-- Add Unit Tests -->
                <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>

            <plugin>
                <groupId>com.spotify</groupId>
                <artifactId>dockerfile-maven-plugin</artifactId>
                <version>1.3.6</version>
                <configuration>
                    <repository>${docker.image.prefix}/${project.artifactId}</repository>
                    <!-- 후에 mvn으로 docker image 생성시 {docker.image.prefix}/{project.artifactId}라는 이름을 가진 image가 생성될 것이다. -->
                <buildArgs>
                        <JAR_FILE>target/${project.build.finalName}.jar</JAR_FILE>
                    <!--- mvn build시킨 jar파일을 docker image로 빌드 -->
                </buildArgs>
                </configuration>
            </plugin>
        </plugins>
    </build>

    <repositories>
                <repository>
                        <id>spring-milestones</id>
                        <name>Spring Milestones</name>
                        <url>https://repo.spring.io/milestone</url>
                        <snapshots>
                                <enabled>false</enabled>
                        </snapshots>
                </repository>
        </repositories>

2. configuration

Spring Boot에서는 SnakeYAML을 포함하고 있기에 외부파일은 YAML로 작성하여 쉽게 로드 가능하다. 따라서 cofiguring을 야믈파일로 설정해도 되고, 기존 properties 파일을 사용해도 무방하다. 그리고 bootstrap.yml 파일은 spring cloud application에서 application.yml 파일보다 먼저 실행된다. 따라서 상황에 맞게 사용하면 된다. 이제 아래처럼 각 yml파일을 세팅하자.

application.yml

server:
    port: 8761

eureka:
  client:
    registerWithEureka: false
    fetchRegistry: false
    server:
        waitTimeInMsWhenSyncEmpty: 0
        ## Set this only for this sample service without which starting the instance will by default wait for the default of 5 mins

Eureka Server를 standalone하게 활용하는 방법이다. 이 외에도 상세한 설명은 다음을 참고하자. (https://cloud.spring.io/spring-cloud-netflix/single/spring-cloud-netflix.html#spring-cloud-eureka-server-standalone-mode)

bootstrap.yml

spring:
    application:
        name: eureka-server

위처럼 application 이름을 지정한다. 추후에 Eureka Client가 Eureka Server에 자신을 등록할 때 application.name으로 등록된다.

참고

야믈파일 사용시 한가지 주의할 점은 "TAB" 이다.. indent가 제대로 들어가 있지 않으면 적용되지 않는경우도 있다. indent 덕분에 꽤 오랜시간 삽질한 경험이 있다..

추후에 Eureka Client가 Eureka에 등록될 때 eurek.client.hostname으로 등록된다. 그래서 때때로 ipAddress를 써야하는 경우도 생긴다. 이것은 Eureka Client 구축 단계에서 다시 설명할 것이니 알아두면 된다.

3. EurekaServerApplication.java

EurekaServerApplication.java

@SpringBootApplication
@EnableEurekaServer
public class EurekaServerApplication {
     public static void main(String[] args) {
           SpringApplication.run(EurekaServerApplication.class, args);
     }
}

@SpringBootApplication, @EnableEurekaServer annotation만 추가하면 된다.

4. Maven Packaging

Host OS에 설치된 maven을 이용해도 되고, spring boot application의 maven wrapper를 사용해도 된다 (maven wrapper는 Linux, OSX, Windows, Solaris 등 서로 다른 OS에서도 동작한다. 따라서 추후에 여러 서비스들을 Jenkins에서 build 할 때 각 서비스들의 Maven version을 맞출 필요가 없다.)

A Quick Guide to Maven Wrapper => http://www.baeldung.com/maven-wrapper)

a. Host OS의 maven 이용

[sangmin@Mint-SM] ~/Eureka-server $ mvn package

b. maven wrapper 이용

[sangmin@Mint-SM] ~/Eureka-server $ ./mvnw package

(IDE를 통해 구축한 Spring boot application을 Linux Server에 올리고 진행시에는, maven wrapper를 실행 가능하게 만들어야 한다. chmod +x mvnw)

이 과정이 잘 마무리 되었다면 ProjectFolder의 target directory 하위에 {your_application_name}.jar 파일이 생성되었을 것이다.

5. Execute Spring Boot Application

Eureka Server가 제대로 실행되는지 확인하여 보자.

jar 파일 실행

[sangmin@Mint-SM] ~/Eureka-server $java -jar target/{your_application_name}.jar

6. Check your Eureka Dashboard

http://localhost:8761

7. Dockerizing

구축한 Eureka Server(Spring boot application) docker image화 하자. 앞서 설명했듯이 dockerfile-maven-plugin으로 dockerfile을 build 해도 되고, docker build Command를 통해 image를 생성해도 된다. 이에 앞서 먼저 Dockerfile을 작성한다.

Dockerfile

FROM openjdk:8-jdk-alpine
VOLUME /tmp

#ARG JAR_FILE
#ADD ${JAR_FILE} app.jar 
#dockerfile-maven-plugin으로 docker image를 생성하려면 아래 ADD ~를 주석처리하고, 위 2줄의 주석을 지우면 된다.
ADD ./target/eureka-server-0.1.0.jar app.jar 
ENTRYPOINT ["java","-Djava.security.egd=file:/dev/./urandom","-jar","/app.jar"]

Dockerfile 작성이 끝났다면 image를 build하자

a. dockerfile-maven-plugin 사용시

[sangmin@Mint-SM] ~/Eureka-server $ ./mvnw dockerfile:build

b. docker CLI 사용시

[sangmin@Mint-SM] ~/Eureka-server $ docker build -t {your_docker_id}/eureka-server:latest .

이후 docker image가 잘 생성 되었음을 확인하자.

[sangmin@Mint-SM] ~/Eureka-server $ docker images
REPOSITORY                      TAG                 IMAGE ID            CREATED             SIZE
phantasmicmeans/eureka-server   latest              4b79d6a1ed24        2 weeks ago         146MB
openjdk                         8-jdk-alpine        224765a6bdbe        5 months ago        102MB

8. Run Docker Container

Docker image를 생성하였으므로 이미지를 실행 시켜보자.

[sangmin@Mint-SM] ~ $ docker run -it -p 8761:8761 phantasmicmeans/eureka-server:latest

문제없이 Eureka Server가 실행되면 다시 Eureka Dashboard를 확인하자.

Conclusion

지금까지 Eureka Server에 대한 간단한 이해와, 구축, Docker image화 까지 진행해 보았다. 다음장에선 간단한 REST API Server(Spring boot Application, Node.JS)로 구축된 3가지 Microservice를 Eureka Client로 만들어 Eureka Server에 등록해 볼 것이다.

각 Service는 위 사진 처럼 Story Service, Notice Service, BBS(Bulletin Board System) Service로 이루어 질 것이고, Story Service와 Notice Service는 Spring boot, BBS Service는 Node.JS로 구축한다.

Spring boot Microservice(REST API Server) => https://github.com/phantasmicmeans/Spring-Boot-Microservice-with-Spring-Cloud-Netflix
Node.JS Microservice(REST API Server) => https://github.com/phantasmicmeans/nodejs_API_tutorial1

References

Spring Cloud Netflix Eureka => https://cloud.spring.io/spring-cloud-netflix/single/spring-cloud-netflix.html#spring-cloud-eureka-server
Spring Cloud Samples => https://github.com/spring-cloud-samples/eureka
Spring Cloud dependencies Finchely.M9 => https://spring.io/blog/2018/03/23/spring-cloud-finchley-m9-has-been-released
Spring Cloud Netflix => https://cloud.spring.io/spring-cloud-netflix/single/spring-cloud-netflix.html
Spring Cloud Samples => https://github.com/spring-cloud-samples/eureka
Spring Cloud Edgware Release Notes => https://github.com/spring-projects/spring-cloud/wiki/Spring-Cloud-Edgware-Release-Notes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

src

src

target

target

Dockerbuild.sh

Dockerbuild.sh

Dockerfile

Dockerfile

README.md

README.md

mvnw

mvnw

mvnw.cmd

mvnw.cmd

pom.xml

pom.xml

Repository files navigation

Spring-Cloud-Netflix-Eureka

Netflix Eureka - Service Discovery & Registry

Spring Cloud Neflix Eureka - Server

version

directory tree

1. Dependency

2. configuration

3. EurekaServerApplication.java

4. Maven Packaging

5. Execute Spring Boot Application

6. Check your Eureka Dashboard

7. Dockerizing

8. Run Docker Container

Conclusion

References

About

Releases

Packages

Languages

Name		Name	Last commit message	Last commit date
Latest commit History 46 Commits
src		src
target		target
Dockerbuild.sh		Dockerbuild.sh
Dockerfile		Dockerfile
README.md		README.md
mvnw		mvnw
mvnw.cmd		mvnw.cmd
pom.xml		pom.xml

phantasmicmeans/spring-cloud-netflix-eureka-tutorial

Folders and files

Latest commit

History

Repository files navigation

Spring-Cloud-Netflix-Eureka

Netflix Eureka - Service Discovery & Registry

Spring Cloud Neflix Eureka - Server

version

directory tree

1. Dependency

2. configuration

3. EurekaServerApplication.java

4. Maven Packaging

5. Execute Spring Boot Application

6. Check your Eureka Dashboard

7. Dockerizing

8. Run Docker Container

Conclusion

References

About

Topics

Resources

Stars

Watchers

Forks

Languages