Skip to content

Commit f3d440d

Browse files
developer-guydeveloper-guy
committed
bring-gitops-to-your-functions-with-argocd-part-2-the-missing-piece-tekton
Signed-off-by: Batuhan Apaydın <[email protected]>
1 parent 852577b commit f3d440d

7 files changed

+265
-0
lines changed

‎_posts/2021-05-14-bring-gitops-to-your-functions-with-argocd-part-2-the-missing-piece-tekton.md

+264
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,264 @@
1+
---
2+
title: "Learn how to build your OpenFaaS Functions with Tekton"
3+
description: "Learn how to trigger builds of your functions from GitHub using Tekton. Then connect them to Argo CD so that you can deploy as new versions are created."
4+
date: 2021-05-14
5+
image: /images/2021-06-tekton/tekton_argocd_power.png
6+
categories:
7+
- arkade
8+
- kubectl
9+
- argocd
10+
- tekton
11+
- gitops
12+
- openfaas-operator
13+
- helm
14+
author_staff_member: developer-guy
15+
dark_background: true
16+
17+
---
18+
19+
Learn how to trigger builds of your functions from GitHub using Tekton. Then connect them to Argo CD so that you can deploy as new versions are created.
20+
21+
## Introduction
22+
23+
We talked about _How we can bring GitOps principles to management of OpenFaaS functions_ in the previous blog post. If you haven't read it yet, you can follow this [link](https://www.openfaas.com/blog/bring-gitops-to-your-openfaas-functions-with-argocd/), because it might help you to understand the all of the pieces of CI/CD pipeline we want to build here. In this guide, we'll add CI (Continious Integration) part to our pipeline by using _Tekton_. After that, to be able to trigger this pipeline based on _GitHub_ events, we'll use an another component of [Tekton](https://tekton.dev) called [Tekton Trigger](https://tekton.dev/docs/triggers/). We will do this demo using KinD on a kubernetes running locally. Because of we are in a private network, we have to listen events that send by GitHub to trigger our Tekton Pipeline. So we need to find a way to susbcribe those events, and this is where Tekton Triggers comes into the picture. So, we said that everyhing is in local, so, we should open our local services to the internet, GitHub in this case, to be able GitHub send events to our event listener, and this is where Inlets, a Cloud Native Tunnel, comes in to the picture. At the end of this tutorial, we'll have a pipeline like the following:
24+
25+
![tekton_argocd_arch](/images/2021-06-tekton/argo_cd_tekton.jpg)
26+
27+
## Prerequisites
28+
29+
We have to install the following tools to be able to achieve this demo, luckily we have [arkade](https://github.com/alexellis/arkade) which is an open-source Kubernetes marketplace, so we can install of the following tools by using arkade:
30+
31+
* [arkade](https://get-arkade.dev) (v0.7.15) Kubernetes marketplace
32+
33+
```bash
34+
# Run with or without sudo
35+
$ curl -sLS https://dl.get-arkade.dev | sudo sh
36+
```
37+
38+
* KinD (Kubernetes in Docker) v0.10.0
39+
40+
Kubernetes is our recommendation for teams running at scale, but in this demo we will be
41+
using [KinD](https://kind.sigs.k8s.io/docs/user/quick-start/) for the sake of simplicity.
42+
43+
```bash
44+
$ arkade get kind --version=v0.10.0
45+
```
46+
47+
* kubectl v1.21.0
48+
49+
You can control your cluster using [kubectl](https://github.com/kubernetes/kubectl) CLI.
50+
51+
```bash
52+
$ arkade get kubectl --version=v1.21.0
53+
```
54+
55+
* tkn v0.18.0
56+
57+
You can use [tkn](https://github.com/tektoncd/cli) CLI for interacting with Tekton resources.
58+
59+
```bash
60+
$ arkade get tkn --version=v0.18.0
61+
```
62+
63+
* ArgoCD CLI v2.0.0
64+
65+
ArgoCD CLI controls an Argo CD server. More detailed installation instructions can be found via
66+
the [CLI installation documentation](https://argoproj.github.io/argo-cd/cli_installation/). Fortunately, we can
67+
install it via arkade too.
68+
69+
```bash
70+
$ arkade get argocd --version=v2.0.0
71+
```
72+
73+
### Setup
74+
75+
Before getting started to install _Tekton_ and _Tekton Trigger_, we have to install _Argo CD_ and _OpenFaaS Operator_ through the Argo CD, so we can follow the steps below to install them before move on to the next step.
76+
77+
1. Provision a local Kubernetes Cluster with KinD
78+
2. Deploy ArgoCD
79+
3. Deploy OpenFaaS Operator and OpenFaaS functions through ArgoCD
80+
81+
### 4. Deploy Tekton and Tekton Trigger
82+
83+
There are various ways to install _Tekton_ and _Tekton Trigger_ Trigger, one of them is _Tekton Operator_, and the other one is just with plain YAML manifest. We are going to deploy Tekton and Tekton Trigger with plain YAML manifest in this section.
84+
85+
To get more detail about _Tekton Operator_, please refer to this [link](https://github.com/tektoncd/operator).
86+
87+
Let's install _Tekton_.
88+
89+
```bash
90+
$ kubectl apply --filename https://storage.googleapis.com/tekton-releases/pipeline/latest/release.yaml
91+
```
92+
93+
Let's install _Tekton Trigger_.
94+
95+
```bash
96+
$ kubectl apply -f https://storage.googleapis.com/tekton-releases/triggers/latest/release.yaml
97+
```
98+
99+
We need to apply one more thing is _Interceptors_. An Interceptor is a "catch-all" event processor for a specific platform that runs before the TriggerBinding. It allows you to perform payload filtering, verification (using a secret), transformation, define and test trigger conditions, and implement other useful processing.
100+
101+
To get more detail about _Interceptors_, please refer to this [link](https://tekton.dev/docs/triggers/eventlisteners/#interceptors).
102+
103+
```bash
104+
$ kubectl apply -f https://storage.googleapis.com/tekton-releases/triggers/latest/interceptors.yaml
105+
```
106+
107+
Verify if everything is working before moving onto the next step.
108+
109+
```bash
110+
$ kubectl get pods --namespace tekton-pipelines
111+
NAME READY STATUS RESTARTS AGE
112+
tekton-pipelines-controller-5cf4d4867f-s6tqv 1/1 Running 0 5m21s
113+
tekton-pipelines-webhook-57bfb4b4d7-7jp8c 1/1 Running 0 5m20s
114+
tekton-triggers-controller-7cbd49fbb8-d2bgj 1/1 Running 0 4m40s
115+
tekton-triggers-core-interceptors-5d7f674ccc-d4fq7 1/1 Running 0 2m5s
116+
tekton-triggers-webhook-748fb7778c-mpg94 1/1 Running 0 4m40s
117+
```
118+
119+
### 5. Install Tasks, Pipelines and Triggers
120+
121+
Tekton provides as some kind of building blocks as _Custom Resources_ in order to build Cloud Native CI/CD pipelines, and these are the basic ones _Tasks_ and _Pipelines_. Task defines steps that needs to be executed. A Task is effectively a Pod, while each step is a container within that Pod. Pipeline takes the name(s) and order of execution of TaskRun object(s). A Trigger specifies what happens when the EventListener detects an event. A Trigger specifies a TriggerTemplate, a TriggerBinding, and optionally an Interceptor.
122+
123+
To get more detail about them, please refer to this [link](https://tekton.dev/docs/pipelines/) for Tekton Primitives and this [link](https://tekton.dev/docs/triggers/) for Tekton Triggers.
124+
125+
Let's install them but we need to first clone the repository that involves manifest files for them.
126+
127+
```bash
128+
$ git clone https://github.com/developer-guy/manage-your-functions-based-on-cloud-native-ci-cd-using-tekton.git
129+
```
130+
131+
Before installing them we do some kind of initial set up for the pipelines such as granting necessary permissions by creating RBAC, creating ssh-key to be able commit and push to the repository, creating git source as PersistentVolumeClaim, creating a secrets which contains Docker Hub credentials, and ssh-key information etc.
132+
133+
```bash
134+
$ cd manage-your-functions-based-on-cloud-native-ci-cd-using-tekton
135+
$ ssh-keygen -t rsa -b 4096 -C "[email protected]"
136+
# save as tekton / tekton.pub
137+
# add tekton.pub contents to GitHub
138+
139+
$ kubectl apply -f tekton-git-ssh-secret.yaml
140+
141+
$ kubectl apply -f serviceaccount.yaml
142+
$ kubectl create secret docker-registry regcred
143+
--docker-username=$DOCKER_USERNAME \
144+
--docker-password=$DOCKER_PASSWORD \
145+
--docker-email=$DOCKER_EMAIL --docker-server https://index.docker.io/v1/
146+
147+
$ kubectl apply -f git-source-pvc.yaml
148+
```
149+
150+
Next step, deploying Tasks, Pipelines and Triggers
151+
152+
```bash
153+
$ kubectl apply -f tasks/
154+
155+
$ kubectl apply -f pipeline/build-and-deploy-pipeline.yaml
156+
157+
$ kubectl apply -f triggers/
158+
```
159+
160+
Verify if everything is working before moving onto the next step.
161+
162+
```bash
163+
$ kubectl get pods
164+
NAME READY STATUS RESTARTS AGE
165+
el-github-listener-interceptor-7bc945b898-jlst8 1/1 Running 0 68s
166+
hellofunction-7849c4cf8d-zdgm4 0/1 InvalidImageName 0 52m
167+
```
168+
169+
_el-github-listener-interceptor-7bc945b898-jlst8_ this Pod is our _EventListener_, we should open it to the internet to be able to get events from the Github, now we'll do port-forwarding to make it reachable from localhost, then we'll run _inlets-pro_ to make it reachable from the internet.
170+
171+
But before doing that we need create some sort of secret for Github Webhook. Save this secret because we'll use that when we set up Webhook in Github for our repository.
172+
173+
```bash
174+
$ export TEKTON_TUTORIAL_SECRET_TOKEN=${TEKTON_TUTORIAL_SECRET_TOKEN-$(head -c 24 /dev/random | base64)}
175+
$ kubectl create secret generic github-secret --from-literal=secretToken=$TEKTON_TUTORIAL_SECRET_TOKEN
176+
$ echo "TEKTON_TUTORIAL_SECRET_TOKEN: $TEKTON_TUTORIAL_SECRET_TOKEN"
177+
xxxxx
178+
```
179+
180+
Our event Listener needs to receive HTTP messages from X. Therefore create an inlets tunnel so that Y.
181+
182+
```bash
183+
$ kubectl port-forward svc/el-github-listener-interceptor 8080 &
184+
185+
$ inlets-pro http client --token=$TOKEN --url=$WSS --upstream http://127.0.0.1:8080 --license-file $HOME/.inlets/LICENSE --auto-tls=false
186+
2021/05/15 15:07:38 Starting HTTP client. Version 0.8.0-dirty - $TOKEN
187+
2021/05/15 15:07:38 Licensed to: Batuhan Apaydın <[email protected]>, expires: 51 day(s)
188+
2021/05/15 15:07:38 Upstream: => http://127.0.0.1:8080
189+
2021/05/15 15:07:38 Token: "$TOKEN"
190+
INFO[2021/05/15 15:07:38] Connecting to proxy url="wss://$WSS"
191+
```
192+
193+
With your _$WSS_ and the _$TEKTON_TUTORIAL_SECRET_TOKEN_, create webhook from _Webhook_ page under the _Settings_ tab of your repository like the following:
194+
195+
![webhook](/images/2021-06-tekton/setup_webhook.png)
196+
197+
Now everything is ready to trigger the pipeline, once we update our function code, it'll trigger the pipeline.
198+
199+
To see everything what's happening in your cluster is opening UI's for both Argo CD and Tekton.
200+
You can visit _localhost:8443_ in order to connect Argo CD UI's screen but for Tekton, you need to install _Tekton Dashboard_.
201+
202+
### 6. Install Tekton Dashboard
203+
204+
Tekton has another great project called [Tekton Dashboard](https://github.com/tektoncd/dashboard). Tekton Dashboard is a general purpose, web-based UI for Tekton Pipelines and Tekton triggers resources. We can easily install this to our cluster and see what's goin' on our cluster. Run the following command to install Tekton Dashboard and its dependencies:
205+
206+
```bash
207+
$ kubectl apply --filename https://storage.googleapis.com/tekton-releases/dashboard/latest/tekton-dashboard-release.yaml
208+
```
209+
210+
You can simple access to your dashboard with running the following command:
211+
212+
```bash
213+
$ kubectl --namespace tekton-pipelines port-forward svc/tekton-dashboard 9097:9097
214+
Forwarding from 127.0.0.1:9097 -> 9097
215+
Forwarding from [::1]:9097 -> 9097
216+
217+
$ open http://localhost:9097
218+
```
219+
220+
I recommend you to divide screen into two part, one for Argo CD UI and one for Tekton UI to follow the process before making any changes on your repository.
221+
222+
![follow_process](/images/2021-06-tekton/follow_process.png)
223+
224+
### 7. Test
225+
226+
Finally, let's test our function, to do so, we should access the OpenFaaS Gateway component.
227+
228+
```bash
229+
$ kubectl port-forward svc/gateway -n openfaas 8081:8080
230+
Forwarding from 127.0.0.1:8081 -> 8080
231+
Forwarding from [::1]:8081 -> 8080
232+
233+
$ httpie POST http://localhost:8081/function/hellofunction.default message="Hello World"
234+
HTTP/1.1 200 OK
235+
Content-Length: 35
236+
Content-Type: text/plain; charset=utf-8
237+
Date: Fri, 07 May 2021 08:35:44 GMT
238+
X-Call-Id: 0ee19dd7-2c09-4093-9b6e-0755836afb9c
239+
X-Duration-Seconds: 0.004628
240+
X-Start-Time: 1620376544209429100
241+
242+
Body v6: {"message": "Hello World"}
243+
```
244+
245+
Tadaaaa 🎉😋✅
246+
247+
### Join the community
248+
249+
Have you got questions, comments, or suggestions? Join the community on [Slack](https://slack.openfaas.io).
250+
251+
Would you like help to set up your OpenFaaS installation, or someone to call when things don't quite go to
252+
plan? [Our OpenFaaS PRO Subscription plan](https://www.openfaas.com/support/) gives you a say in the project roadmap, a
253+
support contact, and access to Enterprise-grade authentication with OIDC.
254+
255+
### Acknowledgements
256+
257+
* [Alex Ellis](https://twitter.com/alexellisuk) for guidance, editing and providing the diagrams.
258+
259+
### References
260+
261+
* [Argo CD - Declarative GitOps CD for Kubernetes](https://argoproj.github.io/argo-cd/getting_started)
262+
* [Getting Started with the OpenFaaS Kubernetes Operator](https://dzone.com/articles/getting-started-with-the-openfaas-kubernetes-opera)
263+
* [Cloud Native CI/CD with Tekton - Laying The Foundation](https://martinheinz.dev/blog/45)
264+
* [Exploring Tekton's cloud native CI/CD primitives](https://www.jetstack.io/blog/exploring-tekton/)

‎_staff_members/developer-guy.md

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ name: Batuhan Apaydın
33
position: Guest
44
image_path: /images/author/developer-guy.png
55
linkedin_username: bthnapydin
6+
twitter_username: developerguyba
67
github_username: developer-guy
78
blurb: Life-long learner. Software engineer at <a href="https://www.trendyol.com">@Trendyol</a>
89
---

‎images/2021-06-tekton/argo_cd_tekton.jpg

44.5 KB
Loading

‎images/2021-06-tekton/follow_process.png

502 KB
Loading

‎images/2021-06-tekton/setup_webhook.png

178 KB
Loading

‎images/2021-06-tekton/synced_resources_tekton_argocd.png

192 KB
Loading

‎images/2021-06-tekton/tekton_argocd_power.png

108 KB
Loading

0 commit comments

Comments
 (0)