Skip to content

A bash wrapper around tekton cli (tkn) to easily launch PipelineRuns

Notifications You must be signed in to change notification settings

bluengo/tkn-wrapper

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

27 Commits
 
 
 
 

Repository files navigation

Tekton CLI Wrapper

An opinionated wrapper to deploy OCP clusters by using OpenShift Pipelines throught tkn cli.


1. How to use it

The steps are simple:

  1. First make sure that you are authenticated throught command line (by using oc login or getting the proper kubeconfig file) to the bootstrap cluster1 to have access to the pipelines
  2. Set the needed variables by exporting them or by placing them in front of the make command. Then, run your desired target. For instance:
export OCP_VER="stable-4.8"
export NAME="my-ocp-cluster"
make deploy-ocp-regular-aws

...or...

OCP_VER="stable-4.8" NAME="my-ocp-cluster" make deploy-ocp-regular-aws

1(The bootstrap cluster is a OpenShift/Kubernetes cluster with the plumbing-gitops manifests for pipelines already applied).


2. Targets

This table shows the different targets within the Makefile that you can call:

Target Description Requires
make help Prints help. OCP_VER
make deploy-ocp-regular-psi Deploys a regular cluster in PSI (OpenStack infrastructure). OCP_VER
make deploy-ocp-regular-aws Deploys a regular cluster in AWS (EC2 infrastructure). OCP_VER
make deploy-ocp-proxy Deploys a proxy cluster in AWS (EC2 infrastructure). OCP_VER
make deploy-ocp-disconnected Deploys a disconnected (air-gapped) cluster in AWS (EC2 infrastructure). OCP_VER
make destroy-cluster Destroys an existent cluster. NAME

3. Variables:

Below you will find the variables reference

Variable Description
OCP_VER OpenShift Version. Take a look into section 4. OCP Versions to see accepted values.
NAME Name for the OpenShift cluster. If not needed for the target, it will be auto-generated.
BOOTSTRAP_CLUSTER Specifies the OCP cluster name where the plumbing-gitops tekton pipelines are installed.
Default: api-ocp-c1-prod-psi-redhat-com

4. OCP Versions:

You can choose one of the versions available on following links:

Take a look at the Release Status webpage

Examples:

Value Description
stable Latest stable release
stable-4.8 Latest stable 4.8 release
fast-4.9 Latest fast 4.9 release (supported, guaranteed to have an upgrade path in the future)
4.10.5 Specific stable release or release candidate

Issues

As far as PSI is very unstable, the target make deploy-ocp-regular-psi will fail very likely. This is an example of the output that you will find:

$ NAME="my-ocp46" OCP_VER="4.6" deploy-ocp-regular-psi
(...)
[provision-cluster : install-cluster] Creating secret with name cluster-my-ocp46
[provision-cluster : install-cluster] secret/cluster-my-ocp46 created
[provision-cluster : install-cluster] File has been uploaded to clusters/my-ocp46/installer-artifacts.zip 🚀File has been uploaded to clusters/my-ocp46/envvars 🚀

failed to get logs for task provision-cluster : container step-install-cluster has failed  : [{"key":"mirror-registry","value":"quay.io","type":"TaskRunResult"},{"key":"StartedAt","value":"2022-03-18T08:40:45.026Z","type":"InternalTektonResult"}]

In such case, you will need to destroy the cluster before retrying.

$ NAME="my-ocp46" make destroy-cluster

About

A bash wrapper around tekton cli (tkn) to easily launch PipelineRuns

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •