SMALL
  • Spring Cloud Config란
  • 구성도
  • Spring Cloud Config 환경 구축
    • Git Repository 설정
    • Server Side 설정
    • Client Side 설정

 

Spring Cloud Config란

Spring Cloud Config는 분산 시스템에서 설정 정보를 외부로 분리하기 위해서 Server-Client 구조를 제공한다.

Config Server를 이용하여 중앙에서 Application들의 설정을 관리할 수 있다. 

Spring Cloud Config의 Default 서버 설정은 GIT Repository이다. 

다만, 다양한 형태의 관리 체계도 지원한다. ( git, db, file, vault, redis...)

 

Spring Cloud Config가 필요한 이유는

MSA 환경에서 여러 Service들의 설정을 중앙화 하여 통일,

설정 수정에 따른 배포를 최소화,

각 Stage(Dev, Test, Prod..) 단계 별로 설정 값 분리하여 관리하기 위해서이다.

 

 

구성도

 

Git Repository 설정

Git lab, GitHub과 같은 환경을 활용하여 Config를 관리할 git repository를 생성한다.

Git Repository를 생성한 이후에 설정 정보를 입력할 파일을 만든다. 

${ApplicationName}-${EnvironmentName}.yml 과 같은 형태로 만들면 된다.

 

 

Server Side 설정

 

pom.xml ( dependency 설정 )

		<dependency>
			<groupId>org.springframework.cloud</groupId>
			<artifactId>spring-cloud-config-server</artifactId>
		</dependency>

 

application.properties ( spring boot 설정 )

spring.cloud.config.server.git.default-label=master
spring.cloud.config.server.git.uri=https://github.com/USER_INFO/REPO_INFO.git

위와 같이 설정 정보가 존재하는 git의 위치를 설정해 주면 된다.

추가적으로 label이라는 설정은 git에서 사용하는 branch 설정이다.

default값은 master로 되어있다.

만약 자신이 작업하는 git의 branch가 master가 아닌경우 해당 설정을 수정해주어야 한다.

 

Spring Main Application 

@SpringBootApplication
@EnableConfigServer // ADDED!
public class SbaServerApplication {

	private static final Logger log = LoggerFactory.getLogger(SbaServerApplication.class);
	
	public static void main(String[] args) {
		SpringApplication.run(SbaServerApplication.class, args);
	}
}

여기까지 설정하면 Server Side의 설정은 모두 완료되었다.

그럼 여기서 설정이 정확하게 되었는지 확인해보도록 하자.

SpringAppliation을 Run 한 상태에서 아래 명령어를 호출해 보자.

curl -X GET "http://localhost:PORT//APP_NAME/ENV"

ex : curl -X GET "http://localhost:8000/apptest/dev"

 

 

 

 

{
    "name": "apptest",
    "profiles": [
        "dev"
    ],
    "label": null,
    "version": "44fac5ed31dbb04e4ace74f7a34a4763a56fade0",
    "state": null,
    "propertySources": [
        {
            "name": "https://github.com/--/--.git/file:C:\\Users\\TTT\\AppData\\Local\\Temp\\config-repo-3582490668620281315\\apptest-dev.yml",
            "source": {
                "test.user.age": "HeeeLLLeee",
                "test.comm": 123
            }
        }
    ]
}

 

이러한 형태로 응답을 받으면 이제 Server는 Client에게 설정을 줄 준비가 된 것이다.

그럼 다음으로 Client-Side의 환경 세팅을 보도록 하자. 

 

 

 

LIST
SMALL

 

Spring Boot Admin에서 기본적으로 타겟 client의 application.properties 설정값을 조회할 수 있다.

 

 

그럼 다음으로 해당 설정 값을 바꿀 수 있는 방법에 대해서 알아보자.

 

pom.xml ( dependency 설정 )

		<dependency>
			<groupId>org.springframework.cloud</groupId> 
			<artifactId>spring-cloud-context</artifactId>
		</dependency>

 

application.properties ( spring boot 설정 )

management.endpoint.env.post.enabled=true

 

위의 설정들을 추가하면 아래와 같이 해당 화면의 설정할 수 있는 부분이 생기게 된다. 

 

LIST
SMALL

Spring Boot Admin 화면에서 조회되는 Client들의 상태 정보를 추가적으로 조회할 수 있는 것들이 무엇이 있는지 알아보고 어떻게 설정해야 하는지 파악해보자.

크게 아래와 같이 구분할 수 있을것 같다.

  • JMX-Bean 관리
  • Logger ( Log 내용 실시간 조회 )
  • Build Version정보 파악 
  • Tag 정보 추가

이 기능들은 기본적으로 설정한 Spring Boot Admin 화면에서는 조회되지 않고 추가적으로 설정을 해주어야지 조회가 가능하다.

 

JMX-Bean 관리

우선 이 기능이 무엇이지 알아보도록 하자.

JMX ( Java Management eXtension ) 
-> JMX는 실행 중인 애플리케이션의 상태를 모니터링하고, 설정을 변경할 수 있게 해주는 API
-> JDK 1.5부터 포함된 사양

JConsole과 같은 미리 구현된 모니터링 도구를 이용하여 MBean 서버에 접근할 수 있다.

JMX를 통해 리소스 관리를 하려면 MBeans라는 Managed Beans를 생성해야 하고, 

생성한 MBean을 MBean Server에 등록해야 한다. 

MBean 서버는 등록된 MBeans를 관리하는 agent 역할을 수행하게 된다. 

 

이제 JMX가 무엇인지 알았으니 Spring Boot Admin에서 JMX 기능을 사용하는 방법을 알아보자.

 

pom.xml ( dependency 설정 )

		<dependency>
			<groupId>org.jolokia</groupId>
			<artifactId>jolokia-core</artifactId>
		</dependency>

 

application.yml( spring boot 설정 )

spring:
  jmx:
    enabled: true

 

이렇게 설정을 하면 Spring Boot Admin에 JVM 메뉴 하위에 JMX 메뉴가 추가된다.

여기서 추가한 jolokia라는것은 무엇인지 의문이 들었다.

해당 모듈이 무엇인지 찾아본 내역은 아래와 같다.

Jolokia
-> HTTP 프로토콜을 이용해 손쉽게 JMX 값을 JSON 형식으로 받아볼 수 있게 해주는
    일종의 JMX-HTTP 커넥터

위의 JMX를 설명하며 언급한 JConsole이 JMX를 관리하기 위한 툴이었다면, Jolokia는 JMX에서 관리하는 Bean들의 내용을 조회 및 액션을 수행하기 위한 HTTP 호출 툴(?), 커넥터라고 이해하면 될 것 같다.

 

Logger ( Log 내용 실시간 조회 )

기본으로 제공되는 Spring Boot Admin의 Logger기능은 Log Level를 변경하는 것이다.

거기에 추가적으로 로그의 내용들을 조회하고 싶은경우에는 추가적인 application.yml 파일 설정이 필요하다.

 

application.yml( spring boot 설정 )

logging:
  file:
    name: "/var/log/sample-boot-application.log"    
  pattern:
    file: "%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(%5p) %clr(${PID}){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n%wEx"

 

log파일의 위치를 명시적으로 지정해 주어야한다.

( 추가 적으로 log의 패턴도 지정할 수 있다) 

 

 

Build Version정보 파악 

Spring Boot의 빌드 버전 정보는 META-INF/build-info.properties 위치에서 쉽게 파악할 수 있다.

해당 정보를 생성하기 위해서는 추가적인 설정이 필요하다.

 

pom.xml ( dependency 설정 )

<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
            <executions>
                <execution>
                    <goals>
                        <goal>build-info</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

해당 정보를 추가해 주면 Spring Boot Admin 화면에서 실행 중인 Appliation의 빌드 버전 조회가 가능해진다.

 

Tag 정보 추가

Tag 정보는 단순히 해당 Application에 대한 정보를 추가적으로 표시하기 위한 용도이다.

관리하는 Appliation의 종류가 많아지는 경우에는 해당 Tag를 통해 좀 더 쉽게 Application들의 관리가 이루어질 수도 있을 것 같다.

 

application.yml( spring boot 설정 )

spring:
  boot:
    admin:
      client:
        instance:
          metadata:
            tags:
              environment: "tag-test1"
info:
  tags:
    environment: "tag-test1"

 

 

 

 

 

 

 

LIST
SMALL

일반적인 환경에서 Spring Boot Application을 띄우는 경우 이외에,

Kubernetes 환경에 Spring Boot Application을 띄우는 경우에 해당 Application에 대한 정보를 모니터링하고 싶은 경우에 사용하는 방법을 알아보도록 하자.

 

아래와 같은 목차로 설명하도록 하겠다.

  • Kubernetes 환경 리소스 생성
  • SpringBootAppliation 설정 ( Server, Client)
  • Dockerimage 생성
  • Kubernetes ( Deployment, Service ) 생성

 

출처 : https://youtu.be/Ql1Gnz4L_-c?t=1500

Kubernetes 환경 리소스 생성

먼저 Spring Boot Admin의 Server에서 Kubernetes관련 정보를 수집할 수 있는 권한이 필요하다.

이에 해당하는 Role, ServiceAccount, RoleBinding 관련 리소스를 생성해보자.

 

kind: Role
apiVersion: rbac.authorization.k8s.io/v1
metadata:
  namespace: {user_ns}
  name: admin
rules:
  - apiGroups: ["", "extensions", "apps"]
    resources: ["configmaps", "pods", "services", "endpoints", "secrets"]
    verbs: ["get", "list", "watch"]

 

apiVersion: v1
kind: ServiceAccount
metadata:
  name: admin

 

kind: RoleBinding
apiVersion: rbac.authorization.k8s.io/v1
metadata:
  name: admin
  namespace: {user_ns}
subjects:
- kind: ServiceAccount
  name: admin
  apiGroup: ""
roleRef:
  kind: Role
  name: admin
  apiGroup: ""

해당 리소스들의 관계는 Kubernetes 리소스 관련 control을 할 수 있는 Role (권한)이 있고,

해당 권한과 ServiceAccount를 Binding해주는 RoleBinding이 있다.

RoleBinding을 통해서 특정 ServiceAccount는 Kubernetes 리소스를 control 하는 Role을 가지게 된다.

추후에 Kubernetes Deployment를 생성할때 해당 ServiceAccount 정보를 기입하면 해당 Deployment는 Role을 가질 수 있게 된다. 

 

SpringBootAppliation 설정 (Server)

 

pom.xml ( dependency 설정 ) 

		<dependency>
			<groupId>de.codecentric</groupId>
			<artifactId>spring-boot-admin-starter-server</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.cloud</groupId>
			<artifactId>spring-cloud-starter-kubernetes</artifactId>
		</dependency>

 

application.yml( spring boot 설정 )

spring:
  cloud:
    kubernetes:
      discovery:
        service-labels:
          type: spring-boot #해당 label이 붙은 k8s 리소스만의 정보만 조회 가능
  boot:
    admin:
      monitor:
        status-interval: 3s
        status-lifetime: 3s

 

Spring Main Application 

@SpringBootApplication
@EnableAdminServer
@EnableScheduling
@EnableDiscoveryClient // !!
public class SbaK8sServerApplication {

	public static void main(String[] args) {
		SpringApplication.run(SbaK8sServerApplication.class, args);
	}

}

 

SpringBootAppliation 설정 (Client)

 

pom.xml ( dependency 설정 ) 

		<dependency>
			<groupId>de.codecentric</groupId>
			<artifactId>spring-boot-admin-starter-client</artifactId>
		</dependency>

 

application.yml( spring boot 설정 )

server:
  port: 8082

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

 

Dockerimage 생성

Kubernetes에 Pod를 띄우기 위해서는 Dockerimage를 생성하여 Deployment에 해당 정보를 넣어주어야한다.

여기서는 자세하게 다루지 않고, 생성하기 위한 명령어들만 간단하게 공유하도록 하겠다.

 # client
 docker build -t sba-client:v1 ./
 docker push sba-client:v1
 # server
 docker build -t sba-server:v1 ./
 docker push sba-server:v1

 

Kubernetes  Spring Boot Admin Server( Deployment, Service ) 생성

apiVersion: apps/v1
kind: Deployment
metadata:
  namespace: {user_ns}
  name: admin-pod
  labels:
    type: spring-boot
spec:
  replicas: 1
  template:
    metadata:
      labels:
        app: admin
    spec:
      serviceAccountName: admin
      containers:
        - image: {sba-server_image_name}
          name: admin
          env:
            - name: management.endpoints.web.exposure.include
              value: "*"
            - name: management.endpoint.health.show-details
              value: "always"
          ports:
            - containerPort: 8080
          resources: {}
          readinessProbe:
            httpGet:
              path: /actuator/health
              port: 8080
            initialDelaySeconds: 10
            timeoutSeconds: 2
            periodSeconds: 5
            failureThreshold: 5
          livenessProbe:
            httpGet:
              path: /actuator/health
              port: 8080
            initialDelaySeconds: 20
            timeoutSeconds: 2
            periodSeconds: 8
            failureThreshold: 5
      restartPolicy: Always
  selector:
    matchLabels:
      app: admin

 

apiVersion: v1
kind: Service
metadata:
  namespace: {user_ns}
  name: admin-service
  labels:
    type: spring-boot
spec:
  type: NodePort
  ports:
    - name: "http"
      port: 8080
      targetPort: 8080
  selector:
    app: admin

 

Kubernetes Client ( Deployment, Service ) 생성

apiVersion: apps/v1
kind: Deployment
metadata:
  namespace: {user_ns}
  name: {user_pod_name}
  labels:
    type: spring-boot
spec:
  replicas: 1
  template:
    metadata:
      labels:
        app: {user_pod_name}
    spec:
      containers:
        - image: {user_image_name}
          name: {user_pod_name}
          env:
            - name: management.endpoints.web.exposure.include
              value: "*"
            - name: management.endpoint.health.show-details
              value: "always"
          ports:
            - containerPort: 8082
          resources: {}
          readinessProbe:
            httpGet:
              path: /actuator/health
              port: 8082
            initialDelaySeconds: 10
            timeoutSeconds: 2
            periodSeconds: 5
            failureThreshold: 5
          livenessProbe:
            httpGet:
              path: /actuator/health
              port: 8082
            initialDelaySeconds: 20
            timeoutSeconds: 2
            periodSeconds: 8
            failureThreshold: 5
      restartPolicy: Always
  selector:
    matchLabels:
      app: {user_pod_name}

Service에 대한 내용은 Spring Boot Admin Server와 동일하다. ( port 정보만 중복되지 않도록 바꾸어주면 된다)

 

이번 포스팅의 내용을 대략적으로 보면 기본적으로 Kubernetes의 리소스를 사용하기 위한 설정이 대부분이었던 것 같다.

핵심으로는 Kubernetes환경에서 Spring Boot Admin을 사용하기 위해서 해야 하는 Application에 설정해야 하는 부분에 집중하면 될 것 같다. 

(Server에서 Client를 찾을 수 있도록 Applicaiton에 설정을 추가해주는 부분)

LIST

+ Recent posts