TKN-PIPELINE-START(1)

πŸ“¦ version 0.46.2, in nixos 26.05, nixpkgs unstable

πŸŽ€ tkn-pipeline-start β€” Start Pipelines πŸŽ€

okay bestie, you made it to the TKN-PIPELINE-START(1) manual page πŸ’– this is the tkn command for starting Pipelines, and we're gonna read it together like a group chat. no cap, every flag is staying. ✨


🌸 NAME 🌸

tkn-pipeline-start β€” Start Pipelines


🌈 SYNOPSIS 🌈

tkn pipeline start

πŸ’… DESCRIPTION πŸ’…

okay so to start a pipeline, you will need to pass the following, bestie:

  • Workspaces
  • Parameters, at least those that have no default value

that's the whole vibe check. 🫢


✨ OPTIONS ✨

here's the entire flag family, no skips, periodt πŸ‘‘

  • --dry-run[=false] β€” preview PipelineRun without running it
  • -E, --exit-with-pipelinerun-error[=false] β€” when using --showlog, exit with pipelinerun to the unix shell, 0 if success, 1 if error, 2 on unknown status
  • -f, --filename="" β€” local or remote file name containing a Pipeline definition to start a PipelineRun
  • --finally-timeout="" β€” timeout for Finally TaskRuns
  • -h, --help[=false] β€” help for start
  • -l, --labels=[] β€” pass labels as label=value.
  • -L, --last[=false] β€” re-run the Pipeline using last PipelineRun values
  • -o, --output="" β€” format of PipelineRun (yaml, json or name)
  • -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
  • --pipeline-timeout="" β€” timeout for PipelineRun
  • --pod-template="" β€” local or remote file containing a PodTemplate definition
  • --prefix-name="" β€” specify a prefix for the PipelineRun name (must be lowercase alphanumeric characters)
  • --resolvertype="" β€” resolver type for remote pipelines (hub, git, http, cluster, bundle, remote)
  • -s, --serviceaccount="" β€” pass the serviceaccount name
  • --showlog[=false] β€” show logs right after starting the Pipeline
  • --skip-optional-workspace[=false] β€” skips the prompt for optional workspaces
  • --task-serviceaccount=[] β€” pass the service account corresponding to the task
  • --tasks-timeout="" β€” timeout for Pipeline TaskRuns
  • --use-param-defaults[=false] β€” use default parameter values without prompting for input
  • --use-pipelinerun="" β€” use this pipelinerun values to re-run the pipeline.
  • -w, --workspace=[] β€” pass one or more workspaces to map to the corresponding physical volumes

🌟 OPTIONS INHERITED FROM PARENT COMMANDS 🌟

these come from the parent command, still iconic, still important πŸ’œ

  • -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 πŸ¦‹

bestie, here are the examples, copied exactly and ready to slay πŸŽ€

To run a Pipeline that has one workspace and no parameter.

$ tkn pipeline start --workspace name=my-empty-dir,emptyDir=""

To create a workspace-template.yaml

$ cat <<EOF > workspace-template.yaml
spec:
    accessModes:
        - ReadWriteOnce
    resources:
        requests:
            storage: 1Gi
EOF

To create a csi-template.yaml

$ cat <<EOF > csi-template.yaml driver: secrets-store.csi.k8s.io readOnly: true volumeAttributes: secretProviderClass: "vault-database" EOF

To run a Pipeline that has two parameters (foo and bar) and six workspaces (my-config, my-pvc, my-secret, my-empty-dir, my-csi-template and my-volume-claim-template)

$ tkn pipeline start \
    --param foo=yay \
    --param bar=10 \
    --workspace name=my-secret,secret=secret-name \
    --workspace name=my-config,config=rpg,item=ultimav=1 \
    --workspace name=my-empty-dir,emptyDir="" \
    --workspace name=my-pvc,claimName=pvc1,subPath=dir
    --workspace name=my-volume-claim-template,volumeClaimTemplateFile=workspace-template.yaml
    --workspace name=my-csi-template,csiFile=csi-template.yaml

πŸ“ SEE ALSO πŸ“

go see the parent page too, iykyk πŸ’«


πŸ’– auto generated by spf13/cobra Β· TKN-PIPELINE-START(1) Β· (no date in this footer, bestie) πŸ’–

πŸ“¦ where this page comes from