From fb9068c72423d724a8e7135bc8d54886e6e4bb29 Mon Sep 17 00:00:00 2001 From: Alan Christie Date: Thu, 27 Jul 2023 09:38:39 +0100 Subject: [PATCH] docs: Improves doc for cores and memory --- decoder/job-definition-schema.yaml | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/decoder/job-definition-schema.yaml b/decoder/job-definition-schema.yaml index 701ceb7..ab5fa2a 100644 --- a/decoder/job-definition-schema.yaml +++ b/decoder/job-definition-schema.yaml @@ -148,6 +148,10 @@ definitions: # A kubernetes CPU (cores) declaration (minimum of 10m). # Here we allow an up-to 4-digit 'm' value or a 2-digit integer. + # The value is used by the Data Manager to set the corresponding Job + # resource request and limit values. By providing this value you + # essentially define a "guaranteed" minimum CPU allocation for the Job. + # If you do not specify a value, the Data Manager will use a default. cores: oneOf: - type: string @@ -159,6 +163,10 @@ definitions: # A kubernetes memory declaration. # Here we allow an up-to 4-digit Mi value (minimum of 100Mi) # or a 2-digit Gi value (minimum of 1G). + # The value is used by the Data Manager to set the corresponding Job + # resource request and limit values. By providing this value you + # essentially define a "guaranteed" minimum memory budget for the Job. + # If you do not specify a value, the Data Manager will use a default. memory: type: string pattern: '^([1-9][0-9]{2,3}Mi|[1-9][0-9]{0,1}Gi)$'