Skip to content

Initial auth proxy chart #1237

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Conversation

welteki
Copy link
Member

@welteki welteki commented Apr 22, 2025

Description

Initial chart for the OpenFaaS authentication proxy tech preview.

Deploy the auth proxy

Create a secret for the static API token:

openssl rand -hex 32 > access-token

kubectl create secret generic \
    -n openfaas \
    auth-proxy-access-token \
    --from-file access_token=./access-token

Example values.yaml configuration:

image: docker.io/welteki/auth-proxy:v0.0.1-dirty

# Public url of the auth proxy
url: "https://auth-proxy.openfaas.example.com"

# Getaway URL
gatewayURL: http://gateway.openfaas:8080

accessTokenSecret: "auth-proxy-access-token"

iam:
  loginIssuer:
    url: "https://oauth.examle.com"
    clientId: ""
    clientSecret: "oauth-client-secret

Install the auth proxy with Helm:

helm upgrade --install \
  --namespace openfaas \
  auth-proxy \
  ./chart/auth-proxy \
  --values ./values.yaml

Configure Ingress for the auth proxy

Optionally ingress can be configured for the auth proxy through the OpenFaasS helm chart similar to how it is done for the Gateway and Dasboard. Modify the ingress section of the openfaas chart to add a tls and hosts entry for the auth proxy:

ingress:
  enabled: true
  ingressClassName: nginx
  annotations:
    cert-manager.io/issuer: letsencrypt-prod
    nginx.ingress.kubernetes.io/proxy-read-timeout: "1800"
  tls:
    - hosts:
        - auth-proxy.openfaas.example.com
      secretName: openfaas-auth-proxy-cert
  hosts:
  - host: auth-proxy.openfaas.example.com
    http:
      paths:
      - path: /
        pathType: Prefix
        backend:
          service:
            name: auth-proxy
            port:
              number: 8080

Why is this needed?

  • I have raised an issue to propose this change (required)

Who is this for?

What company is this for? Are you listed in the ADOPTERS.md file?

How Has This Been Tested?

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I've read the CONTRIBUTION guide
  • I have signed-off my commits with git commit -s
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Signed-off-by: Han Verstraete (OpenFaaS Ltd) <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant