Fix minor README flaws #184
42
README.md
42
README.md
@ -23,6 +23,7 @@ Dependencies:
|
||||
|
||||
```sh
|
||||
helm repo add gitea-charts https://dl.gitea.io/charts/
|
||||
helm repo update
|
||||
helm install gitea gitea-charts/gitea
|
||||
```
|
||||
|
||||
@ -147,7 +148,7 @@ By default port 3000 is used for web traffic and 22 for ssh. Those can be change
|
||||
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.
|
||||
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
|
||||
|
||||
@ -213,7 +214,6 @@ 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.
|
||||
@ -347,7 +347,7 @@ gitea:
|
||||
|
||||
### OAuth2 Settings
|
||||
|
||||
Like the admin user the OAuth2 settings can be updated but also disabled or deleted.
|
||||
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 from <https://docs.gitea.io/en-us/command-line/#admin> are available.
|
||||
You can either use them in camel case or kebab case.
|
||||
|
||||
@ -420,10 +420,10 @@ Annotations can be added to the Gitea pod.
|
||||
|
||||
| Parameter | Description | Default |
|
||||
|-------------------------------------------|--------------------------------------------------------|-------------|
|
||||
| statefulset.terminationGracePeriodSeconds | Image to start for this pod | gitea/gitea |
|
||||
| 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 volumes mounts for the Gitea containers | {} |
|
||||
| extraVolumeMounts | Additional volume mounts for the Gitea containers | {} |
|
||||
| initPreScript | Bash script copied verbatim to start of init container | |
|
||||
| securityContext | Run as a specific securityContext | {} |
|
||||
| schedulerName | Use an alternate scheduler, e.g. "stork" | |
|
||||
@ -460,6 +460,8 @@ Annotations can be added to the Gitea pod.
|
||||
|
||||
### Service
|
||||
|
||||
#### Web
|
||||
|
||||
| Parameter | Description | Default |
|
||||
|---------------------|-----------------------------------|------------------------------|
|
||||
|service.http.type| Kubernetes service type for web traffic | ClusterIP |
|
||||
@ -468,16 +470,20 @@ Annotations can be added to the Gitea pod.
|
||||
|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 | 3000 |
|
||||
|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 | 3000 |
|
||||
|service.ssh.externalIPs| ssh service external IP addresses | |
|
||||
|service.ssh.loadBalancerSourceRanges| Source range filter for ssh loadbalancer | [] |
|
||||
|service.ssh.annotations| ssh service annotations | |
|
||||
|
||||
@ -485,7 +491,7 @@ Annotations can be added to the Gitea pod.
|
||||
|
||||
| Parameter | Description | Default |
|
||||
|---------------------|-----------------------------------|------------------------------|
|
||||
|gitea.config | Everything in app.ini can be configured with this dict. See Examples for more details | {} |
|
||||
|gitea.config | Everything in `app.ini` can be configured with this dict. See [Examples](#examples) for more details | {} |
|
||||
|
||||
### Gitea Probes
|
||||
|
||||
@ -500,13 +506,13 @@ Configure Liveness, Readiness and Startup [Probes](https://kubernetes.io/docs/ta
|
||||
|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.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 | 10 |
|
||||
|gitea.readinessProbe.failureThreshold | Minimum consecutive error probes | 3 |
|
||||
|gitea.startupProbe.enabled | Enable startup probe | false |
|
||||
|gitea.startupProbe.initialDelaySeconds | Delay before probe start| 200 |
|
||||
|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 |
|
||||
@ -527,22 +533,22 @@ The following parameters are the defaults set by this chart
|
||||
|
||||
### 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)
|
||||
Mysql is loaded as a dependency from stable. Configuration can be found on 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.root.password|Password for the root user. Ignored if existing secret is provided|gitea|
|
||||
|mysql.db.user|Username of new user to create.|gitea|
|
||||
|mysql.db.password|Password for the new user. Ignored if existing secret is provided|gitea|
|
||||
|mysql.db.name|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](https://github.com/bitnami/charts/tree/master/bitnami/postgresql) repository.
|
||||
Postgresql is loaded as a dependency from Bitnami. The chart configuration can be found in this [Bitnami](https://github.com/bitnami/charts/tree/master/bitnami/postgresql) repository.
|
||||
|
||||
The following parameters are the defaults set by this chart
|
||||
|
||||
@ -556,7 +562,7 @@ The following parameters are the defaults set by this chart
|
||||
|
||||
### 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)
|
||||
MariaDB is loaded as a dependency from bitnami. Configuration can be found in this [Bitnami](https://github.com/bitnami/charts/tree/master/bitnami/mariadb) repository.
|
||||
|
||||
The following parameters are the defaults set by this chart
|
||||
|
||||
|
||||
@ -210,6 +210,7 @@ gitea:
|
||||
startupProbe:
|
||||
enabled: false
|
||||
initialDelaySeconds: 60
|
||||
timeoutSeconds: 1
|
||||
periodSeconds: 10
|
||||
successThreshold: 1
|
||||
failureThreshold: 10
|
||||
|
||||
Reference in New Issue
Block a user