| --- |
| apiVersion: apiextensions.k8s.io/v1 |
| kind: CustomResourceDefinition |
| metadata: |
| annotations: |
| controller-gen.kubebuilder.io/version: v0.9.2 |
| creationTimestamp: null |
| name: sonataflows.sonataflow.org |
| spec: |
| group: sonataflow.org |
| names: |
| kind: SonataFlow |
| listKind: SonataFlowList |
| plural: sonataflows |
| shortNames: |
| - sf |
| - workflow |
| - workflows |
| singular: sonataflow |
| scope: Namespaced |
| versions: |
| - additionalPrinterColumns: |
| - jsonPath: .metadata.annotations.sonataflow\.org\/profile |
| name: Profile |
| type: string |
| - jsonPath: .metadata.annotations.sonataflow\.org\/version |
| name: Version |
| type: string |
| - jsonPath: .status.endpoint |
| name: URL |
| type: string |
| - jsonPath: .status.conditions[?(@.type=='Running')].status |
| name: Ready |
| type: string |
| - jsonPath: .status.conditions[?(@.type=='Running')].reason |
| name: Reason |
| type: string |
| name: v1alpha08 |
| schema: |
| openAPIV3Schema: |
| description: SonataFlow is the descriptor representation for a workflow application |
| based on the CNCF Serverless Workflow specification. |
| properties: |
| apiVersion: |
| description: 'APIVersion defines the versioned schema of this representation |
| of an object. Servers should convert recognized schemas to the latest |
| internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' |
| type: string |
| kind: |
| description: 'Kind is a string value representing the REST resource this |
| object represents. Servers may infer this from the endpoint the client |
| submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' |
| type: string |
| metadata: |
| type: object |
| spec: |
| description: SonataFlowSpec defines the desired state of SonataFlow |
| properties: |
| flow: |
| description: Flow the workflow definition. |
| properties: |
| annotations: |
| description: Annotations List of helpful terms describing the |
| workflows intended purpose, subject areas, or other important |
| qualities. |
| items: |
| type: string |
| type: array |
| auth: |
| description: Auth definitions can be used to define authentication |
| information that should be applied to resources defined in the |
| operation property of function definitions. It is not used as |
| authentication information for the function invocation, but |
| just to access the resource containing the function invocation |
| information. |
| x-kubernetes-preserve-unknown-fields: true |
| autoRetries: |
| description: AutoRetries If set to true, actions should automatically |
| be retried on unchecked errors. Default is false |
| type: boolean |
| constants: |
| additionalProperties: |
| description: RawMessage is a raw encoded JSON value. It implements |
| Marshaler and Unmarshaler and can be used to delay JSON decoding |
| or precompute a JSON encoding. |
| format: byte |
| type: string |
| description: Constants Workflow constants are used to define static, |
| and immutable, data which is available to Workflow Expressions. |
| type: object |
| dataInputSchema: |
| description: DataInputSchema URI of the JSON Schema used to validate |
| the workflow data input |
| properties: |
| failOnValidationErrors: |
| type: boolean |
| schema: |
| type: string |
| required: |
| - failOnValidationErrors |
| - schema |
| type: object |
| errors: |
| description: Defines checked errors that can be explicitly handled |
| during workflow execution. |
| items: |
| description: Error declaration for workflow definitions |
| properties: |
| code: |
| description: Code OnError code. Can be used in addition |
| to the name to help runtimes resolve to technical errors/exceptions. |
| Should not be defined if error is set to '*'. |
| type: string |
| description: |
| description: OnError description. |
| type: string |
| name: |
| description: Name Domain-specific error name. |
| type: string |
| required: |
| - name |
| type: object |
| type: array |
| events: |
| items: |
| description: Event used to define events and their correlations |
| properties: |
| correlation: |
| description: Define event correlation rules for this event. |
| Only used for consumed events. |
| items: |
| description: Correlation define event correlation rules |
| for an event. Only used for `consumed` events |
| properties: |
| contextAttributeName: |
| description: CloudEvent Extension Context Attribute |
| name |
| type: string |
| contextAttributeValue: |
| description: CloudEvent Extension Context Attribute |
| value |
| type: string |
| required: |
| - contextAttributeName |
| type: object |
| type: array |
| dataOnly: |
| description: If `true`, only the Event payload is accessible |
| to consuming Workflow states. If `false`, both event payload |
| and context attributes should be accessible. Defaults |
| to true. |
| type: boolean |
| kind: |
| default: consumed |
| description: Defines the CloudEvent as either 'consumed' |
| or 'produced' by the workflow. Defaults to `consumed`. |
| enum: |
| - consumed |
| - produced |
| type: string |
| metadata: |
| additionalProperties: |
| type: object |
| description: Metadata information |
| type: object |
| name: |
| description: Unique event name. |
| type: string |
| source: |
| description: CloudEvent source. |
| type: string |
| type: |
| description: CloudEvent type. |
| type: string |
| required: |
| - name |
| - type |
| type: object |
| type: array |
| functions: |
| items: |
| description: Function ... |
| properties: |
| authRef: |
| description: References an auth definition name to be used |
| to access to resource defined in the operation parameter. |
| type: string |
| metadata: |
| additionalProperties: |
| type: object |
| description: Metadata information |
| type: object |
| name: |
| description: Unique function name |
| type: string |
| operation: |
| description: If type is `rest`, <path_to_openapi_definition>#<operation_id>. |
| If type is `rpc`, <path_to_grpc_proto_file>#<service_name>#<service_method>. |
| If type is `expression`, defines the workflow expression. |
| If the type is `custom`, <path_to_custom_script>#<custom_service_method>. |
| type: string |
| type: |
| default: rest |
| description: Defines the function type. Is either `custom`, |
| `rest`, `rpc`, `expression`, `graphql`, `odata` or `asyncapi`. |
| Default is `rest`. |
| enum: |
| - rest |
| - rpc |
| - expression |
| - graphql |
| - odata |
| - asyncapi |
| - custom |
| type: string |
| required: |
| - name |
| - operation |
| type: object |
| type: array |
| keepActive: |
| description: If "true", workflow instances is not terminated when |
| there are no active execution paths. Instance can be terminated |
| with "terminate end definition" or reaching defined "workflowExecTimeout" |
| type: boolean |
| metadata: |
| description: Metadata custom information shared with the runtime. |
| x-kubernetes-preserve-unknown-fields: true |
| retries: |
| items: |
| description: Retry ... |
| properties: |
| delay: |
| description: Time delay between retry attempts (ISO 8601 |
| duration format) |
| type: string |
| increment: |
| description: Static value by which the delay increases during |
| each attempt (ISO 8601 time format) |
| type: string |
| jitter: |
| description: 'If float type, maximum amount of random time |
| added or subtracted from the delay between each retry |
| relative to total delay (between 0 and 1). If string type, |
| absolute maximum amount of random time added or subtracted |
| from the delay between each retry (ISO 8601 duration format) |
| TODO: make iso8601duration compatible this type' |
| properties: |
| floatVal: |
| type: number |
| strVal: |
| type: string |
| type: |
| description: Type represents the stored type of Float32OrString. |
| format: int64 |
| type: integer |
| type: object |
| maxAttempts: |
| anyOf: |
| - type: integer |
| - type: string |
| description: Maximum number of retry attempts. |
| x-kubernetes-int-or-string: true |
| maxDelay: |
| description: Maximum time delay between retry attempts (ISO |
| 8601 duration format) |
| type: string |
| multiplier: |
| description: Numeric value, if specified the delay between |
| retries is multiplied by this value. |
| properties: |
| floatVal: |
| type: number |
| strVal: |
| type: string |
| type: |
| description: Type represents the stored type of Float32OrString. |
| format: int64 |
| type: integer |
| type: object |
| name: |
| description: Unique retry strategy name |
| type: string |
| required: |
| - maxAttempts |
| - name |
| type: object |
| type: array |
| secrets: |
| description: Secrets allow you to access sensitive information, |
| such as passwords, OAuth tokens, ssh keys, etc, inside your |
| Workflow Expressions. |
| items: |
| type: string |
| type: array |
| start: |
| description: Workflow start definition. |
| x-kubernetes-preserve-unknown-fields: true |
| states: |
| items: |
| properties: |
| callbackState: |
| description: callbackState executes a function and waits |
| for callback event that indicates completion of the task. |
| properties: |
| action: |
| description: Defines the action to be executed. |
| properties: |
| actionDataFilter: |
| description: Filter the state data to select only |
| the data that can be used within function definition |
| arguments using its fromStateData property. Filter |
| the action results to select only the result data |
| that should be added/merged back into the state |
| data using its results property. Select the part |
| of state data which the action data results should |
| be added/merged to using the toStateData property. |
| properties: |
| fromStateData: |
| description: Workflow expression that filters |
| state data that can be used by the action. |
| type: string |
| results: |
| description: Workflow expression that filters |
| the actions data results. |
| type: string |
| toStateData: |
| description: Workflow expression that selects |
| a state data element to which the action results |
| should be added/merged into. If not specified |
| denotes the top-level state data element. |
| type: string |
| useResults: |
| description: If set to false, action data results |
| are not added/merged to state data. In this |
| case 'results' and 'toStateData' should be |
| ignored. Default is true. |
| type: boolean |
| type: object |
| condition: |
| description: Expression, if defined, must evaluate |
| to true for this action to be performed. If false, |
| action is disregarded. |
| type: string |
| eventRef: |
| description: References a 'trigger' and 'result' |
| reusable event definitions. |
| properties: |
| contextAttributes: |
| additionalProperties: |
| type: object |
| description: Add additional extension context |
| attributes to the produced event. |
| type: object |
| data: |
| description: If string type, an expression which |
| selects parts of the states data output to |
| become the data (payload) of the event referenced |
| by triggerEventRef. If object type, a custom |
| object to become the data (payload) of the |
| event referenced by triggerEventRef. |
| type: object |
| invoke: |
| default: sync |
| description: Specifies if the function should |
| be invoked sync or async. Default is sync. |
| enum: |
| - async |
| - sync |
| type: string |
| resultEventRef: |
| description: Reference to the unique name of |
| a 'consumed' event definition |
| type: string |
| resultEventTimeout: |
| description: Maximum amount of time (ISO 8601 |
| format) to wait for the result event. If not |
| defined it be set to the actionExecutionTimeout |
| type: string |
| triggerEventRef: |
| description: Reference to the unique name of |
| a 'produced' event definition, |
| type: string |
| required: |
| - resultEventRef |
| - triggerEventRef |
| type: object |
| functionRef: |
| description: References a reusable function definition. |
| properties: |
| arguments: |
| additionalProperties: |
| type: object |
| description: 'Arguments (inputs) to be passed |
| to the referenced function TODO: validate |
| it as required if function type is graphql' |
| type: object |
| invoke: |
| default: sync |
| description: Specifies if the function should |
| be invoked sync or async. Default is sync. |
| enum: |
| - async |
| - sync |
| type: string |
| refName: |
| description: Name of the referenced function. |
| type: string |
| selectionSet: |
| description: 'Used if function type is graphql. |
| String containing a valid GraphQL selection |
| set. TODO: validate it as required if function |
| type is graphql' |
| type: string |
| required: |
| - refName |
| type: object |
| id: |
| description: Defines Unique action identifier. |
| type: string |
| name: |
| description: Defines Unique action name. |
| type: string |
| nonRetryableErrors: |
| description: List of unique references to defined |
| workflow errors for which the action should not |
| be retried. Used only when `autoRetries` is set |
| to `true` |
| items: |
| type: string |
| type: array |
| retryRef: |
| description: References a defined workflow retry |
| definition. If not defined uses the default runtime |
| retry definition. |
| type: string |
| retryableErrors: |
| description: List of unique references to defined |
| workflow errors for which the action should be |
| retried. Used only when `autoRetries` is set to |
| `false` |
| items: |
| type: string |
| type: array |
| sleep: |
| description: Defines time period workflow execution |
| should sleep before / after function execution. |
| properties: |
| after: |
| description: Defines amount of time (ISO 8601 |
| duration format) to sleep after function/subflow |
| invocation. Does not apply if 'eventRef' is |
| defined. |
| type: string |
| before: |
| description: Defines amount of time (ISO 8601 |
| duration format) to sleep before function/subflow |
| invocation. Does not apply if 'eventRef' is |
| defined. |
| type: string |
| type: object |
| subFlowRef: |
| description: References a workflow to be invoked. |
| properties: |
| invoke: |
| default: sync |
| description: Specifies if the subflow should |
| be invoked sync or async. Defaults to sync. |
| enum: |
| - async |
| - sync |
| type: string |
| onParentComplete: |
| default: terminate |
| description: onParentComplete specifies how |
| subflow execution should behave when parent |
| workflow completes if invoke is 'async'. Defaults |
| to terminate. |
| enum: |
| - terminate |
| - continue |
| type: string |
| version: |
| description: Sub-workflow version |
| type: string |
| workflowId: |
| description: Sub-workflow unique id |
| type: string |
| required: |
| - workflowId |
| type: object |
| type: object |
| eventDataFilter: |
| description: Event data filter definition. |
| properties: |
| data: |
| description: Workflow expression that filters of |
| the event data (payload). |
| type: string |
| toStateData: |
| description: Workflow expression that selects a |
| state data element to which the action results |
| should be added/merged into. If not specified |
| denotes the top-level state data element |
| type: string |
| useData: |
| description: If set to false, event payload is not |
| added/merged to state data. In this case 'data' |
| and 'toStateData' should be ignored. Default is |
| true. |
| type: boolean |
| type: object |
| eventRef: |
| description: References a unique callback event name |
| in the defined workflow events. |
| type: string |
| timeouts: |
| description: Time period to wait for incoming events |
| (ISO 8601 format) |
| properties: |
| actionExecTimeout: |
| description: Default single actions definition execution |
| timeout (ISO 8601 duration format) |
| type: string |
| eventTimeout: |
| description: Default timeout for consuming defined |
| events (ISO 8601 duration format) |
| type: string |
| stateExecTimeout: |
| description: Default workflow state execution timeout |
| (ISO 8601 duration format) |
| properties: |
| single: |
| description: Single state execution timeout, |
| not including retries (ISO 8601 duration format) |
| type: string |
| total: |
| description: Total state execution timeout, |
| including retries (ISO 8601 duration format) |
| type: string |
| required: |
| - total |
| type: object |
| type: object |
| required: |
| - action |
| - eventRef |
| type: object |
| compensatedBy: |
| description: Unique Name of a workflow state which is responsible |
| for compensation of this state. |
| type: string |
| delayState: |
| description: delayState Causes the workflow execution to |
| delay for a specified duration. |
| properties: |
| timeDelay: |
| description: Amount of time (ISO 8601 format) to delay |
| type: string |
| required: |
| - timeDelay |
| type: object |
| end: |
| description: State end definition. |
| x-kubernetes-preserve-unknown-fields: true |
| eventState: |
| description: event states await one or more events and perform |
| actions when they are received. If defined as the workflow |
| starting state, the event state definition controls when |
| the workflow instances should be created. |
| properties: |
| exclusive: |
| default: true |
| description: If true consuming one of the defined events |
| causes its associated actions to be performed. If |
| false all the defined events must be consumed in order |
| for actions to be performed. Defaults to true. |
| type: boolean |
| onEvents: |
| description: Define the events to be consumed and optional |
| actions to be performed. |
| items: |
| description: OnEvents define which actions are be |
| performed for the one or more events. |
| properties: |
| actionMode: |
| default: sequential |
| description: Should actions be performed sequentially |
| or in parallel. Default is sequential. |
| enum: |
| - sequential |
| - parallel |
| type: string |
| actions: |
| description: Actions to be performed if expression |
| matches |
| items: |
| description: Action specify invocations of services |
| or other workflows during workflow execution. |
| properties: |
| actionDataFilter: |
| description: Filter the state data to select |
| only the data that can be used within |
| function definition arguments using its |
| fromStateData property. Filter the action |
| results to select only the result data |
| that should be added/merged back into |
| the state data using its results property. |
| Select the part of state data which the |
| action data results should be added/merged |
| to using the toStateData property. |
| properties: |
| fromStateData: |
| description: Workflow expression that |
| filters state data that can be used |
| by the action. |
| type: string |
| results: |
| description: Workflow expression that |
| filters the actions data results. |
| type: string |
| toStateData: |
| description: Workflow expression that |
| selects a state data element to which |
| the action results should be added/merged |
| into. If not specified denotes the |
| top-level state data element. |
| type: string |
| useResults: |
| description: If set to false, action |
| data results are not added/merged |
| to state data. In this case 'results' |
| and 'toStateData' should be ignored. |
| Default is true. |
| type: boolean |
| type: object |
| condition: |
| description: Expression, if defined, must |
| evaluate to true for this action to be |
| performed. If false, action is disregarded. |
| type: string |
| eventRef: |
| description: References a 'trigger' and |
| 'result' reusable event definitions. |
| properties: |
| contextAttributes: |
| additionalProperties: |
| type: object |
| description: Add additional extension |
| context attributes to the produced |
| event. |
| type: object |
| data: |
| description: If string type, an expression |
| which selects parts of the states |
| data output to become the data (payload) |
| of the event referenced by triggerEventRef. |
| If object type, a custom object to |
| become the data (payload) of the event |
| referenced by triggerEventRef. |
| type: object |
| invoke: |
| default: sync |
| description: Specifies if the function |
| should be invoked sync or async. Default |
| is sync. |
| enum: |
| - async |
| - sync |
| type: string |
| resultEventRef: |
| description: Reference to the unique |
| name of a 'consumed' event definition |
| type: string |
| resultEventTimeout: |
| description: Maximum amount of time |
| (ISO 8601 format) to wait for the |
| result event. If not defined it be |
| set to the actionExecutionTimeout |
| type: string |
| triggerEventRef: |
| description: Reference to the unique |
| name of a 'produced' event definition, |
| type: string |
| required: |
| - resultEventRef |
| - triggerEventRef |
| type: object |
| functionRef: |
| description: References a reusable function |
| definition. |
| properties: |
| arguments: |
| additionalProperties: |
| type: object |
| description: 'Arguments (inputs) to |
| be passed to the referenced function |
| TODO: validate it as required if function |
| type is graphql' |
| type: object |
| invoke: |
| default: sync |
| description: Specifies if the function |
| should be invoked sync or async. Default |
| is sync. |
| enum: |
| - async |
| - sync |
| type: string |
| refName: |
| description: Name of the referenced |
| function. |
| type: string |
| selectionSet: |
| description: 'Used if function type |
| is graphql. String containing a valid |
| GraphQL selection set. TODO: validate |
| it as required if function type is |
| graphql' |
| type: string |
| required: |
| - refName |
| type: object |
| id: |
| description: Defines Unique action identifier. |
| type: string |
| name: |
| description: Defines Unique action name. |
| type: string |
| nonRetryableErrors: |
| description: List of unique references to |
| defined workflow errors for which the |
| action should not be retried. Used only |
| when `autoRetries` is set to `true` |
| items: |
| type: string |
| type: array |
| retryRef: |
| description: References a defined workflow |
| retry definition. If not defined uses |
| the default runtime retry definition. |
| type: string |
| retryableErrors: |
| description: List of unique references to |
| defined workflow errors for which the |
| action should be retried. Used only when |
| `autoRetries` is set to `false` |
| items: |
| type: string |
| type: array |
| sleep: |
| description: Defines time period workflow |
| execution should sleep before / after |
| function execution. |
| properties: |
| after: |
| description: Defines amount of time |
| (ISO 8601 duration format) to sleep |
| after function/subflow invocation. |
| Does not apply if 'eventRef' is defined. |
| type: string |
| before: |
| description: Defines amount of time |
| (ISO 8601 duration format) to sleep |
| before function/subflow invocation. |
| Does not apply if 'eventRef' is defined. |
| type: string |
| type: object |
| subFlowRef: |
| description: References a workflow to be |
| invoked. |
| properties: |
| invoke: |
| default: sync |
| description: Specifies if the subflow |
| should be invoked sync or async. Defaults |
| to sync. |
| enum: |
| - async |
| - sync |
| type: string |
| onParentComplete: |
| default: terminate |
| description: onParentComplete specifies |
| how subflow execution should behave |
| when parent workflow completes if |
| invoke is 'async'. Defaults to terminate. |
| enum: |
| - terminate |
| - continue |
| type: string |
| version: |
| description: Sub-workflow version |
| type: string |
| workflowId: |
| description: Sub-workflow unique id |
| type: string |
| required: |
| - workflowId |
| type: object |
| type: object |
| type: array |
| eventDataFilter: |
| description: eventDataFilter defines the callback |
| event data filter definition |
| properties: |
| data: |
| description: Workflow expression that filters |
| of the event data (payload). |
| type: string |
| toStateData: |
| description: Workflow expression that selects |
| a state data element to which the action |
| results should be added/merged into. If |
| not specified denotes the top-level state |
| data element |
| type: string |
| useData: |
| description: If set to false, event payload |
| is not added/merged to state data. In this |
| case 'data' and 'toStateData' should be |
| ignored. Default is true. |
| type: boolean |
| type: object |
| eventRefs: |
| description: References one or more unique event |
| names in the defined workflow events. |
| items: |
| type: string |
| minItems: 1 |
| type: array |
| required: |
| - eventRefs |
| type: object |
| minItems: 1 |
| type: array |
| timeouts: |
| description: State specific timeouts. |
| properties: |
| actionExecTimeout: |
| description: Default single actions definition execution |
| timeout (ISO 8601 duration format) |
| type: string |
| eventTimeout: |
| description: Default timeout for consuming defined |
| events (ISO 8601 duration format) |
| type: string |
| stateExecTimeout: |
| description: Default workflow state execution timeout |
| (ISO 8601 duration format) |
| properties: |
| single: |
| description: Single state execution timeout, |
| not including retries (ISO 8601 duration format) |
| type: string |
| total: |
| description: Total state execution timeout, |
| including retries (ISO 8601 duration format) |
| type: string |
| required: |
| - total |
| type: object |
| type: object |
| required: |
| - onEvents |
| type: object |
| forEachState: |
| description: forEachState used to execute actions for each |
| element of a data set. |
| properties: |
| actions: |
| description: Actions to be executed for each of the |
| elements of inputCollection. |
| items: |
| description: Action specify invocations of services |
| or other workflows during workflow execution. |
| properties: |
| actionDataFilter: |
| description: Filter the state data to select only |
| the data that can be used within function definition |
| arguments using its fromStateData property. |
| Filter the action results to select only the |
| result data that should be added/merged back |
| into the state data using its results property. |
| Select the part of state data which the action |
| data results should be added/merged to using |
| the toStateData property. |
| properties: |
| fromStateData: |
| description: Workflow expression that filters |
| state data that can be used by the action. |
| type: string |
| results: |
| description: Workflow expression that filters |
| the actions data results. |
| type: string |
| toStateData: |
| description: Workflow expression that selects |
| a state data element to which the action |
| results should be added/merged into. If |
| not specified denotes the top-level state |
| data element. |
| type: string |
| useResults: |
| description: If set to false, action data |
| results are not added/merged to state data. |
| In this case 'results' and 'toStateData' |
| should be ignored. Default is true. |
| type: boolean |
| type: object |
| condition: |
| description: Expression, if defined, must evaluate |
| to true for this action to be performed. If |
| false, action is disregarded. |
| type: string |
| eventRef: |
| description: References a 'trigger' and 'result' |
| reusable event definitions. |
| properties: |
| contextAttributes: |
| additionalProperties: |
| type: object |
| description: Add additional extension context |
| attributes to the produced event. |
| type: object |
| data: |
| description: If string type, an expression |
| which selects parts of the states data output |
| to become the data (payload) of the event |
| referenced by triggerEventRef. If object |
| type, a custom object to become the data |
| (payload) of the event referenced by triggerEventRef. |
| type: object |
| invoke: |
| default: sync |
| description: Specifies if the function should |
| be invoked sync or async. Default is sync. |
| enum: |
| - async |
| - sync |
| type: string |
| resultEventRef: |
| description: Reference to the unique name |
| of a 'consumed' event definition |
| type: string |
| resultEventTimeout: |
| description: Maximum amount of time (ISO 8601 |
| format) to wait for the result event. If |
| not defined it be set to the actionExecutionTimeout |
| type: string |
| triggerEventRef: |
| description: Reference to the unique name |
| of a 'produced' event definition, |
| type: string |
| required: |
| - resultEventRef |
| - triggerEventRef |
| type: object |
| functionRef: |
| description: References a reusable function definition. |
| properties: |
| arguments: |
| additionalProperties: |
| type: object |
| description: 'Arguments (inputs) to be passed |
| to the referenced function TODO: validate |
| it as required if function type is graphql' |
| type: object |
| invoke: |
| default: sync |
| description: Specifies if the function should |
| be invoked sync or async. Default is sync. |
| enum: |
| - async |
| - sync |
| type: string |
| refName: |
| description: Name of the referenced function. |
| type: string |
| selectionSet: |
| description: 'Used if function type is graphql. |
| String containing a valid GraphQL selection |
| set. TODO: validate it as required if function |
| type is graphql' |
| type: string |
| required: |
| - refName |
| type: object |
| id: |
| description: Defines Unique action identifier. |
| type: string |
| name: |
| description: Defines Unique action name. |
| type: string |
| nonRetryableErrors: |
| description: List of unique references to defined |
| workflow errors for which the action should |
| not be retried. Used only when `autoRetries` |
| is set to `true` |
| items: |
| type: string |
| type: array |
| retryRef: |
| description: References a defined workflow retry |
| definition. If not defined uses the default |
| runtime retry definition. |
| type: string |
| retryableErrors: |
| description: List of unique references to defined |
| workflow errors for which the action should |
| be retried. Used only when `autoRetries` is |
| set to `false` |
| items: |
| type: string |
| type: array |
| sleep: |
| description: Defines time period workflow execution |
| should sleep before / after function execution. |
| properties: |
| after: |
| description: Defines amount of time (ISO 8601 |
| duration format) to sleep after function/subflow |
| invocation. Does not apply if 'eventRef' |
| is defined. |
| type: string |
| before: |
| description: Defines amount of time (ISO 8601 |
| duration format) to sleep before function/subflow |
| invocation. Does not apply if 'eventRef' |
| is defined. |
| type: string |
| type: object |
| subFlowRef: |
| description: References a workflow to be invoked. |
| properties: |
| invoke: |
| default: sync |
| description: Specifies if the subflow should |
| be invoked sync or async. Defaults to sync. |
| enum: |
| - async |
| - sync |
| type: string |
| onParentComplete: |
| default: terminate |
| description: onParentComplete specifies how |
| subflow execution should behave when parent |
| workflow completes if invoke is 'async'. |
| Defaults to terminate. |
| enum: |
| - terminate |
| - continue |
| type: string |
| version: |
| description: Sub-workflow version |
| type: string |
| workflowId: |
| description: Sub-workflow unique id |
| type: string |
| required: |
| - workflowId |
| type: object |
| type: object |
| minItems: 0 |
| type: array |
| batchSize: |
| anyOf: |
| - type: integer |
| - type: string |
| description: Specifies how many iterations may run in |
| parallel at the same time. Used if mode property is |
| set to parallel (default). If not specified, its value |
| should be the size of the inputCollection. |
| x-kubernetes-int-or-string: true |
| inputCollection: |
| description: Workflow expression selecting an array |
| element of the states' data. |
| type: string |
| iterationParam: |
| description: Name of the iteration parameter that can |
| be referenced in actions/workflow. For each parallel |
| iteration, this param should contain a unique element |
| of the inputCollection array. |
| type: string |
| mode: |
| default: parallel |
| description: Specifies how iterations are to be performed |
| (sequential or in parallel), defaults to parallel. |
| enum: |
| - sequential |
| - parallel |
| type: string |
| outputCollection: |
| description: Workflow expression specifying an array |
| element of the states data to add the results of each |
| iteration. |
| type: string |
| timeouts: |
| description: State specific timeout. |
| properties: |
| actionExecTimeout: |
| description: Default single actions definition execution |
| timeout (ISO 8601 duration format) |
| type: string |
| stateExecTimeout: |
| description: Default workflow state execution timeout |
| (ISO 8601 duration format) |
| properties: |
| single: |
| description: Single state execution timeout, |
| not including retries (ISO 8601 duration format) |
| type: string |
| total: |
| description: Total state execution timeout, |
| including retries (ISO 8601 duration format) |
| type: string |
| required: |
| - total |
| type: object |
| type: object |
| required: |
| - inputCollection |
| type: object |
| id: |
| description: Unique State id. |
| type: string |
| injectState: |
| description: injectState used to inject static data into |
| state data input. |
| properties: |
| data: |
| additionalProperties: |
| type: object |
| description: JSON object which can be set as state's |
| data input and can be manipulated via filter |
| minProperties: 1 |
| type: object |
| timeouts: |
| description: State specific timeouts |
| properties: |
| stateExecTimeout: |
| description: Default workflow state execution timeout |
| (ISO 8601 duration format) |
| properties: |
| single: |
| description: Single state execution timeout, |
| not including retries (ISO 8601 duration format) |
| type: string |
| total: |
| description: Total state execution timeout, |
| including retries (ISO 8601 duration format) |
| type: string |
| required: |
| - total |
| type: object |
| type: object |
| required: |
| - data |
| type: object |
| metadata: |
| additionalProperties: |
| type: object |
| description: Metadata information. |
| type: object |
| name: |
| description: State name. |
| type: string |
| onErrors: |
| description: States error handling and retries definitions. |
| items: |
| description: OnError ... |
| properties: |
| end: |
| description: End workflow execution in case of this |
| error. If retryRef is defined, this ends workflow |
| only if retries were unsuccessful. |
| x-kubernetes-preserve-unknown-fields: true |
| errorRef: |
| description: ErrorRef Reference to a unique workflow |
| error definition. Used of errorRefs is not used |
| type: string |
| errorRefs: |
| description: ErrorRefs References one or more workflow |
| error definitions. Used if errorRef is not used |
| items: |
| type: string |
| type: array |
| transition: |
| description: Transition to next state to handle the |
| error. If retryRef is defined, this transition is |
| taken only if retries were unsuccessful. |
| x-kubernetes-preserve-unknown-fields: true |
| type: object |
| type: array |
| operationState: |
| description: operationState defines a set of actions to |
| be performed in sequence or in parallel. |
| properties: |
| actionMode: |
| default: sequential |
| description: Specifies whether actions are performed |
| in sequence or in parallel, defaults to sequential. |
| enum: |
| - sequential |
| - parallel |
| type: string |
| actions: |
| description: Actions to be performed |
| items: |
| description: Action specify invocations of services |
| or other workflows during workflow execution. |
| properties: |
| actionDataFilter: |
| description: Filter the state data to select only |
| the data that can be used within function definition |
| arguments using its fromStateData property. |
| Filter the action results to select only the |
| result data that should be added/merged back |
| into the state data using its results property. |
| Select the part of state data which the action |
| data results should be added/merged to using |
| the toStateData property. |
| properties: |
| fromStateData: |
| description: Workflow expression that filters |
| state data that can be used by the action. |
| type: string |
| results: |
| description: Workflow expression that filters |
| the actions data results. |
| type: string |
| toStateData: |
| description: Workflow expression that selects |
| a state data element to which the action |
| results should be added/merged into. If |
| not specified denotes the top-level state |
| data element. |
| type: string |
| useResults: |
| description: If set to false, action data |
| results are not added/merged to state data. |
| In this case 'results' and 'toStateData' |
| should be ignored. Default is true. |
| type: boolean |
| type: object |
| condition: |
| description: Expression, if defined, must evaluate |
| to true for this action to be performed. If |
| false, action is disregarded. |
| type: string |
| eventRef: |
| description: References a 'trigger' and 'result' |
| reusable event definitions. |
| properties: |
| contextAttributes: |
| additionalProperties: |
| type: object |
| description: Add additional extension context |
| attributes to the produced event. |
| type: object |
| data: |
| description: If string type, an expression |
| which selects parts of the states data output |
| to become the data (payload) of the event |
| referenced by triggerEventRef. If object |
| type, a custom object to become the data |
| (payload) of the event referenced by triggerEventRef. |
| type: object |
| invoke: |
| default: sync |
| description: Specifies if the function should |
| be invoked sync or async. Default is sync. |
| enum: |
| - async |
| - sync |
| type: string |
| resultEventRef: |
| description: Reference to the unique name |
| of a 'consumed' event definition |
| type: string |
| resultEventTimeout: |
| description: Maximum amount of time (ISO 8601 |
| format) to wait for the result event. If |
| not defined it be set to the actionExecutionTimeout |
| type: string |
| triggerEventRef: |
| description: Reference to the unique name |
| of a 'produced' event definition, |
| type: string |
| required: |
| - resultEventRef |
| - triggerEventRef |
| type: object |
| functionRef: |
| description: References a reusable function definition. |
| properties: |
| arguments: |
| additionalProperties: |
| type: object |
| description: 'Arguments (inputs) to be passed |
| to the referenced function TODO: validate |
| it as required if function type is graphql' |
| type: object |
| invoke: |
| default: sync |
| description: Specifies if the function should |
| be invoked sync or async. Default is sync. |
| enum: |
| - async |
| - sync |
| type: string |
| refName: |
| description: Name of the referenced function. |
| type: string |
| selectionSet: |
| description: 'Used if function type is graphql. |
| String containing a valid GraphQL selection |
| set. TODO: validate it as required if function |
| type is graphql' |
| type: string |
| required: |
| - refName |
| type: object |
| id: |
| description: Defines Unique action identifier. |
| type: string |
| name: |
| description: Defines Unique action name. |
| type: string |
| nonRetryableErrors: |
| description: List of unique references to defined |
| workflow errors for which the action should |
| not be retried. Used only when `autoRetries` |
| is set to `true` |
| items: |
| type: string |
| type: array |
| retryRef: |
| description: References a defined workflow retry |
| definition. If not defined uses the default |
| runtime retry definition. |
| type: string |
| retryableErrors: |
| description: List of unique references to defined |
| workflow errors for which the action should |
| be retried. Used only when `autoRetries` is |
| set to `false` |
| items: |
| type: string |
| type: array |
| sleep: |
| description: Defines time period workflow execution |
| should sleep before / after function execution. |
| properties: |
| after: |
| description: Defines amount of time (ISO 8601 |
| duration format) to sleep after function/subflow |
| invocation. Does not apply if 'eventRef' |
| is defined. |
| type: string |
| before: |
| description: Defines amount of time (ISO 8601 |
| duration format) to sleep before function/subflow |
| invocation. Does not apply if 'eventRef' |
| is defined. |
| type: string |
| type: object |
| subFlowRef: |
| description: References a workflow to be invoked. |
| properties: |
| invoke: |
| default: sync |
| description: Specifies if the subflow should |
| be invoked sync or async. Defaults to sync. |
| enum: |
| - async |
| - sync |
| type: string |
| onParentComplete: |
| default: terminate |
| description: onParentComplete specifies how |
| subflow execution should behave when parent |
| workflow completes if invoke is 'async'. |
| Defaults to terminate. |
| enum: |
| - terminate |
| - continue |
| type: string |
| version: |
| description: Sub-workflow version |
| type: string |
| workflowId: |
| description: Sub-workflow unique id |
| type: string |
| required: |
| - workflowId |
| type: object |
| type: object |
| minItems: 0 |
| type: array |
| timeouts: |
| description: State specific timeouts |
| properties: |
| actionExecTimeout: |
| description: Default single actions definition execution |
| timeout (ISO 8601 duration format) |
| type: string |
| stateExecTimeout: |
| description: Defines workflow state execution timeout. |
| properties: |
| single: |
| description: Single state execution timeout, |
| not including retries (ISO 8601 duration format) |
| type: string |
| total: |
| description: Total state execution timeout, |
| including retries (ISO 8601 duration format) |
| type: string |
| required: |
| - total |
| type: object |
| type: object |
| required: |
| - actions |
| type: object |
| parallelState: |
| description: parallelState Consists of a number of states |
| that are executed in parallel. |
| properties: |
| branches: |
| description: List of branches for this parallel state. |
| items: |
| description: Branch Definition |
| properties: |
| actions: |
| description: Actions to be executed in this branch |
| items: |
| description: Action specify invocations of services |
| or other workflows during workflow execution. |
| properties: |
| actionDataFilter: |
| description: Filter the state data to select |
| only the data that can be used within |
| function definition arguments using its |
| fromStateData property. Filter the action |
| results to select only the result data |
| that should be added/merged back into |
| the state data using its results property. |
| Select the part of state data which the |
| action data results should be added/merged |
| to using the toStateData property. |
| properties: |
| fromStateData: |
| description: Workflow expression that |
| filters state data that can be used |
| by the action. |
| type: string |
| results: |
| description: Workflow expression that |
| filters the actions data results. |
| type: string |
| toStateData: |
| description: Workflow expression that |
| selects a state data element to which |
| the action results should be added/merged |
| into. If not specified denotes the |
| top-level state data element. |
| type: string |
| useResults: |
| description: If set to false, action |
| data results are not added/merged |
| to state data. In this case 'results' |
| and 'toStateData' should be ignored. |
| Default is true. |
| type: boolean |
| type: object |
| condition: |
| description: Expression, if defined, must |
| evaluate to true for this action to be |
| performed. If false, action is disregarded. |
| type: string |
| eventRef: |
| description: References a 'trigger' and |
| 'result' reusable event definitions. |
| properties: |
| contextAttributes: |
| additionalProperties: |
| type: object |
| description: Add additional extension |
| context attributes to the produced |
| event. |
| type: object |
| data: |
| description: If string type, an expression |
| which selects parts of the states |
| data output to become the data (payload) |
| of the event referenced by triggerEventRef. |
| If object type, a custom object to |
| become the data (payload) of the event |
| referenced by triggerEventRef. |
| type: object |
| invoke: |
| default: sync |
| description: Specifies if the function |
| should be invoked sync or async. Default |
| is sync. |
| enum: |
| - async |
| - sync |
| type: string |
| resultEventRef: |
| description: Reference to the unique |
| name of a 'consumed' event definition |
| type: string |
| resultEventTimeout: |
| description: Maximum amount of time |
| (ISO 8601 format) to wait for the |
| result event. If not defined it be |
| set to the actionExecutionTimeout |
| type: string |
| triggerEventRef: |
| description: Reference to the unique |
| name of a 'produced' event definition, |
| type: string |
| required: |
| - resultEventRef |
| - triggerEventRef |
| type: object |
| functionRef: |
| description: References a reusable function |
| definition. |
| properties: |
| arguments: |
| additionalProperties: |
| type: object |
| description: 'Arguments (inputs) to |
| be passed to the referenced function |
| TODO: validate it as required if function |
| type is graphql' |
| type: object |
| invoke: |
| default: sync |
| description: Specifies if the function |
| should be invoked sync or async. Default |
| is sync. |
| enum: |
| - async |
| - sync |
| type: string |
| refName: |
| description: Name of the referenced |
| function. |
| type: string |
| selectionSet: |
| description: 'Used if function type |
| is graphql. String containing a valid |
| GraphQL selection set. TODO: validate |
| it as required if function type is |
| graphql' |
| type: string |
| required: |
| - refName |
| type: object |
| id: |
| description: Defines Unique action identifier. |
| type: string |
| name: |
| description: Defines Unique action name. |
| type: string |
| nonRetryableErrors: |
| description: List of unique references to |
| defined workflow errors for which the |
| action should not be retried. Used only |
| when `autoRetries` is set to `true` |
| items: |
| type: string |
| type: array |
| retryRef: |
| description: References a defined workflow |
| retry definition. If not defined uses |
| the default runtime retry definition. |
| type: string |
| retryableErrors: |
| description: List of unique references to |
| defined workflow errors for which the |
| action should be retried. Used only when |
| `autoRetries` is set to `false` |
| items: |
| type: string |
| type: array |
| sleep: |
| description: Defines time period workflow |
| execution should sleep before / after |
| function execution. |
| properties: |
| after: |
| description: Defines amount of time |
| (ISO 8601 duration format) to sleep |
| after function/subflow invocation. |
| Does not apply if 'eventRef' is defined. |
| type: string |
| before: |
| description: Defines amount of time |
| (ISO 8601 duration format) to sleep |
| before function/subflow invocation. |
| Does not apply if 'eventRef' is defined. |
| type: string |
| type: object |
| subFlowRef: |
| description: References a workflow to be |
| invoked. |
| properties: |
| invoke: |
| default: sync |
| description: Specifies if the subflow |
| should be invoked sync or async. Defaults |
| to sync. |
| enum: |
| - async |
| - sync |
| type: string |
| onParentComplete: |
| default: terminate |
| description: onParentComplete specifies |
| how subflow execution should behave |
| when parent workflow completes if |
| invoke is 'async'. Defaults to terminate. |
| enum: |
| - terminate |
| - continue |
| type: string |
| version: |
| description: Sub-workflow version |
| type: string |
| workflowId: |
| description: Sub-workflow unique id |
| type: string |
| required: |
| - workflowId |
| type: object |
| type: object |
| minItems: 1 |
| type: array |
| name: |
| description: Branch name |
| type: string |
| timeouts: |
| description: Branch specific timeout settings |
| properties: |
| actionExecTimeout: |
| description: Single actions definition execution |
| timeout duration (ISO 8601 duration format) |
| type: string |
| branchExecTimeout: |
| description: Single branch execution timeout |
| duration (ISO 8601 duration format) |
| type: string |
| type: object |
| required: |
| - actions |
| - name |
| type: object |
| minItems: 1 |
| type: array |
| completionType: |
| default: allOf |
| description: Option types on how to complete branch |
| execution. Defaults to `allOf`. |
| enum: |
| - allOf |
| - atLeast |
| type: string |
| numCompleted: |
| anyOf: |
| - type: integer |
| - type: string |
| description: 'Used when branchCompletionType is set |
| to atLeast to specify the least number of branches |
| that must complete in order for the state to transition/end. |
| TODO: change this field to unmarshal result as int' |
| x-kubernetes-int-or-string: true |
| timeouts: |
| description: State specific timeouts |
| properties: |
| branchExecTimeout: |
| description: Default single branch execution timeout |
| (ISO 8601 duration format) |
| type: string |
| stateExecTimeout: |
| description: Default workflow state execution timeout |
| (ISO 8601 duration format) |
| properties: |
| single: |
| description: Single state execution timeout, |
| not including retries (ISO 8601 duration format) |
| type: string |
| total: |
| description: Total state execution timeout, |
| including retries (ISO 8601 duration format) |
| type: string |
| required: |
| - total |
| type: object |
| type: object |
| required: |
| - branches |
| type: object |
| sleepState: |
| description: sleepState suspends workflow execution for |
| a given time duration. |
| properties: |
| duration: |
| description: Duration (ISO 8601 duration format) to |
| sleep |
| type: string |
| timeouts: |
| description: Timeouts State specific timeouts |
| properties: |
| stateExecTimeout: |
| description: Default workflow state execution timeout |
| (ISO 8601 duration format) |
| properties: |
| single: |
| description: Single state execution timeout, |
| not including retries (ISO 8601 duration format) |
| type: string |
| total: |
| description: Total state execution timeout, |
| including retries (ISO 8601 duration format) |
| type: string |
| required: |
| - total |
| type: object |
| type: object |
| required: |
| - duration |
| type: object |
| stateDataFilter: |
| description: State data filter. |
| properties: |
| input: |
| description: Workflow expression to filter the state |
| data input |
| type: string |
| output: |
| description: Workflow expression that filters the state |
| data output |
| type: string |
| type: object |
| switchState: |
| description: 'switchState is workflow''s gateways: direct |
| transitions onf a workflow based on certain conditions.' |
| properties: |
| dataConditions: |
| description: Defines conditions evaluated against data |
| items: |
| description: DataCondition specify a data-based condition |
| statement which causes a transition to another workflow |
| state if evaluated to true. |
| properties: |
| condition: |
| description: Workflow expression evaluated against |
| state data. Must evaluate to true or false. |
| type: string |
| end: |
| description: TODO End or Transition needs to be |
| exclusive tag, one or another should be set. |
| Explicit transition to end |
| properties: |
| compensate: |
| description: If set to true, triggers workflow |
| compensation before workflow execution completes. |
| Default is false. |
| type: boolean |
| continueAs: |
| description: Defines that current workflow |
| execution should stop, and execution should |
| continue as a new workflow instance of the |
| provided id |
| properties: |
| data: |
| description: If string type, an expression |
| which selects parts of the states data |
| output to become the workflow data input |
| of continued execution. If object type, |
| a custom object to become the workflow |
| data input of the continued execution |
| type: object |
| version: |
| description: Version of the workflow to |
| continue execution as. |
| type: string |
| workflowExecTimeout: |
| description: WorkflowExecTimeout Workflow |
| execution timeout to be used by the |
| workflow continuing execution. Overwrites |
| any specific settings set by that workflow |
| properties: |
| duration: |
| default: unlimited |
| description: Workflow execution timeout |
| duration (ISO 8601 duration format). |
| If not specified should be 'unlimited'. |
| type: string |
| interrupt: |
| description: If false, workflow instance |
| is allowed to finish current execution. |
| If true, current workflow execution |
| is stopped immediately. Default |
| is false. |
| type: boolean |
| runBefore: |
| description: Name of a workflow state |
| to be executed before workflow instance |
| is terminated. |
| type: string |
| required: |
| - duration |
| type: object |
| workflowId: |
| description: Unique id of the workflow |
| to continue execution as. |
| type: string |
| required: |
| - workflowId |
| type: object |
| produceEvents: |
| description: Array of producedEvent definitions. |
| Defines events that should be produced. |
| items: |
| description: ProduceEvent Defines the event |
| (CloudEvent format) to be produced when |
| workflow execution completes or during |
| a workflow transitions. The eventRef property |
| must match the name of one of the defined |
| produced events in the events definition. |
| properties: |
| contextAttributes: |
| additionalProperties: |
| type: string |
| description: Add additional event extension |
| context attributes. |
| type: object |
| data: |
| description: If String, expression which |
| selects parts of the states data output |
| to become the data of the produced |
| event. If object a custom object to |
| become the data of produced event. |
| type: object |
| eventRef: |
| description: Reference to a defined |
| unique event name in the events definition |
| type: string |
| required: |
| - eventRef |
| type: object |
| type: array |
| terminate: |
| description: If true, completes all execution |
| flows in the given workflow instance. |
| type: boolean |
| type: object |
| metadata: |
| additionalProperties: |
| type: object |
| description: Metadata information. |
| type: object |
| name: |
| description: Data condition name. |
| type: string |
| transition: |
| description: Workflow transition if condition |
| is evaluated to true |
| properties: |
| compensate: |
| default: false |
| description: If set to true, triggers workflow |
| compensation before this transition is taken. |
| Default is false. |
| type: boolean |
| nextState: |
| description: Name of the state to transition |
| to next. |
| type: string |
| produceEvents: |
| description: Array of producedEvent definitions. |
| Events to be produced before the transition |
| takes place. |
| items: |
| description: ProduceEvent Defines the event |
| (CloudEvent format) to be produced when |
| workflow execution completes or during |
| a workflow transitions. The eventRef property |
| must match the name of one of the defined |
| produced events in the events definition. |
| properties: |
| contextAttributes: |
| additionalProperties: |
| type: string |
| description: Add additional event extension |
| context attributes. |
| type: object |
| data: |
| description: If String, expression which |
| selects parts of the states data output |
| to become the data of the produced |
| event. If object a custom object to |
| become the data of produced event. |
| type: object |
| eventRef: |
| description: Reference to a defined |
| unique event name in the events definition |
| type: string |
| required: |
| - eventRef |
| type: object |
| type: array |
| required: |
| - nextState |
| type: object |
| required: |
| - condition |
| - end |
| type: object |
| type: array |
| defaultCondition: |
| description: Default transition of the workflow if there |
| is no matching data conditions. Can include a transition |
| or end definition. |
| properties: |
| end: |
| description: If this state an end state |
| x-kubernetes-preserve-unknown-fields: true |
| transition: |
| description: Serverless workflow states can have |
| one or more incoming and outgoing transitions |
| (from/to other states). Each state can define |
| a transition definition that is used to determine |
| which state to transition to next. |
| x-kubernetes-preserve-unknown-fields: true |
| type: object |
| eventConditions: |
| description: Defines conditions evaluated against events. |
| items: |
| description: EventCondition specify events which the |
| switch state must wait for. |
| properties: |
| end: |
| description: TODO End or Transition needs to be |
| exclusive tag, one or another should be set. |
| Explicit transition to end |
| x-kubernetes-preserve-unknown-fields: true |
| eventDataFilter: |
| description: Event data filter definition. |
| properties: |
| data: |
| description: Workflow expression that filters |
| of the event data (payload). |
| type: string |
| toStateData: |
| description: Workflow expression that selects |
| a state data element to which the action |
| results should be added/merged into. If |
| not specified denotes the top-level state |
| data element |
| type: string |
| useData: |
| description: If set to false, event payload |
| is not added/merged to state data. In this |
| case 'data' and 'toStateData' should be |
| ignored. Default is true. |
| type: boolean |
| type: object |
| eventRef: |
| description: References a unique event name in |
| the defined workflow events. |
| type: string |
| metadata: |
| description: Metadata information. |
| x-kubernetes-preserve-unknown-fields: true |
| name: |
| description: Event condition name. |
| type: string |
| transition: |
| description: Workflow transition if condition |
| is evaluated to true |
| x-kubernetes-preserve-unknown-fields: true |
| required: |
| - eventRef |
| type: object |
| type: array |
| timeouts: |
| description: SwitchState specific timeouts |
| properties: |
| eventTimeout: |
| description: 'Specify the expire value to transitions |
| to defaultCondition. When event-based conditions |
| do not arrive. NOTE: this is only available for |
| EventConditions' |
| type: string |
| stateExecTimeout: |
| description: Default workflow state execution timeout |
| (ISO 8601 duration format) |
| properties: |
| single: |
| description: Single state execution timeout, |
| not including retries (ISO 8601 duration format) |
| type: string |
| total: |
| description: Total state execution timeout, |
| including retries (ISO 8601 duration format) |
| type: string |
| required: |
| - total |
| type: object |
| type: object |
| required: |
| - defaultCondition |
| type: object |
| transition: |
| description: Next transition of the workflow after the time |
| delay. |
| x-kubernetes-preserve-unknown-fields: true |
| type: |
| description: stateType can be any of delay, callback, event, |
| foreach, inject, operation, parallel, sleep, switch |
| enum: |
| - delay |
| - callback |
| - event |
| - foreach |
| - inject |
| - operation |
| - parallel |
| - sleep |
| - switch |
| type: string |
| usedForCompensation: |
| description: If true, this state is used to compensate another |
| state. Default is false. |
| type: boolean |
| required: |
| - name |
| - type |
| type: object |
| minItems: 1 |
| type: array |
| x-kubernetes-preserve-unknown-fields: true |
| timeouts: |
| description: Defines the workflow default timeout settings. |
| properties: |
| actionExecTimeout: |
| description: ActionExecTimeout Single actions definition execution |
| timeout duration (ISO 8601 duration format). |
| type: string |
| branchExecTimeout: |
| description: BranchExecTimeout Single branch execution timeout |
| duration (ISO 8601 duration format). |
| type: string |
| eventTimeout: |
| description: EventTimeout Timeout duration to wait for consuming |
| defined events (ISO 8601 duration format). |
| type: string |
| stateExecTimeout: |
| description: StateExecTimeout Total state execution timeout |
| (including retries) (ISO 8601 duration format). |
| properties: |
| single: |
| description: Single state execution timeout, not including |
| retries (ISO 8601 duration format) |
| type: string |
| total: |
| description: Total state execution timeout, including |
| retries (ISO 8601 duration format) |
| type: string |
| required: |
| - total |
| type: object |
| workflowExecTimeout: |
| description: WorkflowExecTimeout Workflow execution timeout |
| duration (ISO 8601 duration format). If not specified should |
| be 'unlimited'. |
| properties: |
| duration: |
| default: unlimited |
| description: Workflow execution timeout duration (ISO |
| 8601 duration format). If not specified should be 'unlimited'. |
| type: string |
| interrupt: |
| description: If false, workflow instance is allowed to |
| finish current execution. If true, current workflow |
| execution is stopped immediately. Default is false. |
| type: boolean |
| runBefore: |
| description: Name of a workflow state to be executed before |
| workflow instance is terminated. |
| type: string |
| required: |
| - duration |
| type: object |
| type: object |
| required: |
| - states |
| type: object |
| persistence: |
| description: Persists service to a datasource of choice. Ephemeral |
| by default. |
| maxProperties: 1 |
| properties: |
| postgresql: |
| description: Connect configured services to a postgresql database. |
| maxProperties: 2 |
| minProperties: 2 |
| properties: |
| jdbcUrl: |
| description: PostgreSql JDBC URL. Mutually exclusive to serviceRef. |
| e.g. "jdbc:postgresql://host:port/database?currentSchema=data-index-service" |
| type: string |
| secretRef: |
| description: Secret reference to the database user credentials |
| properties: |
| name: |
| description: Name of the postgresql credentials secret. |
| type: string |
| passwordKey: |
| description: Defaults to POSTGRESQL_PASSWORD |
| type: string |
| userKey: |
| description: Defaults to POSTGRESQL_USER |
| type: string |
| required: |
| - name |
| type: object |
| serviceRef: |
| description: Service reference to postgresql datasource. Mutually |
| exclusive to jdbcUrl. |
| properties: |
| databaseName: |
| description: Name of postgresql database to be used. Defaults |
| to "sonataflow" |
| type: string |
| databaseSchema: |
| description: Schema of postgresql database to be used. |
| Defaults to "data-index-service" |
| type: string |
| name: |
| description: Name of the postgresql k8s service. |
| type: string |
| namespace: |
| description: Namespace of the postgresql k8s service. |
| Defaults to the SonataFlowPlatform's local namespace. |
| type: string |
| port: |
| description: Port to use when connecting to the postgresql |
| k8s service. Defaults to 5432. |
| type: integer |
| required: |
| - name |
| type: object |
| required: |
| - secretRef |
| type: object |
| type: object |
| podTemplate: |
| description: PodTemplate describes the deployment details of this |
| SonataFlow instance. |
| properties: |
| activeDeadlineSeconds: |
| description: Optional duration in seconds the pod may be active |
| on the node relative to StartTime before the system will actively |
| try to mark it failed and kill associated containers. Value |
| must be a positive integer. |
| format: int64 |
| type: integer |
| affinity: |
| description: If specified, the pod's scheduling constraints |
| properties: |
| nodeAffinity: |
| description: Describes node affinity scheduling rules for |
| the pod. |
| properties: |
| preferredDuringSchedulingIgnoredDuringExecution: |
| description: The scheduler will prefer to schedule pods |
| to nodes that satisfy the affinity expressions specified |
| by this field, but it may choose a node that violates |
| one or more of the expressions. The node that is most |
| preferred is the one with the greatest sum of weights, |
| i.e. for each node that meets all of the scheduling |
| requirements (resource request, requiredDuringScheduling |
| affinity expressions, etc.), compute a sum by iterating |
| through the elements of this field and adding "weight" |
| to the sum if the node matches the corresponding matchExpressions; |
| the node(s) with the highest sum are the most preferred. |
| items: |
| description: An empty preferred scheduling term matches |
| all objects with implicit weight 0 (i.e. it's a no-op). |
| A null preferred scheduling term matches no objects |
| (i.e. is also a no-op). |
| properties: |
| preference: |
| description: A node selector term, associated with |
| the corresponding weight. |
| properties: |
| matchExpressions: |
| description: A list of node selector requirements |
| by node's labels. |
| items: |
| description: A node selector requirement is |
| a selector that contains values, a key, |
| and an operator that relates the key and |
| values. |
| properties: |
| key: |
| description: The label key that the selector |
| applies to. |
| type: string |
| operator: |
| description: Represents a key's relationship |
| to a set of values. Valid operators |
| are In, NotIn, Exists, DoesNotExist. |
| Gt, and Lt. |
| type: string |
| values: |
| description: An array of string values. |
| If the operator is In or NotIn, the |
| values array must be non-empty. If the |
| operator is Exists or DoesNotExist, |
| the values array must be empty. If the |
| operator is Gt or Lt, the values array |
| must have a single element, which will |
| be interpreted as an integer. This array |
| is replaced during a strategic merge |
| patch. |
| items: |
| type: string |
| type: array |
| required: |
| - key |
| - operator |
| type: object |
| type: array |
| matchFields: |
| description: A list of node selector requirements |
| by node's fields. |
| items: |
| description: A node selector requirement is |
| a selector that contains values, a key, |
| and an operator that relates the key and |
| values. |
| properties: |
| key: |
| description: The label key that the selector |
| applies to. |
| type: string |
| operator: |
| description: Represents a key's relationship |
| to a set of values. Valid operators |
| are In, NotIn, Exists, DoesNotExist. |
| Gt, and Lt. |
| type: string |
| values: |
| description: An array of string values. |
| If the operator is In or NotIn, the |
| values array must be non-empty. If the |
| operator is Exists or DoesNotExist, |
| the values array must be empty. If the |
| operator is Gt or Lt, the values array |
| must have a single element, which will |
| be interpreted as an integer. This array |
| is replaced during a strategic merge |
| patch. |
| items: |
| type: string |
| type: array |
| required: |
| - key |
| - operator |
| type: object |
| type: array |
| type: object |
| x-kubernetes-map-type: atomic |
| weight: |
| description: Weight associated with matching the |
| corresponding nodeSelectorTerm, in the range 1-100. |
| format: int32 |
| type: integer |
| required: |
| - preference |
| - weight |
| type: object |
| type: array |
| requiredDuringSchedulingIgnoredDuringExecution: |
| description: If the affinity requirements specified by |
| this field are not met at scheduling time, the pod will |
| not be scheduled onto the node. If the affinity requirements |
| specified by this field cease to be met at some point |
| during pod execution (e.g. due to an update), the system |
| may or may not try to eventually evict the pod from |
| its node. |
| properties: |
| nodeSelectorTerms: |
| description: Required. A list of node selector terms. |
| The terms are ORed. |
| items: |
| description: A null or empty node selector term |
| matches no objects. The requirements of them are |
| ANDed. The TopologySelectorTerm type implements |
| a subset of the NodeSelectorTerm. |
| properties: |
| matchExpressions: |
| description: A list of node selector requirements |
| by node's labels. |
| items: |
| description: A node selector requirement is |
| a selector that contains values, a key, |
| and an operator that relates the key and |
| values. |
| properties: |
| key: |
| description: The label key that the selector |
| applies to. |
| type: string |
| operator: |
| description: Represents a key's relationship |
| to a set of values. Valid operators |
| are In, NotIn, Exists, DoesNotExist. |
| Gt, and Lt. |
| type: string |
| values: |
| description: An array of string values. |
| If the operator is In or NotIn, the |
| values array must be non-empty. If the |
| operator is Exists or DoesNotExist, |
| the values array must be empty. If the |
| operator is Gt or Lt, the values array |
| must have a single element, which will |
| be interpreted as an integer. This array |
| is replaced during a strategic merge |
| patch. |
| items: |
| type: string |
| type: array |
| required: |
| - key |
| - operator |
| type: object |
| type: array |
| matchFields: |
| description: A list of node selector requirements |
| by node's fields. |
| items: |
| description: A node selector requirement is |
| a selector that contains values, a key, |
| and an operator that relates the key and |
| values. |
| properties: |
| key: |
| description: The label key that the selector |
| applies to. |
| type: string |
| operator: |
| description: Represents a key's relationship |
| to a set of values. Valid operators |
| are In, NotIn, Exists, DoesNotExist. |
| Gt, and Lt. |
| type: string |
| values: |
| description: An array of string values. |
| If the operator is In or NotIn, the |
| values array must be non-empty. If the |
| operator is Exists or DoesNotExist, |
| the values array must be empty. If the |
| operator is Gt or Lt, the values array |
| must have a single element, which will |
| be interpreted as an integer. This array |
| is replaced during a strategic merge |
| patch. |
| items: |
| type: string |
| type: array |
| required: |
| - key |
| - operator |
| type: object |
| type: array |
| type: object |
| x-kubernetes-map-type: atomic |
| type: array |
| required: |
| - nodeSelectorTerms |
| type: object |
| x-kubernetes-map-type: atomic |
| type: object |
| podAffinity: |
| description: Describes pod affinity scheduling rules (e.g. |
| co-locate this pod in the same node, zone, etc. as some |
| other pod(s)). |
| properties: |
| preferredDuringSchedulingIgnoredDuringExecution: |
| description: The scheduler will prefer to schedule pods |
| to nodes that satisfy the affinity expressions specified |
| by this field, but it may choose a node that violates |
| one or more of the expressions. The node that is most |
| preferred is the one with the greatest sum of weights, |
| i.e. for each node that meets all of the scheduling |
| requirements (resource request, requiredDuringScheduling |
| affinity expressions, etc.), compute a sum by iterating |
| through the elements of this field and adding "weight" |
| to the sum if the node has pods which matches the corresponding |
| podAffinityTerm; the node(s) with the highest sum are |
| the most preferred. |
| items: |
| description: The weights of all of the matched WeightedPodAffinityTerm |
| fields are added per-node to find the most preferred |
| node(s) |
| properties: |
| podAffinityTerm: |
| description: Required. A pod affinity term, associated |
| with the corresponding weight. |
| properties: |
| labelSelector: |
| description: A label query over a set of resources, |
| in this case pods. |
| properties: |
| matchExpressions: |
| description: matchExpressions is a list |
| of label selector requirements. The requirements |
| are ANDed. |
| items: |
| description: A label selector requirement |
| is a selector that contains values, |
| a key, and an operator that relates |
| the key and values. |
| properties: |
| key: |
| description: key is the label key |
| that the selector applies to. |
| type: string |
| operator: |
| description: operator represents a |
| key's relationship to a set of values. |
| Valid operators are In, NotIn, Exists |
| and DoesNotExist. |
| type: string |
| values: |
| description: values is an array of |
| string values. If the operator is |
| In or NotIn, the values array must |
| be non-empty. If the operator is |
| Exists or DoesNotExist, the values |
| array must be empty. This array |
| is replaced during a strategic merge |
| patch. |
| items: |
| type: string |
| type: array |
| required: |
| - key |
| - operator |
| type: object |
| type: array |
| matchLabels: |
| additionalProperties: |
| type: string |
| description: matchLabels is a map of {key,value} |
| pairs. A single {key,value} in the matchLabels |
| map is equivalent to an element of matchExpressions, |
| whose key field is "key", the operator |
| is "In", and the values array contains |
| only "value". The requirements are ANDed. |
| type: object |
| type: object |
| x-kubernetes-map-type: atomic |
| namespaceSelector: |
| description: A label query over the set of namespaces |
| that the term applies to. The term is applied |
| to the union of the namespaces selected by |
| this field and the ones listed in the namespaces |
| field. null selector and null or empty namespaces |
| list means "this pod's namespace". An empty |
| selector ({}) matches all namespaces. |
| properties: |
| matchExpressions: |
| description: matchExpressions is a list |
| of label selector requirements. The requirements |
| are ANDed. |
| items: |
| description: A label selector requirement |
| is a selector that contains values, |
| a key, and an operator that relates |
| the key and values. |
| properties: |
| key: |
| description: key is the label key |
| that the selector applies to. |
| type: string |
| operator: |
| description: operator represents a |
| key's relationship to a set of values. |
| Valid operators are In, NotIn, Exists |
| and DoesNotExist. |
| type: string |
| values: |
| description: values is an array of |
| string values. If the operator is |
| In or NotIn, the values array must |
| be non-empty. If the operator is |
| Exists or DoesNotExist, the values |
| array must be empty. This array |
| is replaced during a strategic merge |
| patch. |
| items: |
| type: string |
| type: array |
| required: |
| - key |
| - operator |
| type: object |
| type: array |
| matchLabels: |
| additionalProperties: |
| type: string |
| description: matchLabels is a map of {key,value} |
| pairs. A single {key,value} in the matchLabels |
| map is equivalent to an element of matchExpressions, |
| whose key field is "key", the operator |
| is "In", and the values array contains |
| only "value". The requirements are ANDed. |
| type: object |
| type: object |
| x-kubernetes-map-type: atomic |
| namespaces: |
| description: namespaces specifies a static list |
| of namespace names that the term applies to. |
| The term is applied to the union of the namespaces |
| listed in this field and the ones selected |
| by namespaceSelector. null or empty namespaces |
| list and null namespaceSelector means "this |
| pod's namespace". |
| items: |
| type: string |
| type: array |
| topologyKey: |
| description: This pod should be co-located (affinity) |
| or not co-located (anti-affinity) with the |
| pods matching the labelSelector in the specified |
| namespaces, where co-located is defined as |
| running on a node whose value of the label |
| with key topologyKey matches that of any node |
| on which any of the selected pods is running. |
| Empty topologyKey is not allowed. |
| type: string |
| required: |
| - topologyKey |
| type: object |
| weight: |
| description: weight associated with matching the |
| corresponding podAffinityTerm, in the range 1-100. |
| format: int32 |
| type: integer |
| required: |
| - podAffinityTerm |
| - weight |
| type: object |
| type: array |
| requiredDuringSchedulingIgnoredDuringExecution: |
| description: If the affinity requirements specified by |
| this field are not met at scheduling time, the pod will |
| not be scheduled onto the node. If the affinity requirements |
| specified by this field cease to be met at some point |
| during pod execution (e.g. due to a pod label update), |
| the system may or may not try to eventually evict the |
| pod from its node. When there are multiple elements, |
| the lists of nodes corresponding to each podAffinityTerm |
| are intersected, i.e. all terms must be satisfied. |
| items: |
| description: Defines a set of pods (namely those matching |
| the labelSelector relative to the given namespace(s)) |
| that this pod should be co-located (affinity) or not |
| co-located (anti-affinity) with, where co-located |
| is defined as running on a node whose value of the |
| label with key <topologyKey> matches that of any node |
| on which a pod of the set of pods is running |
| properties: |
| labelSelector: |
| description: A label query over a set of resources, |
| in this case pods. |
| properties: |
| matchExpressions: |
| description: matchExpressions is a list of label |
| selector requirements. The requirements are |
| ANDed. |
| items: |
| description: A label selector requirement |
| is a selector that contains values, a key, |
| and an operator that relates the key and |
| values. |
| properties: |
| key: |
| description: key is the label key that |
| the selector applies to. |
| type: string |
| operator: |
| description: operator represents a key's |
| relationship to a set of values. Valid |
| operators are In, NotIn, Exists and |
| DoesNotExist. |
| type: string |
| values: |
| description: values is an array of string |
| values. If the operator is In or NotIn, |
| the values array must be non-empty. |
| If the operator is Exists or DoesNotExist, |
| the values array must be empty. This |
| array is replaced during a strategic |
| merge patch. |
| items: |
| type: string |
| type: array |
| required: |
| - key |
| - operator |
| type: object |
| type: array |
| matchLabels: |
| additionalProperties: |
| type: string |
| description: matchLabels is a map of {key,value} |
| pairs. A single {key,value} in the matchLabels |
| map is equivalent to an element of matchExpressions, |
| whose key field is "key", the operator is |
| "In", and the values array contains only "value". |
| The requirements are ANDed. |
| type: object |
| type: object |
| x-kubernetes-map-type: atomic |
| namespaceSelector: |
| description: A label query over the set of namespaces |
| that the term applies to. The term is applied |
| to the union of the namespaces selected by this |
| field and the ones listed in the namespaces field. |
| null selector and null or empty namespaces list |
| means "this pod's namespace". An empty selector |
| ({}) matches all namespaces. |
| properties: |
| matchExpressions: |
| description: matchExpressions is a list of label |
| selector requirements. The requirements are |
| ANDed. |
| items: |
| description: A label selector requirement |
| is a selector that contains values, a key, |
| and an operator that relates the key and |
| values. |
| properties: |
| key: |
| description: key is the label key that |
| the selector applies to. |
| type: string |
| operator: |
| description: operator represents a key's |
| relationship to a set of values. Valid |
| operators are In, NotIn, Exists and |
| DoesNotExist. |
| type: string |
| values: |
| description: values is an array of string |
| values. If the operator is In or NotIn, |
| the values array must be non-empty. |
| If the operator is Exists or DoesNotExist, |
| the values array must be empty. This |
| array is replaced during a strategic |
| merge patch. |
| items: |
| type: string |
| type: array |
| required: |
| - key |
| - operator |
| type: object |
| type: array |
| matchLabels: |
| additionalProperties: |
| type: string |
| description: matchLabels is a map of {key,value} |
| pairs. A single {key,value} in the matchLabels |
| map is equivalent to an element of matchExpressions, |
| whose key field is "key", the operator is |
| "In", and the values array contains only "value". |
| The requirements are ANDed. |
| type: object |
| type: object |
| x-kubernetes-map-type: atomic |
| namespaces: |
| description: namespaces specifies a static list |
| of namespace names that the term applies to. The |
| term is applied to the union of the namespaces |
| listed in this field and the ones selected by |
| namespaceSelector. null or empty namespaces list |
| and null namespaceSelector means "this pod's namespace". |
| items: |
| type: string |
| type: array |
| topologyKey: |
| description: This pod should be co-located (affinity) |
| or not co-located (anti-affinity) with the pods |
| matching the labelSelector in the specified namespaces, |
| where co-located is defined as running on a node |
| whose value of the label with key topologyKey |
| matches that of any node on which any of the selected |
| pods is running. Empty topologyKey is not allowed. |
| type: string |
| required: |
| - topologyKey |
| type: object |
| type: array |
| type: object |
| podAntiAffinity: |
| description: Describes pod anti-affinity scheduling rules |
| (e.g. avoid putting this pod in the same node, zone, etc. |
| as some other pod(s)). |
| properties: |
| preferredDuringSchedulingIgnoredDuringExecution: |
| description: The scheduler will prefer to schedule pods |
| to nodes that satisfy the anti-affinity expressions |
| specified by this field, but it may choose a node that |
| violates one or more of the expressions. The node that |
| is most preferred is the one with the greatest sum of |
| weights, i.e. for each node that meets all of the scheduling |
| requirements (resource request, requiredDuringScheduling |
| anti-affinity expressions, etc.), compute a sum by iterating |
| through the elements of this field and adding "weight" |
| to the sum if the node has pods which matches the corresponding |
| podAffinityTerm; the node(s) with the highest sum are |
| the most preferred. |
| items: |
| description: The weights of all of the matched WeightedPodAffinityTerm |
| fields are added per-node to find the most preferred |
| node(s) |
| properties: |
| podAffinityTerm: |
| description: Required. A pod affinity term, associated |
| with the corresponding weight. |
| properties: |
| labelSelector: |
| description: A label query over a set of resources, |
| in this case pods. |
| properties: |
| matchExpressions: |
| description: matchExpressions is a list |
| of label selector requirements. The requirements |
| are ANDed. |
| items: |
| description: A label selector requirement |
| is a selector that contains values, |
| a key, and an operator that relates |
| the key and values. |
| properties: |
| key: |
| description: key is the label key |
| that the selector applies to. |
| type: string |
| operator: |
| description: operator represents a |
| key's relationship to a set of values. |
| Valid operators are In, NotIn, Exists |
| and DoesNotExist. |
| type: string |
| values: |
| description: values is an array of |
| string values. If the operator is |
| In or NotIn, the values array must |
| be non-empty. If the operator is |
| Exists or DoesNotExist, the values |
| array must be empty. This array |
| is replaced during a strategic merge |
| patch. |
| items: |
| type: string |
| type: array |
| required: |
| - key |
| - operator |
| type: object |
| type: array |
| matchLabels: |
| additionalProperties: |
| type: string |
| description: matchLabels is a map of {key,value} |
| pairs. A single {key,value} in the matchLabels |
| map is equivalent to an element of matchExpressions, |
| whose key field is "key", the operator |
| is "In", and the values array contains |
| only "value". The requirements are ANDed. |
| type: object |
| type: object |
| x-kubernetes-map-type: atomic |
| namespaceSelector: |
| description: A label query over the set of namespaces |
| that the term applies to. The term is applied |
| to the union of the namespaces selected by |
| this field and the ones listed in the namespaces |
| field. null selector and null or empty namespaces |
| list means "this pod's namespace". An empty |
| selector ({}) matches all namespaces. |
| properties: |
| matchExpressions: |
| description: matchExpressions is a list |
| of label selector requirements. The requirements |
| are ANDed. |
| items: |
| description: A label selector requirement |
| is a selector that contains values, |
| a key, and an operator that relates |
| the key and values. |
| properties: |
| key: |
| description: key is the label key |
| that the selector applies to. |
| type: string |
| operator: |
| description: operator represents a |
| key's relationship to a set of values. |
| Valid operators are In, NotIn, Exists |
| and DoesNotExist. |
| type: string |
| values: |
| description: values is an array of |
| string values. If the operator is |
| In or NotIn, the values array must |
| be non-empty. If the operator is |
| Exists or DoesNotExist, the values |
| array must be empty. This array |
| is replaced during a strategic merge |
| patch. |
| items: |
| type: string |
| type: array |
| required: |
| - key |
| - operator |
| type: object |
| type: array |
| matchLabels: |
| additionalProperties: |
| type: string |
| description: matchLabels is a map of {key,value} |
| pairs. A single {key,value} in the matchLabels |
| map is equivalent to an element of matchExpressions, |
| whose key field is "key", the operator |
| is "In", and the values array contains |
| only "value". The requirements are ANDed. |
| type: object |
| type: object |
| x-kubernetes-map-type: atomic |
| namespaces: |
| description: namespaces specifies a static list |
| of namespace names that the term applies to. |
| The term is applied to the union of the namespaces |
| listed in this field and the ones selected |
| by namespaceSelector. null or empty namespaces |
| list and null namespaceSelector means "this |
| pod's namespace". |
| items: |
| type: string |
| type: array |
| topologyKey: |
| description: This pod should be co-located (affinity) |
| or not co-located (anti-affinity) with the |
| pods matching the labelSelector in the specified |
| namespaces, where co-located is defined as |
| running on a node whose value of the label |
| with key topologyKey matches that of any node |
| on which any of the selected pods is running. |
| Empty topologyKey is not allowed. |
| type: string |
| required: |
| - topologyKey |
| type: object |
| weight: |
| description: weight associated with matching the |
| corresponding podAffinityTerm, in the range 1-100. |
| format: int32 |
| type: integer |
| required: |
| - podAffinityTerm |
| - weight |
| type: object |
| type: array |
| requiredDuringSchedulingIgnoredDuringExecution: |
| description: If the anti-affinity requirements specified |
| by this field are not met at scheduling time, the pod |
| will not be scheduled onto the node. If the anti-affinity |
| requirements specified by this field cease to be met |
| at some point during pod execution (e.g. due to a pod |
| label update), the system may or may not try to eventually |
| evict the pod from its node. When there are multiple |
| elements, the lists of nodes corresponding to each podAffinityTerm |
| are intersected, i.e. all terms must be satisfied. |
| items: |
| description: Defines a set of pods (namely those matching |
| the labelSelector relative to the given namespace(s)) |
| that this pod should be co-located (affinity) or not |
| co-located (anti-affinity) with, where co-located |
| is defined as running on a node whose value of the |
| label with key <topologyKey> matches that of any node |
| on which a pod of the set of pods is running |
| properties: |
| labelSelector: |
| description: A label query over a set of resources, |
| in this case pods. |
| properties: |
| matchExpressions: |
| description: matchExpressions is a list of label |
| selector requirements. The requirements are |
| ANDed. |
| items: |
| description: A label selector requirement |
| is a selector that contains values, a key, |
| and an operator that relates the key and |
| values. |
| properties: |
| key: |
| description: key is the label key that |
| the selector applies to. |
| type: string |
| operator: |
| description: operator represents a key's |
| relationship to a set of values. Valid |
| operators are In, NotIn, Exists and |
| DoesNotExist. |
| type: string |
| values: |
| description: values is an array of string |
| values. If the operator is In or NotIn, |
| the values array must be non-empty. |
| If the operator is Exists or DoesNotExist, |
| the values array must be empty. This |
| array is replaced during a strategic |
| merge patch. |
| items: |
| type: string |
| type: array |
| required: |
| - key |
| - operator |
| type: object |
| type: array |
| matchLabels: |
| additionalProperties: |
| type: string |
| description: matchLabels is a map of {key,value} |
| pairs. A single {key,value} in the matchLabels |
| map is equivalent to an element of matchExpressions, |
| whose key field is "key", the operator is |
| "In", and the values array contains only "value". |
| The requirements are ANDed. |
| type: object |
| type: object |
| x-kubernetes-map-type: atomic |
| namespaceSelector: |
| description: A label query over the set of namespaces |
| that the term applies to. The term is applied |
| to the union of the namespaces selected by this |
| field and the ones listed in the namespaces field. |
| null selector and null or empty namespaces list |
| means "this pod's namespace". An empty selector |
| ({}) matches all namespaces. |
| properties: |
| matchExpressions: |
| description: matchExpressions is a list of label |
| selector requirements. The requirements are |
| ANDed. |
| items: |
| description: A label selector requirement |
| is a selector that contains values, a key, |
| and an operator that relates the key and |
| values. |
| properties: |
| key: |
| description: key is the label key that |
| the selector applies to. |
| type: string |
| operator: |
| description: operator represents a key's |
| relationship to a set of values. Valid |
| operators are In, NotIn, Exists and |
| DoesNotExist. |
| type: string |
| values: |
| description: values is an array of string |
| values. If the operator is In or NotIn, |
| the values array must be non-empty. |
| If the operator is Exists or DoesNotExist, |
| the values array must be empty. This |
| array is replaced during a strategic |
| merge patch. |
| items: |
| type: string |
| type: array |
| required: |
| - key |
| - operator |
| type: object |
| type: array |
| matchLabels: |
| additionalProperties: |
| type: string |
| description: matchLabels is a map of {key,value} |
| pairs. A single {key,value} in the matchLabels |
| map is equivalent to an element of matchExpressions, |
| whose key field is "key", the operator is |
| "In", and the values array contains only "value". |
| The requirements are ANDed. |
| type: object |
| type: object |
| x-kubernetes-map-type: atomic |
| namespaces: |
| description: namespaces specifies a static list |
| of namespace names that the term applies to. The |
| term is applied to the union of the namespaces |
| listed in this field and the ones selected by |
| namespaceSelector. null or empty namespaces list |
| and null namespaceSelector means "this pod's namespace". |
| items: |
| type: string |
| type: array |
| topologyKey: |
| description: This pod should be co-located (affinity) |
| or not co-located (anti-affinity) with the pods |
| matching the labelSelector in the specified namespaces, |
| where co-located is defined as running on a node |
| whose value of the label with key topologyKey |
| matches that of any node on which any of the selected |
| pods is running. Empty topologyKey is not allowed. |
| type: string |
| required: |
| - topologyKey |
| type: object |
| type: array |
| type: object |
| type: object |
| automountServiceAccountToken: |
| description: AutomountServiceAccountToken indicates whether a |
| service account token should be automatically mounted. |
| type: boolean |
| container: |
| description: Container is the Kubernetes container where the application |
| should run. One can change this attribute in order to override |
| the defaults provided by the operator. |
| properties: |
| args: |
| description: 'Arguments to the entrypoint. The container image''s |
| CMD is used if this is not provided. Variable references |
| $(VAR_NAME) are expanded using the container''s environment. |
| If a variable cannot be resolved, the reference in the input |
| string will be unchanged. Double $$ are reduced to a single |
| $, which allows for escaping the $(VAR_NAME) syntax: i.e. |
| "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". |
| Escaped references will never be expanded, regardless of |
| whether the variable exists or not. Cannot be updated. More |
| info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell' |
| items: |
| type: string |
| type: array |
| command: |
| description: 'Entrypoint array. Not executed within a shell. |
| The container image''s ENTRYPOINT is used if this is not |
| provided. Variable references $(VAR_NAME) are expanded using |
| the container''s environment. If a variable cannot be resolved, |
| the reference in the input string will be unchanged. Double |
| $$ are reduced to a single $, which allows for escaping |
| the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce |
| the string literal "$(VAR_NAME)". Escaped references will |
| never be expanded, regardless of whether the variable exists |
| or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell' |
| items: |
| type: string |
| type: array |
| env: |
| description: List of environment variables to set in the container. |
| Cannot be updated. |
| items: |
| description: EnvVar represents an environment variable present |
| in a Container. |
| properties: |
| name: |
| description: Name of the environment variable. Must |
| be a C_IDENTIFIER. |
| type: string |
| value: |
| description: 'Variable references $(VAR_NAME) are expanded |
| using the previously defined environment variables |
| in the container and any service environment variables. |
| If a variable cannot be resolved, the reference in |
| the input string will be unchanged. Double $$ are |
| reduced to a single $, which allows for escaping the |
| $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce |
| the string literal "$(VAR_NAME)". Escaped references |
| will never be expanded, regardless of whether the |
| variable exists or not. Defaults to "".' |
| type: string |
| valueFrom: |
| description: Source for the environment variable's value. |
| Cannot be used if value is not empty. |
| properties: |
| configMapKeyRef: |
| description: Selects a key of a ConfigMap. |
| properties: |
| key: |
| description: The key to select. |
| type: string |
| name: |
| description: 'Name of the referent. More info: |
| https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| TODO: Add other useful fields. apiVersion, |
| kind, uid?' |
| type: string |
| optional: |
| description: Specify whether the ConfigMap or |
| its key must be defined |
| type: boolean |
| required: |
| - key |
| type: object |
| x-kubernetes-map-type: atomic |
| fieldRef: |
| description: 'Selects a field of the pod: supports |
| metadata.name, metadata.namespace, `metadata.labels[''<KEY>'']`, |
| `metadata.annotations[''<KEY>'']`, spec.nodeName, |
| spec.serviceAccountName, status.hostIP, status.podIP, |
| status.podIPs.' |
| properties: |
| apiVersion: |
| description: Version of the schema the FieldPath |
| is written in terms of, defaults to "v1". |
| type: string |
| fieldPath: |
| description: Path of the field to select in |
| the specified API version. |
| type: string |
| required: |
| - fieldPath |
| type: object |
| x-kubernetes-map-type: atomic |
| resourceFieldRef: |
| description: 'Selects a resource of the container: |
| only resources limits and requests (limits.cpu, |
| limits.memory, limits.ephemeral-storage, requests.cpu, |
| requests.memory and requests.ephemeral-storage) |
| are currently supported.' |
| properties: |
| containerName: |
| description: 'Container name: required for volumes, |
| optional for env vars' |
| type: string |
| divisor: |
| anyOf: |
| - type: integer |
| - type: string |
| description: Specifies the output format of |
| the exposed resources, defaults to "1" |
| pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ |
| x-kubernetes-int-or-string: true |
| resource: |
| description: 'Required: resource to select' |
| type: string |
| required: |
| - resource |
| type: object |
| x-kubernetes-map-type: atomic |
| secretKeyRef: |
| description: Selects a key of a secret in the pod's |
| namespace |
| properties: |
| key: |
| description: The key of the secret to select |
| from. Must be a valid secret key. |
| type: string |
| name: |
| description: 'Name of the referent. More info: |
| https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| TODO: Add other useful fields. apiVersion, |
| kind, uid?' |
| type: string |
| optional: |
| description: Specify whether the Secret or its |
| key must be defined |
| type: boolean |
| required: |
| - key |
| type: object |
| x-kubernetes-map-type: atomic |
| type: object |
| required: |
| - name |
| type: object |
| type: array |
| envFrom: |
| description: List of sources to populate environment variables |
| in the container. The keys defined within a source must |
| be a C_IDENTIFIER. All invalid keys will be reported as |
| an event when the container is starting. When a key exists |
| in multiple sources, the value associated with the last |
| source will take precedence. Values defined by an Env with |
| a duplicate key will take precedence. Cannot be updated. |
| items: |
| description: EnvFromSource represents the source of a set |
| of ConfigMaps |
| properties: |
| configMapRef: |
| description: The ConfigMap to select from |
| properties: |
| name: |
| description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| TODO: Add other useful fields. apiVersion, kind, |
| uid?' |
| type: string |
| optional: |
| description: Specify whether the ConfigMap must |
| be defined |
| type: boolean |
| type: object |
| x-kubernetes-map-type: atomic |
| prefix: |
| description: An optional identifier to prepend to each |
| key in the ConfigMap. Must be a C_IDENTIFIER. |
| type: string |
| secretRef: |
| description: The Secret to select from |
| properties: |
| name: |
| description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| TODO: Add other useful fields. apiVersion, kind, |
| uid?' |
| type: string |
| optional: |
| description: Specify whether the Secret must be |
| defined |
| type: boolean |
| type: object |
| x-kubernetes-map-type: atomic |
| type: object |
| type: array |
| image: |
| description: 'Container image name. More info: https://kubernetes.io/docs/concepts/containers/images |
| This field is optional to allow higher level config management |
| to default or override container images in workload controllers |
| like Deployments and StatefulSets.' |
| type: string |
| imagePullPolicy: |
| description: 'Image pull policy. One of Always, Never, IfNotPresent. |
| Defaults to Always if :latest tag is specified, or IfNotPresent |
| otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images' |
| type: string |
| lifecycle: |
| description: Actions that the management system should take |
| in response to container lifecycle events. Cannot be updated. |
| properties: |
| postStart: |
| description: 'PostStart is called immediately after a |
| container is created. If the handler fails, the container |
| is terminated and restarted according to its restart |
| policy. Other management of the container blocks until |
| the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks' |
| properties: |
| exec: |
| description: Exec specifies the action to take. |
| properties: |
| command: |
| description: Command is the command line to execute |
| inside the container, the working directory |
| for the command is root ('/') in the container's |
| filesystem. The command is simply exec'd, it |
| is not run inside a shell, so traditional shell |
| instructions ('|', etc) won't work. To use a |
| shell, you need to explicitly call out to that |
| shell. Exit status of 0 is treated as live/healthy |
| and non-zero is unhealthy. |
| items: |
| type: string |
| type: array |
| type: object |
| httpGet: |
| description: HTTPGet specifies the http request to |
| perform. |
| properties: |
| host: |
| description: Host name to connect to, defaults |
| to the pod IP. You probably want to set "Host" |
| in httpHeaders instead. |
| type: string |
| httpHeaders: |
| description: Custom headers to set in the request. |
| HTTP allows repeated headers. |
| items: |
| description: HTTPHeader describes a custom header |
| to be used in HTTP probes |
| properties: |
| name: |
| description: The header field name. This |
| will be canonicalized upon output, so |
| case-variant names will be understood |
| as the same header. |
| type: string |
| value: |
| description: The header field value |
| type: string |
| required: |
| - name |
| - value |
| type: object |
| type: array |
| path: |
| description: Path to access on the HTTP server. |
| type: string |
| port: |
| anyOf: |
| - type: integer |
| - type: string |
| description: Name or number of the port to access |
| on the container. Number must be in the range |
| 1 to 65535. Name must be an IANA_SVC_NAME. |
| x-kubernetes-int-or-string: true |
| scheme: |
| description: Scheme to use for connecting to the |
| host. Defaults to HTTP. |
| type: string |
| required: |
| - port |
| type: object |
| tcpSocket: |
| description: Deprecated. TCPSocket is NOT supported |
| as a LifecycleHandler and kept for the backward |
| compatibility. There are no validation of this field |
| and lifecycle hooks will fail in runtime when tcp |
| handler is specified. |
| properties: |
| host: |
| description: 'Optional: Host name to connect to, |
| defaults to the pod IP.' |
| type: string |
| port: |
| anyOf: |
| - type: integer |
| - type: string |
| description: Number or name of the port to access |
| on the container. Number must be in the range |
| 1 to 65535. Name must be an IANA_SVC_NAME. |
| x-kubernetes-int-or-string: true |
| required: |
| - port |
| type: object |
| type: object |
| preStop: |
| description: 'PreStop is called immediately before a container |
| is terminated due to an API request or management event |
| such as liveness/startup probe failure, preemption, |
| resource contention, etc. The handler is not called |
| if the container crashes or exits. The Pod''s termination |
| grace period countdown begins before the PreStop hook |
| is executed. Regardless of the outcome of the handler, |
| the container will eventually terminate within the Pod''s |
| termination grace period (unless delayed by finalizers). |
| Other management of the container blocks until the hook |
| completes or until the termination grace period is reached. |
| More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks' |
| properties: |
| exec: |
| description: Exec specifies the action to take. |
| properties: |
| command: |
| description: Command is the command line to execute |
| inside the container, the working directory |
| for the command is root ('/') in the container's |
| filesystem. The command is simply exec'd, it |
| is not run inside a shell, so traditional shell |
| instructions ('|', etc) won't work. To use a |
| shell, you need to explicitly call out to that |
| shell. Exit status of 0 is treated as live/healthy |
| and non-zero is unhealthy. |
| items: |
| type: string |
| type: array |
| type: object |
| httpGet: |
| description: HTTPGet specifies the http request to |
| perform. |
| properties: |
| host: |
| description: Host name to connect to, defaults |
| to the pod IP. You probably want to set "Host" |
| in httpHeaders instead. |
| type: string |
| httpHeaders: |
| description: Custom headers to set in the request. |
| HTTP allows repeated headers. |
| items: |
| description: HTTPHeader describes a custom header |
| to be used in HTTP probes |
| properties: |
| name: |
| description: The header field name. This |
| will be canonicalized upon output, so |
| case-variant names will be understood |
| as the same header. |
| type: string |
| value: |
| description: The header field value |
| type: string |
| required: |
| - name |
| - value |
| type: object |
| type: array |
| path: |
| description: Path to access on the HTTP server. |
| type: string |
| port: |
| anyOf: |
| - type: integer |
| - type: string |
| description: Name or number of the port to access |
| on the container. Number must be in the range |
| 1 to 65535. Name must be an IANA_SVC_NAME. |
| x-kubernetes-int-or-string: true |
| scheme: |
| description: Scheme to use for connecting to the |
| host. Defaults to HTTP. |
| type: string |
| required: |
| - port |
| type: object |
| tcpSocket: |
| description: Deprecated. TCPSocket is NOT supported |
| as a LifecycleHandler and kept for the backward |
| compatibility. There are no validation of this field |
| and lifecycle hooks will fail in runtime when tcp |
| handler is specified. |
| properties: |
| host: |
| description: 'Optional: Host name to connect to, |
| defaults to the pod IP.' |
| type: string |
| port: |
| anyOf: |
| - type: integer |
| - type: string |
| description: Number or name of the port to access |
| on the container. Number must be in the range |
| 1 to 65535. Name must be an IANA_SVC_NAME. |
| x-kubernetes-int-or-string: true |
| required: |
| - port |
| type: object |
| type: object |
| type: object |
| livenessProbe: |
| description: 'Periodic probe of container liveness. Container |
| will be restarted if the probe fails. Cannot be updated. |
| More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes' |
| properties: |
| exec: |
| description: Exec specifies the action to take. |
| properties: |
| command: |
| description: Command is the command line to execute |
| inside the container, the working directory for |
| the command is root ('/') in the container's filesystem. |
| The command is simply exec'd, it is not run inside |
| a shell, so traditional shell instructions ('|', |
| etc) won't work. To use a shell, you need to explicitly |
| call out to that shell. Exit status of 0 is treated |
| as live/healthy and non-zero is unhealthy. |
| items: |
| type: string |
| type: array |
| type: object |
| failureThreshold: |
| description: Minimum consecutive failures for the probe |
| to be considered failed after having succeeded. Defaults |
| to 3. Minimum value is 1. |
| format: int32 |
| type: integer |
| grpc: |
| description: GRPC specifies an action involving a GRPC |
| port. |
| properties: |
| port: |
| description: Port number of the gRPC service. Number |
| must be in the range 1 to 65535. |
| format: int32 |
| type: integer |
| service: |
| description: "Service is the name of the service to |
| place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). |
| \n If this is not specified, the default behavior |
| is defined by gRPC." |
| type: string |
| required: |
| - port |
| type: object |
| httpGet: |
| description: HTTPGet specifies the http request to perform. |
| properties: |
| host: |
| description: Host name to connect to, defaults to |
| the pod IP. You probably want to set "Host" in httpHeaders |
| instead. |
| type: string |
| httpHeaders: |
| description: Custom headers to set in the request. |
| HTTP allows repeated headers. |
| items: |
| description: HTTPHeader describes a custom header |
| to be used in HTTP probes |
| properties: |
| name: |
| description: The header field name. This will |
| be canonicalized upon output, so case-variant |
| names will be understood as the same header. |
| type: string |
| value: |
| description: The header field value |
| type: string |
| required: |
| - name |
| - value |
| type: object |
| type: array |
| path: |
| description: Path to access on the HTTP server. |
| type: string |
| port: |
| anyOf: |
| - type: integer |
| - type: string |
| description: Name or number of the port to access |
| on the container. Number must be in the range 1 |
| to 65535. Name must be an IANA_SVC_NAME. |
| x-kubernetes-int-or-string: true |
| scheme: |
| description: Scheme to use for connecting to the host. |
| Defaults to HTTP. |
| type: string |
| required: |
| - port |
| type: object |
| initialDelaySeconds: |
| description: 'Number of seconds after the container has |
| started before liveness probes are initiated. More info: |
| https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes' |
| format: int32 |
| type: integer |
| periodSeconds: |
| description: How often (in seconds) to perform the probe. |
| Default to 10 seconds. Minimum value is 1. |
| format: int32 |
| type: integer |
| successThreshold: |
| description: Minimum consecutive successes for the probe |
| to be considered successful after having failed. Defaults |
| to 1. Must be 1 for liveness and startup. Minimum value |
| is 1. |
| format: int32 |
| type: integer |
| tcpSocket: |
| description: TCPSocket specifies an action involving a |
| TCP port. |
| properties: |
| host: |
| description: 'Optional: Host name to connect to, defaults |
| to the pod IP.' |
| type: string |
| port: |
| anyOf: |
| - type: integer |
| - type: string |
| description: Number or name of the port to access |
| on the container. Number must be in the range 1 |
| to 65535. Name must be an IANA_SVC_NAME. |
| x-kubernetes-int-or-string: true |
| required: |
| - port |
| type: object |
| terminationGracePeriodSeconds: |
| description: Optional duration in seconds the pod needs |
| to terminate gracefully upon probe failure. The grace |
| period is the duration in seconds after the processes |
| running in the pod are sent a termination signal and |
| the time when the processes are forcibly halted with |
| a kill signal. Set this value longer than the expected |
| cleanup time for your process. If this value is nil, |
| the pod's terminationGracePeriodSeconds will be used. |
| Otherwise, this value overrides the value provided by |
| the pod spec. Value must be non-negative integer. The |
| value zero indicates stop immediately via the kill signal |
| (no opportunity to shut down). This is a beta field |
| and requires enabling ProbeTerminationGracePeriod feature |
| gate. Minimum value is 1. spec.terminationGracePeriodSeconds |
| is used if unset. |
| format: int64 |
| type: integer |
| timeoutSeconds: |
| description: 'Number of seconds after which the probe |
| times out. Defaults to 1 second. Minimum value is 1. |
| More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes' |
| format: int32 |
| type: integer |
| type: object |
| ports: |
| description: List of ports to expose from the container. Not |
| specifying a port here DOES NOT prevent that port from being |
| exposed. Any port which is listening on the default "0.0.0.0" |
| address inside a container will be accessible from the network. |
| Modifying this array with strategic merge patch may corrupt |
| the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. |
| Cannot be updated. |
| items: |
| description: ContainerPort represents a network port in |
| a single container. |
| properties: |
| containerPort: |
| description: Number of port to expose on the pod's IP |
| address. This must be a valid port number, 0 < x < |
| 65536. |
| format: int32 |
| type: integer |
| hostIP: |
| description: What host IP to bind the external port |
| to. |
| type: string |
| hostPort: |
| description: Number of port to expose on the host. If |
| specified, this must be a valid port number, 0 < x |
| < 65536. If HostNetwork is specified, this must match |
| ContainerPort. Most containers do not need this. |
| format: int32 |
| type: integer |
| name: |
| description: If specified, this must be an IANA_SVC_NAME |
| and unique within the pod. Each named port in a pod |
| must have a unique name. Name for the port that can |
| be referred to by services. |
| type: string |
| protocol: |
| default: TCP |
| description: Protocol for port. Must be UDP, TCP, or |
| SCTP. Defaults to "TCP". |
| type: string |
| required: |
| - containerPort |
| type: object |
| type: array |
| x-kubernetes-list-map-keys: |
| - containerPort |
| - protocol |
| x-kubernetes-list-type: map |
| readinessProbe: |
| description: 'Periodic probe of container service readiness. |
| Container will be removed from service endpoints if the |
| probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes' |
| properties: |
| exec: |
| description: Exec specifies the action to take. |
| properties: |
| command: |
| description: Command is the command line to execute |
| inside the container, the working directory for |
| the command is root ('/') in the container's filesystem. |
| The command is simply exec'd, it is not run inside |
| a shell, so traditional shell instructions ('|', |
| etc) won't work. To use a shell, you need to explicitly |
| call out to that shell. Exit status of 0 is treated |
| as live/healthy and non-zero is unhealthy. |
| items: |
| type: string |
| type: array |
| type: object |
| failureThreshold: |
| description: Minimum consecutive failures for the probe |
| to be considered failed after having succeeded. Defaults |
| to 3. Minimum value is 1. |
| format: int32 |
| type: integer |
| grpc: |
| description: GRPC specifies an action involving a GRPC |
| port. |
| properties: |
| port: |
| description: Port number of the gRPC service. Number |
| must be in the range 1 to 65535. |
| format: int32 |
| type: integer |
| service: |
| description: "Service is the name of the service to |
| place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). |
| \n If this is not specified, the default behavior |
| is defined by gRPC." |
| type: string |
| required: |
| - port |
| type: object |
| httpGet: |
| description: HTTPGet specifies the http request to perform. |
| properties: |
| host: |
| description: Host name to connect to, defaults to |
| the pod IP. You probably want to set "Host" in httpHeaders |
| instead. |
| type: string |
| httpHeaders: |
| description: Custom headers to set in the request. |
| HTTP allows repeated headers. |
| items: |
| description: HTTPHeader describes a custom header |
| to be used in HTTP probes |
| properties: |
| name: |
| description: The header field name. This will |
| be canonicalized upon output, so case-variant |
| names will be understood as the same header. |
| type: string |
| value: |
| description: The header field value |
| type: string |
| required: |
| - name |
| - value |
| type: object |
| type: array |
| path: |
| description: Path to access on the HTTP server. |
| type: string |
| port: |
| anyOf: |
| - type: integer |
| - type: string |
| description: Name or number of the port to access |
| on the container. Number must be in the range 1 |
| to 65535. Name must be an IANA_SVC_NAME. |
| x-kubernetes-int-or-string: true |
| scheme: |
| description: Scheme to use for connecting to the host. |
| Defaults to HTTP. |
| type: string |
| required: |
| - port |
| type: object |
| initialDelaySeconds: |
| description: 'Number of seconds after the container has |
| started before liveness probes are initiated. More info: |
| https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes' |
| format: int32 |
| type: integer |
| periodSeconds: |
| description: How often (in seconds) to perform the probe. |
| Default to 10 seconds. Minimum value is 1. |
| format: int32 |
| type: integer |
| successThreshold: |
| description: Minimum consecutive successes for the probe |
| to be considered successful after having failed. Defaults |
| to 1. Must be 1 for liveness and startup. Minimum value |
| is 1. |
| format: int32 |
| type: integer |
| tcpSocket: |
| description: TCPSocket specifies an action involving a |
| TCP port. |
| properties: |
| host: |
| description: 'Optional: Host name to connect to, defaults |
| to the pod IP.' |
| type: string |
| port: |
| anyOf: |
| - type: integer |
| - type: string |
| description: Number or name of the port to access |
| on the container. Number must be in the range 1 |
| to 65535. Name must be an IANA_SVC_NAME. |
| x-kubernetes-int-or-string: true |
| required: |
| - port |
| type: object |
| terminationGracePeriodSeconds: |
| description: Optional duration in seconds the pod needs |
| to terminate gracefully upon probe failure. The grace |
| period is the duration in seconds after the processes |
| running in the pod are sent a termination signal and |
| the time when the processes are forcibly halted with |
| a kill signal. Set this value longer than the expected |
| cleanup time for your process. If this value is nil, |
| the pod's terminationGracePeriodSeconds will be used. |
| Otherwise, this value overrides the value provided by |
| the pod spec. Value must be non-negative integer. The |
| value zero indicates stop immediately via the ki
|