Introducing our new CEO Don Johnson - Read More

bitnamicharts/oauth2-proxy

Verified Publisher

By VMware

Updated 1 day ago

Bitnami Helm chart for OAuth2 Proxy

Helm
Image
Networking
Security
0

100K+

Bitnami package for OAuth2 Proxy

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

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

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

Docker Pull Command

docker pull bitnamicharts/oauth2-proxy
Bitnami