Create CUSTOM-README.md

charts/nemo/CUSTOM-README.md

@@ -0,0 +1,85 @@
+
+# Nemo 배포 
+
+## 1. 배포 방법
+
+### 1) 배포시 주의 사항
+- 사용할 모델에 따라서 적절한 자원(CPU, Memory, GPU)를 설정한 후 배포 해야한다.
+
+### 2) 배포 방법 
+
+``` sh
+# 차트 다운로드
+# oauthtoken: 특정한 값을 지정하는 것이 아닌 아래와 같이 그대로 입력
+# NGC_API_KEY: 위 준비과정에서 생성한 API_KEY 입력
+$ helm fetch https://helm.ngc.nvidia.com/nvidia/nemo-microservices/charts/nemo-microservices-helm-chart-25.4.0.tgz \
+   --username='$oauthtoken' \
+   --password=$NGC_API_KEY
+# 압축해제
+$ tar xvzf nemo-microservices-helm-chart-25.4.0.tgz
+
+# 배포
+$ helm --namespace nemo install nemo . -f custom-values.yaml --create-namespace
+```
+
+
+## 2.custom-values.yaml 설명
+
+- custom-values.yaml에 정의된 값에 대한 설명이다.
+
+### 1) Pod 설정
+
+### 2) nemo 설정
+
+### 3) Ingress 설정
+
+#### 3.1) tls 시크릿 직접 생성
+
+- nemo ingress 사용을 위해서는 다음과 같이 설정할 수 있다.
+  ``` yaml
+ingress:
+  enabled: true
+  tls:
+    - hosts:
+        - nemo.example.com
+      secretName: nemo-tls-secret
+  hosts:
+    default:
+      name: nemo.example.com
+    nimProxy:
+      name: nim.example.com
+    dataStore:
+      name: data-store.example.com
+  ```
+  
+- ingress 사용을 위해서는 인증서를 secret으로 제공해야한다. 로컬 파일을 이용해 secret을 생성하는 방법은 다음과 같다.
+  
+  ``` sh
+  kubectl create secret tls nemo-tls-secret --cert=<path-to-cert-file> --key=<path-to-key-file> -n <namespace>
+  ```
+
+#### 3.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: root-ca-issuer
+    cert-manager.io/duration: 8760h
+    cert-manager.io/renew-before: 720h
+  className: "kong"
+  tls:
+    - hosts:
+        - nemo.example.com
+      secretName: nemo-tls-secret
+  hosts:
+    default:
+      name: nemo.example.com
+    nimProxy:
+      name: nim.example.com
+    dataStore:
+      name: data-store.example.com
+  ```