Add custom-values.yaml, CUSTOM-README.md

charts/qdrant/CUSTOM-README.md

@@ -0,0 +1,106 @@
+
+# Qdrant 배포 
+
+## 1. 배포 방법
+- 명령어
+  ``` sh
+  $ helm upgrade qdrant ../qdrant  --install \
+   --namespace qdrant \
+   -f ./custom-values.yaml
+  ```
+
+
+
+## 2.custom-values.yaml 설명
+
+- custom-values.yaml에 정의된 값에 대한 설명이다.
+
+### 1) 이미지 설정
+- private 환경 배포시 사용한다.
+
+| Name                   | 설명                                                         | 기본값 |
+| ---------------------- | ------------------------------------------------------------ | ------ |
+| `image.repository` | 오프라인 설치 시에 설정 변경 필요. <br />paasup 설치시에는 "paasup.io/qdrant/qdrant"로 설정 | `"docker.io/qdrant/qdrant"`   |
+| `image.tag` | 이미지의 태그 설정 | `"v1.12.4"`   |
+
+
+
+### 2) pod 설정
+- pod의 수, tolerations, nodeSelector 리소스 등을 설정한다.
+
+| Name                     | 설명                               | 기본값    |
+| ------------------------ | ---------------------------------- | --------- |
+| `replicaCount`             | qdrant pod의 replicas 설정.         | "1"       |
+| `tolerations`              | qdrant pod의 toleration 설정.       | `[]`      |
+| `nodeSelector`             | qdrant pod의 nodeSelector 설정.     | `{}`      |
+| `resources.request.cpu`    | qdrant pod의 cpu requst 설정.       | ``  |
+| `resources.request.memory` | qdrant pod의 memory requst 설정.    | `` |
+| `resources.limits.cpu`     | qdrant pod의 cpu limits 설정.       | ``  |
+| `resources.limits.memory`  | qdrant pod의 memory limits 설정.    | ``   |
+| `persistence.accessModes`  | 생성할 Persistent Volume의 accessModes.   | `["ReadWriteOnce"]`    |
+| `persistence.size`         | 생성할 Persistent Volume 사이즈.   | `10Gi`    |
+| `persistence.storageClass` | Storage Class 설정.                | `""`      |
+
+
+
+### 3) Qdrant 설정
+
+- qdrant에 적용되는 configuration을 작성한다.
+
+| Name                        | 설명                                                         | 기본값                  |
+| --------------------------- | ------------------------------------------------------------ | ----------------------- |
+| `config`      | qdrant에 적용되는 기본 configuration을 덮어씌운다. | `custom-values.yaml 참조` |
+| apiKey | api key 생성 여부. | `false` |
+| readOnlyApiKey | read-only api key 생성 여부. | `false` |
+
+
+
+### 4) Ingress 설정
+
+#### 4.1) tls 시크릿 직접 생성
+
+
+- Rancher에서 ingress 사용을 위해서는 다음과 같이 설정할 수 있다.
+  ``` yaml
+  ingress:
+  enabled: true
+    hosts:
+    - host: qdrant.example.org
+      paths:
+      - path: /
+        pathType: Prefix
+        servicePort: 6333
+    tls: 
+    -  hosts:
+      - qdrant.example.org
+      secretName: qdrant-tls-secret
+  ```
+  
+- ingress 사용을 위해서는 인증서를 secret으로 제공해야한다. 로컬 파일을 이용해 secret을 생성하는 방법은 다음과 같다.
+  ``` sh
+  kubectl create secret tls qdrant-tls-secret --cert=<path-to-cert-file> --key=<path-to-key-file> -n <namespace>
+  ```
+
+
+#### 4.2) cert-manager를 이용한 자동 생성
+
+- cert manager를 통해 인증서 자동 생성 시 `custom-values.yaml` 수정한다.
+- `ingress.annotations.cert-manager.io/cluster-issuer`에 미리 배포된 Cluster Issuer의 이름으로 변경한다.
+  ``` yaml
+  ingress:
+    enabled: true
+    annotations:
+      cert-manager.io/cluster-issuer: "selfsigned-issuer" 
+      cert-manager.io/duration: 8760h  
+      cert-manager.io/renew-before: 720h
+    hosts:
+    - host: qdrant.example.org
+      paths:
+      - path: /
+        pathType: Prefix
+        servicePort: 6333
+    tls: 
+    -  hosts:
+       - qdrant.example.org
+       secretName: qdrant-tls-secret
+  ```

charts/qdrant/custom-values.yaml

@@ -0,0 +1,54 @@
+# 이미지 설정
+images:
+  repository: docker.io/qdrant/qdrant
+  tag: v1.12.4
+
+# pod 설정
+replicaCount: 1
+
+nodeSelector: {}
+tolerations: []
+resources: {}
+  # limits:
+  #   cpu: 100m
+  #   memory: 128Mi
+  # requests:
+  #   cpu: 100m
+  #   memory: 128Mi
+
+persistence:
+  accessModes: ["ReadWriteOnce"]
+  size: 10Gi
+  storageClassName: ""
+
+# qdrant 설정
+config:
+  log_level: INFO
+  cluster:
+    enabled: true
+    p2p:
+      port: 6335
+    consensus:
+      tick_period_ms: 100
+
+# 보안
+apiKey: false
+readOnlyApiKey: false
+
+# ingress 설정
+ingress:
+  enabled: true
+  annotations:
+    cert-manager.io/cluster-issuer: "selfsigned-issuer" 
+    cert-manager.io/duration: 8760h  
+    cert-manager.io/renew-before: 720h
+  hosts:
+  - host: qdrant.example.org
+    paths:
+    - path: /
+      pathType: Prefix
+      servicePort: 6333
+  tls: 
+  -  hosts:
+     - qdrant.example.org
+     secretName: qdrant-tls-secret