github.com/oam-dev/kubevela@v1.9.11/charts/vela-core/templates/defwithtemplate/cron-task.yaml

# Code generated by KubeVela templates. DO NOT EDIT. Please edit the original cue file.
# Definition source cue file: vela-templates/definitions/internal/cron-task.cue
apiVersion: core.oam.dev/v1beta1
kind: ComponentDefinition
metadata:
  annotations:
    definition.oam.dev/description: Describes cron jobs that run code or a script to completion.
  name: cron-task
  namespace: {{ include "systemDefinitionNamespace" . }}
spec:
  schematic:
    cue:
      template: |
        mountsArray: {
        	pvc: *[
        		for v in parameter.volumeMounts.pvc {
        			{
        				mountPath: v.mountPath
        				if v.subPath != _|_ {
        					subPath: v.subPath
        				}
        				name: v.name
        			}
        		},
        	] | []

        	configMap: *[
        			for v in parameter.volumeMounts.configMap {
        			{
        				mountPath: v.mountPath
        				if v.subPath != _|_ {
        					subPath: v.subPath
        				}
        				name: v.name
        			}
        		},
        	] | []

        	secret: *[
        		for v in parameter.volumeMounts.secret {
        			{
        				mountPath: v.mountPath
        				if v.subPath != _|_ {
        					subPath: v.subPath
        				}
        				name: v.name
        			}
        		},
        	] | []

        	emptyDir: *[
        			for v in parameter.volumeMounts.emptyDir {
        			{
        				mountPath: v.mountPath
        				if v.subPath != _|_ {
        					subPath: v.subPath
        				}
        				name: v.name
        			}
        		},
        	] | []

        	hostPath: *[
        			for v in parameter.volumeMounts.hostPath {
        			{
        				mountPath: v.mountPath
        				if v.subPath != _|_ {
        					subPath: v.subPath
        				}
        				name: v.name
        			}
        		},
        	] | []
        }
        volumesArray: {
        	pvc: *[
        		for v in parameter.volumeMounts.pvc {
        			{
        				name: v.name
        				persistentVolumeClaim: claimName: v.claimName
        			}
        		},
        	] | []

        	configMap: *[
        			for v in parameter.volumeMounts.configMap {
        			{
        				name: v.name
        				configMap: {
        					defaultMode: v.defaultMode
        					name:        v.cmName
        					if v.items != _|_ {
        						items: v.items
        					}
        				}
        			}
        		},
        	] | []

        	secret: *[
        		for v in parameter.volumeMounts.secret {
        			{
        				name: v.name
        				secret: {
        					defaultMode: v.defaultMode
        					secretName:  v.secretName
        					if v.items != _|_ {
        						items: v.items
        					}
        				}
        			}
        		},
        	] | []

        	emptyDir: *[
        			for v in parameter.volumeMounts.emptyDir {
        			{
        				name: v.name
        				emptyDir: medium: v.medium
        			}
        		},
        	] | []

        	hostPath: *[
        			for v in parameter.volumeMounts.hostPath {
        			{
        				name: v.name
        				hostPath: path: v.path
        			}
        		},
        	] | []
        }
        volumesList: volumesArray.pvc + volumesArray.configMap + volumesArray.secret + volumesArray.emptyDir + volumesArray.hostPath
        deDupVolumesArray: [
        	for val in [
        		for i, vi in volumesList {
        			for j, vj in volumesList if j < i && vi.name == vj.name {
        				_ignore: true
        			}
        			vi
        		},
        	] if val._ignore == _|_ {
        		val
        	},
        ]
        output: {
        	if context.clusterVersion.minor < 25 {
        		apiVersion: "batch/v1beta1"
        	}
        	if context.clusterVersion.minor >= 25 {
        		apiVersion: "batch/v1"
        	}
        	kind: "CronJob"
        	spec: {
        		schedule:                   parameter.schedule
        		concurrencyPolicy:          parameter.concurrencyPolicy
        		suspend:                    parameter.suspend
        		successfulJobsHistoryLimit: parameter.successfulJobsHistoryLimit
        		failedJobsHistoryLimit:     parameter.failedJobsHistoryLimit
        		if parameter.startingDeadlineSeconds != _|_ {
        			startingDeadlineSeconds: parameter.startingDeadlineSeconds
        		}
        		jobTemplate: {
        			metadata: {
        				labels: {
        					if parameter.labels != _|_ {
        						parameter.labels
        					}
        					"app.oam.dev/name":      context.appName
        					"app.oam.dev/component": context.name
        				}
        				if parameter.annotations != _|_ {
        					annotations: parameter.annotations
        				}
        			}
        			spec: {
        				parallelism: parameter.count
        				completions: parameter.count
        				if parameter.ttlSecondsAfterFinished != _|_ {
        					ttlSecondsAfterFinished: parameter.ttlSecondsAfterFinished
        				}
        				if parameter.activeDeadlineSeconds != _|_ {
        					activeDeadlineSeconds: parameter.activeDeadlineSeconds
        				}
        				backoffLimit: parameter.backoffLimit
        				template: {
        					metadata: {
        						labels: {
        							if parameter.labels != _|_ {
        								parameter.labels
        							}
        							"app.oam.dev/name":      context.appName
        							"app.oam.dev/component": context.name
        						}
        						if parameter.annotations != _|_ {
        							annotations: parameter.annotations
        						}
        					}
        					spec: {
        						restartPolicy: parameter.restart
        						containers: [{
        							name:  context.name
        							image: parameter.image
        							if parameter["imagePullPolicy"] != _|_ {
        								imagePullPolicy: parameter.imagePullPolicy
        							}
        							if parameter["cmd"] != _|_ {
        								command: parameter.cmd
        							}
        							if parameter["env"] != _|_ {
        								env: parameter.env
        							}
        							if parameter["cpu"] != _|_ {
        								resources: {
        									limits: cpu:   parameter.cpu
        									requests: cpu: parameter.cpu
        								}
        							}
        							if parameter["memory"] != _|_ {
        								resources: {
        									limits: memory:   parameter.memory
        									requests: memory: parameter.memory
        								}
        							}
        							if parameter["volumes"] != _|_ if parameter["volumeMounts"] == _|_ {
        								volumeMounts: [ for v in parameter.volumes {
        									{
        										mountPath: v.mountPath
        										name:      v.name
        									}}]
        							}
        							if parameter["volumeMounts"] != _|_ {
        								volumeMounts: mountsArray.pvc + mountsArray.configMap + mountsArray.secret + mountsArray.emptyDir + mountsArray.hostPath
        							}
        						}]
        						if parameter["volumes"] != _|_ if parameter["volumeMounts"] == _|_ {
        							volumes: [ for v in parameter.volumes {
        								{
        									name: v.name
        									if v.type == "pvc" {
        										persistentVolumeClaim: claimName: v.claimName
        									}
        									if v.type == "configMap" {
        										configMap: {
        											defaultMode: v.defaultMode
        											name:        v.cmName
        											if v.items != _|_ {
        												items: v.items
        											}
        										}
        									}
        									if v.type == "secret" {
        										secret: {
        											defaultMode: v.defaultMode
        											secretName:  v.secretName
        											if v.items != _|_ {
        												items: v.items
        											}
        										}
        									}
        									if v.type == "emptyDir" {
        										emptyDir: medium: v.medium
        									}
        								}}]
        						}
        						if parameter["volumeMounts"] != _|_ {
        							volumes: deDupVolumesArray
        						}
        						if parameter["imagePullSecrets"] != _|_ {
        							imagePullSecrets: [ for v in parameter.imagePullSecrets {
        								name: v
        							},
        							]
        						}
        						if parameter.hostAliases != _|_ {
        							hostAliases: [ for v in parameter.hostAliases {
        								ip:        v.ip
        								hostnames: v.hostnames
        							},
        							]
        						}
        					}
        				}
        			}
        		}
        	}
        }

        parameter: {
        	// +usage=Specify the labels in the workload
        	labels?: [string]: string

        	// +usage=Specify the annotations in the workload
        	annotations?: [string]: string

        	// +usage=Specify the schedule in Cron format, see https://en.wikipedia.org/wiki/Cron
        	schedule: string

        	// +usage=Specify deadline in seconds for starting the job if it misses scheduled
        	startingDeadlineSeconds?: int

        	// +usage=suspend subsequent executions
        	suspend: *false | bool

        	// +usage=Specifies how to treat concurrent executions of a Job
        	concurrencyPolicy: *"Allow" | "Allow" | "Forbid" | "Replace"

        	// +usage=The number of successful finished jobs to retain
        	successfulJobsHistoryLimit: *3 | int

        	// +usage=The number of failed finished jobs to retain
        	failedJobsHistoryLimit: *1 | int

        	// +usage=Specify number of tasks to run in parallel
        	// +short=c
        	count: *1 | int

        	// +usage=Which image would you like to use for your service
        	// +short=i
        	image: string

        	// +usage=Specify image pull policy for your service
        	imagePullPolicy?: "Always" | "Never" | "IfNotPresent"

        	// +usage=Specify image pull secrets for your service
        	imagePullSecrets?: [...string]

        	// +usage=Define the job restart policy, the value can only be Never or OnFailure. By default, it's Never.
        	restart: *"Never" | string

        	// +usage=Commands to run in the container
        	cmd?: [...string]

        	// +usage=Define arguments by using environment variables
        	env?: [...{
        		// +usage=Environment variable name
        		name: string
        		// +usage=The value of the environment variable
        		value?: string
        		// +usage=Specifies a source the value of this var should come from
        		valueFrom?: {
        			// +usage=Selects a key of a secret in the pod's namespace
        			secretKeyRef?: {
        				// +usage=The name of the secret in the pod's namespace to select from
        				name: string
        				// +usage=The key of the secret to select from. Must be a valid secret key
        				key: string
        			}
        			// +usage=Selects a key of a config map in the pod's namespace
        			configMapKeyRef?: {
        				// +usage=The name of the config map in the pod's namespace to select from
        				name: string
        				// +usage=The key of the config map to select from. Must be a valid secret key
        				key: string
        			}
        		}
        	}]

        	// +usage=Number of CPU units for the service, like `0.5` (0.5 CPU core), `1` (1 CPU core)
        	cpu?: string

        	// +usage=Specifies the attributes of the memory resource required for the container.
        	memory?: string

        	volumeMounts?: {
        		// +usage=Mount PVC type volume
        		pvc?: [...{
        			name:      string
        			mountPath: string
        			subPath?:  string
        			// +usage=The name of the PVC
        			claimName: string
        		}]
        		// +usage=Mount ConfigMap type volume
        		configMap?: [...{
        			name:        string
        			mountPath:   string
        			subPath?:    string
        			defaultMode: *420 | int
        			cmName:      string
        			items?: [...{
        				key:  string
        				path: string
        				mode: *511 | int
        			}]
        		}]
        		// +usage=Mount Secret type volume
        		secret?: [...{
        			name:        string
        			mountPath:   string
        			subPath?:    string
        			defaultMode: *420 | int
        			secretName:  string
        			items?: [...{
        				key:  string
        				path: string
        				mode: *511 | int
        			}]
        		}]
        		// +usage=Mount EmptyDir type volume
        		emptyDir?: [...{
        			name:      string
        			mountPath: string
        			subPath?:  string
        			medium:    *"" | "Memory"
        		}]
        		// +usage=Mount HostPath type volume
        		hostPath?: [...{
        			name:      string
        			mountPath: string
        			subPath?:  string
        			path:      string
        		}]
        	}

        	// +usage=Deprecated field, use volumeMounts instead.
        	volumes?: [...{
        		name:      string
        		mountPath: string
        		// +usage=Specify volume type, options: "pvc","configMap","secret","emptyDir", default to emptyDir
        		type: *"emptyDir" | "pvc" | "configMap" | "secret"
        		if type == "pvc" {
        			claimName: string
        		}
        		if type == "configMap" {
        			defaultMode: *420 | int
        			cmName:      string
        			items?: [...{
        				key:  string
        				path: string
        				mode: *511 | int
        			}]
        		}
        		if type == "secret" {
        			defaultMode: *420 | int
        			secretName:  string
        			items?: [...{
        				key:  string
        				path: string
        				mode: *511 | int
        			}]
        		}
        		if type == "emptyDir" {
        			medium: *"" | "Memory"
        		}
        	}]

        	// +usage=An optional list of hosts and IPs that will be injected into the pod's hosts file
        	hostAliases?: [...{
        		ip: string
        		hostnames: [...string]
        	}]

        	// +usage=Limits the lifetime of a Job that has finished
        	ttlSecondsAfterFinished?: int

        	// +usage=The duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it
        	activeDeadlineSeconds?: int

        	// +usage=The number of retries before marking this job failed
        	backoffLimit: *6 | int

        	// +usage=Instructions for assessing whether the container is alive.
        	livenessProbe?: #HealthProbe

        	// +usage=Instructions for assessing whether the container is in a suitable state to serve traffic.
        	readinessProbe?: #HealthProbe
        }

        #HealthProbe: {

        	// +usage=Instructions for assessing container health by executing a command. Either this attribute or the httpGet attribute or the tcpSocket attribute MUST be specified. This attribute is mutually exclusive with both the httpGet attribute and the tcpSocket attribute.
        	exec?: {
        		// +usage=A command to be executed inside the container to assess its health. Each space delimited token of the command is a separate array element. Commands exiting 0 are considered to be successful probes, whilst all other exit codes are considered failures.
        		command: [...string]
        	}

        	// +usage=Instructions for assessing container health by executing an HTTP GET request. Either this attribute or the exec attribute or the tcpSocket attribute MUST be specified. This attribute is mutually exclusive with both the exec attribute and the tcpSocket attribute.
        	httpGet?: {
        		// +usage=The endpoint, relative to the port, to which the HTTP GET request should be directed.
        		path: string
        		// +usage=The TCP socket within the container to which the HTTP GET request should be directed.
        		port: int
        		httpHeaders?: [...{
        			name:  string
        			value: string
        		}]
        	}

        	// +usage=Instructions for assessing container health by probing a TCP socket. Either this attribute or the exec attribute or the httpGet attribute MUST be specified. This attribute is mutually exclusive with both the exec attribute and the httpGet attribute.
        	tcpSocket?: {
        		// +usage=The TCP socket within the container that should be probed to assess container health.
        		port: int
        	}

        	// +usage=Number of seconds after the container is started before the first probe is initiated.
        	initialDelaySeconds: *0 | int

        	// +usage=How often, in seconds, to execute the probe.
        	periodSeconds: *10 | int

        	// +usage=Number of seconds after which the probe times out.
        	timeoutSeconds: *1 | int

        	// +usage=Minimum consecutive successes for the probe to be considered successful after having failed.
        	successThreshold: *1 | int

        	// +usage=Number of consecutive failures required to determine the container is not alive (liveness probe) or not ready (readiness probe).
        	failureThreshold: *3 | int
        }
  workload:
    type: autodetects.core.oam.dev