mirror of
				https://gitee.com/gitea/gitea
				synced 2025-11-04 16:40:24 +08:00 
			
		
		
		
	This PR cleans up the docs in a way to make them simpler to ingest by our [docs repo](https://gitea.com/gitea/gitea-docusaurus). 1. It includes all of the sed invocations our ingestion did, removing the need to do it at build time. 2. It replaces the shortcode variable replacement method with `@variable@` style, simply for easier sed invocations when required. 3. It removes unused files and moves the docs up a level as cleanup. --------- Signed-off-by: jolheiser <john.olheiser@gmail.com>
		
			
				
	
	
		
			73 lines
		
	
	
		
			1.7 KiB
		
	
	
	
		
			Markdown
		
	
	
	
	
	
			
		
		
	
	
			73 lines
		
	
	
		
			1.7 KiB
		
	
	
	
		
			Markdown
		
	
	
	
	
	
---
 | 
						|
date: "2020-03-19T19:27:00+02:00"
 | 
						|
title: "Install on Kubernetes"
 | 
						|
slug: "install-on-kubernetes"
 | 
						|
sidebar_position: 80
 | 
						|
toc: false
 | 
						|
draft: false
 | 
						|
aliases:
 | 
						|
  - /en-us/install-on-kubernetes
 | 
						|
menu:
 | 
						|
  sidebar:
 | 
						|
    parent: "installation"
 | 
						|
    name: "Kubernetes"
 | 
						|
    sidebar_position: 80
 | 
						|
    identifier: "install-on-kubernetes"
 | 
						|
---
 | 
						|
 | 
						|
# Installation with Helm (on Kubernetes)
 | 
						|
 | 
						|
Gitea provides a Helm Chart to allow for installation on kubernetes.
 | 
						|
 | 
						|
A non-customized install can be done with:
 | 
						|
 | 
						|
```
 | 
						|
helm repo add gitea-charts https://dl.gitea.com/charts/
 | 
						|
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)
 |