Helm chart for gitea

Go to file

Lucas Hahn ef3a92f397 Update documentation		2021-12-22 16:47:24 +00:00
templates	Fix redis-cluster settings	2021-12-22 16:47:24 +00:00
.drone.yml	Add deprecation fail-safe for Chart templating (#269 )	2021-12-23 00:25:32 +08:00
.gitignore	Fix typo enabling pprof (#114 )	2021-02-17 17:44:40 +08:00
.helmignore	Integrate NOVUM-RGI chart into the official helm chart. (#7 )	2020-08-23 17:56:55 +00:00
.markdownlint.yaml	Generic way for configuring Gitea app.ini (#240 )	2021-12-22 18:44:04 +08:00
Chart.yaml	add redis-cluster support	2021-12-22 16:47:24 +00:00
LICENSE	Integrate NOVUM-RGI chart into the official helm chart. (#7 )	2020-08-23 17:56:55 +00:00
README.md	Update documentation	2021-12-22 16:47:24 +00:00
values.yaml	Redis requires auth.password to be set for updates	2021-12-22 16:47:24 +00:00

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 jfelten's 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 repo update
helm install gitea gitea-charts/gitea

Prerequisites

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

Chart upgrade to 5.0.0

⚠️ The most recent 5.0.0 update brings some major and breaking changes. Please note the following changes in the Chart to upgrade successfully. ⚠️

Enable Dependencies

⚠️ The values to enable the dependencies, such as PostgreSQL, Memcached, MySQL and MariaDB have been moved from gitea.database.builtIn. to the dependency values. ⚠️

You can now enable the dependencies as followed:

memcached:
  enabled: true

postgresql:
  enabled: true

mysql:
  enabled: false

mariadb:
  enabled: false

App.ini generation

The app.ini generation has changed and now utilizes the environment-to-ini script provided by newer Gitea versions.

💥 The Helm Chart now requires Gitea versions of at least 1.11.0.

This change ensures, that the app.ini is now persistent.

Secret Key generation

Gitea secret keys (SECRET_KEY, INTERNAL_TOKEN, JWT_SECRET) are now generated automatically in certain situations:

New install: By default the secrets are created automatically. If you provide secrets via gitea.config they will be used instead of automatic generation.
Existing installs: The secrets won't be deployed, neither via configuration nor via auto generation. We explicitly prevent to set new secrets.

🚨 It would be possible to set new secret keys manually by entering the running container and rewriting the app.ini by hand. However, this it is not advisable to do so for existing installations. Certain settings like LDAP would not be readable anymore.

Probes

💥 gitea.customLivenessProbe, gitea.customReadinessProbe and gitea.customStartupProbe have been removed.

They are replaced by the settings gitea.livenessProbe, gitea.readinessProbe and gitea.startupProbe which are now fully configurable and used as-is for a Chart deployment. If you have customized their values instead of using the custom prefixed settings, please ensure that you remove the enabled property from each of them.

In case you want to disable one of these probes, let's say the livenessProbe, add the following to your values. The podAnnotation is just there to have a bit more context.

gitea:
+ livenessProbe:
  podAnnotations: {}

Multiple OAuth authentication sources

With 5.0.0 of this Chart it is now possible to configure Gitea with multiple OAuth sources. As a result, you need to update an existing OAuth configuration in your customized values.yaml by replacing the object with settings to a list of settings objects. See OAuth2 Settings section for details.

Chart upgrade from 3.x.x to 4.0.0

⚠️ The most recent 4.0.0 update brings some breaking changes. Please note the following changes in the Chart to upgrade successfully. ⚠️

Ingress changes

To provide a more flexible Ingress configuration we now support not only host settings but also provide configuration for the path and pathType. So this change changes the hosts from a simple string list, to a list containing a more complex object for more configuration.

ingress:
  enabled: false
  annotations: {}
    # kubernetes.io/ingress.class: nginx
    # kubernetes.io/tls-acme: "true"
-  hosts:
-    - git.example.com
+  hosts:
+    - host: git.example.com
+      paths:
+        - path: /
+          pathType: Prefix
  tls: []
  #  - secretName: chart-example-tls
  #    hosts:
  #      - git.example.com

If you want everything as it was before, you can simply add the following code to all your host entries.

paths:
  - path: /
    pathType: Prefix

Dropped kebab-case support

In 3.x.x it was possible to provide an ldap configuration via kebab-case, this support has now been dropped and only camel case is supported. See LDAP section for more information.

Dependency update

The chart comes with multiple databases and Memcached as dependency, the latest release updated the dependencies.

Memcached: 4.2.20 -> 5.9.0
PostgreSQL: 9.7.2 -> 10.3.17
MariaDB: 8.0.0 -> 9.3.6

If you're using the builtin databases you will most likely redeploy the chart in order to update the database correctly.

Execution of initPreScript

Generally spoken, this might not be a breaking change, but it is worth to be mentioned.

Prior to 4.0.0 only one init container was used to both setup directories and configure Gitea. As of now the actual Gitea configuration is separated from the other pre-execution. This also includes the execution of initPreScript. If you have such script, please be aware of this. Dynamically prepare the Gitea setup during execution by e.g. adding environment variables to the execution context won't work anymore.

Gitea Version 1.14.X repository ROOT

Previously the ROOT folder for the Gitea repositories was located at /data/git/gitea-repositories. In version 1.14 has the path been changed to /data/gitea-repositories.

This chart will set the gitea.config.repository.ROOT value default to /data/git/gitea-repositories.

Configure Commit Signing

When using the rootless image the gpg key folder was is not persistent by default. If you consider using signed commits for internal Gitea activities (e.g. initial commit), you'd need to provide a signing key. Prior to PR186, imported keys had to be re-imported once the container got replaced by another.

The mentioned PR introduced a new configuration object signing allowing you to configure prerequisites for commit signing. By default this section is disabled to maintain backwards compatibility.

signing:
  enabled: false
  gpgHome: /data/git/.gnupg

Gitea - HA

With Version 4.1.x the helm chart supports Gitea running in HA(High Availability) mode. To run Gitea in HA you'll need to set a few values in order to run successfully.

Redis

HA requires a Queue to run, we're going to use redis as default for this.

redis:
  enabled: true

You can also run Redis in HA mode:

redis-cluster:
  enabled: true

Both variants can be found at Bitnami.

Once redis is enabled, the chart will automatically configure Gitea to run with redis queue, indexer and session. Running with Redis already provides a sticky session, which saves you the trouble from configuring your ingress running with a sticky session. The following values are autogenerated. However you can overwrite any setting in the config section of the chart.

[session]
PROVIDER        = redis
PROVIDER_CONFIG = redis://:gitea@gitea-redis-master.svc.cluster.local:6379/0?pool_size=100&idle_timeout=180s

[queue]
CONN_STR = redis://:gitea@gitea-redis-master.svc.cluster.local:6379/0?pool_size=100&idle_timeout=180s
TYPE     = redis

[queue.issue_indexer]
TYPE = redis

Persistence

When running in HA you cannot use the default persistence for the chart. You'll need to setup an extra PVC running with access mode "RWX" - "ReadWriteMany". Otherwise the chart will create a PVC for every replica.

persistence:
  enabled: true
  existingClaim: rwx-pvc-gitea

PostgreSQL

You can also run PostgreSQL in HA mode also provided by Bitnami. ⚠️ Please disable the default PostgreSQL version, when you enabled the HA PostgreSQL.

postgresql-ha:
  enabled: true

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

Additional app.ini settings

The generic section cannot be defined that way.

Some settings inside app.ini (like passwords or whole authentication configurations) must be considered sensitive and therefore should not be passed via plain text inside the values.yaml file. In times of GitOps the values.yaml could be stored in a Git repository where sensitive data should never be accessible.

The Helm Chart supports this approach and let the user define custom sources like Kubernetes Secrets to be loaded as environment variables during app.ini creation or update.

gitea:
  additionalConfigSources:
    - secret:
        secretName: gitea-app-ini-oauth
    - configMap:
        name: gitea-app-ini-plaintext

This would mount the two additional volumes (oauth and some-additionals) from different sources to the init containerwhere the app.ini gets updated. All files mounted that way will be read and converted to environment variables and then added to the app.ini using environment-to-ini.

The key of such additional source represents the section inside the app.ini. The value for each key can be multiline ini-like definitions.

In example, the referenced gitea-app-ini-plaintext could look like this.

apiVersion: v1
kind: ConfigMap
metadata:
  name: gitea-app-ini-plaintext
data:
  session: |
    PROVIDER=memory
    SAME_SITE=strict    
  cron.archive_cleanup: |
    ENABLED=true

External Database

An external Database can be used instead of builtIn PostgreSQL or MySQL.

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

postgresql:
  enabled: false

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 won'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

SSH on crio based kubernetes cluster

If you use crio as container runtime it is not possible to read from a remote repository. You should get an error message like this:

$ git clone git@k8s-demo.internal:admin/test.git
Cloning into 'test'...
Connection reset by 192.168.179.217 port 22
fatal: Could not read from remote repository.

Please make sure you have the correct access rights
and the repository exists.

To solve this problem add the capability SYS_CHROOT to the securityContext. More about this issue here.

Cache

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

memcached:
  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.

Please note, that an empty storageClass in the persistence will result in kubernetes using your default storage class.

If you want to use your own storageClass define it as followed:

persistence:
  enabled: true
  storageClass: myOwnStorageClass

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"

You can also use an existing Secret to configure the admin user:

apiVersion: v1
kind: Secret
metadata:
  name: gitea-admin-secret
type: Opaque
stringData:
  username: MyAwesomeGiteaAdmin
  password: AReallyAwesomeGiteaPassword

gitea:
    admin:
      existingSecret: gitea-admin-secret

LDAP Settings

Like the admin user the LDAP settings can be updated. All LDAP values from https://docs.gitea.io/en-us/command-line/#admin are available.

Multiple LDAP sources can be configured with additional LDAP list items.

  gitea:
    ldap:
      - 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
        publicSSHKeyAttribute: publicSSHKey

You can also use an existing secret to set the bindDn and bindPassword:

apiVersion: v1
kind: Secret
metadata:
  name: gitea-ldap-secret
type: Opaque
stringData:
  bindDn: CN=ldap read,OU=Spezial,DC=example,DC=com
  bindPassword: JustAnotherBindPw

gitea:
    ldap:
      - existingSecret: gitea-ldap-secret
        ...

⚠️ Some options are just flags and therefore don't any values. If they are defined in gitea.ldap configuration, they will be passed to the Gitea cli without any value. Affected options:

notActive
skipTlsVerify
allowDeactivateAll
synchronizeUsers
attributesInBind

OAuth2 Settings

Like the admin user, OAuth2 settings can be updated and disabled but not deleted. Deleting OAuth2 settings has to be done in the ui. All OAuth2 values, which are documented here, are available.

Multiple OAuth2 sources can be configured with additional OAuth list items.

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

You can also use an existing secret to set the key and secret:

apiVersion: v1
kind: Secret
metadata:
  name: gitea-oauth-secret
type: Opaque
stringData:
  key: hello
  secret: world

gitea:
  oauth:
    - name: 'MyAwesomeGiteaOAuth'
      existingSecret: gitea-oauth-secret
        ...

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.

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`	How long to wait until forcefully kill the pod	`60`
`statefulset.env`	Additional environment variables to pass to containers	`[]`
`extraVolumes`	Additional volumes to mount to the Gitea statefulset	`{}`
`extraVolumeMounts`	Additional volume mounts for the Gitea containers	`{}`
`initPreScript`	Bash script copied verbatim to start of init container
`podSecurityContext.fsGroup`	Set the shared file system group for all containers	1000
`containerSecurityContext`	Run init and Gitea containers as a specific securityContext	`{}`
`schedulerName`	Use an alternate scheduler, e.g. "stork"

Image

Parameter	Description	Default
`image.repository`	Image to start for this pod	`gitea/gitea`
`image.tag`	Image tag	`1.14.6`
`image.pullPolicy`	Image pull policy	`Always`
`image.rootless`	Wether or not to pull the rootless version of Gitea, only works on Gitea 1.14.x or higher	`false`

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.subPath`	Subdirectory of the volume to mount at
`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[0].host`	add hosts for ingress	`git.example.com`
`ingress.hosts[0].paths[0].path`	add path for each ingress host	`/`
`ingress.hosts[0].paths[0].pathType`	add ingress path type	`Prefix`
`ingress.tls`	add ingress tls settings	`[]`
`ingress.className`	add ingress class name. Only used in k8s 1.19+
`ingress.apiVersion`	specify APIVersion of ingress object. Mostly would only be used for argocd.	version indicated by helm's `Capabilities` object.

Service

Web

Parameter	Description	Default
`service.http.type`	Kubernetes service type for web traffic	`ClusterIP`
`service.http.port`	Port for web traffic	`3000`
`service.http.clusterIP`	ClusterIP setting for http autosetup for statefulset is None	`None`
`service.http.loadBalancerIP`	LoadBalancer Ip setting
`service.http.nodePort`	NodePort for http service
`service.http.externalTrafficPolicy`	If `service.http.type` is `NodePort` or `LoadBalancer`, set this to `Local` to enable source IP preservation
`service.http.externalIPs`	http service external IP addresses
`service.http.loadBalancerSourceRanges`	Source range filter for http loadbalancer	`[]`
`service.http.annotations`	http service annotations

SSH

Parameter	Description	Default
`service.ssh.type`	Kubernetes service type for ssh traffic	`ClusterIP`
`service.ssh.port`	Port for ssh traffic	`22`
`service.ssh.loadBalancerIP`	LoadBalancer Ip setting
`service.ssh.nodePort`	NodePort for ssh service
`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.loadBalancerSourceRanges`	Source range filter for ssh loadbalancer	`[]`
`service.ssh.annotations`	ssh service annotations

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.

Liveness probe

Default status: Enabled
Default action: tcp socket connect

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

Readiness probe

Default status: Enabled
Default action: tcp socket connect

Parameter	Description	Default
`gitea.readinessProbe.initialDelaySeconds`	Delay before probe start	`5`
`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	`3`

Startup probe

Default status: Disabled
Default action: tcp socket connect

Parameter	Description	Default
`gitea.startupProbe.initialDelaySeconds`	Delay before probe start	`60`
`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`

Redis BuiltIn

Redis is loaded as a dependency from Bitnami if enabled in the values. Complete Configuration can be taken from their website.