Tanzu Application Catalog services

Bitnami package for OAuth2 Proxy

Last Updated March 07, 2025

A reverse proxy and static file server that provides authentication using Providers (Google, GitHub, and others) to validate accounts by email, domain or group.

Overview of OAuth2 Proxy

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.

TL;DR

helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/oauth2-proxy

Note: You need to substitute the placeholders REGISTRY_NAME and REPOSITORY_NAME with a reference to your Helm chart registry and repository.

Introduction

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.

Prerequisites

  • Kubernetes 1.23+
  • Helm 3.8.0+
  • PV provisioner support in the underlying infrastructure
  • ReadWriteMany volumes for deployment scaling

Installing the Chart

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 and REPOSITORY_NAME with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to use REGISTRY_NAME=registry-1.docker.io and REPOSITORY_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

Configuration and installation details

Resource requests and limits

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.

Rolling VS Immutable tags

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.

Ingress

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.

Securing traffic using TLS

The chart also facilitates the creation of TLS secrets for use with the Ingress controller, with different options for certificate management.

Additional environment variables

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.

Sidecars

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. The sidecars 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.

Pod affinity

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.

Backup and restore

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.

Persistence

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.

Parameters

Global parameters

NameDescriptionValue
global.imageRegistryGlobal Docker image registry""
global.imagePullSecretsGlobal Docker registry secret names as an array[]
global.defaultStorageClassGlobal default StorageClass for Persistent Volume(s)""
global.storageClassDEPRECATED: use global.defaultStorageClass instead""
global.security.allowInsecureImagesAllows skipping image verificationfalse
global.compatibility.openshift.adaptSecurityContextAdapt 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

Common parameters

NameDescriptionValue
kubeVersionOverride Kubernetes version""
nameOverrideString to partially override common.names.fullname""
fullnameOverrideString to fully override common.names.fullname""
commonLabelsLabels to add to all deployed objects{}
commonAnnotationsAnnotations to add to all deployed objects{}
clusterDomainKubernetes cluster domain namecluster.local
extraDeployArray of extra objects to deploy with the release[]
diagnosticMode.enabledEnable diagnostic mode (all probes will be disabled and the command will be overridden)false
diagnosticMode.commandCommand to override all containers in the deployment["sleep"]
diagnosticMode.argsArgs to override all containers in the deployment["infinity"]

Traffic Exposure Parameters

NameDescriptionValue
service.typeOAuth2 Proxy service typeClusterIP
service.portOAuth2 Proxy service HTTP port80
service.nodePorts.httpNode port for HTTP""
service.clusterIPOAuth2 Proxy service Cluster IP""
service.loadBalancerIPOAuth2 Proxy service Load Balancer IP""
service.loadBalancerSourceRangesOAuth2 Proxy service Load Balancer sources[]
service.externalTrafficPolicyOAuth2 Proxy service external traffic policyCluster
service.extraPortsExtra ports to expose (normally used with the sidecar value)[]
service.annotationsAdditional custom annotations for OAuth2 Proxy service{}
service.sessionAffinitySession Affinity for Kubernetes service, can be “None” or “ClientIP”None
service.sessionAffinityConfigAdditional settings for the sessionAffinity{}
networkPolicy.enabledSpecifies whether a NetworkPolicy should be createdtrue
networkPolicy.allowExternalDon’t require server label for connectionstrue
networkPolicy.allowExternalEgressAllow the pod to access any range of port and all destinations.true
networkPolicy.extraIngressAdd extra ingress rules to the NetworkPolicy[]
networkPolicy.extraEgressAdd extra ingress rules to the NetworkPolicy[]
networkPolicy.ingressNSMatchLabelsLabels to match to allow traffic from other namespaces{}
networkPolicy.ingressNSPodMatchLabelsPod labels to match to allow traffic from other namespaces{}
ingress.enabledEnable ingress record generation for OAuth2 Proxyfalse
ingress.pathTypeIngress path typeImplementationSpecific
ingress.apiVersionForce Ingress API version (automatically detected if not set)""
ingress.ingressClassNameIngressClass that will be be used to implement the Ingress (Kubernetes 1.18+)""
ingress.hostnameDefault host for the ingress recordoaut2-proxy.local
ingress.pathDefault path for the ingress record/
ingress.annotationsAdditional annotations for the Ingress resource. To enable certificate autogeneration, place here your cert-manager annotations.{}
ingress.tlsEnable TLS configuration for the host defined at ingress.hostname parameterfalse
ingress.extraHostsAn array with additional hostname(s) to be covered with the ingress record[]
ingress.extraPathsAn array with additional arbitrary paths that may need to be added to the ingress under the main host[]
ingress.extraTlsTLS configuration for additional hostname(s) to be covered with this ingress record[]
ingress.certManagerAdd the corresponding annotations for cert-manager integrationfalse
ingress.selfSignedCreate a TLS secret for this ingress record using self-signed certificates generated by Helmfalse
ingress.secretsCustom TLS certificates as secrets[]
ingress.existingSecretNameIf you’re providing your own certificate and want to manage the secret yourself""
ingress.extraRulesAdditional rules to be covered with this ingress record[]

OAuth2 Proxy Image parameters

NameDescriptionValue
image.registryOAuth2 Proxy image registryREGISTRY_NAME
image.repositoryOAuth2 Proxy image repositoryREPOSITORY_NAME/oauth2-proxy
image.digestOAuth2 Proxy image digest in the way sha256:aa…. Please note this parameter, if set, will override the tag""
image.pullPolicyOAuth2 Proxy image pull policyIfNotPresent
image.pullSecretsOAuth2 Proxy image pull secrets[]

OAuth2 Proxy configuration parameters

NameDescriptionValue
configuration.clientIDOAuth client IDXXXXXXX
configuration.clientSecretOAuth client secretXXXXXXXX
configuration.cookieSecretOAuth cookie secretXXXXXXXXXXXXXXXX
configuration.existingSecretSecret with the client ID, secret and cookie secret""
configuration.google.enabledEnable Google service accountfalse
configuration.google.useApplicationDefaultCredentialsUse the application-default credentials (i.e. Workload Identity on GKE) instead of providing a service account JSONfalse
configuration.google.adminEmailGoogle admin email""
configuration.google.groupsRestrict logins to members of these google groups[]
configuration.google.serviceAccountJsonGoogle Service account JSON""
configuration.google.existingSecretExisting secret containing Google Service Account""
configuration.contentDefault configuration""
configuration.existingConfigmapConfigmap with the OAuth2 Proxy configuration""
configuration.authenticatedEmailsFile.enabledEnable authenticated emails filefalse
configuration.authenticatedEmailsFile.contentRestricted access list (one email per line)""
configuration.authenticatedEmailsFile.existingSecretSecret with the authenticated emails file""
configuration.htpasswdFile.enabledEnable htpasswd filefalse
configuration.htpasswdFile.existingSecretExisting secret for htpasswd file""
configuration.htpasswdFile.contenthtpasswd file entries (one row per user)""
configuration.oidcIssuerUrlOpenID Connect issuer URL""
configuration.redirectUrlOAuth Redirect URL""
configuration.whiteListAllowed domains for redirection after authentication. Prefix domain with a . or a *. to allow subdomains""

OAuth2 Proxy deployment parameters

NameDescriptionValue
containerPortOAuth2 Proxy port number4180
extraContainerPortsArray of additional container ports for the OAuth2 Proxy container[]
replicaCountNumber of OAuth2 Proxy replicas to deploy1
extraArgsadd extra args to the default command[]
startupProbe.enabledEnable startupProbe on OAuth2 Proxy nodesfalse
startupProbe.initialDelaySecondsInitial delay seconds for startupProbe0
startupProbe.periodSecondsPeriod seconds for startupProbe10
startupProbe.timeoutSecondsTimeout seconds for startupProbe1
startupProbe.failureThresholdFailure threshold for startupProbe5
startupProbe.successThresholdSuccess threshold for startupProbe1
livenessProbe.enabledEnable livenessProbe on OAuth2 Proxy nodestrue
livenessProbe.initialDelaySecondsInitial delay seconds for livenessProbe0
livenessProbe.periodSecondsPeriod seconds for livenessProbe10
livenessProbe.timeoutSecondsTimeout seconds for livenessProbe1
livenessProbe.failureThresholdFailure threshold for livenessProbe5
livenessProbe.successThresholdSuccess threshold for livenessProbe1
readinessProbe.enabledEnable readinessProbe on OAuth2 Proxy nodestrue
readinessProbe.initialDelaySecondsInitial delay seconds for readinessProbe0
readinessProbe.periodSecondsPeriod seconds for readinessProbe10
readinessProbe.timeoutSecondsTimeout seconds for readinessProbe1
readinessProbe.failureThresholdFailure threshold for readinessProbe5
readinessProbe.successThresholdSuccess threshold for readinessProbe1
customStartupProbeCustom startupProbe that overrides the default one{}
customLivenessProbeCustom livenessProbe that overrides the default one{}
customReadinessProbeCustom readinessProbe that overrides the default one{}
resourcesPresetSet container resources according to one common preset (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge). This is ignored if resources is set (resources is recommended for production).nano
resourcesSet container requests and limits for different resources like CPU or memory (essential for production workloads){}
pdb.createEnable a Pod Disruption Budget creationtrue
pdb.minAvailableMinimum number/percentage of pods that should remain scheduled""
pdb.maxUnavailableMaximum number/percentage of pods that may be made unavailable. Defaults to 1 if both pdb.minAvailable and pdb.maxUnavailable are empty.""
podSecurityContext.enabledEnabled OAuth2 Proxy pods’ Security Contexttrue
podSecurityContext.fsGroupChangePolicySet filesystem group change policyAlways
podSecurityContext.sysctlsSet kernel settings using the sysctl interface[]
podSecurityContext.supplementalGroupsSet filesystem extra groups[]
podSecurityContext.fsGroupSet OAuth2 Proxy pod’s Security Context fsGroup1001
containerSecurityContext.enabledEnabled containers’ Security Contexttrue
containerSecurityContext.seLinuxOptionsSet SELinux options in container{}
containerSecurityContext.runAsUserSet containers’ Security Context runAsUser1001
containerSecurityContext.runAsGroupSet containers’ Security Context runAsGroup1001
containerSecurityContext.runAsNonRootSet container’s Security Context runAsNonRoottrue
containerSecurityContext.privilegedSet container’s Security Context privilegedfalse
containerSecurityContext.readOnlyRootFilesystemSet container’s Security Context readOnlyRootFilesystemtrue
containerSecurityContext.allowPrivilegeEscalationSet container’s Security Context allowPrivilegeEscalationfalse
containerSecurityContext.capabilities.dropList of capabilities to be dropped["ALL"]
containerSecurityContext.seccompProfile.typeSet container’s Security Context seccomp profileRuntimeDefault
commandOverride default container command (useful when using custom images)[]
argsOverride default container args (useful when using custom images)[]
automountServiceAccountTokenMount Service Account token in podfalse
hostAliasesOAuth2 Proxy pods host aliases[]
podLabelsExtra labels for OAuth2 Proxy pods{}
podAnnotationsAnnotations for OAuth2 Proxy pods{}
podAffinityPresetPod affinity preset. Ignored if affinity is set. Allowed values: soft or hard""
podAntiAffinityPresetPod anti-affinity preset. Ignored if affinity is set. Allowed values: soft or hardsoft
nodeAffinityPreset.typeNode affinity preset type. Ignored if affinity is set. Allowed values: soft or hard""
nodeAffinityPreset.keyNode label key to match. Ignored if affinity is set""
nodeAffinityPreset.valuesNode label values to match. Ignored if affinity is set[]
affinityAffinity for OAuth2 Proxy pods assignment{}
nodeSelectorNode labels for OAuth2 Proxy pods assignment{}
tolerationsTolerations for OAuth2 Proxy pods assignment[]
updateStrategy.typeOAuth2 Proxy statefulset strategy typeRollingUpdate
priorityClassNameOAuth2 Proxy pods’ priorityClassName""
schedulerNameName of the k8s scheduler (other than default)""
topologySpreadConstraintsTopology Spread Constraints for pod assignment[]
lifecycleHooksfor the OAuth2 Proxy container(s) to automate configuration before or after startup{}
extraEnvVarsArray with extra environment variables to add to OAuth2 Proxy nodes[]
extraEnvVarsCMName of existing ConfigMap containing extra env vars for OAuth2 Proxy nodes""
extraEnvVarsSecretName of existing Secret containing extra env vars for OAuth2 Proxy nodes""
extraVolumesOptionally specify extra list of additional volumes for the OAuth2 Proxy pod(s)[]
extraVolumeMountsOptionally specify extra list of additional volumeMounts for the OAuth2 Proxy container(s)[]
sidecarsAdd additional sidecar containers to the OAuth2 Proxy pod(s)[]
initContainersAdd additional init containers to the OAuth2 Proxy pod(s)[]
dnsPolicyPod DNS policy. Valid values are ‘ClusterFirstWithHostNet’, ‘ClusterFirst’, ‘Default’ or ‘None’.""
dnsConfigPod DNS configuration.{}
serviceAccount.createSpecifies whether a ServiceAccount should be createdtrue
serviceAccount.nameThe name of the ServiceAccount to use""
serviceAccount.automountServiceAccountTokenAutomount service account token for the server service accountfalse
serviceAccount.annotationsAnnotations for service account. Evaluated as a template. Only used if create is true.{}

External Redis® parameters

NameDescriptionValue
externalRedis.hostExternal Redis® server host""
externalRedis.passwordExternal Redis® user password""
externalRedis.portExternal Redis® server port6379
externalRedis.databaseIndexExternal Redis® database index0
externalRedis.existingSecretThe name of an existing secret with Redis® credentials""
externalRedis.existingSecretPasswordKeyKey inside the existing secret with Redis® credentials""

Redis® sub-chart parameters

NameDescriptionValue
redis.enabledDeploy Redis® sub-charttrue
redis.architectureRedis® architecturestandalone
redis.master.service.portRedis® (without Sentinel) service port6379
redis.replica.replicaCountNumber of Redis® replicas3
redis.auth.enabledEnable Redis® authenticationtrue
redis.auth.existingSecretSecret with Redis® credentials""
redis.auth.existingSecretPasswordKeyKey inside the existing secret with Redis® credentials""
redis.auth.sentinelEnable authentication in the Sentinel nodestrue
redis.sentinel.enabledEnable Redis® sentinel in the deploymentfalse
redis.sentinel.masterSetName of the Redis® Sentinel master setmymaster
redis.sentinel.service.portRedis® (with Sentinel) service port6379
redis.sentinel.service.sentinelPortRedis® (with Sentinel) sentinel service port26379

See https://github.com/bitnami/readme-generator-for-helm to create the table

The above parameters map to the env variables defined in bitnami/oauth2-proxy. For more information please refer to the bitnami/oauth2-proxy image documentation.

Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,

helm install my-release \
  --set replicaCount=2 \
    oci://REGISTRY_NAME/REPOSITORY_NAME/oauth2-proxy

Note: You need to substitute the placeholders REGISTRY_NAME and REPOSITORY_NAME with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to use REGISTRY_NAME=registry-1.docker.io and REPOSITORY_NAME=bitnamicharts.

The above command increase the default number of replicas.

NOTE: Once this chart is deployed, it is not possible to change the application’s access credentials, such as usernames or passwords, using Helm. To change these application credentials after deployment, delete any persistent volumes (PVs) used by the chart and re-deploy it, or use the application’s built-in administrative tools if available.

Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example,

helm install my-release -f values.yaml oci://REGISTRY_NAME/REPOSITORY_NAME/oauth2-proxy

Note: You need to substitute the placeholders REGISTRY_NAME and REPOSITORY_NAME with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to use REGISTRY_NAME=registry-1.docker.io and REPOSITORY_NAME=bitnamicharts. Tip: You can use the default values.yaml

Troubleshooting

Find more information about how to deal with common errors related to Bitnami’s Helm charts in this troubleshooting guide.

Upgrading

To 6.2.0

This version introduces image verification for security purposes. To disable it, set global.security.allowInsecureImages to true. More details at GitHub issue.

To 6.0.0

This major updates the Redis® subchart to its newest major, 20.0.0. Here you can find more information about the changes introduced in that version.

To 5.0.0

This major bump changes the following security defaults:

  • runAsGroup is changed from 0 to 1001
  • readOnlyRootFilesystem is set to true
  • resourcesPreset is changed from none to the minimum size working in our test suites (NOTE: resourcesPreset is not meant for production usage, but resources adapted to your use case).
  • global.compatibility.openshift.adaptSecurityContext is changed from disabled to auto.

This could potentially break any customization or init scripts used in your deployment. If this is the case, change the default values to the previous ones.

To 4.0.0

This major updates the Redis® subchart to its newest major, 18.0.0. Here you can find more information about the changes introduced in that version.

NOTE: Due to an error in our release process, Redis®’ chart versions higher or equal than 17.15.4 already use Redis® 7.2 by default.

To 3.0.0

This major update the Redis® subchart to its newest major, 17.0.0, which updates Redis® from its version 6.2 to version 7.0.

To 2.0.0

This major update the Redis® subchart to its newest major, 16.0.0. Here you can find more info about the specific changes.

Additionally, this chart has been standardised adding features from other charts.

To 1.0.0

This major update the Redis® subchart to its newest major, 15.0.0. Here you can find more info about the specific changes.

License

Copyright © 2025 Broadcom. The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries.

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.