Skip to content

feat: let devs specify an existing secret #14

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

Closed
JeferCatarina wants to merge 1 commit into from
Closed

feat: let devs specify an existing secret #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 3 additions & 2 deletions charts/jit-k8s-agent/templates/_job_helper.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
{{- define "jit-job-spec" -}}
{{- $jitCredentialsSecret := .Values.jit.existingSecret | default (printf "%s-jit-credentials" .Chart.Name) -}}
spec:
serviceAccountName: {{ .Values.serviceAccount.name }}
restartPolicy: OnFailure
Expand All @@ -19,12 +20,12 @@ spec:
- name: JIT_CLIENT_ID
valueFrom:
secretKeyRef:
name: {{ .Chart.Name }}-jit-credentials
name: {{ $jitCredentialsSecret }}
key: JIT_CLIENT_ID
- name: JIT_CLIENT_SECRET
valueFrom:
secretKeyRef:
name: {{ .Chart.Name }}-jit-credentials
name: {{ $jitCredentialsSecret }}
key: JIT_CLIENT_SECRET
- name: JIT_API_URL
value: {{ .Values.jit.apiUrl }}
Expand Down
40 changes: 40 additions & 0 deletions charts/jit-k8s-agent/templates/_validation.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
{{/*
Validate required values and provide clear error messages
*/}}
{{- define "jit-k8s-agent.validateValues" -}}
{{- $errors := list -}}

{{- if not .Values.cluster.name -}}
{{- $errors = append $errors "cluster.name is required and cannot be empty" -}}
{{- end -}}

{{- if .Values.jit -}}
{{- if and .Values.jit.clientId .Values.jit.clientSecret -}}
{{- if .Values.jit.existingSecret -}}
{{- $errors = append $errors "Cannot specify both direct credentials (clientId/clientSecret) and existingSecret. Choose one authentication method." -}}
{{- end -}}
{{- else if .Values.jit.existingSecret -}}
{{- /* Valid: using existingSecret */ -}}
{{- else -}}
{{- $errors = append $errors "Jit authentication requires either: 1) Both 'clientId' and 'clientSecret' for direct authentication, or 2) 'existingSecret' to reference an existing Kubernetes secret" -}}
{{- end -}}
{{- else -}}
{{- $errors = append $errors "Jit configuration is required. Please provide either clientId/clientSecret or existingSecret" -}}
{{- end -}}

{{- if $errors -}}
{{- $errorMsg := printf "Configuration validation failed:\n" -}}
{{- range $errors -}}
{{- $errorMsg = printf "%s • %s\n" $errorMsg . -}}
{{- end -}}
{{- $errorMsg = printf "%s\nExample configurations:\n" $errorMsg -}}
{{- $errorMsg = printf "%s # Option 1: Direct credentials\n" $errorMsg -}}
{{- $errorMsg = printf "%s jit:\n" $errorMsg -}}
{{- $errorMsg = printf "%s clientId: \"your-client-id\"\n" $errorMsg -}}
{{- $errorMsg = printf "%s clientSecret: \"your-client-secret\"\n" $errorMsg -}}
{{- $errorMsg = printf "%s\n # Option 2: Existing secret\n" $errorMsg -}}
{{- $errorMsg = printf "%s jit:\n" $errorMsg -}}
{{- $errorMsg = printf "%s existingSecret: \"jit-credentials\"\n" $errorMsg -}}
{{- fail $errorMsg -}}
{{- end -}}
{{- end -}}
5 changes: 4 additions & 1 deletion charts/jit-k8s-agent/templates/secret.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
{{- include "jit-k8s-agent.validateValues" . -}}
{{- if not .Values.jit.existingSecret }}
apiVersion: v1
kind: Secret
metadata:
Expand All @@ -8,4 +10,5 @@ metadata:
type: Opaque
data:
JIT_CLIENT_ID: {{ .Values.jit.clientId | b64enc }}
JIT_CLIENT_SECRET: {{ .Values.jit.clientSecret | b64enc }}
JIT_CLIENT_SECRET: {{ .Values.jit.clientSecret | b64enc }}
{{- end }}
16 changes: 11 additions & 5 deletions charts/jit-k8s-agent/values.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,22 @@
"properties": {
"clientId": {
"type": "string",
"minLength": 1,
"description": "The client ID for Jit. This field is required."
"description": "The client ID for Jit. This field is required when not using an existing secret."
},
"clientSecret": {
"type": "string",
"minLength": 1,
"description": "The client secret for Jit. This field is required."
"description": "The client secret for Jit. This field is required when not using an existing secret."
},
"existingSecret": {
"type": "string",
"description": "The name of an existing secret to use for Jit credentials. If provided, clientId and clientSecret will be ignored."
},
"apiUrl": {
"type": "string",
"description": "The Jit API URL"
}
},
"required": ["clientId", "clientSecret"]
"description": "Jit authentication requires either: 1) Both 'clientId' and 'clientSecret' for direct authentication, or 2) 'existingSecret' to reference an existing Kubernetes secret containing the credentials."
}
}
}
7 changes: 5 additions & 2 deletions charts/jit-k8s-agent/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,11 @@ cluster:
name: "" # Required, set it while installing the chart. Should be unique across all clusters.

jit:
clientId: "" # Required, set it while installing the chart
clientSecret: "" # Required, set it while installing the chart
# clientId and clientSecret are required when not using an existing secret
# clientId: ""
# clientSecret: ""
# existingSecret prevents storing clientId and clientSecret as plain text in the values.yaml file
# existingSecret: ""
apiUrl: https://api.jit.io

kubescape:
Expand Down
Loading