Skip to content
This repository has been archived by the owner on Nov 11, 2023. It is now read-only.

Latest commit

 

History

History
115 lines (80 loc) · 4.43 KB

README.md

File metadata and controls

115 lines (80 loc) · 4.43 KB
Raw

Tekton Catalog

Test Workflow Release Workflow The SLSA Level 3 badge The Apache 2.0 license badge Follow us on Twitter

Warning This package has been archived. The tasks and pipelines from this package are now included in the cartographer-supply-chains package.

A Carvel package providing a set of Tekton pipelines and tasks used by the Kadras platform to support testing, scanning, delivering and deploying applications.

🚀  Getting Started

Prerequisites

  • Kubernetes 1.26+

  • Carvel kctrl CLI.

  • Carvel kapp-controller deployed in your Kubernetes cluster. You can install it with Carvel kapp (recommended choice) or kubectl.

    kapp deploy -a kapp-controller -y \
  -f https://github.com/carvel-dev/kapp-controller/releases/latest/download/release.yml

Dependencies

Tekton Catalog requires the Tekton Pipelines package. You can install it from the Kadras package repository.

Installation

Add the Kadras package repository to your Kubernetes cluster:

kctrl package repository add -r kadras-packages \
  --url ghcr.io/kadras-io/kadras-packages \
  -n kadras-packages --create-namespace
Installation without package repository The recommended way of installing the tekton-catalog package is via the Kadras package repository. If you prefer not using the repository, you can add the package definition directly using kapp or kubectl. 
kubectl create namespace kadras-packages
kapp deploy -a tekton-catalog-package -n kadras-packages -y \
  -f https://github.com/kadras-io/tekton-catalog/releases/latest/download/metadata.yml \
  -f https://github.com/kadras-io/tekton-catalog/releases/latest/download/package.yml

Install the Tekton Catalog package:

kctrl package install -i tekton-catalog \
  -p tekton-catalog.packages.kadras.io \
  -v ${VERSION} \
  -n kadras-packages

Note You can find the ${VERSION} value by retrieving the list of package versions available in the Kadras package repository installed on your cluster.

kctrl package available list -p tekton-catalog.packages.kadras.io -n kadras-packages

Verify the installed packages and their status:

kctrl package installed list -n kadras-packages

📙  Documentation

Documentation, tutorials and examples for this package are available in the docs folder. For documentation specific to Tekton Pipelines, check out tekton.dev.

🎯  Configuration

The Tekton Catalog package can be customized via a values.yml file.

namespace: tekton-catalog

Reference the values.yml file from the kctrl command when installing or upgrading the package.

kctrl package install -i tekton-catalog \
  -p tekton-catalog.packages.kadras.io \
  -v ${VERSION} \
  -n kadras-packages \
  --values-file values.yml

Values

The Tekton Catalog package has the following configurable properties.

Configurable properties
Config Default Description
namespace tekton-catalog The namespace where to deploy the Tekton Catalog.

🛡️  Security

The security process for reporting vulnerabilities is described in SECURITY.md.

🖊️  License

This project is licensed under the Apache License 2.0. See LICENSE for more information.