Getting Started

If you would like to configure the size and storage class of the Persistent Volume Tekton requests, update the default config-artifact-pvc configMap. This configMap includes two attributes:

• size: the size of the volume
• storageClassName: the name of the storage class of the volume

The following example asks Tekton to request a Persistent Volume of 10Gi with the manual storage class when running a workflow:

kubectl create configmap config-artifact-pvc \
                         --from-literal=size=10Gi \
                         --from-literal=storageClassName=manual \
                         -o yaml -n tekton-pipelines \
                         --dry-run=client | kubectl replace -f -

If you would like to use Google Cloud Storage or AWS S3 buckets instead, remove the default config-artifact-pvc configMap and create another one of the name config-artifact-bucket. This configMap includes the following attributes:

• location: the address of the bucket, such as gs://my-gcs-bucket/
• bucket.service.account.secret.name: the name of the Kubernetes secret where the service account credentials for accessing the bucket reside.
• bucket.service.account.secret.key: the name of the key in the secret which Tekton should use
• bucket.service.account.field.name: the name of the environment variable to use when setting up the credentials. Defaults to GOOGLE_APPLICATION_CREDENTIALS; use BOTO_CONFIG if you plan to use an AWS S3 bucket.

The following example asks Tekton to use a Google Cloud Storage bucket for storage when running a workflow:

kubectl create configmap config-artifact-pvc \
                         --from-literal=location=gs://MY-GCS-BUCKET \
                         --from-literal=bucket.service.account.secret.name=my-secret \
                         --from-literal=bucket.service.account.secret.key=my-key \
                         -o yaml -n tekton-pipelines \
                         --dry-run=client | kubectl replace -f -

And the my-secret Kubernetes secret is configured as follows:

apiVersion: v1
kind: Secret
metadata:
  name: my-secret
type: kubernetes.io/opaque
stringData:
  my-key: MY-SERVICE-ACCOUNT-JSON-KEY

tkn is available on macOS via brew:

brew tap tektoncd/tools
brew install tektoncd/tools/tektoncd-cli

You can also download it as a tarball from the tkn Releases page. After downloading the file, extract it to your PATH:

# Replace YOUR-DOWNLOADED-FILE with the file path of your own.
sudo tar xvzf YOUR-DOWNLOADED-FILE -C /usr/local/bin/ tkn

tkn is available on Windows via Chocolatey:

choco install tektoncd-cli --confirm

You can also download it as a .zip file from the tkn Releases page. After downloading the file, add it to your Path:

• Uncompress the .zip file.
• Open Control Panel > System and Security > System > Advanced System Settings.
• Click Environment Variables, select the Path variable and click Edit.
• Click New and add the path to your uncompressed file.
• Click OK.

tkn is available on Linux as a .deb package (for Debian, Ubuntu and other deb-based distros) and .rpm package (for Fedora, CentOS, and other rpm-based distros).

• Debian, Ubuntu, and other deb-based distros

  Find the .deb package of the tkn release you would like to install on the tkn Releases page and install it with

  # Replace LINK-TO-THE-PACKAGE with the package URL you would like to use.
  curl -LO LINK-TO-THE-PACKAGE
  sudo dpkg -i ./PACKAGE-NAME

  If you are using the latest releases of Ubuntu or Debian, you may use the TektonCD CLI PPA instead:

  sudo apt update;sudo apt install -y gnupg
  sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 3EFE0E0A2F2F60AA
  echo "deb http://ppa.launchpad.net/tektoncd/cli/ubuntu eoan main"|sudo tee /etc/apt/sources.list.d/tektoncd-ubuntu-cli.list
  sudo apt update && sudo apt install -y tektoncd-cli

• Fedora, CentOS, and other rpm-based distros

  Find the .rpm package of the tkn release you would like to install on the tkn Releases page and install it with

  # Replace LINK-TO-THE-PACKAGE with the package URL you would like to use.
  rpm -Uvh LINK-TO-THE-PACKAGE

  If you are using Fedora ³⁰⁄₃₁, CentOS ⁷⁄₈, EPEL, or RHEL 8, @chmousel provides an unofficial copr package repository for installing the package:

  dnf copr enable chmouel/tektoncd-cli
  dnf install tektoncd-cli

Alternatively, you may download tkn as a tarball:

Find the tarball of the tkn release for your platform (ARM or X86-64) you would like to install on the tkn Releases page and install it with

# Replace LINK-TO-TARBALL with the package URL you would like to use.
curl -LO LINK-TO-TARBALL
# Replace YOUR-DOWNLOADED-FILE with the file path of your own.
sudo tar xvzf YOUR-DOWNLOADED-FILE -C /usr/local/bin/ tkn