github.com/kubevela/workflow@v0.6.0/charts/vela-workflow/crds/core.oam.dev_workflowruns.yaml (about)

     1  ---
     2  apiVersion: apiextensions.k8s.io/v1
     3  kind: CustomResourceDefinition
     4  metadata:
     5    annotations:
     6      controller-gen.kubebuilder.io/version: v0.9.0
     7    creationTimestamp: null
     8    name: workflowruns.core.oam.dev
     9  spec:
    10    group: core.oam.dev
    11    names:
    12      categories:
    13      - oam
    14      kind: WorkflowRun
    15      listKind: WorkflowRunList
    16      plural: workflowruns
    17      shortNames:
    18      - wr
    19      singular: workflowrun
    20    scope: Namespaced
    21    versions:
    22    - additionalPrinterColumns:
    23      - jsonPath: .status.status
    24        name: PHASE
    25        type: string
    26      - jsonPath: .metadata.creationTimestamp
    27        name: AGE
    28        type: date
    29      name: v1alpha1
    30      schema:
    31        openAPIV3Schema:
    32          description: WorkflowRun is the Schema for the workflowRun API
    33          properties:
    34            apiVersion:
    35              description: 'APIVersion defines the versioned schema of this representation
    36                of an object. Servers should convert recognized schemas to the latest
    37                internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
    38              type: string
    39            kind:
    40              description: 'Kind is a string value representing the REST resource this
    41                object represents. Servers may infer this from the endpoint the client
    42                submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
    43              type: string
    44            metadata:
    45              type: object
    46            spec:
    47              description: WorkflowRunSpec is the spec for the WorkflowRun
    48              properties:
    49                context:
    50                  type: object
    51                  x-kubernetes-preserve-unknown-fields: true
    52                mode:
    53                  description: WorkflowExecuteMode defines the mode of workflow execution
    54                  properties:
    55                    steps:
    56                      description: Steps is the mode of workflow steps execution
    57                      type: string
    58                    subSteps:
    59                      description: SubSteps is the mode of workflow sub steps execution
    60                      type: string
    61                  type: object
    62                workflowRef:
    63                  type: string
    64                workflowSpec:
    65                  description: WorkflowSpec defines workflow steps and other attributes
    66                  properties:
    67                    steps:
    68                      items:
    69                        description: WorkflowStep defines how to execute a workflow
    70                          step.
    71                        properties:
    72                          dependsOn:
    73                            description: DependsOn is the dependency of the step
    74                            items:
    75                              type: string
    76                            type: array
    77                          if:
    78                            description: If is the if condition of the step
    79                            type: string
    80                          inputs:
    81                            description: Inputs is the inputs of the step
    82                            items:
    83                              description: InputItem defines an input variable of WorkflowStep
    84                              properties:
    85                                from:
    86                                  type: string
    87                                parameterKey:
    88                                  type: string
    89                              required:
    90                              - from
    91                              type: object
    92                            type: array
    93                          meta:
    94                            description: Meta is the meta data of the workflow step.
    95                            properties:
    96                              alias:
    97                                type: string
    98                            type: object
    99                          mode:
   100                            description: Mode is only valid for sub steps, it defines
   101                              the mode of the sub steps
   102                            nullable: true
   103                            type: string
   104                          name:
   105                            description: Name is the unique name of the workflow step.
   106                            type: string
   107                          outputs:
   108                            description: Outputs is the outputs of the step
   109                            items:
   110                              description: OutputItem defines an output variable of
   111                                WorkflowStep
   112                              properties:
   113                                name:
   114                                  type: string
   115                                valueFrom:
   116                                  type: string
   117                              required:
   118                              - name
   119                              - valueFrom
   120                              type: object
   121                            type: array
   122                          properties:
   123                            description: Properties is the properties of the step
   124                            type: object
   125                            x-kubernetes-preserve-unknown-fields: true
   126                          subSteps:
   127                            items:
   128                              description: WorkflowStepBase defines the workflow step
   129                                base
   130                              properties:
   131                                dependsOn:
   132                                  description: DependsOn is the dependency of the step
   133                                  items:
   134                                    type: string
   135                                  type: array
   136                                if:
   137                                  description: If is the if condition of the step
   138                                  type: string
   139                                inputs:
   140                                  description: Inputs is the inputs of the step
   141                                  items:
   142                                    description: InputItem defines an input variable
   143                                      of WorkflowStep
   144                                    properties:
   145                                      from:
   146                                        type: string
   147                                      parameterKey:
   148                                        type: string
   149                                    required:
   150                                    - from
   151                                    type: object
   152                                  type: array
   153                                meta:
   154                                  description: Meta is the meta data of the workflow
   155                                    step.
   156                                  properties:
   157                                    alias:
   158                                      type: string
   159                                  type: object
   160                                name:
   161                                  description: Name is the unique name of the workflow
   162                                    step.
   163                                  type: string
   164                                outputs:
   165                                  description: Outputs is the outputs of the step
   166                                  items:
   167                                    description: OutputItem defines an output variable
   168                                      of WorkflowStep
   169                                    properties:
   170                                      name:
   171                                        type: string
   172                                      valueFrom:
   173                                        type: string
   174                                    required:
   175                                    - name
   176                                    - valueFrom
   177                                    type: object
   178                                  type: array
   179                                properties:
   180                                  description: Properties is the properties of the step
   181                                  type: object
   182                                  x-kubernetes-preserve-unknown-fields: true
   183                                timeout:
   184                                  description: Timeout is the timeout of the step
   185                                  type: string
   186                                type:
   187                                  description: Type is the type of the workflow step.
   188                                  type: string
   189                              required:
   190                              - type
   191                              type: object
   192                            type: array
   193                          timeout:
   194                            description: Timeout is the timeout of the step
   195                            type: string
   196                          type:
   197                            description: Type is the type of the workflow step.
   198                            type: string
   199                        required:
   200                        - type
   201                        type: object
   202                      type: array
   203                  type: object
   204              type: object
   205            status:
   206              description: WorkflowRunStatus record the status of workflow run
   207              properties:
   208                conditions:
   209                  description: Conditions of the resource.
   210                  items:
   211                    description: A Condition that may apply to a resource.
   212                    properties:
   213                      lastTransitionTime:
   214                        description: LastTransitionTime is the last time this condition
   215                          transitioned from one status to another.
   216                        format: date-time
   217                        type: string
   218                      message:
   219                        description: A Message containing details about this condition's
   220                          last transition from one status to another, if any.
   221                        type: string
   222                      reason:
   223                        description: A Reason for this condition's last transition from
   224                          one status to another.
   225                        type: string
   226                      status:
   227                        description: Status of this condition; is it currently True,
   228                          False, or Unknown?
   229                        type: string
   230                      type:
   231                        description: Type of this condition. At most one of each condition
   232                          type may apply to a resource at any point in time.
   233                        type: string
   234                    required:
   235                    - lastTransitionTime
   236                    - reason
   237                    - status
   238                    - type
   239                    type: object
   240                  type: array
   241                contextBackend:
   242                  description: "ObjectReference contains enough information to let you
   243                    inspect or modify the referred object. --- New uses of this type
   244                    are discouraged because of difficulty describing its usage when
   245                    embedded in APIs. 1. Ignored fields.  It includes many fields which
   246                    are not generally honored.  For instance, ResourceVersion and FieldPath
   247                    are both very rarely valid in actual usage. 2. Invalid usage help.
   248                    \ It is impossible to add specific help for individual usage.  In
   249                    most embedded usages, there are particular restrictions like, \"must
   250                    refer only to types A and B\" or \"UID not honored\" or \"name must
   251                    be restricted\". Those cannot be well described when embedded. 3.
   252                    Inconsistent validation.  Because the usages are different, the
   253                    validation rules are different by usage, which makes it hard for
   254                    users to predict what will happen. 4. The fields are both imprecise
   255                    and overly precise.  Kind is not a precise mapping to a URL. This
   256                    can produce ambiguity during interpretation and require a REST mapping.
   257                    \ In most cases, the dependency is on the group,resource tuple and
   258                    the version of the actual struct is irrelevant. 5. We cannot easily
   259                    change it.  Because this type is embedded in many locations, updates
   260                    to this type will affect numerous schemas.  Don't make new APIs
   261                    embed an underspecified API type they do not control. \n Instead
   262                    of using this type, create a locally provided and used type that
   263                    is well-focused on your reference. For example, ServiceReferences
   264                    for admission registration: https://github.com/kubernetes/api/blob/release-1.17/admissionregistration/v1/types.go#L533
   265                    ."
   266                  properties:
   267                    apiVersion:
   268                      description: API version of the referent.
   269                      type: string
   270                    fieldPath:
   271                      description: 'If referring to a piece of an object instead of
   272                        an entire object, this string should contain a valid JSON/Go
   273                        field access statement, such as desiredState.manifest.containers[2].
   274                        For example, if the object reference is to a container within
   275                        a pod, this would take on a value like: "spec.containers{name}"
   276                        (where "name" refers to the name of the container that triggered
   277                        the event) or if no container name is specified "spec.containers[2]"
   278                        (container with index 2 in this pod). This syntax is chosen
   279                        only to have some well-defined way of referencing a part of
   280                        an object. TODO: this design is not final and this field is
   281                        subject to change in the future.'
   282                      type: string
   283                    kind:
   284                      description: 'Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
   285                      type: string
   286                    name:
   287                      description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
   288                      type: string
   289                    namespace:
   290                      description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
   291                      type: string
   292                    resourceVersion:
   293                      description: 'Specific resourceVersion to which this reference
   294                        is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency'
   295                      type: string
   296                    uid:
   297                      description: 'UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids'
   298                      type: string
   299                  type: object
   300                endTime:
   301                  format: date-time
   302                  type: string
   303                finished:
   304                  type: boolean
   305                message:
   306                  type: string
   307                mode:
   308                  description: WorkflowExecuteMode defines the mode of workflow execution
   309                  properties:
   310                    steps:
   311                      description: Steps is the mode of workflow steps execution
   312                      type: string
   313                    subSteps:
   314                      description: SubSteps is the mode of workflow sub steps execution
   315                      type: string
   316                  type: object
   317                startTime:
   318                  format: date-time
   319                  type: string
   320                status:
   321                  description: WorkflowRunPhase is a label for the condition of a WorkflowRun
   322                    at the current time
   323                  type: string
   324                steps:
   325                  items:
   326                    description: WorkflowStepStatus record the status of a workflow
   327                      step, include step status and subStep status
   328                    properties:
   329                      firstExecuteTime:
   330                        description: FirstExecuteTime is the first time this step execution.
   331                        format: date-time
   332                        type: string
   333                      id:
   334                        type: string
   335                      lastExecuteTime:
   336                        description: LastExecuteTime is the last time this step execution.
   337                        format: date-time
   338                        type: string
   339                      message:
   340                        description: A human readable message indicating details about
   341                          why the workflowStep is in this state.
   342                        type: string
   343                      name:
   344                        type: string
   345                      phase:
   346                        description: WorkflowStepPhase describes the phase of a workflow
   347                          step.
   348                        type: string
   349                      reason:
   350                        description: A brief CamelCase message indicating details about
   351                          why the workflowStep is in this state.
   352                        type: string
   353                      subSteps:
   354                        items:
   355                          description: StepStatus record the base status of workflow
   356                            step, which could be workflow step or subStep
   357                          properties:
   358                            firstExecuteTime:
   359                              description: FirstExecuteTime is the first time this step
   360                                execution.
   361                              format: date-time
   362                              type: string
   363                            id:
   364                              type: string
   365                            lastExecuteTime:
   366                              description: LastExecuteTime is the last time this step
   367                                execution.
   368                              format: date-time
   369                              type: string
   370                            message:
   371                              description: A human readable message indicating details
   372                                about why the workflowStep is in this state.
   373                              type: string
   374                            name:
   375                              type: string
   376                            phase:
   377                              description: WorkflowStepPhase describes the phase of
   378                                a workflow step.
   379                              type: string
   380                            reason:
   381                              description: A brief CamelCase message indicating details
   382                                about why the workflowStep is in this state.
   383                              type: string
   384                            type:
   385                              type: string
   386                          required:
   387                          - id
   388                          type: object
   389                        type: array
   390                      type:
   391                        type: string
   392                    required:
   393                    - id
   394                    type: object
   395                  type: array
   396                suspend:
   397                  type: boolean
   398                suspendState:
   399                  type: string
   400                terminated:
   401                  type: boolean
   402              required:
   403              - finished
   404              - mode
   405              - status
   406              - suspend
   407              - terminated
   408              type: object
   409          type: object
   410      served: true
   411      storage: true
   412      subresources:
   413        status: {}