2020-08-23 17:56:55 +00:00
# Gitea Helm Chart
2019-12-12 13:38:31 -05:00
2020-08-23 17:56:55 +00:00
[Gitea ](https://gitea.io/en-us/ ) is a community managed lightweight code hosting solution written in Go. It is published under the MIT license.
2019-12-12 13:38:31 -05:00
2020-08-23 17:56:55 +00:00
## Introduction
2019-12-12 13:38:31 -05:00
2020-12-21 06:53:45 +08:00
This helm chart has taken some inspiration from < https: / / github . com / jfelten / gitea-helm-chart >
2020-08-23 17:56:55 +00:00
But takes a completly different approach in providing database and cache with dependencies.
2020-12-21 06:53:45 +08:00
Also this chart provides LDAP and admin user configuration with values as well as it is deployed as statefulset to retain stored repositories.
2019-12-12 13:38:31 -05:00
2020-08-23 17:56:55 +00:00
## Dependencies
Gitea can be run with external database and cache. This chart provides those dependencies, which can be
enabled, or disabled via [configuration ](#configuration ).
Dependencies:
2019-12-12 13:38:31 -05:00
2020-08-23 17:56:55 +00:00
* Postgresql
* Memcached
* Mysql
2019-12-12 13:38:31 -05:00
2020-08-23 17:56:55 +00:00
## Installing
2020-12-21 06:53:45 +08:00
```sh
2020-08-29 03:54:09 +00:00
helm repo add gitea-charts https://dl.gitea.io/charts/
helm install gitea gitea-charts/gitea
2020-08-23 17:56:55 +00:00
```
2019-12-12 13:38:31 -05:00
## Prerequisites
2020-08-23 17:56:55 +00:00
* Kubernetes 1.12+
* Helm 3.0+
* PV provisioner for persistent data support
2019-12-12 13:38:31 -05:00
2020-08-23 17:56:55 +00:00
## Examples
2019-12-12 13:38:31 -05:00
2020-08-23 17:56:55 +00:00
### Gitea Configuration
2019-12-12 13:38:31 -05:00
2020-08-23 17:56:55 +00:00
Gitea offers lots of configuration. This is fully described in the [Gitea Cheat Sheet ](https://docs.gitea.io/en-us/config-cheat-sheet/ ).
2019-12-12 13:38:31 -05:00
2020-08-23 17:56:55 +00:00
```yaml
gitea:
config:
APP_NAME: "Gitea: With a cup of tea."
repository:
ROOT: "~/gitea-repositories"
repository.pull-request:
WORK_IN_PROGRESS_PREFIXES: "WIP:,[WIP]:"
2019-12-12 13:38:31 -05:00
```
2020-10-06 09:03:20 +00:00
### Default Configuration
This chart will set a few defaults in the gitea configuration based on the service and ingress settings. All defaults can be overwritten in gitea.config.
INSTALL_LOCK is always set to true, since we want to configure gitea with this helm chart and everything is taken care of.
*All default settings are made directly in the generated app.ini, not in the Values.*
#### Database defaults
If a builtIn database is enabled the database configuration is set automatically. For example postgresql builtIn which will appear in the app.ini as:
2020-12-21 06:53:45 +08:00
```ini
2020-10-06 09:03:20 +00:00
[database]
DB_TYPE = postgres
HOST = RELEASE-NAME-postgresql.default.svc.cluster.local:5432
NAME = gitea
PASSWD = gitea
USER = gitea
```
#### Memcached defaults
Memcached is handled the exakt same way as database builtIn. Once memcached builtIn is enabled, this chart will generate the following part in the app.ini:
2020-12-21 06:53:45 +08:00
```ini
2020-10-06 09:03:20 +00:00
[cache]
ADAPTER = memcache
ENABLED = true
HOST = RELEASE-NAME-memcached.default.svc.cluster.local:11211
```
#### Server defaults
The server defaults are a bit more complex.
If ingress is enabled, the ROOT_URL, DOMAIN and SSH_DOMAIN will be set accordingly. HTTP_PORT always defaults to 3000 as well as SSH_PORT to 22.
2020-12-21 06:53:45 +08:00
```ini
2020-10-06 09:03:20 +00:00
[server]
APP_DATA_PATH = /data
DOMAIN = git.example.com
HTTP_PORT = 3000
PROTOCOL = http
ROOT_URL = http://git.example.com
SSH_DOMAIN = git.example.com
SSH_LISTEN_PORT = 22
SSH_PORT = 22
2021-01-21 23:45:26 +08:00
ENABLE_PPROF = false
```
#### Metrics defaults
The Prometheus `/metrics` endpoint is disabled by default.
```ini
[metrics]
ENABLED = false
2020-10-06 09:03:20 +00:00
```
2020-09-03 21:27:11 +00:00
### External Database
An external Database can be used instead of builtIn postgresql or mysql.
```yaml
gitea:
database:
builtIn:
postgresql:
enabled: false
config:
database:
DB_TYPE: mysql
HOST: 127.0.0.1:3306
NAME: gitea
USER: root
PASSWD: gitea
2020-09-25 20:00:46 +00:00
SCHEMA: gitea
2020-09-03 21:27:11 +00:00
```
2019-12-12 13:38:31 -05:00
2020-08-23 17:56:55 +00:00
### Ports and external url
By default port 3000 is used for web traffic and 22 for ssh. Those can be changed:
2019-12-12 13:38:31 -05:00
2020-08-23 17:56:55 +00:00
```yaml
service:
http:
port: 3000
ssh:
port: 22
2019-12-12 13:38:31 -05:00
```
2020-08-23 17:56:55 +00:00
This helmchart automatically configures the clone urls to use the correct ports. You can change these ports by hand using the gitea.config dict. However you should know what you're doing.
2020-12-16 20:37:47 +08:00
### ClusterIP
By default the clusterIP will be set to None, which is the default for headless services. However if you want to omit the clusterIP field in the service, use the following values:
```yaml
service:
http:
type: ClusterIP
port: 3000
clusterIP:
ssh:
type: ClusterIP
port: 22
clusterIP:
```
2020-12-10 17:16:13 +08:00
### SSH and Ingress
If you're using ingress and wan't to use SSH, keep in mind, that ingress is not able to forward SSH Ports.
You will need a LoadBalancer like metallb and a setting in your ssh service annotations.
```yaml
service:
ssh:
annotations:
metallb.universe.tf/allow-shared-ip: test
```
2020-08-23 17:56:55 +00:00
### Cache
2019-12-12 13:38:31 -05:00
2020-08-23 17:56:55 +00:00
This helm chart can use a built in cache. The default is memcached from bitnami.
2019-12-12 13:38:31 -05:00
```yaml
2020-08-23 17:56:55 +00:00
gitea:
cache:
builtIn:
enabled: true
2019-12-12 13:38:31 -05:00
```
2020-08-23 17:56:55 +00:00
If the built in cache should not be used simply configure the cache in gitea.config
2019-12-12 13:38:31 -05:00
```yaml
2020-08-23 17:56:55 +00:00
gitea:
config:
cache:
ENABLED: true
ADAPTER: memory
INTERVAL: 60
HOST: 127.0.0.1:9090
2019-12-12 13:38:31 -05:00
```
2020-10-06 09:03:20 +00:00
2020-08-23 17:56:55 +00:00
### Persistence
2019-12-12 13:38:31 -05:00
2020-08-23 17:56:55 +00:00
Gitea will be deployed as a statefulset. By simply enabling the persistence and setting the storage class according to your cluster
everything else will be taken care of. The following example will create a PVC as a part of the statefulset. This PVC will not be deleted
even if you uninstall the chart.
2020-12-21 06:53:45 +08:00
When using Postgresql as dependency, this will also be deployed as a statefulset by default.
2019-12-12 13:38:31 -05:00
2020-12-21 06:53:45 +08:00
If you want to manage your own PVC you can simply pass the PVC name to the chart.
2019-12-12 13:38:31 -05:00
2020-08-23 17:56:55 +00:00
```yaml
persistence:
enabled: true
existingClaim: MyAwesomeGiteaClaim
```
2019-12-12 13:38:31 -05:00
2020-08-23 17:56:55 +00:00
In case that peristence has been disabled it will simply use an empty dir volume.
2019-12-12 13:38:31 -05:00
2020-12-21 06:53:45 +08:00
Postgresql handles the persistence in the exact same way.
2020-08-23 17:56:55 +00:00
You can interact with the postgres settings as displayed in the following example:
2019-12-12 13:38:31 -05:00
```yaml
2020-08-23 17:56:55 +00:00
postgresql:
persistence:
enabled: true
existingClaim: MyAwesomeGiteaPostgresClaim
2019-12-12 13:38:31 -05:00
```
2020-08-23 17:56:55 +00:00
Mysql also handles persistence the same, even though it is not deployed as a statefulset.
You can interact with the postgres settings as displayed in the following example:
2019-12-12 13:38:31 -05:00
2020-08-23 17:56:55 +00:00
```yaml
mysql:
persistence:
enabled: true
existingClaim: MyAwesomeGiteaMysqlClaim
```
### Admin User
This chart enables you to create a default admin user. It is also possible to update the password for this user by upgrading or redeloying the chart.
It is not possible to delete an admin user after it has been created. This has to be done in the ui.
2021-01-13 23:49:58 +08:00
You cannot use `admin` as username.
2019-12-12 13:38:31 -05:00
```yaml
2020-08-23 17:56:55 +00:00
gitea:
admin:
username: "MyAwesomeGiteaAdmin"
password: "AReallyAwesomeGiteaPassword"
email: "gi@tea.com"
2019-12-12 13:38:31 -05:00
```
2020-08-23 17:56:55 +00:00
### LDAP Settings
2020-12-21 06:53:45 +08:00
Like the admin user the LDAP settings can be updated but also disabled or deleted.
All LDAP values from < https: / / docs . gitea . io / en-us / command-line / # admin > are available.
2020-12-16 20:37:47 +08:00
You can either use them in camel case or kebab case.
camelCase:
2019-12-12 13:38:31 -05:00
```yaml
2020-08-23 17:56:55 +00:00
gitea:
ldap:
enabled: true
name: 'MyAwesomeGiteaLdap'
securityProtocol: unencrypted
host: "127.0.0.1"
port: "389"
userSearchBase: ou=Users,dc=example,dc=com
userFilter: sAMAccountName=%s
adminFilter: CN=Admin,CN=Group,DC=example,DC=com
emailAttribute: mail
bindDn: CN=ldap read,OU=Spezial,DC=example,DC=com
bindPassword: JustAnotherBindPw
usernameAttribute: CN
2021-01-22 16:24:37 +08:00
sshPublicKeyAttribute: sshPublicKey
2019-12-12 13:38:31 -05:00
```
2020-12-16 20:37:47 +08:00
kebab-case:
```yaml
gitea:
ldap:
enabled: true
name: 'MyAwesomeGiteaLdap'
security-protocol: unencrypted
host: "127.0.0.1"
port: "389"
user-search-base: ou=Users,dc=example,dc=com
user-filter: sAMAccountName=%s
admin-filter: CN=Admin,CN=Group,DC=example,DC=com
email-attribute: mail
bind-dn: CN=ldap read,OU=Spezial,DC=example,DC=com
bind-password: JustAnotherBindPw
username-attribute: CN
```
2021-01-21 23:45:26 +08:00
### Metrics and profiling
A Prometheus `/metrics` endpoint on the `HTTP_PORT` and `pprof` profiling endpoints on port 6060 can be enabled under `gitea` . Beware that the metrics endpoint is exposed via the ingress, manage access using ingress annotations for example.
To deploy the `ServiceMonitor` , you first need to ensure that you have deployed `prometheus-operator` and its CRDs: https://github.com/prometheus-operator/prometheus-operator#customresourcedefinitions.
```yaml
gitea:
metrics:
enabled: true
serviceMonitor:
enabled: true
config:
server:
PPROF_ENABLED: true
```
2020-09-24 16:32:11 +00:00
### Pod Annotations
Annotations can be added to the Gitea pod.
```yaml
gitea:
podAnnotations: {}
```
2020-08-23 17:56:55 +00:00
## Configuration
2019-12-12 13:38:31 -05:00
2020-08-23 17:56:55 +00:00
### Others
2019-12-12 13:38:31 -05:00
2021-01-20 19:28:39 +08:00
| Parameter | Description | Default |
|-------------------------------------------|--------------------------------------------------------|-------------|
| statefulset.terminationGracePeriodSeconds | Image to start for this pod | gitea/gitea |
| statefulset.env | Additional environment variables to pass to containers | [] |
| extraVolumes | Additional volumes to mount to the Gitea statefulset | {} |
| extraVolumeMounts | Additional volumes mounts for the Gitea containers | {} |
| initPreScript | Bash script copied verbatim to start of init container | |
2019-12-12 13:38:31 -05:00
2020-08-23 17:56:55 +00:00
### Image
2019-12-12 13:38:31 -05:00
2020-08-23 17:56:55 +00:00
| Parameter | Description | Default |
|---------------------|-----------------------------------|------------------------------|
|image.repository| Image to start for this pod | gitea/gitea |
2021-02-05 01:46:55 +08:00
|image.tag| [Image tag ](https://hub.docker.com/r/gitea/gitea/tags?page=1&ordering=last_updated ) | 1.13.2 |
2020-08-23 17:56:55 +00:00
|image.pullPolicy| Image pull policy | Always |
2019-12-12 13:38:31 -05:00
2020-08-23 17:56:55 +00:00
### Persistence
2019-12-12 13:38:31 -05:00
2020-08-23 17:56:55 +00:00
| Parameter | Description | Default |
|---------------------|-----------------------------------|------------------------------|
|persistence.enabled| Enable persistence for Gitea |true|
|persistence.existingClaim| Use an existing claim to store repository information | |
|persistence.size| Size for persistence to store repo information | 10Gi |
|persistence.accessModes|AccessMode for persistence||
2020-10-30 01:10:10 +08:00
|persistence.storageClass|Storage class for repository persistence||
2021-01-22 16:24:37 +08:00
|persistence.labels|Labels for the persistence volume claim to be created|{}|
|persistence.annotations|Annotations for the persistence volume claim to be created|{}|
2019-12-12 13:38:31 -05:00
2020-08-23 17:56:55 +00:00
### Ingress
2019-12-12 13:38:31 -05:00
2020-08-23 17:56:55 +00:00
| Parameter | Description | Default |
|---------------------|-----------------------------------|------------------------------|
|ingress.enabled| enable ingress | false|
|ingress.annotations| add ingress annotations | |
|ingress.hosts| add hosts for ingress as string list | git.example.com |
|ingress.tls|add ingress tls settings|[]|
### Service
| Parameter | Description | Default |
|---------------------|-----------------------------------|------------------------------|
|service.http.type| Kubernetes service type for web traffic | ClusterIP |
|service.http.port| Port for web traffic | 3000 |
|service.ssh.type| Kubernetes service type for ssh traffic | ClusterIP |
|service.ssh.port| Port for ssh traffic | 22 |
2020-09-02 12:09:24 +00:00
|service.ssh.externalTrafficPolicy| If `service.ssh.type` is `NodePort` or `LoadBalancer` , set this to `Local` to enable source IP preservation | |
|service.ssh.externalIPs| SSH service external IP addresses |[]|
2020-08-23 17:56:55 +00:00
|service.ssh.annotations| Additional ssh annotations for the ssh service ||
### Gitea Configuration
| Parameter | Description | Default |
|---------------------|-----------------------------------|------------------------------|
|gitea.config | Everything in app.ini can be configured with this dict. See Examples for more details | {} |
### Memcached BuiltIn
Memcached is loaded as a dependency from [Bitnami ](https://github.com/bitnami/charts/tree/master/bitnami/memcached ) if enabled in the values. Complete Configuration can be taken from their website.
The following parameters are the defaults set by this chart
| Parameter | Description | Default |
|---------------------|-----------------------------------|------------------------------|
|memcached.service.port|Memcached Port| 11211|
### Mysql BuiltIn
Mysql is loaded as a dependency from stable. Configuration can be found from this [website ](https://github.com/helm/charts/tree/master/stable/mysql )
The following parameters are the defaults set by this chart
| Parameter | Description | Default |
|---------------------|-----------------------------------|------------------------------|
|mysql.mysqlRootPassword|Password for the root user. Ignored if existing secret is provided|gitea|
|mysql.mysqlUser|Username of new user to create.|gitea|
|mysql.mysqlPassword|Password for the new user. Ignored if existing secret is provided|gitea|
|mysql.mysqlDatabase|Name for new database to create.|gitea|
|mysql.service.port|Port to connect to mysql service|3306|
2020-10-06 09:03:20 +00:00
|mysql.persistence.size|Persistence size for mysql |10Gi|
2020-08-23 17:56:55 +00:00
### Postgresql BuiltIn
Postgresql is loaded as a dependency from bitnami. Configuration can be found from this [Bitnami ](https://github.com/bitnami/charts/tree/master/bitnami/postgresql )
The following parameters are the defaults set by this chart
2019-12-12 13:38:31 -05:00
2020-08-23 17:56:55 +00:00
| Parameter | Description | Default |
|---------------------|-----------------------------------|------------------------------|
|postgresql.global.postgresql.postgresqlDatabase| PostgreSQL database (overrides postgresqlDatabase)|gitea|
|postgresql.global.postgresql.postgresqlUsername| PostgreSQL username (overrides postgresqlUsername)|gitea|
|postgresql.global.postgresql.postgresqlPassword| PostgreSQL admin password (overrides postgresqlPassword)|gitea|
|postgresql.global.postgresql.servicePort|PostgreSQL port (overrides service.port)|5432|
|postgresql.persistence.size| PVC Storage Request for PostgreSQL volume |10Gi|
2020-10-06 09:03:20 +00:00
### MariaDB BuiltIn
MariaDB is loaded as a dependency from bitnami. Configuration can be found from this [Bitnami ](https://github.com/bitnami/charts/tree/master/bitnami/mariadb )
The following parameters are the defaults set by this chart
| Parameter | Description | Default |
|---------------------|-----------------------------------|------------------------------|
2020-10-22 13:13:37 +08:00
|mariadb.auth.username|Username of new user to create.|gitea|
|mariadb.auth.password|Password for the new user. Ignored if existing secret is provided|gitea|
|mariadb.auth.database|Name for new database to create.|gitea|
|mariadb.auth.rootPassword|Password for the root user.|gitea|
|mariadb.primary.service.port|Port to connect to mariadb service|3306|
|mariadb.primary.persistence.size|Persistence size for mariadb |10Gi|