Skip to content

Commit ef874ba

Browse files
committed
changing name to be more readable
1 parent d167f3d commit ef874ba

5 files changed

Lines changed: 33 additions & 34 deletions

File tree

helm/blueapi/README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,12 @@ A Helm chart deploying a worker pod that runs Bluesky plans
3232
| podAnnotations | object | `{}` | |
3333
| podLabels | object | `{}` | |
3434
| podSecurityContext | object | `{}` | |
35-
| pvcautodeletion.enabled | bool | `true` | |
35+
| pvcAutoDeletion.enabled | bool | `true` | |
3636
| readinessProbe | object | `{"failureThreshold":2,"httpGet":{"path":"/healthz","port":"http"},"periodSeconds":10}` | Readiness probe, if configured kubernetes will not route traffic to this pod if failed consecutively. This could allow the service time to recover if it is being overwhelmed by traffic, but without the to ability to load balance or scale up/outwards, upstream services will need to know to back off. This is automatically disabled when in debug mode. |
37-
| resources | object | `{"limits":{"cpu":"2000m","memory":"4000Mi"},"requests":{"cpu":"200m","memory":"400Mi"}}` | Sets the compute resources available to the pod. These defaults are appropriate when using debug mode or an internal PVC and therefore running VS Code server in the pod. In the Diamond cluster, requests must be >= 0.1*limits When not using either of the above, the limits may be lowered. When idle but connected, blueapi consumes ~400MB of memory and 1% cpu and may struggle when allocated less. |
37+
| resources.limits.cpu | string | `"2000m"` | |
38+
| resources.limits.memory | string | `"4000Mi"` | |
39+
| resources.requests.cpu | string | `"200m"` | |
40+
| resources.requests.memory | string | `"400Mi"` | |
3841
| restartOnConfigChange | bool | `true` | If enabled the blueapi pod will restart on changes to `worker` |
3942
| securityContext.runAsNonRoot | bool | `true` | |
4043
| securityContext.runAsUser | int | `1000` | |
@@ -53,6 +56,5 @@ A Helm chart deploying a worker pod that runs Bluesky plans
5356
| worker | object | `{"api":{"url":"http://0.0.0.0:8000/"},"env":{"sources":[{"kind":"planFunctions","module":"dodal.plans"},{"kind":"planFunctions","module":"dodal.plan_stubs.wrapped"}]},"logging":{"graylog":{"enabled":false,"url":"tcp://graylog-log-target.diamond.ac.uk:12231/"},"level":"INFO"},"scratch":{"repositories":[],"root":"/workspace"},"stomp":{"auth":{"password":"guest","username":"guest"},"enabled":false,"url":"tcp://rabbitmq:61613/"}}` | Config for the worker goes here, will be mounted into a config file |
5457
| worker.api.url | string | `"http://0.0.0.0:8000/"` | 0.0.0.0 required to allow non-loopback traffic If using hostNetwork, the port must be free on the host |
5558
| worker.env.sources | list | `[{"kind":"planFunctions","module":"dodal.plans"},{"kind":"planFunctions","module":"dodal.plan_stubs.wrapped"}]` | modules (must be installed in the venv) to fetch devices/plans from |
56-
| worker.logging | object | `{"graylog":{"enabled":false,"url":"tcp://graylog-log-target.diamond.ac.uk:12231/"},"level":"INFO"}` | Configures logging. Port 12231 is the `dodal` input on graylog which will be renamed `blueapi` |
5759
| worker.scratch | object | `{"repositories":[],"root":"/workspace"}` | If initContainer is enabled the default branch of python projects in this section are installed into the venv *without their dependencies* |
5860
| worker.stomp | object | `{"auth":{"password":"guest","username":"guest"},"enabled":false,"url":"tcp://rabbitmq:61613/"}` | Message bus configuration for returning status to GDA/forwarding documents downstream Password may be in the form ${ENV_VAR} to be fetched from an environment variable e.g. mounted from a SealedSecret |

helm/blueapi/templates/configmap.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,11 +48,11 @@ data:
4848
{{- end }}
4949

5050
---
51-
{{- if .Values.pvcautodeletion.enabled }}
51+
{{- if .Values.pvcAutoDeletion.enabled }}
5252
apiVersion: v1
5353
kind: ConfigMap
5454
metadata:
55-
name : {{include "blueapi.fullname" . }}-pvc-autodeletion-script
55+
name : {{include "blueapi.fullname" . }}-pvc-auto-deletion-script
5656
data:
5757
{{- $files := .Files }}
5858
pvc-deletion.sh: |-

helm/blueapi/templates/cronjob.yaml

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ spec:
4545
spec:
4646
# amount of attempts of labeling a pvc
4747
backoffLimit: 3
48-
# job stops after 60 seconds
49-
activeDeadlineSeconds: 60
48+
# job stops after 180 seconds
49+
activeDeadlineSeconds: 180
5050
template:
5151
spec:
5252
serviceAccountName: {{ include "blueapi.fullname" . }}-last-used-stamper
@@ -77,19 +77,19 @@ spec:
7777
command: ["/scripts/time-stamper.sh"]
7878
restartPolicy: OnFailure
7979
{{- end }}
80-
{{- if .Values.pvcautodeletion.enabled }}
80+
{{- if .Values.pvcAutoDeletion.enabled }}
8181
---
8282
apiVersion: v1
8383
kind: ServiceAccount
8484
metadata:
85-
name: {{ include "blueapi.fullname" . }}-pvcautodeletion
85+
name: {{ include "blueapi.fullname" . }}-pvc-auto-deletion
8686
namespace: {{ .Release.Namespace }}
8787
automountServiceAccountToken: true
8888
---
8989
apiVersion: rbac.authorization.k8s.io/v1
9090
kind: Role
9191
metadata:
92-
name: {{ include "blueapi.fullname" . }}-pvcautodeletion
92+
name: {{ include "blueapi.fullname" . }}-pvc-auto-deletion
9393
namespace: {{ .Release.Namespace }}
9494
rules:
9595
- apiGroups: [""]
@@ -99,21 +99,21 @@ rules:
9999
apiVersion: rbac.authorization.k8s.io/v1
100100
kind: RoleBinding
101101
metadata:
102-
name: {{ include "blueapi.fullname" . }}-pvcautodeletion
102+
name: {{ include "blueapi.fullname" . }}-pvc-auto-deletion
103103
namespace: {{ .Release.Namespace }}
104104
subjects:
105105
- kind: ServiceAccount
106-
name: {{ include "blueapi.fullname" . }}-pvcautodeletion
106+
name: {{ include "blueapi.fullname" . }}-pvc-auto-deletion
107107
namespace: {{ .Release.Namespace }}
108108
roleRef:
109109
kind: Role
110-
name: {{ include "blueapi.fullname" . }}-pvcautodeletion
110+
name: {{ include "blueapi.fullname" . }}-pvc-auto-deletion
111111
apiGroup: rbac.authorization.k8s.io
112112
---
113113
apiVersion: batch/v1
114114
kind: CronJob
115115
metadata:
116-
name: {{ include "blueapi.fullname" . }}-pvcautodeletion
116+
name: {{ include "blueapi.fullname" . }}-pvc-auto-deletion
117117
namespace: {{ .Release.Namespace }}
118118
spec:
119119
concurrencyPolicy: Forbid
@@ -129,28 +129,28 @@ spec:
129129
activeDeadlineSeconds: 300
130130
template:
131131
spec:
132-
serviceAccountName: {{ include "blueapi.fullname" . }}-pvcautodeletion
132+
serviceAccountName: {{ include "blueapi.fullname" . }}-pvc-auto-deletion
133133
{{- with .Values.tolerations }}
134134
tolerations:
135135
{{- toYaml . | nindent 12 }}
136136
{{- end }}
137137

138138
volumes:
139-
- name : {{include "blueapi.fullname" . }}-pvc-autodeletion-script
139+
- name : {{include "blueapi.fullname" . }}-pvc-auto-deletion-script
140140
configMap:
141-
name: {{include "blueapi.fullname" . }}-pvc-autodeletion-script
141+
name: {{include "blueapi.fullname" . }}-pvc-auto-deletion-script
142142
defaultMode: 0555
143143

144144

145145
containers:
146-
- name: pvcautodeletion
146+
- name: pvc-auto-deletion
147147
env:
148148
- name: RELEASE_NAME
149149
value: {{ .Release.Name }}
150150
- name: RELEASE_NAMESPACE
151151
value: {{ .Release.Namespace }}
152152
volumeMounts:
153-
- name: {{include "blueapi.fullname" . }}-pvc-autodeletion-script
153+
- name: {{include "blueapi.fullname" . }}-pvc-auto-deletion-script
154154
mountPath: /scripts
155155
image: bitnami/kubectl:latest
156156
imagePullPolicy: IfNotPresent

helm/blueapi/values.schema.json

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@
174174
"podSecurityContext": {
175175
"type": "object"
176176
},
177-
"pvcautodeletion": {
177+
"pvcAutoDeletion": {
178178
"type": "object",
179179
"properties": {
180180
"enabled": {
@@ -206,7 +206,6 @@
206206
}
207207
},
208208
"resources": {
209-
"description": "Sets the compute resources available to the pod. These defaults are appropriate when using debug mode or an internal PVC and therefore running VS Code server in the pod. In the Diamond cluster, requests must be \u003e= 0.1*limits When not using either of the above, the limits may be lowered. When idle but connected, blueapi consumes ~400MB of memory and 1% cpu and may struggle when allocated less.",
210209
"type": "object",
211210
"properties": {
212211
"limits": {
@@ -405,7 +404,6 @@
405404
}
406405
},
407406
"logging": {
408-
"description": "Configures logging. Port 12231 is the `dodal` input on graylog which will be renamed `blueapi`",
409407
"type": "object",
410408
"properties": {
411409
"graylog": {

helm/blueapi/values.yaml

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,7 @@ podAnnotations: {}
3636
# For more information checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
3737
podLabels: {}
3838

39-
podSecurityContext: {}
40-
# fsGroup: 2000
39+
podSecurityContext: {} # fsGroup: 2000
4140

4241
securityContext:
4342
# https://github.com/DiamondLightSource/blueapi/issues/1096
@@ -48,7 +47,7 @@ securityContext:
4847
# drop:
4948
# - ALL
5049

51-
# This is for setting up a service more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/
50+
# This is for setting up a service more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/
5251
service:
5352
# This sets the service type more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types
5453
# -- To make blueapi available on an IP outside of the cluster prior to an Ingress being created, change this to LoadBalancer
@@ -76,13 +75,13 @@ ingress:
7675
# hosts:
7776
# - chart-example.local
7877

79-
# -- Sets the compute resources available to the pod.
80-
# These defaults are appropriate when using debug mode or an internal PVC and therefore
81-
# running VS Code server in the pod.
82-
# In the Diamond cluster, requests must be >= 0.1*limits
83-
# When not using either of the above, the limits may be lowered.
84-
# When idle but connected, blueapi consumes ~400MB of memory and 1% cpu
85-
# and may struggle when allocated less.
78+
# -- Sets the compute resources available to the pod.
79+
# These defaults are appropriate when using debug mode or an internal PVC and therefore
80+
# running VS Code server in the pod.
81+
# In the Diamond cluster, requests must be >= 0.1*limits
82+
# When not using either of the above, the limits may be lowered.
83+
# When idle but connected, blueapi consumes ~400MB of memory and 1% cpu
84+
# and may struggle when allocated less.
8685
resources:
8786
# We usually recommend not to specify default resources and to leave this as a conscious
8887
# choice for the user. This also increases chances charts run on environments with little
@@ -205,7 +204,7 @@ worker:
205204
repositories: []
206205
# - name: "dodal"
207206
# remote_url: https://github.com/DiamondLightSource/dodal.git
208-
# -- Configures logging. Port 12231 is the `dodal` input on graylog which will be renamed `blueapi`
207+
# -- Configures logging. Port 12231 is the `dodal` input on graylog which will be renamed `blueapi`
209208
logging:
210209
level: "INFO"
211210
graylog:
@@ -227,7 +226,7 @@ initContainer:
227226
timeStampCron:
228227
enabled: true
229228

230-
pvcautodeletion:
229+
pvcAutoDeletion:
231230
enabled: true
232231

233232
debug:

0 commit comments

Comments
 (0)