Skip to content
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

Jump to bottom

Check storage class #98

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Check storage class #98

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3eed3a5
create a helper that tests for valid storage classes
colearendt Dec 1, 2021
809143a
show an example for how to use this
colearendt Dec 1, 2021
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: 5 additions & 0 deletions charts/rstudio-workbench/templates/NOTES.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,3 +38,8 @@ NOTE: `.Values.config.server.rserver\.conf.server-license-type` is configured ma
Please consider removing this configuration value.

{{- end }}

{{- /* check for invalid storage classes */ -}}
{{- if .Values.homeStorage.create }}
{{ include "rstudio-library.check-storage-class" (dict "accessModes" .Values.homeStorage.accessModes "storageClassName" .Values.homeStorage.storageClassName "key" "homeStorage" "check" true) }}
{{- end }}
45 changes: 45 additions & 0 deletions charts/rstudio-workbench/templates/_helpers.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -396,3 +396,48 @@ app.kubernetes.io/instance: {{ .Release.Name }}
{{- define "rstudio-workbench.xdg-config-dirs" -}}
{{ trimSuffix ":" ( join ":" (list .Values.xdgConfigDirs (join ":" .Values.xdgConfigDirsExtra) ) ) }}
{{- end -}}

{{- /*
A helper to check whether the provided storage class is a problematic one...
Unfortunately, Kubernetes does not "store" what access modes are allowed for a storage class
So we just store a list of known troublemakers (and reference docs here: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes)

Argument Dict:
"accessModes": required. the access modes for the given storage pvc
"storageClassName": required. the storage class name in use (or `false` if using the default)
"key": optional. default "storage". The values key to use when referencing `accessModes` or `storageClassName`
"check": optional. default true. Whether to run the check or not
*/ -}}
{{- define "rstudio-library.check-storage-class" -}}
{{- $allowedAccessModes := .accessModes }}
{{- $storageClassName := .storageClassName }}
{{- $key := .key | default "storage" }}
{{- $check := .check | default true }}
{{- if $check }}
{{- $storageClass := dict }}
{{- $isDefault := "" }}
{{- $knownNotReadWriteManyProvisioners := list "kubernetes.io/aws-ebs" }}
{{- $knownNotReadWriteManyClasses := list "gp2" }}
{{- $allStorageClasses := lookup "storage.k8s.io/v1" "StorageClass" "" "" }}
{{- range $sc := $allStorageClasses.items }}
{{- if not $storageClassName }}
{{- /* need to get the default */ -}}
{{- if eq (get $sc.metadata.annotations "storageclass.kubernetes.io/is-default-class") "true" }}
{{- /* this is the default storage class */ -}}
{{- $storageClassName = $sc.metadata.name }}
{{- $storageClass = $sc }}
{{- $isDefault = " (the default on this cluster)" }}
{{- end }}
{{- else if eq $storageClassName $sc.metadata.name }}
{{- $storageClass := $sc }}
{{- end }}
{{- end }}
{{- /* get the actual storage class */ -}}
{{- /* check whether the ReadWriteMany is valid */ -}}
{{- if has "ReadWriteMany" $allowedAccessModes -}}
{{- if or (has $storageClass.provisioner $knownNotReadWriteManyProvisioners) (has $storageClassName $knownNotReadWriteManyClasses) }}
{{- fail (printf "\n\nThe storage class '%s'%s is known to not support 'ReadWriteMany' PersistentVolumeClaims. This is important for proper disk provisioning. \nFix by setting `%s.accessModes` appropriately, changing `%s.storageClassName` or disabling this check with `%s.checkAccessModes: false`\n\n" $storageClassName $isDefault $key $key $key) -}}
{{- end }}
{{- end }}
{{- end }}
{{- end }}