Kong Kong Builders Livestream Recordings, 31 Aug 2022

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: Kong Builders - August 31 | Hackathon Edition - Getting started contributing to Kong OSS

Description

All next month, we will be featuring the Kong Summit Hackathon with a live stream every Wednesday to help you get started with contributing to Kong! In this kick-off stream, Viktor Gamov will show you how to submit to the Hackathon, and talk about Plugin development in Kong open-source products.

Kong Builders is a Livestream series that takes our developer-focused toolsets and puts them on display in the best venue possible – building applications and connecting workloads.

#KongHack22 #Hackathon #OSS #opensource #KongBuilders #developer #devops

=== chapters

00:00 - stream starts
01:55 - introducing Kong Summit Hackathon
10:00 - Let's build Kong Plugin in Go
15:40 - Roll the sleeves and open terminal
19:42 - Defining config schema for your plugin
24:30 - Building a plugin binary (platform dependent)
28:20 - testing plugins with Kong using docker-compose
36:30 - It works!
38:12 - Adding plugin logic. Into to plugin phases
46:08 - testing plugin in insomnia
48:46 - outro

A

Well well, well, we meet again hello and welcome to kong builders.

A

My name is victor gamov and before I just jump right in immediately immediately write down in the comments, if you can hear me well, if you can see me well and write down in the comments uh where are we coming from, I will check because I'm using some of the new new hardware, so we um I'm constantly improving my setup and what could go wrong with a new setup with new things that you know you play around um and just you know, let's go with live stream and see how how this will work.

A

So that's why I need a little bit more um of your attention so make some uh make some noise make some noise in the comments. um Meanwhile, meanwhile, it's uh I'm excited. I'm super excited today. I'm super excited because uh this is gonna be. um This is gonna, be a month of linux on desktop I'm just kidding, it's gonna be month of uh live streams and hackathons.

A

And uh um and we're gonna be doing a lot of cool things. Okay, so I got some some confirmation. Oh cool uh benny is coming from the germany, and that looks good. um We have a my colleague from from twitch, yes, cat checking from twitch and uh elaine from denver. Denver colorado also sees as well fantastic all works. um I I really. I really love when everything works anyway. So what I was trying to say, um yeah, I'm super excited super excited super pumped, even though I didn't even add my you know.

A

First glass of in energy drink um also write down in the comments. What you're drinking I usually drink, water or coffee or energy drinks, some of the energy drinks without sugar um anyway, so yeah excited so live streams, we're getting back and we're getting back like very regular cadence.

A

So in uh next month, every wednesday same time uh we're gonna be going live and we're gonna be talking about very exciting uh thing for me and very cool thing uh that I hope you also will be excited to learn about, and this is where I'm gonna go with my share screen and, as you may know, it's also september end of september. We're gonna be celebrating um fifth annual user conference cong summit. I'm excited um and this this new thing potentially have this like audio effects.

A

I don't want to use them today, but next time like next uh next wednesday we're going to be meeting, I promise you, you will see all the power of the thing, so it will be super excited so kung summit now and the consummate. It is exciting event. um I will be speaking there. My colleagues will be speaking there. Some of our community members will be speaking there. uh Cong champions will be speaking there.

A

We will have a panel uh about uh women in api, so it's gonna be pretty cool event, and I'm I'm super excited about this now, but I'm also excited to to announce some of the things that I already did on youtube. If you follow our youtube channel, which you should uh our youtube channel, is the youtube.com conch inc and you can subscribe and enable those notifications. So hopefully you will. You will- um and I did some announcement about things that we're going to be.

A

Do uh we're going to be doing during the clunk summit or before consignment. So hackathons um idea of the hackathons.

A

Like it to you or you, don't like those I like hackathons hackathons, allow me to personally allow me to focus on certain things, because usually hackathons are time boxed, and there is a time where we start working on something we're very, very much focusing on this something and after that, we need to present our results.

A

Basically, that's what I do every um ever it's going to be doing. I also will do in hackathon, like with you, I'm not going to be submitting my things, but I will be there with you and my colleagues uh with devrel team and developer marketing team will be with you all this time, uh helping you with the hackathon. So what's a hackathon? What's the format, that's gonna be very simple. um Since we still in the post pandemic situation, not many people feel comfortable to travel. Not many people uh feel um you know.

B

A

Comfortable to be around the people, we think okay, so this time, hopefully for the last time we're doing this uh a virtual hackathon, so you can work from wherever you are um and you will be um working on on your own time. Just you know find the time where you're, comfortable and working, um but it is also time boxed september 27. It's going to be uh end date and september 1st tomorrow tomorrow.

A

So if you go, um if you go to the uh to this webpage, you can leave your your email today and uh we will notify you when the the the official submission page will be ready, so you will be able to submit and what you can do from september. um First, until september 27 you build stuff, you can build something um that you didn't have time otherwise to build.

A

um You can learn something you can. You can um learn. Some of the you were. I personally was super excited about hacking because it's opportunity for me to learn some stuff as well. It's opportunity for me to learn some of the um the kong stuff and also I will be presenting the selfies to you.

A

So that's why, every week, starting from today, until next week, wednesday and wednesday after invest after we will have a four coin builder streams, where you can bring your ideas, you can bring your questions, you can bring, you know whatever you want and we can. I will try to show you something and even uh even better, maybe I will be able to bring some engineers who are working on some stuff and they will be um we're going to be looking deeper into some of these some of the things.

A

So um let me see what our um comments are happening, so the.

A

And important thing yeah: this is the important thing we are everyone who will submit their uh their work and this work will be approved. So it will be something significant. It cannot be just I don't know. I did the the pr to documentation, even though pr documentation is a fantastic way, how you can start contributing things uh or like. I fix the typo, um but we really want you to get one of those cool t-shirts uh to commemorate so you'll.

A

Remember this hecaton or somehow now uh for those of you who are really serious about this stuff um and they can win some prizes, so we're gonna be for doing four prizes in the we're not doing categories this year, because um we don't want to limit ourselves and we don't want to limit your imagination.

A

So the um but we're going to be picking up like four top top uh contributors and uh the top overall contributor will will be able to get the the trophy trophy in 500 card and if some of the things that you will be able to submit until september 20th and some of those things would be really cool and approved. And you you have ability to travel, you will be able to come to to hang out with us in san francisco. So I think it's pretty cool.

A

I think I think it's pretty awesome, so you just start doing some stuff and.

A

And build build some of the some of the some of the things with the uh with the kong.

A

um Now, what we're going to be doing is the uh before that it's called being called builders, we're building some stuff um and the we're going to be building something today. So I was thinking what we can build. uh One of the examples that I want to show you how you can start or how you can get your hands dirty is: let's, let's build the plugin, let's build the plugin for for clone, so I was I was thinking.

A

I was having this idea to bring in some of the so the engineers to talk about different flavors of the uh from the apis, um and if I go to this one like a plug-in development, a reference and we gonna be talking about plugins developed in other languages. Now I really want to learn a language called lua. That is a standard language of writing plugins for for quank, and I will use this opportunity to learn, lua and learn uh lua pdka.

A

um However, I already more or less familiar with other languages. Like I familiar with java, I familiar more on um jvm languages. However, a goal language also looks uh like a cool thing to learn, so I will try to I'll show you um how we can build your first uh plugin with go, how we can test this and how you can enable this one. So that's where we're gonna spend some time today, so before all these announcements and all this adjust. So let me answer some of the questions.

A

um So this is some questions about the pricing dear bro, bro nifty. So the questions about the pricing is better to ask the people who are trained to to answer those questions. I feel dirty talking about money, so I cannot help answering these questions. Unfortunately, unfortunately, however, you can write email to sales concom and ask all your questions, and you know you will get uh all responses that you want um cool cool.

A

Let me see if I will be able to uh it's a good opportunity for me to fix this uh fix this ui, so that all the questions will will appear here. um So in this in the stream. I will not be able to answer the questions about pricing about licensing and all this stuff. I will be able to get you. I don't know trial if you would be interested for building something and you think you need to enterprise license.

A

Please let me know my dm and twitter is open. My twitter where's, my twitter, um do I have this. Can we uh can we show this.

B

A

So my twitter is down below you can press the post and you can find my twitter and don't forget to where's this where's, this nice button, don't forget to subscribe, subscribe all right. So now, let's get uh let's get uh let's get to work, so let's get to work and um we're going to starting with the pdk. So what is the plug? So essentially, um um there are some things that clone can do. There are some things that colin cannot do or some things that clunk potentially can do.

A

This is the where kwon cannot do in a it's in somewhere in the in order of um impossible things, so you need to go and hacking around, um but there are some things that kwon cannot do for the reason that no one thought that would be good idea or no one thought that would be something that many people will use or for that matter.

A

If we're talking about some enterprise stuff, some people will be able to even pay, um and this is where your use case come can come into play and with your use case, you will be able to um to build something that is, um that is, makes sense.

A

We can build, I will show you just the idea where we can start and after that you can go from this, so how we can start. This is very I'm not saying this is very simple and I'm not saying this is like very straightforward, but even programmer I'm I am average, I'm not 10x, I'm maybe 5x, maybe 6x, uh I'm not 10x. Definitely, but I I was able to figure out this thing um in in couple hours.

A

Looking for for examples and also for me, it also opportunity to improve documentation and stuff that I learned during this process with you. You will be building stuff, I will be building stuff and I will be improving uh documentation. That's going to be my uh contribution um back to back to call now so we're gonna start a this uh go, go plugin, so we're gonna be using this um go pdk.

A

It is a um github project. You can go there and just you know, get the things, and this is our module that we will get started. So if I will go to my to my terminal and I'll just do lcd builders.

A

Go plugin all right.

A

There's nothing there I'll just do go, get.

A

uh Okay, so we're gonna do this something start like.

A

Like go needs how we can start the go project. So again, not the uh not the, not the go, not the go expert. um We can start with uh something to initialize project.

A

uh Go mod, okay, quan go plugin. Let's do this one and it's created for us module and after that I can do go. Go.

A

uh And now in pdk, okay, perfect, so start intellij.

A

Yes, trust projects here, trust project.

A

um I will bring the idea from uh from from another winner in a second, so uh people, um let's, let's do something with this. So what we're gonna be, uh what we are gonna be building: okay,.

B

A

We need to do like pump up the phones a little bit, so you will see this uh very clear, so we're gonna be size. 22 sounds about right, something cool all right. Now um we need to have uh two things: where's where's documentation. So we have this pdk uh and we're going to develop and go plugins.

A

So the previously before quang 2.3, as far as I remember, um go, plugin was running, is in a separate um as a separate process with a plugin server and the go server will be interacting with gokor using the.

A

Unix sockets or whatnot, so this significantly changed so make sure every time you look into pdk for for current version, uh make sure that you're using the latest version, because if you will google something- and you will find some of the um some of the references to this pdk, you might find, for example, some other people build. You might find the old version that is is deprecated as of 2.8 we're going to be current version 2.8 and will be removed in the version 3.0, which is going to be.

A

Don't tell anyone that I told you, but there's a high chance that it's going to be big announcement during consummate. So don't tell anyone anyway. So, yes, we're going to start with the development, define a structure that hold configuration, create new function, to create instance of the structure, uh add methods to handle phases uh and include, go pdk server to sub library and add main function. So, let's start with um with something: um let's do this now to do file go plug dot, go not going to be super, I'm not going to be super.

A

Inventive and super creative with this configuration, um as far as I remember I was reading this, the it should be in the package package main so let's go and create this.

A

um Now type type config config and it is going to be our struct and um we're not gonna. I'm not gonna go like very crazy here with these configurations, because, for example, here you can even include some some json stuff um for your configuration for for your schemas. I'm gonna do something like.

A

So everyone doing um simple plugin that either will modify, request and response we're going to modify response. We will add some some headers there and some of the things that I was I was thinking to do, uh but we're going to be returning to this one like, but maybe next time we will do something something interesting, um but for this one let's say it's going to be.

A

And type of boolean- so I just want to say in configuration if attach attach header would be there. So, every time uh when the request comes in, we will check the configuration. If we're going to say yeah, we can attach something to this to this plugin, then we will be able to.

A

We will be able to execute logic now what it says. We have a structure we define now we need to define a new constructor to to to to um to get this configuration. So in this case I'll just do function, it's called new and it's gonna be interface.

A

um It's gonna be return to pointer to configuration.

A

That's that's that we get this done now. We need to define main function so when this will be executed, it will be running this built-in server so function main.

A

uh Function main that will include what they say: server start server, server server start server, we're gonna, do our call our new and version a string and priority string. So we can have the two constants here.

A

So what I can do, what it says.

B

A

No, let's do this something like can we do this, create the variable create variable, create constant uh and uh it's gonna be version 0.1.

A

0.01, it's good enough to to ship this into production.

A

And type inference is gonna, be.

A

A

A

So we can define the priority when the plugin will be executed, with new upcoming version of conc, we'll be able to dynamically. This change and, let's say priority one by default,.

A

Okay, so uh that's that's pretty much it! That's your uh that's your plugin! um Let's see if we can.

A

Just uh it's called make file to build to build this. What we can do, I have a.

A

I have a command, it's called.

A

A

So we're going to building this guy and output to the beam directory. So when I do this, let's see.

A

Default and build.

A

A

Build plugin, something like this and I'll just do make okay. So what doesn't uh so? uh Go? Some entry module back? Okay. So what is imported server at github server?

A

um I thought this would be created automatically. Okay, some do we have a sum. Yes, we have this and we have this.

A

uh Quan pdk server missing some entry for module, but go get.

A

Pdk server, let's see.

A

Here we go now the here's the interesting thing, so the we build this, um let's, let's build infrastructure first and after that, we'll talk about the what is going on here. So um here's the interesting thing. I'm running this on my um my computer, which is um apple, silicon and one not to brag, but uh most likely. This binary needs to be executed in an environment which would be not the same environment as as as mine plus. When I do this build this build. As a matter of fact, let me show you something.

A

So if I go to bin- uh and I will just do- go plug um and just do, dump I'll just do gq.

A

So what it does- um and even let me do this without anything, so I'll just do mine as hell. So since we, uh since we inherited this server, plug-in server information, uh there's a bunch of things that you already have out of the box here, and this is convention, because this command will be executed by quank in order to com, to communicate to this plugin, and when I run this dump command, it will be basically printing.

A

The schema of configuration of my um of my system, so this is how kwon would know about structure of configuration how to configure this one, and they will be talking through this. You know the socket unique, socket communication, so the conch will be sending the commands to this guy.

A

um That's that's basically, but this particular binary was built for mac os because I run this go build it's a native image in the the native file. um Now the glow allows me to build this for the platforms. That is not, uh for example, I can build on mac but build this for for linux. So with this I can do something like go os, so in this case the binary will be will be produced for linux. So if I run this where's my make oops.

A

A

So I won't be able, if I run this being go plug. I won't be able to execute this because now this binary in the linux format. This is what I need in order to run this plugin.

A

I'm not gonna run this in my computer, with with my clone, because I like docker, and I prefer run all these workloads inside the docker in future- maybe even integrate with tools, some test, containers or whatnot, um and if I would say so, the way how it would work.

A

I built a plugin. This binary will be attached as a configuration that um that will, I will attach to whatever image of conrad will be using, and um I will specify the plug-in path and extending the this this plug-in path for cloning. In order to execute this configuration. So for this I already have prepared one of the things that make things a little bit easier for us and I will explain what we're going to be doing here.

B

A

Start with docker compose yaml.

A

And with this docker compose, we will have a couple things.

A

So uh it will include service that will include quank, I'm using um the version of open source clonk, because my plugin will be working with open source enterprise. I'll show you how we can use this with enterprise as well. uh Also I'm using the the open source version, because open source version has uh arm build and it's faster than executing quan in virtualization in my mac. It's my personal. You know my personal hell in in the world of um dealing with this type of jazz, but hey you.

B

A

Got to learn uh some of the things hard way now uh we're going to be using containercon now database off we're not going to be using any database here, it's going to be dbls mode. So that's why we need to specify a declarative configuration.

A

So in order my plugin to work, I will have this declarative configuration cone and just a file just config.

A

By convention, let's call it clone gamo, so what it will have, it will have a service that points to more bin, and um this smoke bean will be serving requests, and I also will have my plugin here. This is the name of my plugin, very, very creative, a name of the plugin, and this is where I configuring this. This is where I'm putting this is my my configuration uh remember the thing that we configured here um and for now. Let's just do.

A

um Yeah, that's it um the the infrastructure, so we're gonna be doing a clone config. Now this is the standard things that I want to make sure that the the I will have an output of this uh we'll have an admin. Interface, listen um debug level.

A

Now this is important, so this is where we can look into documentation why it is important. So.

A

um When we're configuring this plug-in, so we need to put this into configuration and give you through environment variables so through the quant configuration so for each plugin. We need to provide those small things, so we're gonna be saying the name of the plugin.

A

um I can use bundle plugins, but I I'm not. I don't need those and I'm not including those, so they will not be started so plugins are gonna, be go plug, so this is going to be my plugin and I need to replace this go with go plug and two important things here is the command to start, which is going to be executing this binary and creating this uh tcp server connection, and there is a query command that say this: this dash dump it will throw the configuration.

A

So the coin knows how to um apply configuration of the plugin that I'm requesting in a config and how to uh interact this with the plugin and they will be talking to each other through this through this socket.

A

Now the that's. What we did the quote start blah blah blah we're exposing things, and we are um adding two things here. One thing is that we, actually I couldn't, let's do this one. We can still have a config and my clone.yaml will change cone, camo so and also I'll. Take the contents of this folder and attach this to userly folder called go plugins where I will be using this go plugins and all this type of things. Okay,.

A

So, let's see if this work again, um I'm running another thing that I probably need to do. um Probably it's okay.

A

And probably this will work if I just do go arch architecture and say it's going to be arm.

A

Arm 64., so let me show you where's the my so this command that I have in my history that will post the images that have an arm64 architecture. So in this particular case, this quang has a arm architecture image. Since I'm not specifying anything specific here in in here it by default, it will be using the arm image uh from uh from con.

A

I think it's going to be uh good enough for for for now. Okay, so, let's see- uh if I will just do build this again so now it will build this with the arm64 architecture. When the images are will start, they will be running on my arm instances.

A

um If you're running this in x86 instances, you will be able to build this for something I don't know.

A

A

64., oh actually, you can. You will be able to see what you can do go to the distribution list. So basically uh that's the list. All of the platforms that you will be able to build your binaries, which is actually pretty cool. I can build windows binaries on my computer here in in in mac os.

A

I think it's pretty uh it's pretty dope.

B

A

The where we are so we build this with arm 64.. Let's do it one more time, just make sure that.

A

Now the deutscher camp was up and let's see how this will work.

A

Let's see uh to do to do starting uh go plug, so this is. This is where this is, where corn talking to this plugin starting and the listening for the socket, so it means that um we have a. We have a lift off. We have a lift off uh our infrastructure, for the plugin is ready. Calling is running. This plugin is running. Let's see, um where is it? Let me see if I will be able to to show you something.

A

There should be something yes, so at least old, uh no, no where's, the plugins they get.

A

To do I forgot where's, the where's the can I do.

A

Plugins admin base, url 8088, um let's see, if we can ah it's not the post, I want to get.

A

um I run this get requests and uh looks like my plugin is successfully attached. um That's the name of the plugin, so it works.

A

So next next thing is that we're going to be doing is adding some some logic here. So let's take a look. What the communication says in terms of the things that we were talking.

A

Start server blah blah blah now the add methods on the structure to handle phases, so quan requests um have phases and we can attach to two different uh different phases where we can find this information phases implement custom logic. Air follows an expected function. Signature will be the same as all of them certificate rewrite access response, pre-read log. So when we we in majority.

A

Stuff that we will dealing with the it's going to be access when we kind of like touching a upstream um upstream service uh with this.

A

uh With this, so what I will be doing is we need to create new function.

A

Function that we will pass a config.

A

And name is gonna, be access because we're dealing with access phase and uh we're gonna be passing here pointer to pdk, uh we'll call it.

A

A

And it's going to be 0.0.

B

A

Let's see if we will be able to.

A

uh Get a request get a header before we're doing this, let's see if we, if we can do anything um hello world as as always.

A

uh No, we actually can do that. So let's do uh user agent uh user agent um and we're gonna do user agent. So there.

A

Because it's a string.

A

Now we're going to be using.

A

Got's request from string- and we say it's going to be user agent and error. Well, I mean yolo.

A

Cool, so that we should do okay, now, the let's stop. It.

A

Stopping clone.

A

A

Build the plugin and restart the clonk.

A

Now, let's see where's the insomnia, if we can get anything interesting here now the configuration is here. We saw this.

A

A

We didn't uh we didn't do anything, however, we already sitting here and attach a touch face and remember our configuration says that for the service that we have as a matter of fact, let's see get services.

A

Where's these services.

A

A

I I don't, I don't, have it nah, this can be anyway. So let's see list of all available, endpoints plugins and do I have it mine.

A

My endpoint should be should be something like okay, let's, let's close it.

A

A new http request: let's do this.

A

Proxy based url, so if I will call the proxy base url, so what it will do, it will send requests to mock bin um and all sorts of stuff. We're gonna happen here, um but what we are interested here. We are interested in the got request from insomnia, so insomnia created this user agent and now we're getting response from our go plugin so from the our plugin. So plugin works, so it attaches to the the um to to to our service and looks like it works now.

A

If I would do something like, for example, header, let's do.

A

Modify and just call it conc builders.

A

And today is going to be what uh 8, 31 2022 uh and we'll send the request in our log file. That's gonna be yep. That's our calling builders user agent! Okay! Now and let's do this next thing.

B

A

A

If we have a configuration, says oops, if c config.

A

A

My keyboard is, is not he's not communicating with me correctly today.

B

A

Contains a user agent.

B

A

A

If so, if we're sending this request from someone that contains calling builders we're going to do something like um response um set header and let's call it.

A

X, builders and we'll put this- I don't know.

A

So yeah the the calling time it's going to be attaining your uh has a has a jungle jungle, um jungle theme uh to to to see this jungle and and uh where innovation runs wild, so jungle, and so in this case, welcome to the jungle and, let's see if we will be able to do.

A

Palm if we will be able to also include a emoji now so the so in this case, if user agent will have a calling builders and we will attach clone builders, um we will attach clone builders header here, let's see if this works.

A

Okay, so my the this thing is ready for test. I just send.

A

Let's see got requests, let's see if we have headers.

A

And I think this is winning. This is winning. um If you, if you, if you agree, write down in the comments, this is winning. um We just built your go plugin and it does something it modifies. Your request and rest is, is basically history, not the history, it's uh it's. It's all about your imagination. So now next thing is just you just go and crush on it and building something and after that share with us, um the we will be posting all these links and some of the cool documentation bits.

A

I would definitely post the source code of this into.

A

There is a portal portal, there is a github repo called demo scene and there is a special folder called calling builders. This is where you can find all the demos and there will be something like 0, 8, 31 2022. You will find the source code of this plugin again check this out our youtube channel. um I I will be interviewing more and more speakers of congx summit uh they'll come in there do not forget the check the website to today.

A

Just go there and just put this: let's do up and I'll just get updates. So the you should do the same. You should do the same. I get updates. You will get the link to the submission form. You start hacking, you start building your stuff and I just cannot wait to see what you guys will build important note once again, I'm asking for your support.

A

Once again, I'm asking first go here enable notifications. Next stream is gonna happen next wednesday mark your calendar, bring your ideas, bring your questions um we go. Next uh is gonna be september or something the we're gonna be talking about some some automations, probably cat will be here and talking about service, mesh and github's.

A

um I will be talking about some some creative stuff as well. Go learn about this learn, uh start building and I'm I'm super excited for kong summit. I'm super excited to see everyone in in san francisco, and so you know the drill with this. My name is victor gamoph and, as always, have a nice day. I will see you in a in the next week in the next one in the calling builders take care.