helm-chart/README.md

Gitea Helm Chart

Gitea is a community managed lightweight code hosting solution written in Go. It is published under the MIT license.

Introduction

This helm chart has taken some inspiration from https://github.com/jfelten/gitea-helm-chart But takes a completely different approach in providing a database and cache with dependencies. Additionally, this chart provides LDAP and admin user configuration with values, as well as being deployed as a statefulset to retain stored repositories.

Dependencies

Gitea can be run with an external database and cache. This chart provides those dependencies, which can be enabled, or disabled via configuration.

Dependencies:

• Postgresql
• Memcached
• Mysql

Installing

  helm repo add gitea-charts https://dl.gitea.io/charts/
  helm install gitea gitea-charts/gitea

Prerequisites

• Kubernetes 1.12+
• Helm 3.0+
• PV provisioner for persistent data support

Examples

Gitea Configuration

Gitea offers lots of configuration options. This is fully described in the Gitea Cheat Sheet.

  gitea:
    config:
      APP_NAME: "Gitea: With a cup of tea."
      repository:
        ROOT: "~/gitea-repositories"
      repository.pull-request:
        WORK_IN_PROGRESS_PREFIXES: "WIP:,[WIP]:"

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 will appear in the app.ini as:

[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 exact same way as database builtIn. Once memcached builtIn is enabled, this chart will generate the following part in the app.ini:

[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.

[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
ENABLE_PPROF = false

Metrics defaults

The Prometheus /metrics endpoint is disabled by default.

[metrics]
ENABLED = false

External Database

An external Database can be used instead of builtIn postgresql or mysql.

  gitea:
    database:
      builtIn:
        postgresql:
          enabled: false

    config:
      database:
        DB_TYPE: mysql
        HOST: 127.0.0.1:3306
        NAME: gitea
        USER: root
        PASSWD: gitea
        SCHEMA: gitea

Ports and external url

By default port 3000 is used for web traffic and 22 for ssh. Those can be changed:

  service:
    http: 
      port: 3000
    ssh:
      port: 22

This helm chart 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.

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:

service:
  http:
    type: ClusterIP
    port: 3000
    clusterIP:
  ssh:
    type: ClusterIP
    port: 22
    clusterIP:

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.

service:
  ssh:
    annotations:
      metallb.universe.tf/allow-shared-ip: test

Cache

This helm chart can use a built in cache. The default is memcached from bitnami.

  gitea:
    cache:
      builtIn:
        enabled: true

If the built in cache should not be used simply configure the cache in gitea.config

  gitea:
    config:
      cache:
        ENABLED: true
        ADAPTER: memory
        INTERVAL: 60
        HOST: 127.0.0.1:9090

Persistence

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.

When using Postgresql as dependency, this will also be deployed as a statefulset by default.

If you want to manage your own PVC you can simply pass the PVC name to the chart.

  persistence:
    enabled: true
    existingClaim: MyAwesomeGiteaClaim

In case that peristence has been disabled it will simply use an empty dir volume.

Postgresql handles the persistence in the exact same way. You can interact with the postgres settings as displayed in the following example:

  postgresql:
    persistence:
      enabled: true
      existingClaim: MyAwesomeGiteaPostgresClaim

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:

  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. You cannot use admin as username.

  gitea:
    admin:
      username: "MyAwesomeGiteaAdmin"
      password: "AReallyAwesomeGiteaPassword"
      email: "gi@tea.com"

LDAP Settings

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. You can either use them in camel case or kebab case.

camelCase:

  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
      sshPublicKeyAttribute: sshPublicKey

kebab-case:

  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

OAuth2 Settings

Like the admin user the OAuth2 settings can be updated but also disabled or deleted. All OAuth2 values from https://docs.gitea.io/en-us/command-line/#admin are available. You can either use them in camel case or kebab case.

camelCase:

  gitea:
    oauth:
      enabled: true
      name: 'MyAwesomeGiteaOAuth'
      provider: 'openidConnect'
      key: 'hello'
      secret: 'world'
      autoDiscoverUrl: 'https://gitea.example.com/.well-known/openid-configuration'
      #useCustomUrls:
      #customAuthUrl:
      #customTokenUrl:
      #customProfileUrl:
      #customEmailUrl:

kebab-case:

  gitea:
    oauth:
      enabled: true
      name: 'MyAwesomeGiteaOAuth'
      provider: 'openidConnect'
      key: 'hello'
      secret: 'world'
      auto-discover-url: 'https://gitea.example.com/.well-known/openid-configuration'
      #use-custom-urls:
      #custom-auth-url:
      #custom-token-url:
      #custom-profile-url:
      #custom-email-url:

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.

gitea:
  metrics:
    enabled: true
    serviceMonitor:
      enabled: true

  config:
    server:
      ENABLE_PPROF: true

Pod Annotations

Annotations can be added to the Gitea pod.

  gitea:
    podAnnotations: {}

Configuration

Others

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
securityContext	Run as a specific securityContext	{}

Image

Parameter	Description	Default
image.repository	Image to start for this pod	gitea/gitea
image.tag	Image tag	1.13.2
image.pullPolicy	Image pull policy	Always

Persistence

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
persistence.storageClass	Storage class for repository persistence
persistence.labels	Labels for the persistence volume claim to be created	{}
persistence.annotations	Annotations for the persistence volume claim to be created	{}

Ingress

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
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	[]
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	{}

Gitea Probes

Configure Liveness, Readiness and Startup Probes

Parameter	Description	Default
gitea.livenessProbe.enabled	Enable liveness probe	true
gitea.livenessProbe.initialDelaySeconds	Delay before probe start	200
gitea.livenessProbe.timeoutSeconds	probe timeout	1
gitea.livenessProbe.periodSeconds	period between probes	10
gitea.livenessProbe.successThreshold	Minimum consecutive success probes	1
gitea.livenessProbe.failureThreshold	Minimum consecutive error probes	10
gitea.readinessProbe.enabled	Enable readiness probe	true
gitea.readinessProbe.initialDelaySeconds	Delay before probe start	200
gitea.readinessProbe.timeoutSeconds	probe timeout	1
gitea.readinessProbe.periodSeconds	period between probes	10
gitea.readinessProbe.successThreshold	Minimum consecutive success probes	1
gitea.readinessProbe.failureThreshold	Minimum consecutive error probes	10
gitea.startupProbe.enabled	Enable startup probe	false
gitea.startupProbe.initialDelaySeconds	Delay before probe start	200
gitea.startupProbe.timeoutSeconds	probe timeout	1
gitea.startupProbe.periodSeconds	period between probes	10
gitea.startupProbe.successThreshold	Minimum consecutive success probes	1
gitea.startupProbe.failureThreshold	Minimum consecutive error probes	10
gitea.customLivenessProbe	Custom liveness probe (needs gitea.livenessProbe.enabled: false)
gitea.customReadinessProbe	Custom readiness probe (needs gitea.readinessProbe.enabled: false)
gitea.customStartupProbe	Custom startup probe (needs gitea.startupProbe.enabled: false)

Memcached BuiltIn

Memcached is loaded as a dependency from Bitnami 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

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
mysql.persistence.size	Persistence size for mysql	10Gi

Postgresql BuiltIn

Postgresql is loaded as a dependency from Bitnami. The chart configuration can be found from this Bitnami repository.

The following parameters are the defaults set by this chart

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

MariaDB BuiltIn

MariaDB is loaded as a dependency from bitnami. Configuration can be found from this Bitnami

The following parameters are the defaults set by this chart

Parameter	Description	Default
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