[PR #550] [MERGED] fix #548: Add support for OIDC configuration thru the helm #1132

Closed
opened 2025-10-09 19:09:28 +03:00 by OVERLORD · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/plankanban/planka/pull/550
Author: @eternity1984
Created: 11/18/2023
Status: Merged
Merged: 11/20/2023
Merged by: @meltyshev

Base: masterHead: feat-helm-oidc


📝 Commits (2)

  • cfac5a6 Add support for OIDC configuration thru the helm
  • 4d1aa72 chore: Update version

📊 Changes

4 files changed (+110 additions, -1 deletions)

View changed files

📝 charts/planka/Chart.yaml (+1 -1)
📝 charts/planka/templates/deployment.yaml (+27 -0)
charts/planka/templates/secret-oidc.yaml (+17 -0)
📝 charts/planka/values.yaml (+65 -0)

📄 Description

In this PR, makes it easier to configure an oidc thru helm.

For example:

oidc:
  enabled: true
  clientId: sxxaAIAxVXlCxTmc1YLHBbQr8NL8MqLI2DUbt42d
  clientSecret: om4RTMRVHRszU7bqxB7RZNkHIzA8e4sGYWxeCwIMYQXPwEBWe4SY5a0wwCe9ltB3zrq5f0dnFnp34cEHD7QSMHsKvV9AiV5Z7eqDraMnv0I8IFivmuV5wovAECAYreSI
  issuerUrl: https://auth.local/application/o/planka/
  # scopes: []
  admin:
    # ignoreRoles: false
    # rolesAttribute: groups
    roles:
      - planka-admin
% kubectl describe deploy planka
Name:                   planka
Namespace:              planka
CreationTimestamp:      Sat, 18 Nov 2023 11:10:12 +0900
Labels:                 app.kubernetes.io/instance=planka
                        app.kubernetes.io/managed-by=Helm
                        app.kubernetes.io/name=planka
                        app.kubernetes.io/version=1.15.0
                        helm.sh/chart=planka-0.1.10
Annotations:            deployment.kubernetes.io/revision: 1
                        meta.helm.sh/release-name: planka
                        meta.helm.sh/release-namespace: planka
Selector:               app.kubernetes.io/instance=planka,app.kubernetes.io/name=planka
Replicas:               1 desired | 1 updated | 1 total | 1 available | 0 unavailable
StrategyType:           RollingUpdate
MinReadySeconds:        0
RollingUpdateStrategy:  25% max unavailable, 25% max surge
Pod Template:
  Labels:           app.kubernetes.io/instance=planka
                    app.kubernetes.io/name=planka
  Service Account:  planka
  Containers:
   planka:
    Image:      ghcr.io/plankanban/planka:1.14.3
    Port:       1337/TCP
    Host Port:  0/TCP
    Liveness:   http-get http://:http/ delay=0s timeout=1s period=10s #success=1 #failure=3
    Readiness:  http-get http://:http/ delay=0s timeout=1s period=10s #success=1 #failure=3
    Environment:
      DATABASE_URL:            <set to the key 'uri' in secret 'planka-postgresql-svcbind-custom-user'>  Optional: false
      BASE_URL:                http://localhost
      SECRET_KEY:              PH/HcmBWzuTupMNewbIBf+1b72m234E8eTpgud9LfQkEgze3Ke4QDwlduFWn
      TRUST_PROXY:             0
      DEFAULT_ADMIN_EMAIL:     
      DEFAULT_ADMIN_PASSWORD:  
      DEFAULT_ADMIN_NAME:      
      DEFAULT_ADMIN_USERNAME:  
      OIDC_CLIENT_ID:          <set to the key 'clientId' in secret 'planka-oidc'>      Optional: false
      OIDC_CLIENT_SECRET:      <set to the key 'clientSecret' in secret 'planka-oidc'>  Optional: false
      OIDC_ISSUER:             https://auth.local/application/o/planka/
      OIDC_SCOPES:             openid profile email
      OIDC_ADMIN_ROLES:        planka-admin
      OIDC_ROLES_ATTRIBUTE:    groups
    Mounts:
       ...

Fixes issue #548


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/plankanban/planka/pull/550 **Author:** [@eternity1984](https://github.com/eternity1984) **Created:** 11/18/2023 **Status:** ✅ Merged **Merged:** 11/20/2023 **Merged by:** [@meltyshev](https://github.com/meltyshev) **Base:** `master` ← **Head:** `feat-helm-oidc` --- ### 📝 Commits (2) - [`cfac5a6`](https://github.com/plankanban/planka/commit/cfac5a6571eabaf3d0befd7d032ce34c48c93752) Add support for OIDC configuration thru the helm - [`4d1aa72`](https://github.com/plankanban/planka/commit/4d1aa72208c2059aa60113690b7e47b4b0cac9c5) chore: Update version ### 📊 Changes **4 files changed** (+110 additions, -1 deletions) <details> <summary>View changed files</summary> 📝 `charts/planka/Chart.yaml` (+1 -1) 📝 `charts/planka/templates/deployment.yaml` (+27 -0) ➕ `charts/planka/templates/secret-oidc.yaml` (+17 -0) 📝 `charts/planka/values.yaml` (+65 -0) </details> ### 📄 Description In this PR, makes it easier to configure an oidc thru helm. For example: ```yaml oidc: enabled: true clientId: sxxaAIAxVXlCxTmc1YLHBbQr8NL8MqLI2DUbt42d clientSecret: om4RTMRVHRszU7bqxB7RZNkHIzA8e4sGYWxeCwIMYQXPwEBWe4SY5a0wwCe9ltB3zrq5f0dnFnp34cEHD7QSMHsKvV9AiV5Z7eqDraMnv0I8IFivmuV5wovAECAYreSI issuerUrl: https://auth.local/application/o/planka/ # scopes: [] admin: # ignoreRoles: false # rolesAttribute: groups roles: - planka-admin ``` ``` % kubectl describe deploy planka Name: planka Namespace: planka CreationTimestamp: Sat, 18 Nov 2023 11:10:12 +0900 Labels: app.kubernetes.io/instance=planka app.kubernetes.io/managed-by=Helm app.kubernetes.io/name=planka app.kubernetes.io/version=1.15.0 helm.sh/chart=planka-0.1.10 Annotations: deployment.kubernetes.io/revision: 1 meta.helm.sh/release-name: planka meta.helm.sh/release-namespace: planka Selector: app.kubernetes.io/instance=planka,app.kubernetes.io/name=planka Replicas: 1 desired | 1 updated | 1 total | 1 available | 0 unavailable StrategyType: RollingUpdate MinReadySeconds: 0 RollingUpdateStrategy: 25% max unavailable, 25% max surge Pod Template: Labels: app.kubernetes.io/instance=planka app.kubernetes.io/name=planka Service Account: planka Containers: planka: Image: ghcr.io/plankanban/planka:1.14.3 Port: 1337/TCP Host Port: 0/TCP Liveness: http-get http://:http/ delay=0s timeout=1s period=10s #success=1 #failure=3 Readiness: http-get http://:http/ delay=0s timeout=1s period=10s #success=1 #failure=3 Environment: DATABASE_URL: <set to the key 'uri' in secret 'planka-postgresql-svcbind-custom-user'> Optional: false BASE_URL: http://localhost SECRET_KEY: PH/HcmBWzuTupMNewbIBf+1b72m234E8eTpgud9LfQkEgze3Ke4QDwlduFWn TRUST_PROXY: 0 DEFAULT_ADMIN_EMAIL: DEFAULT_ADMIN_PASSWORD: DEFAULT_ADMIN_NAME: DEFAULT_ADMIN_USERNAME: OIDC_CLIENT_ID: <set to the key 'clientId' in secret 'planka-oidc'> Optional: false OIDC_CLIENT_SECRET: <set to the key 'clientSecret' in secret 'planka-oidc'> Optional: false OIDC_ISSUER: https://auth.local/application/o/planka/ OIDC_SCOPES: openid profile email OIDC_ADMIN_ROLES: planka-admin OIDC_ROLES_ATTRIBUTE: groups Mounts: ... ``` Fixes issue #548 --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
OVERLORD added the pull-request label 2025-10-09 19:09:28 +03:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/planka#1132