Skip to content

Change helm defaults to be more newcomer friendly #919

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

Open
tylerohlsen wants to merge 8 commits into
base: main-enterprise
Choose a base branch
from
+53 −40
Open

Change helm defaults to be more newcomer friendly #919

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
7635dac
Updated container port to match the port exposed by the application i…
tylerohlsen Jan 9, 2026
d214a6a
Added examples for common environment variables
tylerohlsen Jan 9, 2026
c271cda
Changed validators to be examples in comments to avoid needing to ove…
tylerohlsen Jan 9, 2026
7c7ccdd
Changed min replica count to 1 for more cost effective defaults
tylerohlsen Jan 9, 2026
d73925e
Updated min replica default in docs
tylerohlsen Jan 12, 2026
c131d0b
Updated service port default in docs
tylerohlsen Jan 12, 2026
a66efa0
Updated validator defaults in docs
tylerohlsen Jan 12, 2026
3958309
Updated restricted repos include default in docs
tylerohlsen Jan 12, 2026
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
19 changes: 6 additions & 13 deletions helm/safe-settings/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,22 +9,15 @@ A Helm chart for Kubernetes
| affinity | object | `{}` | |
| autoscaling.enabled | bool | `false` | |
| autoscaling.maxReplicas | int | `10` | |
| autoscaling.minReplicas | int | `2` | |
| autoscaling.minReplicas | int | `1` | |
| autoscaling.targetCPUUtilizationPercentage | int | `80` | |
| deploymentConfig.configvalidators[0].error | string | `"`Admin cannot be assigned to collaborators`\n"` | |
| deploymentConfig.configvalidators[0].plugin | string | `"collaborators"` | |
| deploymentConfig.configvalidators[0].script | string | `"console.log(`baseConfig ${JSON.stringify(baseconfig)}`)\nreturn baseconfig.permission != 'admin'\n"` | |
| deploymentConfig.overridevalidators[0].error | string | `"`Branch protection required_approving_review_count cannot be overidden to a lower value`\n"` | |
| deploymentConfig.overridevalidators[0].plugin | string | `"branches"` | |
| deploymentConfig.overridevalidators[0].script | string | `"console.log(`baseConfig ${JSON.stringify(baseconfig)}`)\nconsole.log(`overrideConfig ${JSON.stringify(overrideconfig)}`)\nif (baseconfig.protection.required_pull_request_reviews.required_approving_review_count && overrideconfig.protection.required_pull_request_reviews.required_approving_review_count ) {\n return overrideconfig.protection.required_pull_request_reviews.required_approving_review_count >= baseconfig.protection.required_pull_request_reviews.required_approving_review_count\n}\nreturn true\n"` | |
| deploymentConfig.overridevalidators[1].error | string | `"Some error\n"` | |
| deploymentConfig.overridevalidators[1].plugin | string | `"labels"` | |
| deploymentConfig.overridevalidators[1].script | string | `"return true\n"` | |
| deploymentConfig.configvalidators | list | [] | |
| deploymentConfig.overridevalidators | list | [] | |
| deploymentConfig.restrictedRepos.exclude[0] | string | `"^admin$"` | |
| deploymentConfig.restrictedRepos.exclude[1] | string | `"^\\.github$"` | |
| deploymentConfig.restrictedRepos.exclude[2] | string | `"^safe-settings$"` | |
| deploymentConfig.restrictedRepos.exclude[3] | string | `".*-test"` | |
| deploymentConfig.restrictedRepos.include[0] | string | `"^test$"` | |
| deploymentConfig.restrictedRepos.include | list | [] | |
| env | list | `[]` | |
| envFrom | list | `[]` | |
| extraObjects | list | `[]` | Add dynamic manifests via values. Example: extraObjects: - kind: ConfigMap apiVersion: v1 metadata: name: extra-cm-{{ .Release.Name }} data: | extra.yml: "does-my-install-need-extra-info: true" |
Expand All @@ -44,15 +37,15 @@ A Helm chart for Kubernetes
| nodeSelector | object | `{}` | |
| podAnnotations | object | `{}` | |
| podSecurityContext | object | `{}` | |
| replicaCount | int | `2` | |
| replicaCount | int | `1` | |
| resources | object | `{}` | |
| securityContext.allowPrivilegeEscalation | bool | `false` | |
| securityContext.capabilities.drop[0] | string | `"ALL"` | |
| securityContext.privileged | bool | `false` | |
| securityContext.readOnlyRootFilesystem | bool | `true` | |
| securityContext.runAsNonRoot | bool | `true` | |
| securityContext.runAsUser | int | `1000` | |
| service.port | int | `80` | |
| service.port | int | `3000` | |
| service.type | string | `"ClusterIP"` | |
| serviceAccount.annotations | object | `{}` | |
| serviceAccount.automountServiceAccountToken | bool | `false` | |
Expand Down
2 changes: 1 addition & 1 deletion helm/safe-settings/templates/deployment.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ spec:
{{- end }}
ports:
- name: http
containerPort: {{ .Values.service.port }}
containerPort: 3000
protocol: TCP
resources:
{{- toYaml .Values.resources | nindent 12 }}
Expand Down
72 changes: 46 additions & 26 deletions helm/safe-settings/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# This is a YAML-formatted file.
# Declare variables to be passed into your templates.

replicaCount: 2
replicaCount: 1

image:
repository: ghcr.io/github/safe-settings
Expand Down Expand Up @@ -45,6 +45,26 @@ envFrom: []
# name: app-env

env: []
# - name: CRON
# value: '*/5 * * * *'
# - name: APP_ID
# valueFrom:
# secretKeyRef:
# name: github_app_secret
# key: app_id
# optional: false
# - name: PRIVATE_KEY
# valueFrom:
# secretKeyRef:
# name: github_app_secret
# key: private_key
# optional: false
# - name: WEBHOOK_SECRET
# valueFrom:
# secretKeyRef:
# name: github_app_secret
# key: webhook_secret
# optional: false

service:
type: ClusterIP
Expand Down Expand Up @@ -83,7 +103,7 @@ resources:

autoscaling:
enabled: false
minReplicas: 2
minReplicas: 1
maxReplicas: 10
targetCPUUtilizationPercentage: 80
# targetMemoryUtilizationPercentage: 80
Expand All @@ -104,30 +124,30 @@ deploymentConfig:
# If no file is specified, then the following repositories - 'admin', '.github', 'safe-settings' are exempted by default
exclude: ["^admin$", '^\.github$', "^safe-settings$", ".*-test"]
# Alternatively you can only include certain repos
include: ["^test$"]
configvalidators:
- plugin: collaborators
error: |
`Admin cannot be assigned to collaborators`
script: |
console.log(`baseConfig ${JSON.stringify(baseconfig)}`)
return baseconfig.permission != 'admin'
overridevalidators:
- plugin: branches
error: |
`Branch protection required_approving_review_count cannot be overidden to a lower value`
script: |
console.log(`baseConfig ${JSON.stringify(baseconfig)}`)
console.log(`overrideConfig ${JSON.stringify(overrideconfig)}`)
if (baseconfig.protection.required_pull_request_reviews.required_approving_review_count && overrideconfig.protection.required_pull_request_reviews.required_approving_review_count ) {
return overrideconfig.protection.required_pull_request_reviews.required_approving_review_count >= baseconfig.protection.required_pull_request_reviews.required_approving_review_count
}
return true
- plugin: labels
error: |
Some error
script: |
return true
include: [] # ["^test$"]
configvalidators: []
# - plugin: collaborators
# error: |
# `Admin cannot be assigned to collaborators`
# script: |
# console.log(`baseConfig ${JSON.stringify(baseconfig)}`)
# return baseconfig.permission != 'admin'
overridevalidators: []
# - plugin: branches
# error: |
# `Branch protection required_approving_review_count cannot be overidden to a lower value`
# script: |
# console.log(`baseConfig ${JSON.stringify(baseconfig)}`)
# console.log(`overrideConfig ${JSON.stringify(overrideconfig)}`)
# if (baseconfig.protection.required_pull_request_reviews.required_approving_review_count && overrideconfig.protection.required_pull_request_reviews.required_approving_review_count ) {
# return overrideconfig.protection.required_pull_request_reviews.required_approving_review_count >= baseconfig.protection.required_pull_request_reviews.required_approving_review_count
# }
# return true
# - plugin: labels
# error: |
# Some error
# script: |
# return true

# -- Add dynamic manifests via values. Example:
# extraObjects:
Expand Down