Skip to content

Latest commit

 

History

History
212 lines (171 loc) · 14.8 KB

README.md

File metadata and controls

212 lines (171 loc) · 14.8 KB
Raw

Gitea Helm chart

Gitea is a lightweight GitHub clone. This is for those who wish to self host their own git repos on kubernetes.

Introduction

This is a kubernetes helm chart for Gitea. It deploys a pod containing containers for the Gitea application along with a Postgresql db for storing application state. It can create peristent volume claims if desired, and also an ingress if the kubernetes cluster supports it.

This chart should work works on current supported versions of kubernetes. It is always in active use on the latest kubernetes and sync'd to the latest gitea release to stay current.

Currently the chart supports helm 3 only.

Prerequisites

  • A kubernetes cluster ( most recent release recommended)
  • helm client and tiller installed on the cluster
  • Please ensure that nodepools have enough resources to run both a web application and database
  • An external database if not using the in pod database

Installing the Chart

This chart is published in keyporttech/charts. To install the chart, first add the keyporttech helm repo:

helm repo add keyporttech https://keyporttech.github.io/helm-charts/

Then to install with the release name gitea in the namespace gittea with the customized values in custom_values.yaml run:

$ helm install -- values custom_values.yaml --name gitea --namespace gitea keyporttech/gitea

or locally:

$ helm install --name gitea --namespace tools .

Tip: You can use the default values.yaml

Contributing

Please see keyporttech charts contribution guidelines

Running the cicd tooling locally

This chart uses a Makefile to run CICD. To run:

make build

Database config in pod vs external db

By default the chart will spin up a postgres container inside the pod. It can also work with external databases. To disable the in pod database and use and external one use the following values:

dbType: "postgres"
useInPodPostgres: false

#Connect to an external database
externalDB:
   dbUser: "postgres"
   dbPassword: "<MY_PASSWORD>"
   dbHost: "db-service-name.namespace.svc.cluster.local" # or some external host
   dbPort: 5432
   dbDatabase: "gitea"

This chart has only been tested using a postgres database. It is theoretically possible to work with others that gitea supports, but no testing has been done. Pull Requests to support or confirmation of other database connectivity would be much appreciated.

Example custom_values.yaml configs

This configuration creates pvcs with the storageclass glusterfs that cannot be deleted by helm, a kubernetes nginx ingress that serves the web applcation on external dns name git.example.com:8880 and exposes ssh through a NodePort that is exposed externally on a router using port 8022. The external DNS name for ssh is git.example.com.

ingress:
  enabled: true
  useSSL: false
  ## annotations used by the ingress - ex for k8s nginx ingress controller:
  ingress_annotations:
    kubernetes.io/ingress.class: nginx
    nginx.ingress.kubernetes.io/proxy-body-size: "0"
    nginx.ingress.kubernetes.io/proxy-read-timeout: "600"
    nginx.ingress.kubernetes.io/proxy-send-timeout: "600"
    nginx.ingress.kubernetes.io/auth-secret: basic-auth
    nginx.ingress.kubernetes.io/auth-realm: "Authentication Required - lab2"

service:
  http:
    serviceType: ClusterIP
    port: 3000
    externalPort: 8280
    externalHost: git.example.com
  ssh:
    serviceType: NodePort
    port: 22
    nodePort: 30222
    externalPort: 8022
    externalHost: git.example.com

persistence:
  enabled: true
  giteaSize: 10Gi
  postgresSize: 5Gi
  storageClass: glusterfs
  accessMode: ReadWriteMany
  annotations:
    "helm.sh/resource-policy": keep

Uninstalling the Chart

To uninstall/delete the gitea deployment:

$ helm uninstall gitea --namespace gitea

The command removes all the Kubernetes components associated with the chart and deletes the release.

Data Management

This chart will use and create optional persistent volume claims for both postgres (if using in pod db) and gitea data. By default the data will be deleted upon uninstalling the chart. This is not ideal but can be managed in a couple ways:

  • prevent helm from deleting the pvcs it creates. Do this by enabling annotation: helm.sh/resource-policy": keep in the pvc optional annotations
persistence:
  annotations:
    "helm.sh/resource-policy": keep
  • create a pvc outside the chart and configure the chart to use it. Do this by setting the persistence existingGiteaClaim and existingPostgresClaim properties.
 existingGiteaClaim: gitea-gitea
 existingPostgresClaim: gitea-postgres

a trick that can be is used to first set the helm.sh/resource-policy annotation so that the chart generates the pvcs, but doesn't delete them. Upon next deplyment set the exsiting claim names to the generated values.

Ingress And External Host/Ports

Gitea requires ports to be exposed for both web and ssh traffic. The chart is flexible and allow a combination of either ingresses, loadblancer, or nodeport services.

To expose the web application this chart will generate an ingress using the ingress controller of choice if specified. If an ingress is enabled services.http.externalHost must be specified. To expose SSH services it relies on either a LoadBalancer or NodePort.

Configuration

Refer to values.yaml for the full run-down on defaults.

The following table lists the configurable parameters of this chart and their default values.

Parameter Description Default
images.gitea gitea image gitea/gitea:1.12.4
images.postgres postgres image postgres:9.6
images.imagePullPolicy Image pull policy Always if imageTag is latest, else IfNotPresent
images.imagePullSecrets Image pull secrets nil
ingress.enabled Switch to create ingress for this chart deployment false
ingress.useSSL Changes default protocol to SSL? false
ingress.ingress_annotations annotations used by the ingress nil
service.http.serviceType type of kubernetes services used for http i.e. ClusterIP, NodePort or LoadBalancer ClusterIP
service.http.port http port for web traffic 3000
service.http.NodePort Manual NodePort for web traffic nil
service.http.externalPort Port exposed on the internet by a load balancer or firewall that redirects to the ingress or NodePort nil
service.http.externalHost IP or DNS name exposed on the internet by a load balancer or firewall that redirects to the ingress or Node for http traffic nil
service.http.loadBalancerIP If the service is a LoadBalancer you can pre-allocate its IP address here unset
service.http.svc_annotations Set annotations for the http svc object. []
service.ssh.serviceType type of kubernetes services used for ssh i.e. ClusterIP, NodePort or LoadBalancer ClusterIP
service.ssh.port http port for web traffic 22
service.ssh.NodePort Manual NodePort for ssh traffic nil
service.ssh.externalPort Port exposed on the internet by a load balancer or firewall that redirects to the ingress or NodePort nil
service.ssh.externalHost IP or DNS name exposed on the internet by a load balancer or firewall that redirects to the ingress or Node for http traffic
service.ssh.loadBalancerIP If the service is a LoadBalancer you can pre-allocate its IP address here unset
service.ssh.svc_annotations Set annotations for the ssh svc object. E.g. needed when using a load balancer and it should be a private load balancer instead of public. []
resources.gitea.requests.memory gitea container memory request 100Mi
resources.gitea.requests.cpu gitea container request cpu 500m
resources.gitea.limits.memory gitea container memory limits 2Gi
resources.gitea.limits.cpu gitea container CPU/Memory resource requests/limits Memory: 1
resources.postgres.requests.memory postgres container memory request 256Mi
resources.postgres.requests.cpu gitea container request cpu 100m
persistence.enabled Create PVCs to store gitea and postgres data? false
persistence.existingGiteaClaim Already existing PVC that should be used for gitea data. nil
persistence.existingPostgresClaim Already existing PVC that should be used for postgres data. []
persistence.giteaSize Size of gitea pvc to create 10Gi
persistence.postgresSize Size of postgres pvc to create 5Gi
persistence.storageClass NStorageClass to use for dynamic provision if not 'default' nil
persistence.annotations Annotations to set on created PVCs nil
dbType type of database storage "postgres"
useInPodPostgres create a postgres pos for db storage -must use externalDB if false true
externalDB.dbUser external db user unset
externalDB.dbPassword external db password unset
externalDB.dbHost external db host unset
externalDB.dbPort external db port - integer value (ex: 5432) unset
externalDB.dbDatabase external db database name unset
inPodPostgres.secret Generated Secret to store postgres passwords postgressecrets
inPodPostgres.subPath Subpath for Postgres data storage nil
inPodPostgres.dataMountPath Path for Postgres data storage nil
affinity Affinity settings for pod assignment {}
tolerations Toleration labels for pod assignment []
config.offlineMode Sets Gitea's Offline Mode. Values are true or false. false
config.disableRegistration Disable Gitea's user registration. Values are true or false. false
config.requireSignin Require Gitea user to be signed in to see any pages. Values are true or false. false
config.openidSignin Allow login with OpenID. Values are true or false. true
config.notifyMail Mail notification. Values are true or false. false
config.mailer.enabled Enable gitea mailer. Values are true or false. false
config.mailer.host Hostname of the mail server. unset
config.mailer.port Port of the mail server. Note, if the port ends with "465", SMTPS will be used. Using STARTTLS on port 587 is recommended per RFC 6409. If the server supports STARTTLS it will always be used. unset
config.mailer.tls Should SMTP connection use TLS. Values are true or false. false
config.mailer.from Mail from address, RFC 5322. This can be just an email address, or the "Name" <[email protected]> format. unset
config.mailer.user Mailer user name. unset
config.mailer.passwd Use PASSWD = your password for quoting if you use special characters in the password.. unset
config.metrics.enabled Enables metrics endpoint. Values are true or false. false
config.metrics.token If you want to add authorization, specify a token for metrics endpoint. unset