mirror of
https://github.com/k8s-at-home/charts.git
synced 2025-01-23 15:39:02 +00:00
chore: Auto-update chart README [skip ci]
This commit is contained in:
k8s-at-home[bot]
parent
5475a5ffff
commit
0d229ec376
@ -1,6 +1,6 @@
|
||||
# traefik-forward-auth
|
||||
|
||||
  
|
||||
 
|
||||
|
||||
A minimal forward authentication service that provides OAuth/SSO login and authentication for the traefik reverse proxy/load balancer
|
||||
|
||||
@ -13,10 +13,13 @@ A minimal forward authentication service that provides OAuth/SSO login and authe
|
||||
|
||||
## Requirements
|
||||
|
||||
Kubernetes: `>=1.16.0-0`
|
||||
|
||||
## Dependencies
|
||||
|
||||
| Repository | Name | Version |
|
||||
|------------|------|---------|
|
||||
| https://library-charts.k8s-at-home.com | common | 4.3.0 |
|
||||
|
||||
## TL;DR
|
||||
|
||||
@ -73,101 +76,33 @@ N/A
|
||||
|
||||
| Key | Type | Default | Description |
|
||||
|-----|------|---------|-------------|
|
||||
| affinity | object | `{}` | |
|
||||
| authHost | string | `""` | Single host to use when returning from 3rd party auth |
|
||||
| autoscaling.enabled | bool | `false` | |
|
||||
| autoscaling.maxReplicas | int | `100` | |
|
||||
| autoscaling.minReplicas | int | `1` | |
|
||||
| autoscaling.targetCPUUtilizationPercentage | int | `80` | |
|
||||
| cookie.csrfName | string | `""` | CSRF Cookie Name (default: _forward_auth_csrf) |
|
||||
| cookie.domain | string | `""` | Domain(s) to set auth cookie on. (Comma delimited) |
|
||||
| cookie.insecure | string | `""` | Use insecure cookies |
|
||||
| cookie.name | string | `""` | Cookie Name (default: _forward_auth) |
|
||||
| cookie.secret | string | `""` | Cookie Secret used for authentication across multiple instances / clusters (default: randomly generated) |
|
||||
| default.action | string | `""` | [auth|allow] Default action (default: auth) |
|
||||
| default.provider | string | `""` | [google|oidc|generic-oauth] Default provider (default: google) |
|
||||
| env | list | `[]` | |
|
||||
| envFrom | string | `nil` | |
|
||||
| fullnameOverride | string | `""` | |
|
||||
| image.pullPolicy | string | `"IfNotPresent"` | |
|
||||
| image.repository | string | `"thomseddon/traefik-forward-auth"` | |
|
||||
| image.tag | string | `""` | |
|
||||
| imagePullSecrets | list | `[]` | |
|
||||
| ingress.annotations | object | `{}` | |
|
||||
| ingress.enabled | bool | `false` | |
|
||||
| ingress.hosts[0].host | string | `"chart-example.local"` | |
|
||||
| ingress.hosts[0].paths | list | `[]` | |
|
||||
| ingress.tls | list | `[]` | |
|
||||
| lifetime | string | `""` | Lifetime in seconds (default: 43200) |
|
||||
| livenessProbe | object | {"periodSeconds":20,"tcpSocket":{"port":"http"}} | Liveness probe configuration |
|
||||
| livenessProbe.enabled | bool | `true` | Enable liveness probe |
|
||||
| logging.format | string | `""` | [text|json|pretty] Log format (default: text) |
|
||||
| logging.level | string | `""` | [trace|debug|info|warn|error|fatal|panic] Log level (default: warn) |
|
||||
| logoutRedirect | string | `""` | URL to redirect to following logout |
|
||||
| middleware.enabled | bool | `false` | Enable to deploy a preconfigured middleware |
|
||||
| middleware.name | string | `""` | Name for the middleware |
|
||||
| nameOverride | string | `""` | |
|
||||
| nodeSelector | object | `{}` | |
|
||||
| podAnnotations | object | `{}` | |
|
||||
| podSecurityContext | object | `{}` | |
|
||||
| providers.genericOauth.authUrl | string | `""` | Auth/Login URL |
|
||||
| providers.genericOauth.clientId | string | `""` | Client ID |
|
||||
| providers.genericOauth.clientSecret | string | `""` | Client Secret |
|
||||
| providers.genericOauth.enabled | bool | `false` | Enable the generic OAUTH2 provider |
|
||||
| providers.genericOauth.resource | string | `""` | Optional resource indicator |
|
||||
| providers.genericOauth.scope | string | `""` | Scopes (default: profile, email) |
|
||||
| providers.genericOauth.tokenStyle | string | `""` | How token is presented when querying the User URL |
|
||||
| providers.genericOauth.tokenUrl | string | `""` | Token URL |
|
||||
| providers.genericOauth.userUrl | string | `""` | URL used to retrieve user info |
|
||||
| providers.google.clientId | string | `""` | Client ID |
|
||||
| providers.google.clientSecret | string | `""` | Client Secret |
|
||||
| providers.google.enabled | bool | `false` | Enable the google provider |
|
||||
| providers.google.prompt | string | `""` | Space separated list of OpenID prompt options |
|
||||
| providers.oidc.clientId | string | `""` | Client ID |
|
||||
| providers.oidc.clientSecret | string | `""` | Client Secret |
|
||||
| providers.oidc.enabled | bool | `false` | Enable the generic OIDC provider |
|
||||
| providers.oidc.issuerUrl | string | `""` | Issuer URL |
|
||||
| providers.oidc.resource | string | `""` | Optional resource indicator |
|
||||
| readinessProbe | object | {"periodSeconds":10,"tcpSocket":{"port":"http"}} | Readiness probe configuration |
|
||||
| readinessProbe.enabled | bool | `true` | Enable readiness probe |
|
||||
| replicaCount | int | `1` | |
|
||||
| resources | object | `{}` | |
|
||||
| restrictions.domain | string | `""` | Only allow given email domains. (Comma delimited) |
|
||||
| restrictions.whitelist | string | `""` | Only allow given email addresses. (Comma delimited) |
|
||||
| secret | string | `""` | Secret used for signing. If empty, one will be generated. If specifying your own in env use "-" |
|
||||
| securityContext | object | `{}` | |
|
||||
| service.additionalSpec | object | `{}` | |
|
||||
| service.annotations | object | `{}` | |
|
||||
| service.labels | object | `{}` | |
|
||||
| service.port | int | `4181` | |
|
||||
| service.type | string | `"ClusterIP"` | |
|
||||
| serviceAccount.annotations | object | `{}` | |
|
||||
| serviceAccount.create | bool | `true` | |
|
||||
| serviceAccount.name | string | `""` | |
|
||||
| tolerations | list | `[]` | |
|
||||
| urlPath | string | `""` | Callback URL Path (default: /_oauth) |
|
||||
| env | object | See below | environment variables. See more environment variables in the [traefik-forward-auth documentation](https://github.com/thomseddon/traefik-forward-auth#configuration) |
|
||||
| image.pullPolicy | string | `"IfNotPresent"` | image pull policy |
|
||||
| image.repository | string | `"thomseddon/traefik-forward-auth"` | image repository |
|
||||
| image.tag | string | chart.appVersion | image tag |
|
||||
| middleware.enabled | bool | `true` | Enable a preconfigured middleware. |
|
||||
| middleware.nameOverride | string | `""` | Override the middleware name. |
|
||||
| service | object | See values.yaml | Configures service settings for the chart. |
|
||||
|
||||
## Changelog
|
||||
|
||||
All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common#changelog).
|
||||
|
||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||
|
||||
### [1.0.6]
|
||||
### Version 2.0.0
|
||||
|
||||
#### Added
|
||||
|
||||
- N/A
|
||||
* **BREAKING** Added `common` chart dependency. This will likely require you to update your chart values.
|
||||
|
||||
#### Changed
|
||||
|
||||
- use helm-docs
|
||||
* Reuse existing secret if present.
|
||||
|
||||
#### Removed
|
||||
#### Fixed
|
||||
|
||||
- N/A
|
||||
N/A
|
||||
|
||||
[1.0.6]: #1.0.6
|
||||
### Older versions
|
||||
|
||||
A historical overview of changes can be found on [ArtifactHUB](https://artifacthub.io/packages/helm/k8s-at-home/traefik-forward-auth?modal=changelog)
|
||||
|
||||
## Support
|
||||
|
||||
@ -177,4 +112,4 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
||||
|
||||
----------------------------------------------
|
||||
Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
|
||||
Autogenerated from chart metadata using [helm-docs v0.1.1](https://github.com/k8s-at-home/helm-docs/releases/v0.1.1)
|
||||
|
||||
@ -106,6 +106,36 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -
|
||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.changelog" -}}
|
||||
{{ $changeTypes := list "added" "changed" "fixed" }}
|
||||
## Changelog
|
||||
|
||||
### Version {{ template "chart.version" . }}
|
||||
|
||||
{{ range $changeType := $changeTypes }}
|
||||
{{- with (index $.Annotations "artifacthub.io/changes") }}
|
||||
{{- print "#### " ($changeType | title) | nindent 0 }}
|
||||
{{- print "" | nindent 0 }}
|
||||
{{- $changesFound := false }}
|
||||
{{- range (print "changes:\n" . | fromYaml).changes }}
|
||||
{{- if eq .kind $changeType }}
|
||||
{{- print "* " .description | nindent 0 }}
|
||||
{{- $changesFound = true }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- if not $changesFound }}
|
||||
{{- print "N/A" | nindent 0 }}
|
||||
{{- end }}
|
||||
{{- print "" | nindent 0 }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
|
||||
### Older versions
|
||||
|
||||
A historical overview of changes can be found on [ArtifactHUB](https://artifacthub.io/packages/helm/k8s-at-home/{{- template "chart.name" . }}?modal=changelog)
|
||||
|
||||
{{- end -}}
|
||||
|
||||
{{ template "chart.header" . }}
|
||||
|
||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
||||
|
||||
Loading…
Reference in New Issue
Block a user