diff options
| author | John Olheiser <john.olheiser@gmail.com> | 2023-07-25 23:53:13 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-07-26 04:53:13 +0000 |
| commit | bd4c7ce578956d9839309b16753bd5505b63b2e3 (patch) | |
| tree | 1d3074ef542cee11707bc4985ce54dc40facb9b6 /docs/content/installation/on-kubernetes.en-us.md | |
| parent | 5dc37ef97a30628027a723ee944225a33a6511f8 (diff) | |
| download | gitea-bd4c7ce578956d9839309b16753bd5505b63b2e3.tar.gz gitea-bd4c7ce578956d9839309b16753bd5505b63b2e3.zip | |
Docusaurus-ify (#26051)
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>
Diffstat (limited to 'docs/content/installation/on-kubernetes.en-us.md')
| -rw-r--r-- | docs/content/installation/on-kubernetes.en-us.md | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/docs/content/installation/on-kubernetes.en-us.md b/docs/content/installation/on-kubernetes.en-us.md new file mode 100644 index 0000000000..00f2aab28d --- /dev/null +++ b/docs/content/installation/on-kubernetes.en-us.md @@ -0,0 +1,72 @@ +--- +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) |