aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/content/doc/installation/on-kubernetes.en-us.md44
-rw-r--r--docs/content/doc/installation/on-kubernetes.zh-tw.md44
2 files changed, 88 insertions, 0 deletions
diff --git a/docs/content/doc/installation/on-kubernetes.en-us.md b/docs/content/doc/installation/on-kubernetes.en-us.md
index 9fe869254c..abfbdf1679 100644
--- a/docs/content/doc/installation/on-kubernetes.en-us.md
+++ b/docs/content/doc/installation/on-kubernetes.en-us.md
@@ -25,3 +25,47 @@ helm install gitea gitea-charts/gitea
```
If you would like to customize your install, which includes kubernetes ingress, please refer to the complete [Gitea helm chart configuration details](https://gitea.com/gitea/helm-chart/)
+
+## Health check endpoint
+
+Gitea comes with a health check endpoint `/api/healthz`, you can configure it in kubernetes like this:
+
+```yaml
+ livenessProbe:
+ httpGet:
+ path: /api/healthz
+ port: http
+ initialDelaySeconds: 200
+ timeoutSeconds: 5
+ periodSeconds: 10
+ successThreshold: 1
+ failureThreshold: 10
+```
+
+a successful health check response will respond with http code `200`, here's example:
+
+```
+HTTP/1.1 200 OK
+
+
+{
+ "status": "pass",
+ "description": "Gitea: Git with a cup of tea",
+ "checks": {
+ "cache:ping": [
+ {
+ "status": "pass",
+ "time": "2022-02-19T09:16:08Z"
+ }
+ ],
+ "database:ping": [
+ {
+ "status": "pass",
+ "time": "2022-02-19T09:16:08Z"
+ }
+ ]
+ }
+}
+```
+
+for more information, please reference to kubernetes documentation [Define a liveness HTTP request](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#define-a-liveness-http-request)
diff --git a/docs/content/doc/installation/on-kubernetes.zh-tw.md b/docs/content/doc/installation/on-kubernetes.zh-tw.md
index 9add5c4ee1..5ea412aa00 100644
--- a/docs/content/doc/installation/on-kubernetes.zh-tw.md
+++ b/docs/content/doc/installation/on-kubernetes.zh-tw.md
@@ -25,3 +25,47 @@ helm install gitea gitea-charts/gitea
```
若您想自訂安裝(包括使用 kubernetes ingress),請前往完整的 [Gitea helm chart configuration details](https://gitea.com/gitea/helm-chart/)
+
+##運行狀況檢查終端節點
+
+Gitea 附帶了一個運行狀況檢查端點 `/api/healthz`,你可以像這樣在 kubernetes 中配置它:
+
+```yaml
+ livenessProbe:
+ httpGet:
+ path: /api/healthz
+ port: http
+ initialDelaySeconds: 200
+ timeoutSeconds: 5
+ periodSeconds: 10
+ successThreshold: 1
+ failureThreshold: 10
+```
+
+成功的運行狀況檢查回應將使用 HTTP 代碼 `200` 進行回應,下面是示例:
+
+```
+HTTP/1.1 200 OK
+
+
+{
+ "status": "pass",
+ "description": "Gitea: Git with a cup of tea",
+ "checks": {
+ "cache:ping": [
+ {
+ "status": "pass",
+ "time": "2022-02-19T09:16:08Z"
+ }
+ ],
+ "database:ping": [
+ {
+ "status": "pass",
+ "time": "2022-02-19T09:16:08Z"
+ }
+ ]
+ }
+}
+```
+
+有關更多信息,請參考kubernetes文檔[定義一個存活態 HTTP請求接口](https://kubernetes.io/zh/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/)