Skip to content

fix: login method naming #38

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.

Sign up for GitHub

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

Merged
MzUgM merged 3 commits into from
Sep 19, 2025
Merged

fix: login method naming #38

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
16574ea
fix: login method naming
MzUgM Sep 19, 2025
f56c144
bump
MzUgM Sep 19, 2025
5413b76
fix: needs whitelisted email list
MzUgM Sep 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 14 additions & 9 deletions README-ENTERPRISE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,12 +96,12 @@ Configure how the Intelligent Command Center can be accessed

| Name | Description | Default Value | Required |
| --- | --- | --- | --- |
| `services.icc.login_methods.google_oauth.enable` | Enable Google OAuth | false | Yes |
| `services.icc.login_methods.google_oauth.client_id` | Required when Google is enabled | "" | No |
| `services.icc.login_methods.google_oauth.client_secret` | Required when Google is enabled | "" | No |
| `services.icc.login_methods.github_oauth.enable` | Enable Github OAuth | false | Yes |
| `services.icc.login_methods.github_oauth.client_id` | Required when Github is enabled | "" | No |
| `services.icc.login_methods.github_oauth.client_secret` | Required when Github is enabled | "" | No |
| `services.icc.login_methods.google.enable` | Enable Google OAuth | false | Yes |
| `services.icc.login_methods.google.client_id` | Required when Google is enabled | "" | No |
| `services.icc.login_methods.google.client_secret` | Required when Google is enabled | "" | No |
| `services.icc.login_methods.github.enable` | Enable Github OAuth | false | Yes |
| `services.icc.login_methods.github.client_id` | Required when Github is enabled | "" | No |
| `services.icc.login_methods.github.client_secret` | Required when Github is enabled | "" | No |
| `services.icc.login_methods.password.enable` | Enable password authentication. **Enterprise-only** | false | No |
| `services.icc.login_methods.password.password` | Password will be stored in environment variables. **Enterprise-only** | "" | No |
| `services.icc.login_methods.demo.enable` | Creates a fake super user to browse the dashboard. **Enterprise-only** | false | No |
Expand Down Expand Up @@ -147,6 +147,9 @@ variables, and execute the script.
# Name of the cloud provider being deployed to. Valid values are: aws, gcp, or left empty
PLT_CLOUD_PROVIDER=""

# Image pull secret token
DOCKER_TOKEN=""

# Connection string to Postgres cluster
PLT_DATABASE_URL=""

Expand All @@ -171,6 +174,8 @@ helm install platformatic oci://ghcr.io/platformatic/helm \
--create-namespace \
--namespace platformatic \
--set "cloud=$PLT_CLOUD_PROVIDER" \
--set "imagePullSecret.token=${DOCKER_TOKEN}" \
--set "imagePullSecret.user=platformatic" \
--set "services.icc.database_url=$PLT_DATABASE_URL" \
--set "services.icc.public_url=$PLT_PUBLIC_URL" \
--set "services.icc.prometheus.url=$PLT_PROMETHEUS_URL" \
Expand All @@ -179,9 +184,9 @@ helm install platformatic oci://ghcr.io/platformatic/helm \
--set "services.icc.secrets.user_manager_session=$(openssl rand -base64 32)" \
--set "services.icc.secrets.icc_session=$(openssl rand -hex 32)" \
--set "services.icc.secrets.control_plane_keys=$(openssl rand -hex 32)" \
--set "services.icc.login_methods.github_oauth.enable=true" \
--set "services.icc.login_methods.github_oauth.client_id=$GITHUB_OAUTH_CLIENT_ID" \
--set "services.icc.login_methods.github_oauth.client_secret=$GITHUB_OAUTH_CLIENT_SECRET"
--set "services.icc.login_methods.github.enable=true" \
--set "services.icc.login_methods.github.client_id=$GITHUB_OAUTH_CLIENT_ID" \
--set "services.icc.login_methods.github.client_secret=$GITHUB_OAUTH_CLIENT_SECRET"
```

## Notes
Expand Down
18 changes: 9 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,12 +97,12 @@ Configure how the Intelligent Command Center can be accessed

| Name | Description | Default Value | Required |
| --- | --- | --- | --- |
| `services.icc.login_methods.google_oauth.enable` | Enable Google OAuth | false | Yes |
| `services.icc.login_methods.google_oauth.client_id` | Required when Google is enabled | "" | No |
| `services.icc.login_methods.google_oauth.client_secret` | Required when Google is enabled | "" | No |
| `services.icc.login_methods.github_oauth.enable` | Enable Github OAuth | false | Yes |
| `services.icc.login_methods.github_oauth.client_id` | Required when Github is enabled | "" | No |
| `services.icc.login_methods.github_oauth.client_secret` | Required when Github is enabled | "" | No |
| `services.icc.login_methods.google.enable` | Enable Google OAuth | false | Yes |
| `services.icc.login_methods.google.client_id` | Required when Google is enabled | "" | No |
| `services.icc.login_methods.google.client_secret` | Required when Google is enabled | "" | No |
| `services.icc.login_methods.github.enable` | Enable Github OAuth | false | Yes |
| `services.icc.login_methods.github.client_id` | Required when Github is enabled | "" | No |
| `services.icc.login_methods.github.client_secret` | Required when Github is enabled | "" | No |

### Machinist

Expand Down Expand Up @@ -174,9 +174,9 @@ helm install platformatic oci://ghcr.io/platformatic/helm \
--set "services.icc.secrets.user_manager_session=$(openssl rand -base64 32)" \
--set "services.icc.secrets.icc_session=$(openssl rand -hex 32)" \
--set "services.icc.secrets.control_plane_keys=$(openssl rand -hex 32)" \
--set "services.icc.login_methods.github_oauth.enable=true" \
--set "services.icc.login_methods.github_oauth.client_id=$GITHUB_OAUTH_CLIENT_ID" \
--set "services.icc.login_methods.github_oauth.client_secret=$GITHUB_OAUTH_CLIENT_SECRET"
--set "services.icc.login_methods.github.enable=true" \
--set "services.icc.login_methods.github.client_id=$GITHUB_OAUTH_CLIENT_ID" \
--set "services.icc.login_methods.github.client_secret=$GITHUB_OAUTH_CLIENT_SECRET"
```

## Notes
Expand Down
2 changes: 1 addition & 1 deletion chart/Chart.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
apiVersion: v2
name: helm
version: 4.0.0-alpha.9
version: 4.0.0-alpha.11
kubeVersion: ">= 1.30.0-0"
description: Platformatic microservices
type: application
Expand Down
14 changes: 12 additions & 2 deletions chart/templates/deployment/_icc.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ spec:
- name: PLT_COMPLIANCE_RULES_DIR
value: "./rules"

{{- if .login_methods.github_oauth.enable }}
{{- if .login_methods.github.enable }}
- name: PLT_GITHUB_OAUTH_CLIENT_ID
valueFrom:
secretKeyRef:
Expand All @@ -162,9 +162,14 @@ spec:
secretKeyRef:
name: icc-github-oauth
key: client_secret
- name: PLT_USER_MANAGER_SUPER_ADMIN_EMAIL
valueFrom:
secretKeyRef:
name: icc-github-oauth
key: valid_emails
{{- end }}

{{- if .login_methods.google_oauth.enable }}
{{- if .login_methods.google.enable }}
- name: PLT_GOOGLE_OAUTH_CLIENT_ID
valueFrom:
secretKeyRef:
Expand All @@ -175,6 +180,11 @@ spec:
secretKeyRef:
name: icc-google-oauth
key: client_secret
- name: PLT_USER_MANAGER_SUPER_ADMIN_EMAIL
valueFrom:
secretKeyRef:
name: icc-google-oauth
key: valid_emails
{{- end }}

- name: PLT_ICC_SESSION_SECRET
Expand Down
18 changes: 12 additions & 6 deletions chart/templates/secrets.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@ data:

{{/* Add all enabled ICC login methods */}}

{{- if .Values.services.icc.login_methods.google_oauth.enable }}
{{- with .Values.services.icc.login_methods.google }}
{{- if .enable }}
---
apiVersion: v1
kind: Secret
Expand All @@ -43,11 +44,14 @@ metadata:
{{- include "application.labels" $ | nindent 4 }}
{{- include "application.selectorLabels" (merge (dict "name" "icc-google-oauth") $) | nindent 4 }}
data:
client_id: {{ .Values.services.icc.login_methods.google_oauth.client_id | b64enc }}
client_secret: {{ .Values.services.icc.login_methods.google_oauth.client_secret | b64enc }}
client_id: {{ .client_id | b64enc }}
client_secret: {{ .client_secret | b64enc }}
valid_emails: {{ join "," .valid_emails | b64enc }}
{{- end }}
{{- end }}

{{- if .Values.services.icc.login_methods.github_oauth.enable }}
{{- with .Values.services.icc.login_methods.github }}
{{- if .enable }}
---
apiVersion: v1
kind: Secret
Expand All @@ -59,8 +63,10 @@ metadata:
{{- include "application.labels" $ | nindent 4 }}
{{- include "application.selectorLabels" (merge (dict "name" "icc-github-oauth") $) | nindent 4 }}
data:
client_id: {{ .Values.services.icc.login_methods.github_oauth.client_id | b64enc }}
client_secret: {{ .Values.services.icc.login_methods.github_oauth.client_secret | b64enc }}
client_id: {{ .client_id | b64enc }}
client_secret: {{ .client_secret | b64enc }}
valid_emails: {{ join "," .valid_emails | b64enc }}
{{- end }}
{{- end }}

{{/* Setup databases */}}
Expand Down
12 changes: 4 additions & 8 deletions chart/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,20 +77,16 @@ services:
# Change `enable` to `true` to use a method
# At least one method must be enabled
login_methods:
google_oauth:
google:
enable: false
#client_id: ""
#client_secret: ""
github_oauth:
#valid_emails: []
github:
enable: false
#client_id: ""
#client_secret: ""
# These login methods are only supported in our Enterprise release
#password:
#enable: false
#password: ""
#demo:
# enable: false
#valid_emails: []

# The URL that ICC will be accessed from
# Some examples:
Expand Down