| + +```yaml +apiVersion: tekton.dev/v1beta1 +kind: TaskGroup +metadata: + name: ci-tg +spec: + workspaces: + - name: shared-data + params: + - name: repo-url + - name: revision + - name: image-url + - name: dockerfile + results: + - name: commit + - name: digest + steps: + - uses: + taskRef: + name: git-clone + parambindings: + - name: url + param: repo-url + workspacebindings: + - name: output + param: shared-data + - uses: + taskRef: + name: kaniko + parambindings: + - name: url + param: image-url + workspacebindings: + - name: source + param: shared-data +``` + | ++ +```yaml +apiVersion: tekton.dev/v1beta1 +kind: Task +metadata: + name: ci-tg +spec: + workspaces: + - name: shared-data + params: + - name: repo-url + - name: revision + - name: image-url + - name: dockerfile + results: + - name: commit + - name: digest + steps: + - name: git-clone-clone + image: gcr.io/tekton-releases/git-init + script: ... + - name: kaniko-build-and-push + workingDir: $(workspaces.source.path) + image: gcr.io/kaniko-project/executor + args: ... +``` + | +
| Fields in a StepAction CRD | +Example StepAction | +
| Image | ++ +```yaml +apiVersion: tekton.dev/v1alpha1 +kind: StepAction +metadata: + name: git-clone +spec: + image: ... + script: | + git clone ... + command: + args: + env: + params: + results: +``` + | +
| Command | |
| Args | |
| Script | |
| Env | |
| SecurityContext | |
| VolumeMounts | |
| + +[Params](#params) + | |
| + +[Results](#results) + |
| + +```yaml +apiVersion: tekton.dev/v1alpha1 +kind: StepAction +metadata: + name: step1 +spec: + image: alpine + script: | + echo "I am expendable" +``` + | ++ +```yaml +apiVersion: tekton.dev/v1 +kind: Task +metadata: + name: ci-t +spec: + steps: + - name: s1 + ref: + name: step1 + - name: s2 + ref: + name: step2 +``` + | +
| + +```yaml +apiVersion: tekton.dev/v1alpha1 +kind: StepAction +metadata: + name: step2 +spec: + image: alpine + script: | + echo "I am special" +``` + | +
| StepAction from cluster | +StepAction from Git repository | +
| + +```yaml +apiVersion: tekton.dev/v1 +kind: Task +metadata: + name: ci-t +spec: + steps: + - name: s1 + ref: + name: step1 +``` + | ++ +```yaml +apiVersion: tekton.dev/v1 +kind: Task +metadata: + name: ci-t +spec: + steps: + - name: s1 + ref: + resolver: git + params: + - name: url + value: https://... +``` + | +
| Example StepAction | +Example Task with orchestration in Steps | +
| + +```yaml +apiVersion: tekton.dev/v1alpha1 +kind: StepAction +metadata: + name: step1 +spec: + image: alpine + script: | + echo "I am expendable" + +``` + | ++ +```yaml +apiVersion: tekton.dev/v1 +kind: Task +metadata: + name: ci-t +spec: + steps: + - name: s1 + ref: + name: step1 + onError: continue + - name: s2 + ref: + name: step2 + computeResources: + requests: + memory: 1Gi + cpu: 500m + limits: + memory: 2Gi + cpu: 800m +``` + | +
| + +```yaml +apiVersion: tekton.dev/v1alpha1 +kind: StepAction +metadata: + name: step2 +spec: + image: alpine + script: | + echo "I am special" + securityContext: + privileged: true +``` + | +
| + +```yaml +# This is how a step author would +# declare the params that it needs. +apiVersion: tekton.dev/v1alpha1 +kind: StepAction +metadata: + name: myStep +spec: + params: + - name: foo + type: string + description: “This is a param” + default: bar + image: myImage + args: + - $(params.foo) + +``` + | ++ +```yaml +# This is how a task author would +# declare the params that the underlying step needs. +apiVersion: tekton.dev/v1 +kind: Task +metadata: + name: ci-t +spec: + params: + - name: foo + type: string + description: “This is a param” + default: bar + steps: + - name: step1 + ref: + name: myStep +``` + | +
| + +```yaml +# This is how a step author would +# declare the params that it needs. +apiVersion: tekton.dev/v1alpha1 +kind: StepAction +metadata: + name: myStep +spec: + params: + - name: url + description: “This is a param” + default: bar + image: myImage + args: + - $(params.url) + +``` + | ++ +```yaml +# This is how a task author would provide +# the params that the step needs. + +apiVersion: tekton.dev/v1 +kind: Task +metadata: + name: ci-t +spec: + params: + - name: url1 + - name: url2 + steps: + - name: step1 + ref: + name: myStep + params: + - name: url + value: url1 + - name: step2 + ref: + name: myOtherStep + params: + - name: url + value: url2 +``` + | +
| + +```yaml +apiVersion: tekton.dev/v1alpha1 +kind: StepAction +metadata: + name: myStep +spec: + params: + - name: url + description: “Another param” + default: baz + image: myImage + args: + - $(params.url) + +``` + | +
| + +```yaml +# This is how a step author would +# declare the results that it needs. +apiVersion: tekton.dev/v1alpha1 +kind: StepAction +metadata: + name: myStep +spec: + results: + - name: digest + description: “One result” + image: alpine + script: | + echo DIGEST >> $(step.results.digest.path) +``` + | ++ +```yaml +# This is how a task author would +# provide the results that the step needs. +apiVersion: tekton.dev/v1 +kind: Task +metadata: + name: ci-t +spec: + results: + - name: digest1 # Needs to resolve name conflict here + value: $(steps.step1.results.digest) + - name: digest2 # Needs to resolve name conflict here + value: $(steps.step2.results.digest) + - name: stepResult # no name conflict here so nothing to resolve + description: “Step result automatically surfaced from the Step.” + - name: normalResult + description: “Normal result.”#Automatically sent +# to the TaskRun CRD. No need to fetch it via +#values since it was written to the old path. + steps: + - name: step1 + ref: + name: myStep + - name: step2 + ref: + name: myOtherStep + - name: step3 + image: foo + script: | + echo RESULT >> $(results.normalResult.path) +``` + | +
| + +```yaml +apiVersion: tekton.dev/v1alpha1 +kind: StepAction +metadata: + name: myOtherStep +spec: + results: + - name: digest + - name: stepResult + image: alpine + script: | + echo OTHER-DIGEST >> $(step.results.digest.path) + echo STEP-RESULT >> $(step.results.stepResult.path) +``` + | +
| + +```yaml +# This is how a standalone step author +# would declare the results that it is producing. +apiVersion: tekton.dev/v1alpha1 +kind: StepAction +metadata: + name: myStep +spec: + results: + - name: foo + image: ... + script: | + echo “hi” >> $(step.results.foo.path) +``` + | ++ +```yaml +# This is how a task author would +# use the results from one step +# into subsequent steps. +apiVersion: tekton.dev/v1 +kind: Task +metadata: + name: ci-t +spec: + results: + - name: res1 + value: $(steps.step1.results.foo) + steps: + - name: step1 + ref: + name: myStep + - name: step2 + ref: + name: myOtherStep + params: + - name: p1 + value: $(steps.step1.results.foo) +``` + | +
| + +```yaml +apiVersion: tekton.dev/v1alpha1 +kind: StepAction +metadata: + name: myOtherStep +spec: + params: + - name: p1 + image: ... + env: + - name: p1 + value: $(params.p1) + script: + echo "$p1" + +``` + | +
| + +```yaml +apiVersion: tekton.dev/v1 +kind: Task +metadata: + name: ci-t +spec: + workspaces: + - name: shared + steps: + - name: myStep + image: myImage + #A step has a workspace information in + #its context so it can be used here directly + script: | + go test $(workspaces.shared.path)/pkg +``` + | ++ +```yaml +# A standalone step has no context about a workspace. +# It just needs a path to do its work +# which it can accept as a param. +apiVersion: tekton.dev/v1alpha1 +kind: StepAction +metadata: + name: myStep +spec: + params: + - name: path + description: “Path to the test folder” + image: ... + script: | + go test $(params.path) + +``` + | +
| + +```yaml +apiVersion: tekton.dev/v1 +kind: Task +metadata: + name: ci-t +spec: + workspaces: + - name: shared + params: + - name: path + value: $(workspaces.shared.path)/pkg + #A task has to provide a path to the + # referenced step. Here, it’s done + # via a workspace reference. + steps: + - name: myStep + ref: + name: myStep +``` + | +
| + +```yaml +apiVersion: tekton.dev/v1alpha1 +kind: StepAction +metadata: + name: myStep +spec: + params: + - name: registryConfig + - name: otherConfig + volumeMounts: + - name: $(params.registryConfig) + mountPath: /registry-config + volumeMounts: + - name: $(params.otherConfig) + mountPath: /other-config + image: ... + script: ... +``` + | ++ +```yaml +apiVersion: tekton.dev/v1 +kind: Task +metadata: + name: task-name +spec: + volume: + - name: registry-config + secret: + secretName: foo + workspaces: + - name: other-config + steps: + - name: myStep + ref: + name: myStep + params: + - name: registryConfig + value: registry-config + - name: otherConfig + value: $(workspaces.other-config.volume) +``` + | +