TKN-TASK-START(1)

📦
version 0.46.2 · 2 versions
, in nixpkgs unstable

💅 NAME 💅

okay so bestie, welcome to TKN-TASK-START(1) — that's the tkn-task-start page from the tkn manual, section 1, and she is entirely about starting Tasks. Like, tkn task start. That's the whole vibe. 🌸

✨ SYNOPSIS ✨

tkn task start [RESOURCES...] [PARAMS...] [SERVICEACCOUNT]

🎀 DESCRIPTION 🎀

Start Tasks. That's the description, no notes, she said what she said. 💅 If you wanna kick off a Task, this is the command, periodt.

🦋 OPTIONS 🦋

okay this is the long part, stay with me bestie, we're going through every single one 💖

  • --dry-run[=false] — preview the TaskRun without actually running it. very "look but don't touch" energy 👀
  • -f, --filename="" — a local or remote file name that contains a Task definition to start a TaskRun from
  • -h, --help[=false] — help for start. the classic
  • -i, --image="" — use an oci bundle
  • -l, --labels=[] — pass labels as label=value.
  • -L, --last[=false] — re-run the Task using the last TaskRun values. rerun queen behavior 👑
  • --output="" — format of the TaskRun (yaml or json)
  • -p, --param=[] — pass the param as key=value for string type, or key=value1,value2,... for array type, or key="key1:value1, key2:value2" for object type
  • --pod-template="" — local or remote file containing a PodTemplate definition
  • --prefix-name="" — specify a prefix for the TaskRun name (must be lowercase alphanumeric characters, so no shouting please)
  • --remote-bearer="" — a Bearer token to authenticate against the repository
  • --remote-password="" — a password to pass to the registry for basic auth. must be used with --remote-username (they're a package deal fr fr)
  • --remote-skip-tls[=false] — skip TLS certificate verification and allow plain-HTTP connections to the registry (an opt-in insecure mode). bestie this one is literally opt-in insecure, so like, be aware 🫶
  • --remote-username="" — a username to pass to the registry for basic auth. must be used with --remote-password
  • -s, --serviceaccount="" — pass the serviceaccount name
  • --showlog[=false] — show logs right after starting the Task
  • --skip-optional-workspace[=false] — skips the prompt for optional workspaces
  • --timeout="" — timeout for the TaskRun
  • --use-param-defaults[=false] — use the default parameter values without prompting for input. no questions asked, she just goes ✨
  • --use-taskrun="" — specify a TaskRun name to use its values to re-run the TaskRun
  • -w, --workspace=[] — pass one or more workspaces to map to the corresponding physical volumes

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

these ones come from the parent command, they're not hers, she's just borrowing 💜

  • -c, --context="" — name of the kubeconfig context to use (default: kubectl config current-context)
  • -k, --kubeconfig="" — kubectl config file (default: $HOME/.kube/config)
  • -n, --namespace="" — namespace to use (default: from $KUBECONFIG)
  • -C, --no-color[=false] — disable coloring (default: false)

🔥 EXAMPLE 🔥

Start Task foo by creating a TaskRun named "foo-run-xyz123" from namespace 'bar':

tkn task start foo -s ServiceAccountName -n bar

The Task can either be specified by reference in a cluster using the positional argument, an oci bundle using the --image argument and the positional argument, or in a file using the --filename argument. three whole ways, pick your fighter 💅

🔐 Authentication 🔐

There are three ways to authenticate against your registry when using the --image argument.

  1. By default, your docker.config in your home directory and podman's auth.json are used.
  2. Additionally, you can supply a Bearer Token via --remote-bearer
  3. Additionally, you can use Basic auth via --remote-username and --remote-password

🍓 Params 🍓

For params values, if you want to provide multiple values, provide them comma separated like cat,foo,bar

🧚 Passing the workspaces via flags 🧚

  • In case of emptyDir, you can pass it like -w name=my-empty-dir,emptyDir=
  • In case of configMap, you can pass it like -w name=my-config,config=rpg,item=ultimav=1
  • In case of secrets, you can pass it like -w name=my-secret,secret=secret-name
  • In case of pvc, you can pass it like -w name=my-pvc,claimName=pvc1
  • In case of volumeClaimTemplate, you can pass it like -w name=my-volume-claim-template,volumeClaimTemplateFile=workspace-template.yaml but before you need to create a workspace-template.yaml file. Sample contents of the file are as follows: spec: accessModes:
    • ReadWriteOnce resources: requests: storage: 1Gi
  • In case of binding a CSI workspace, you can pass it like -w name=my-csi,csiFile=csi.yaml but you need to create a csi.yaml file before hand. Sample contents of the file are as follows:
driver: secrets-store.csi.k8s.io
  readOnly: true
  volumeAttributes:
    secretProviderClass: "vault-database"

🌟 SEE ALSO 🌟

okay that's the whole page bestie, you ate that 💅✨

and for the cute little sign-off: this page is Auto generated by spf13/cobra, and yes, the header and footer both just say TKN-TASK-START(1) again because she likes her symmetry 🎀 periodt.

📦 where this page comes from