bitnamicharts/oauth2-proxy
Bitnami Helm chart for OAuth2 Proxy
100K+
A reverse proxy and static file server that provides authentication using Providers (Google, GitHub, and others) to validate accounts by email, domain or group.
Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.
helm install my-release oci://registry-1.docker.io/bitnamicharts/oauth2-proxy
Looking to use OAuth2 Proxy in production? Try VMware Tanzu Application Catalog, the commercial edition of the Bitnami catalog.
Bitnami charts for Helm are carefully engineered, actively maintained and are the quickest and easiest way to deploy containers on a Kubernetes cluster that are ready to handle production workloads.
This chart bootstraps a OAuth2 Proxy Deployment in a Kubernetes cluster using the Helm package manager.
Bitnami charts can be used with Kubeapps for deployment and management of Helm Charts in clusters.
To install the chart with the release name my-release
:
helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/oauth2-proxy
Note: You need to substitute the placeholders
REGISTRY_NAME
andREPOSITORY_NAME
with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to useREGISTRY_NAME=registry-1.docker.io
andREPOSITORY_NAME=bitnamicharts
.
The command deploys OAuth2 Proxy on the Kubernetes cluster in the default configuration. The Parameters section lists the parameters that can be configured during installation.
Tip: List all releases using
helm list
Bitnami charts allow setting resource requests and limits for all containers inside the chart deployment. These are inside the resources
value (check parameter table). Setting requests is essential for production workloads and these should be adapted to your specific use case.
To make this process easier, the chart contains the resourcesPreset
values, which automatically sets the resources
section according to different presets. Check these presets in the bitnami/common chart. However, in production workloads using resourcesPreset
is discouraged as it may not fully adapt to your specific needs. Find more information on container resource management in the official Kubernetes documentation.
It is strongly recommended to use immutable tags in a production environment. This ensures your deployment does not change automatically if the same tag is updated with a different image.
Bitnami will release a new chart updating its containers if a new version of the main container, significant changes, or critical vulnerabilities exist.
This chart provides support for Ingress resources. If you have an ingress controller installed on your cluster, such as nginx-ingress-controller or contour you can utilize the ingress controller to serve your application.
To enable Ingress integration, set ingress.enabled
to true
. The ingress.hostname
property can be used to set the host name. The ingress.tls
parameter can be used to add the TLS configuration for this host. It is also possible to have more than one host, with a separate TLS configuration for each host.
The chart also facilitates the creation of TLS secrets for use with the Ingress controller, with different options for certificate management.
In case you want to add extra environment variables (useful for advanced operations like custom init scripts), you can use the extraEnvVars
property.
extraEnvVars:
- name: LOG_LEVEL
value: error
Alternatively, you can use a ConfigMap or a Secret with the environment variables. To do so, use the extraEnvVarsCM
or the extraEnvVarsSecret
values.
If additional containers are needed in the same pod as OAuth2 Proxy (such as additional metrics or logging exporters), they can be defined using the sidecars
parameter.
sidecars:
- name: your-image-name
image: your-image
imagePullPolicy: Always
ports:
- name: portname
containerPort: 1234
If these sidecars export extra ports, extra port definitions can be added using the service.extraPorts
parameter (where available), as shown in the example below:
service:
extraPorts:
- name: extraPort
port: 11311
targetPort: 11311
NOTE: This Helm chart already includes sidecar containers for the Prometheus exporters (where applicable). These can be activated by adding the
--enable-metrics=true
parameter at deployment time. Thesidecars
parameter should therefore only be used for any extra sidecar containers.
If additional init containers are needed in the same pod, they can be defined using the initContainers
parameter. Here is an example:
initContainers:
- name: your-image-name
image: your-image
imagePullPolicy: Always
ports:
- name: portname
containerPort: 1234
Learn more about sidecar containers and init containers.
This chart allows you to set your custom affinity using the affinity
parameter. Find more information about Pod affinity in the kubernetes documentation.
As an alternative, use one of the preset configurations for pod affinity, pod anti-affinity, and node affinity available at the bitnami/common chart. To do so, set the podAffinityPreset
, podAntiAffinityPreset
, or nodeAffinityPreset
parameters.
To back up and restore Helm chart deployments on Kubernetes, you need to back up the persistent volumes from the source deployment and attach them to a new deployment using Velero, a Kubernetes backup/restore tool. Find the instructions for using Velero in this guide.
The Bitnami OAuth2 Proxy image stores the OAuth2 Proxy data and configurations at the /bitnami
path of the container. Persistent Volume Claims are used to keep the data across deployments.
Name | Description | Value |
---|---|---|
global.imageRegistry | Global Docker image registry | "" |
global.imagePullSecrets | Global Docker registry secret names as an array | [] |
global.defaultStorageClass | Global default StorageClass for Persistent Volume(s) | "" |
global.storageClass | DEPRECATED: use global.defaultStorageClass instead | "" |
global.security.allowInsecureImages | Allows skipping image verification | false |
global.compatibility.openshift.adaptSecurityContext | Adapt the securityContext sections of the deployment to make them compatible with Openshift restricted-v2 SCC: remove runAsUser, runAsGroup and fsGroup and let the platform use their allowed default IDs. Possible values: auto (apply if the detected running cluster is Openshift), force (perform the adaptation always), disabled (do not perform adaptation) | auto |
Name | Description | Value |
---|---|---|
kubeVersion | Override Kubernetes version | "" |
nameOverride | String to partially override common.names.fullname | "" |
fullnameOverride | String to fully override common.names.fullname | "" |
commonLabels | Labels to add to all deployed objects | {} |
commonAnnotations | Annotations to add to all deployed objects | {} |
clusterDomain | Kubernetes cluster domain name | cluster.local |
extraDeploy | Array of extra objects to deploy with the release | [] |
diagnosticMode.enabled | Enable diagnostic mode (all probes will be disabled and the command will be overridden) | false |
diagnosticMode.command | Command to override all containers in the deployment | ["sleep"] |
diagnosticMode.args | Args to override all containers in the deployment | ["infinity"] |
Name | Description | Value |
---|---|---|
service.type | OAuth2 Proxy service type | ClusterIP |
service.port | OAuth2 Proxy service HTTP port | 80 |
service.nodePorts.http | Node port for HTTP | "" |
service.clusterIP | OAuth2 Proxy service Cluster IP | "" |
service.loadBalancerIP | OAuth2 Proxy service Load Balancer IP | "" |
service.loadBalancerSourceRanges | OAuth2 Proxy service Load Balancer sources | [] |
service.externalTrafficPolicy | OAuth2 Proxy service external traffic policy | Cluster |
service.extraPorts | Extra ports to expose (normally used with the sidecar value) | [] |
service.annotations | Additional custom annotations for OAuth2 Proxy service | {} |
service.sessionAffinity | Session Affinity for Kubernetes service, can be "None" or "ClientIP" | None |
service.sessionAffinityConfig | Additional settings for the sessionAffinity | {} |
networkPolicy.enabled | Specifies whether a NetworkPolicy should be created | true |
networkPolicy.allowExternal | Don't require server label for connections | true |
networkPolicy.allowExternalEgress | Allow the pod to access any range of port and all destinations. | true |
networkPolicy.extraIngress | Add extra ingress rules to the NetworkPolicy | [] |
networkPolicy.extraEgress | Add extra ingress rules to the NetworkPolicy | [] |
networkPolicy.ingressNSMatchLabels | Labels to match to allow traffic from other namespaces | {} |
networkPolicy.ingressNSPodMatchLabels | Pod labels to match to allow traffic from other namespaces | {} |
ingress.enabled | Enable ingress record generation for OAuth2 Proxy | false |
ingress.pathType | Ingress path type | ImplementationSpecific |
ingress.apiVersion | Force Ingress API version (automatically detected if not set) | "" |
ingress.ingressClassName | IngressClass that will be be used to implement the Ingress (Kubernetes 1.18+) | "" |
ingress.hostname | Default host for the ingress record | oaut2-proxy.local |
ingress.path | Default path for the ingress record | / |
ingress.annotations | Additional annotations for the Ingress resource. To enable certificate autogeneration, place here your cert-manager annotations. | {} |
ingress.tls | Enable TLS configuration for the host defined at ingress.hostname parameter | false |
ingress.extraHosts | An array with additional hostname(s) to be covered with the ingress record | [] |
ingress.extraPaths | An array with additional arbitrary paths that may need to be added to the ingress under the main host | [] |
ingress.extraTls | TLS configuration for additional hostname(s) to be covered with this ingress record | [] |
ingress.certManager | Add the corresponding annotations for cert-manager integration | false |
ingress.selfSigned | Create a TLS secret for this ingress record using self-signed certificates generated by Helm | false |
ingress.secrets | Custom TLS certificates as secrets | [] |
ingress.existingSecretName | If you're providing your own certificate and want to manage the secret yourself | "" |
ingress.extraRules | Additional rules to be covered with this ingress record | [] |
Name | Description | Value |
---|---|---|
image.registry | OAuth2 Proxy image registry | REGISTRY_NAME |
image.repository | OAuth2 Proxy image repository | REPOSITORY_NAME/oauth2-proxy |
image.digest | OAuth2 Proxy image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag | "" |
image.pullPolicy | OAuth2 Proxy image pull policy | IfNotPresent |
image.pullSecrets | OAuth2 Proxy image pull secrets | [] |
Name | Description | Value |
---|---|---|
configuration.clientID | OAuth client ID | XXXXXXX |
configuration.clientSecret | OAuth client secret | XXXXXXXX |
configuration.cookieSecret | OAuth cookie secret | XXXXXXXXXXXXXXXX |
configuration.existingSecret | Secret with the client ID, secret and cookie secret | "" |
configuration.google.enabled | Enable Google service account | false |
configuration.google.useApplicationDefaultCredentials | Use the application-default credentials (i.e. Workload Identity on GKE) instead of providing a service account JSON | false |
configuration.google.adminEmail | Google admin email | "" |
configuration.google.groups | Restrict logins to members of these google groups | [] |
configuration.google.serviceAccountJson | Google Service account JSON | "" |
configuration.google.existingSecret | Existing secret containing Google Service Account | "" |
configuration.content | Default configuration | "" |
configuration.existingConfigmap | Configmap with the OAuth2 Proxy configuration | "" |
configuration.authenticatedEmailsFile.enabled | Enable authenticated emails file | false |
configuration.authenticatedEmailsFile.content | Restricted access list (one email per line) | "" |
configuration.authenticatedEmailsFile.existingSecret | Secret with the authenticated emails file | "" |
`configuration.htpasswdFile |
Note: the README for this chart is longer than the DockerHub length limit of 25000, so it has been trimmed. The full README can be found at https://github.com/bitnami/charts/blob/main/bitnami/oauth2-proxy/README.md