MCAD CRD sync 04/20/2023

Signed-off-by: Anish Asthana <anishasthana1@gmail.com>

Author: anishasthana

bundle/manifests/mcad.ibm.com_appwrappers.yaml

@@ -1,3 +1,5 @@
+
+---
 apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
@@ -59,21 +61,13 @@ spec:
                             reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
                           type: string
                         completionstatus:
-                          description: Optional field that drives completion status
-                            of appwrapper. This field within an item of an appwrapper
-                            determines the full state of appwrapper. The completionstatus
-                            field contains a list of conditions that make the associate
-                            item considered completed, for instance :- completion
-                            conditions could be "Complete" or "Failed". The associated
-                            item's level .status.conditions[].type field is monitored
-                            for any one of these conditions.  Once all items with
-                            this option is set and the conditionstatus is met the
-                            entire appwrapper state will be changed to one of the
-                            valid appwrapper completion state. Note :- this is an
-                            AND operation for all items where this option is set.  See
-                            the list of appwrapper states for a list of valid complete
-                            states.
-                          type: string
+                          description: Optional field that drives completion status of appwrapper.
+                            This field within an item of an appwrapper determines the full state of appwrapper.
+                            The completionstatus field contains a list of conditions that make the associate item considered
+                            completed, for instance :- completion conditions could be "Complete" or "Failed".
+                            The associated item's level .status.conditions[].type field is monitored for any one of these conditions.  Once all items with this
+                            option is set and the conditionstatus is met the entire appwrapper state will be changed to one of the valid appwrapper completion state. Note :- this is an AND
+                            operation for all items where this option is set.  See the list of appwrapper states for a list of valid complete states.
                         custompodresources:
                           description: Optional section that specifies resource requirements
                             for non-standard k8s resources, follows same format as
@@ -259,36 +253,65 @@ spec:
                     type: object
                 type: object
               schedulingSpec:
-                description: SchedSpec specifies the parameters for scheduling.
+                description: Field 'schedulingSpec' specifies the parameters used for scheduling generic items
+                  wrapped inside AppWrappers. It defines the policy for requeuing jobs based on the number
+                  of running pods.
                 properties:
                   minAvailable:
+                    description: Expected number of pods in running and/or completed state. Requeuing is triggered
+                      when the number of running/completed pods is not equal to this value. When not specified,
+                      requeuing is disabled and no check is performed.
                     type: integer
-                  nodeSelector:
-                    additionalProperties:
-                      type: string
-                    type: object
                   requeuing:
-                    description: Specification of the requeuing strategy based on
-                      waiting time
+                    description: Specification of the requeuing strategy based on waiting time. Values in this field
+                      control how often the pod check should happen and if requeuing has reached its maximum number of
+                      times.
                     properties:
-                      growthType:
-                        default: exponential
-                        type: string
                       initialTimeInSeconds:
+                        description: Value to keep track of the initial wait time. Users cannot set this as it is
+                          taken from 'timeInSeconds'.
                         type: integer
-                      maxNumRequeuings:
-                        default: 0
+                      timeInSeconds:
+                        description: Initial waiting time before requeuing conditions are checked. This value is
+                          specified by the user, but it may grow as requeuing events happen.
                         type: integer
+                        default: 300
                       maxTimeInSeconds:
-                        default: 0
+                        description: Maximum waiting time for requeuing checks
                         type: integer
+                        default: 0
+                      growthType:
+                        description: Growth strategy to increase the waiting time between requeuing checks. The values
+                          available are 'exponential', 'linear', or 'none'. For example, 'exponential' growth would
+                          double the 'timeInSeconds' value every time a requeuing event is triggered. If the string value
+                          is misspelled or not one of the possible options, the growth behavior is defaulted to 'none'.
+                        type: string
+                        default: "exponential"
                       numRequeuings:
+                        description: Field to keep track of how many times a requeuing event has been triggered
+                        type: integer
                         default: 0
+                      maxNumRequeuings:
+                        description: Maximum number of requeuing events allowed. Once this value is reached (e.g.,
+                          'numRequeuings = maxNumRequeuings', no more requeuing checks are performed and the generic
+                          items are stopped and removed from the cluster (AppWrapper remains deployed).
                         type: integer
-                      timeInSeconds:
-                        default: 300
+                        default: 0
+                    type: object
+                  dispatchDuration:
+                    description: Wall clock duration time of appwrapper in seconds
+                    properties:
+                      expected:
+                        format: int32
+                        type: integer
+                      limit:
+                        format: int32
                         type: integer
                     type: object
+                  nodeSelector:
+                    additionalProperties:
+                      type: string
+                    type: object
                 type: object
               selector:
                 description: A label selector is a label query over a set of resources.
@@ -706,62 +729,38 @@ spec:
                   - type
                   type: object
                 type: array
-              controllerfirsttimestamp:
-                description: Microsecond level timestamp when controller first sees
-                  QueueJob (by Informer)
-                format: date-time
-                type: string
-              failed:
-                description: The number of resources which reached phase Failed.
-                format: int32
-                type: integer
-              filterignore:
-                description: Tell Informer to ignore this update message (do not generate
-                  a controller event)
-                type: boolean
-              isdispatched:
-                description: Is Dispatched?
-                type: boolean
-              local:
-                description: Indicate if message is a duplicate (for Informer to recognize
-                  duplicate messages)
-                type: boolean
-              message:
-                type: string
-              pending:
-                description: The number of pending pods.
-                format: int32
-                type: integer
               pendingpodconditions:
                 description: Represent conditions of pod(s) that failed scheduling.
                 items:
                   description: Describes scheduling failed condition(s) of a pod
                   properties:
+                    podname:
+                      description: Name of the pod
+                      type: string
                     conditions:
                       description: Failed condition(s) of a pod
                       items:
-                        description: DeploymentCondition describes the state of a
-                          deployment at a certain point.
+                        description: DeploymentCondition describes the state of a deployment
+                          at a certain point.
                         properties:
                           LastProbeTime:
-                            description: Last time the condition transitioned from
-                              one status to another.
+                            description: Last time the condition transitioned from one status
+                              to another.
                             format: date-time
                             type: string
                           LastTransitionTime:
                             description: The last time this condition was updated.
                             format: date-time
                             type: string
                           message:
-                            description: A human readable message indicating details
-                              about the transition.
+                            description: A human readable message indicating details about
+                              the transition.
                             type: string
                           reason:
                             description: The reason for the condition's last transition.
                             type: string
                           status:
-                            description: Status of the condition, one of True, False,
-                              Unknown.
+                            description: Status of the condition, one of True, False, Unknown.
                             type: string
                           type:
                             description: Type of appwrapper condition.
@@ -771,11 +770,34 @@ spec:
                         - type
                         type: object
                       type: array
-                    podname:
-                      description: Name of the pod
-                      type: string
                   type: object
                 type: array
+              controllerfirsttimestamp:
+                description: Microsecond level timestamp when controller first sees
+                  QueueJob (by Informer)
+                format: date-time
+                type: string
+              failed:
+                description: The number of resources which reached phase Failed.
+                format: int32
+                type: integer
+              filterignore:
+                description: Tell Informer to ignore this update message (do not generate
+                  a controller event)
+                type: boolean
+              isdispatched:
+                description: Is Dispatched?
+                type: boolean
+              local:
+                description: Indicate if message is a duplicate (for Informer to recognize
+                  duplicate messages)
+                type: boolean
+              message:
+                type: string
+              pending:
+                description: The number of pending pods.
+                format: int32
+                type: integer
               queuejobstate:
                 description: State of QueueJob - Init, Queueing, HeadOfLine, Rejoining,
                   ...
@@ -805,9 +827,3 @@ spec:
         type: object
     served: true
     storage: true
-status:
-  acceptedNames:
-    kind: ""
-    plural: ""
-  conditions: null
-  storedVersions: null

bundle/manifests/mcad.ibm.com_queuejobs.yaml

@@ -1,3 +1,5 @@
+
+---
 apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
@@ -37,36 +39,65 @@ spec:
               schedulerName:
                 type: string
               schedulingSpec:
-                description: SchedSpec specifies the parameters for scheduling.
+                description: Field 'schedulingSpec' specifies the parameters used for scheduling generic items
+                  wrapped inside AppWrappers. It defines the policy for requeuing jobs based on the number
+                  of running pods.
                 properties:
                   minAvailable:
+                    description: Expected number of pods in running and/or completed state. Requeuing is triggered
+                      when the number of running/completed pods is not equal to this value. When not specified,
+                      requeuing is disabled and no check is performed.
                     type: integer
-                  nodeSelector:
-                    additionalProperties:
-                      type: string
-                    type: object
                   requeuing:
-                    description: Specification of the requeuing strategy based on
-                      waiting time
+                    description: Specification of the requeuing strategy based on waiting time. Values in this field
+                      control how often the pod check should happen and if requeuing has reached its maximum number of
+                      times.
                     properties:
-                      growthType:
-                        default: exponential
-                        type: string
                       initialTimeInSeconds:
+                        description: Value to keep track of the initial wait time. Users cannot set this as it is
+                          taken from 'timeInSeconds'.
                         type: integer
-                      maxNumRequeuings:
-                        default: 0
+                      timeInSeconds:
+                        description: Initial waiting time before requeuing conditions are checked. This value is
+                          specified by the user, but it may grow as requeuing events happen.
                         type: integer
+                        default: 300
                       maxTimeInSeconds:
-                        default: 0
+                        description: Maximum waiting time for requeuing checks
                         type: integer
+                        default: 0
+                      growthType:
+                        description: Growth strategy to increase the waiting time between requeuing checks. The values
+                          available are 'exponential', 'linear', or 'none'. For example, 'exponential' growth would
+                          double the 'timeInSeconds' value every time a requeuing event is triggered. If the string value
+                          is misspelled or not one of the possible options, the growth behavior is defaulted to 'none'.
+                        type: string
+                        default: "exponential"
                       numRequeuings:
+                        description: Field to keep track of how many times a requeuing event has been triggered
+                        type: integer
                         default: 0
+                      maxNumRequeuings:
+                        description: Maximum number of requeuing events allowed. Once this value is reached (e.g.,
+                          'numRequeuings = maxNumRequeuings', no more requeuing checks are performed and the generic
+                          items are stopped and removed from the cluster (AppWrapper remains deployed).
                         type: integer
-                      timeInSeconds:
-                        default: 300
+                        default: 0
+                    type: object
+                  dispatchDuration:
+                    description: Wall clock duration time of appwrapper in seconds
+                    properties:
+                      expected:
+                        format: int32
+                        type: integer
+                      limit:
+                        format: int32
                         type: integer
                     type: object
+                  nodeSelector:
+                    additionalProperties:
+                      type: string
+                    type: object
                 type: object
               taskSpecs:
                 description: TaskSpecs specifies the task specification of QueueJob
@@ -6839,9 +6870,3 @@ spec:
         type: object
     served: true
     storage: true
-status:
-  acceptedNames:
-    kind: ""
-    plural: ""
-  conditions: null
-  storedVersions: null