Development Guide

December 18, 2024 ยท View on GitHub

Development Prerequisites

  1. go
  2. git
  3. kubectl
  4. ko
  5. kustomize

Getting started

Ramp up

Welcome to the project!! You may find these resources helpful to ramp up on some of the technology this project is built on.

Ramp up on CRDs

This project extends Kubernetes (aka k8s) with Custom Resource Definitions (CRDSs). To find out more:

Ramp up on Tekton Pipelines

Ramp up on Kubernetes Operators

Checkout your fork

The Go tools require that you clone the repository to the src/github.com/tektoncd/operator directory in your GOPATH.

To check out this repository:

  1. Create your own fork of this repo
  2. Clone it to your machine:
mkdir -p ${GOPATH}/src/github.com/tektoncd
cd ${GOPATH}/src/github.com/tektoncd
git clone git@github.com:${YOUR_GITHUB_USERNAME}/operator.git
cd operator
git remote add upstream git@github.com:tektoncd/operator.git
git remote set-url --push upstream no_push

Adding the upstream remote sets you up nicely for regularly syncing your fork.

Requirements

You must install these tools:

  1. go: The language Tekton Pipelines is built in
  2. git: For source control
  3. dep: For managing external Go dependencies. - Please Install dep v0.5.0 or greater.
  4. kubectl: For interacting with your kube cluster

Your [$GOPATH] setting is critical for go to function properly.

Kubernetes cluster

Docker for Desktop using an edge version has been proven to work for both developing and running Pipelines. The recommended configuration is:

  • Kubernetes version 1.11 or later
  • 4 vCPU nodes (n1-standard-4)
  • Node autoscaling, up to 3 nodes
  • API scopes for cloud-platform

To setup a cluster with GKE:

  1. Install required tools and setup GCP project (You may find it useful to save the ID of the project in an environment variable (e.g. PROJECT_ID).

  2. Create a GKE cluster (with --cluster-version=latest but you can use any version 1.11 or later):

    export PROJECT_ID=my-gcp-project
export CLUSTER_NAME=mycoolcluster

gcloud container clusters create $CLUSTER_NAME \
 --enable-autoscaling \
 --min-nodes=1 \
 --max-nodes=3 \
 --scopes=cloud-platform \
 --enable-basic-auth \
 --no-issue-client-certificate \
 --project=$PROJECT_ID \
 --region=us-central1 \
 --machine-type=n1-standard-4 \
 --image-type=cos \
 --num-nodes=1 \
 --cluster-version=latest

    Note that the --scopes argument to gcloud container cluster create controls what GCP resources the cluster's default service account has access to; for example to give the default service account full access to your GCR registry, you can add storage-full to your --scopes arg.

  3. Grant cluster-admin permissions to the current user:

    kubectl create clusterrolebinding cluster-admin-binding \
--clusterrole=cluster-admin \
--user=$(gcloud config get-value core/account)

Environment Setup

To run/test your operator you'll need to set these environment variables (we recommend adding them to your .bashrc):

  1. GOPATH: If you don't have one, simply pick a directory and add export GOPATH=...
  2. $GOPATH/bin on PATH: This is so that tooling installed via go get will work properly.

.bashrc example:

export GOPATH="$HOME/go"
export PATH="${PATH}:${GOPATH}/bin"

Iterating

While iterating on the project, you may need to:

  1. Install/Run Operator

  2. Verify it's working by looking at the logs

  3. Update your (external) dependencies with: ./hack/update-deps.sh.

    Running dep ensure manually, will pull a bunch of scripts deleted here

  4. Update your type definitions with: ./hack/update-codegen.sh.

  5. Add new CRD types

  6. Add and run tests

Install Operator

Note: this needs to be completed! We don't yet have any code or config to deploy, watch this space!

Accessing logs

Note: this needs to be completed! We don't yet have any code or config to deploy, watch this space!

Running Codegen

If the files in pkg/apis are updated we need to run codegen scripts

./hack/update-codegen.sh

Setup development environment on localhost

Here are the steps to setup development environment on your localhost with local registry

Pre-requests

  • either docker or podman runtime
  • kind

setup with docker runtime

export KO_DOCKER_REPO="localhost:5000"

make dev-setup

kubernetes cluster ports used

  • 8443 - cluster api access
  • 80 - ingress http
  • 443 - ingress https

setup with podman runtime

podman is a daemonless container engine. You have to setup a socket service on user space.

$ export KO_DOCKER_REPO="localhost:5000"
$ export CONTAINER_RUNTIME=podman
$ systemctl --user start podman.socket
$ export DOCKER_HOST=unix://$XDG_RUNTIME_DIR/podman/podman.sock

$ make dev-setup

kubernetes cluster ports used

  • 8443 - cluster api access
  • 7080 - ingress http
  • 7443 - ingress https

Running Operator (Development)

Reset (Clean) Cluster

Target: Kubernetes

    make clean

Target Openshift

    make TARGET=openshift clean

Setup

  • Set KO_DOCKER_REPO environment variable (ko#usage)
  • If you want to use local image rather than pushing image to registry you can set flags with KO_FLAGS=--local when you run operator

Run operator

Target: Kubernetes

    make apply

Target Openshift

    make TARGET=openshift apply

Install Tekton components

Operator provides an option to choose which components needs to be installed by specifying profile.

profile is an optional field and supported profile are

  • lite
  • basic
  • all
  1. If profile is lite TektonPipeline will be installed
  2. If profile is basic TektonPipeline and TektonTrigger will be installed
  3. If profile is all then all the Tekton Components installed

To create Tekton Components run

make apply-cr
make CR=config/basic apply-cr

To delete installed Tekton Components run

make clean-cr
make CR=config/basic clean-cr

Running Tests

test docs