Post

Kubernetes에 MongoDB 배포하기

Posted Updated
Preview Image
By KKamJi
views 7 min read
Kubernetes에 MongoDB 배포하기

MongoDB는 현대 애플리케이션에서 중요한 역할을 하는 NoSQL 데이터베이스로, 다양한 형태의 데이터와 복잡한 구조를 유연하게 처리할 수 있는 장점을 제공합니다. 관계형 데이터베이스와 비교했을 때 MongoDB는 문서 지향(Document-Oriented) 모델을 채택하여 데이터 스키마를 자유롭게 설계할 수 있습니다. 이를 통해 불규칙하거나 복잡한 데이터 구조를 다룰 때 유리합니다.

사이드 프로젝트로 영어 단어장 애플리케이션을 만들면서 어떤 데이터베이스가 가장 적합할지 고민한 끝에 MongoDB를 채택했습니다. 하나의 단어에 여러 뜻이 존재하면 관계형 데이터베이스에서는 복잡한 테이블 설계나 조인(join) 연산이 필요하지만 MongoDB는 단일 문서에 배열 형태로 다양한 뜻을 저장해 구조를 단순화할 수 있기 때문입니다. 이번 포스트에서는 Kubernetes 환경에 MongoDB를 구축하고 배포하는 과정을 공유합니다.

MongoDB를 사용하는 대표적인 방법에는 MongoDB Atlas, MongoDB Enterprise, MongoDB Community Edition이 있습니다. 이번 과정에서는 MongoDB Community Edition을 Helm으로 배포합니다.

1. 구성 환경

  • Helm: v3.16.2
  • Kubernetes: v1.29.6
  • StorageClass: rancher/local-path-provisioner

2. Helm Repository 추가

1
2
3
4
5
6

❯ helm repo add mongodb https://mongodb.github.io/helm-charts
"mongodb" has been added to your repositories
❯ helm repo update                                           
Hang tight while we grab the latest from your chart repositories...
...Successfully got an update from the "mongodb" chart repository
Update Complete. ⎈Happy Helming!⎈

3. Helm을 사용해 MongoDB Operator 배포

mongodb라는 namespace에 MongoDB Operator를 배포하도록 하겠습니다.

1
2
3
4
5
6
7
8

❯ helm install community-operator mongodb/community-operator --namespace mongodb --create-namespace

NAME: community-operator
LAST DEPLOYED: Tue Nov 12 15:08:45 2024
NAMESPACE: mongodb
STATUS: deployed
REVISION: 1
TEST SUITE: None

4. MongoDB Operator 확인

1
2
3
4
5
6
7
8
9
10
11

❯ kubens mongodb   
✔ Active namespace is "mongodb"
❯ k get all            
NAME                                               READY   STATUS    RESTARTS   AGE
pod/mongodb-kubernetes-operator-6d7f45687c-48222   1/1     Running   0          3m49s

NAME                                          READY   UP-TO-DATE   AVAILABLE   AGE
deployment.apps/mongodb-kubernetes-operator   1/1     1            1           3m50s

NAME                                                     DESIRED   CURRENT   READY   AGE
replicaset.apps/mongodb-kubernetes-operator-6d7f45687c   1         1         1       3m50s

5. MongoDB Custom Resource (CR) 정의 파일 생성

MongoDB Operator로 MongoDB 인스턴스를 배포하려면 Custom Resource(CR)를 정의해 MongoDB 클러스터를 생성해야 합니다.
storageClassName에는 현재 사용 중인 StorageClass를 지정합니다. (예: gp2, gp3, local-path)
예제에서는 MongoDB 8.0을 설치합니다.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

# mongodb-custom-resource.yaml
apiVersion: mongodbcommunity.mongodb.com/v1
kind: MongoDBCommunity
metadata:
  name: mongodb
  namespace: mongodb
spec:
  members: 3
  type: ReplicaSet
  version: "8.0.0" # MongoDB 버전
  security:
    authentication:
      modes: ["SCRAM"] #SCRAM(Salted Challenge Response Authentication Mechanism) 인증을 사용하도록 설정
  users:
    - name: my-user # 사용자의 이름
      db: admin # 사용자가 인증할 데이터베이스
      passwordSecretRef: # 사용자의 Password를 지정하기 위한 Secret 지정
        name: mongodb-user-password
      roles: # 사용자에게 부여할 권한
        - name: clusterAdmin
          db: admin
        - name: userAdminAnyDatabase
          db: admin
      scramCredentialsSecretName: my-scram # SCRAM 인증을 위한 자격 증명 시크릿의 이름
  ## StatefulSet의 Spec Override => 본인의 Storage Class 명을 지정하거나 pvc에 맞는 pv를 직접 생성
  statefulSet:
    spec:
      volumeClaimTemplates:
        - metadata:
            name: data-volume
          spec:
            accessModes: ["ReadWriteOnce"]
            storageClassName: "local-path"  # 여기서 storageClassName을 지정합니다.
            resources:
              requests:
                storage: 10Gi
        - metadata:
            name: logs-volume
          spec:
            accessModes: ["ReadWriteOnce"]
            storageClassName: "local-path"  # 로그 볼륨에도 storageClassName을 지정합니다.
            resources:
              requests:
                storage: 5Gi
  additionalMongodConfig:
    storage.wiredTiger.engineConfig.journalCompressor: zlib
---
apiVersion: v1
kind: Secret
metadata:
  name: mongodb-user-password
type: Opaque
stringData:
  password: <your-password-here> # User의 Password 지정

6. MongoDB Custom Resource (CR)을 사용해 MongoDB 배포

1
2
3

❯ k apply -f mongodb-custom-resource.yaml 
mongodbcommunity.mongodbcommunity.mongodb.com/mongodb created
secret/mongodb-user-password created

7. MongoDB 배포 확인

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

❯ k get all                         
NAME                                               READY   STATUS    RESTARTS   AGE
pod/mongodb-0                                      2/2     Running   0          4m49s
pod/mongodb-kubernetes-operator-6d7f45687c-48222   1/1     Running   0          83m

NAME                  TYPE        CLUSTER-IP   EXTERNAL-IP   PORT(S)     AGE
service/mongodb-svc   ClusterIP   None         <none>        27017/TCP   4m53s

NAME                                          READY   UP-TO-DATE   AVAILABLE   AGE
deployment.apps/mongodb-kubernetes-operator   1/1     1            1           83m

NAME                                                     DESIRED   CURRENT   READY   AGE
replicaset.apps/mongodb-kubernetes-operator-6d7f45687c   1         1         1       83m

NAME                           READY   AGE
statefulset.apps/mongodb       1/1     4m52s
statefulset.apps/mongodb-arb   0/0     4m51s

❯ kubectl port-forward svc/mongodb-svc 27017:27017 -n mongodb

Forwarding from 127.0.0.1:27017 -> 27017
Forwarding from [::1]:27017 -> 27017

8. MongoDB 접속 확인

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

❯ mongosh --username {user_name} --password {user_password} --authenticationDatabase admin
Current Mongosh Log ID: 67330bd4cc38dd6e68c1c18b
Connecting to:          mongodb://<credentials>@127.0.0.1:27017/?directConnection=true&serverSelectionTimeoutMS=2000&authSource=admin&appName=mongosh+2.3.3
Using MongoDB:          8.0.0
Using Mongosh:          2.3.3

For mongosh info see: https://www.mongodb.com/docs/mongodb-shell/

------
   The server generated these startup warnings when booting
   2024-11-12T07:28:08.638+00:00: Using the XFS filesystem is strongly recommended with the WiredTiger storage engine. See http://dochub.mongodb.org/core/prodnotes-filesystem
   2024-11-12T07:28:12.220+00:00: For customers running the tcmalloc-google memory allocator, we suggest setting the contents of sysfsFile to 'always'
   2024-11-12T07:28:12.220+00:00: For customers running the updated tcmalloc-google memory allocator, we suggest setting the contents of sysfsFile to 'defer+madvise'
   2024-11-12T07:28:12.220+00:00: We suggest setting the contents of sysfsFile to 0.
   2024-11-12T07:28:12.220+00:00: vm.max_map_count is too low
------

mongodb [direct: primary] test> show dbs
admin   172.00 KiB
config  176.00 KiB
local   500.00 KiB
mongodb [direct: primary] test> 

이처럼 프롬프트가 출력되면 포트 포워딩 및 인증이 정상적으로 완료된 것입니다. `show dbs`, `rs.status()` 등으로 ReplicaSet 상태를 점검하고, 필요한 데이터베이스와 사용자를 추가로 구성하면 됩니다.

9. Reference

MongoDB Github - https://github.com/mongodb/mongo
MongoDB 공식문서 - https://www.mongodb.com/ko-kr/docs/manual/
MongoDB Operator - https://github.com/mongodb/mongodb-kubernetes-operator/tree/master

궁금하신 점이나 추가해야 할 부분은 댓글이나 아래의 링크를 통해 문의해주세요.
Written with KKamJi

Kubernetes
kubernetes mongodb helm
This post is licensed under CC BY 4.0 by the author.