Kong Kong Tutorials, 5 May 2021

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: Konnect decK: Automating Your Developer Pipeline

Description

How can you leverage the automation capabilities of Konnect to achieve APIOps for connectivity? Start a Free Trial of Konnect: https://bit.ly/3A9njxz

In this tutorial, you'll learn how to:
• Set up an end-to-end automation framework in Kong Konnect.
• Leverage decK to update your API configurations.
• Tie decK into a CI/CD framework for automating updates in the same way you update and deliver code.
• Deploy services with a few simple commands using the tools you already use today.
• Apply policy and govern your services in the same way.

Follow along in the blog tutorial: https://bit.ly/3yPEsMa

Contact us if you have any questions as you’re getting set up: https://support.konghq.com/support/s/

Once you’ve successfully set up APIOps with Konnect decK, you may find these other tutorials helpful:
• Implementing Client Credentials With Kong and Okta: https://bit.ly/3eJd62p
• 3 Ways Kong Helps With API Gateway Governance: https://bit.ly/3ujZDCY
• Getting Started with Kong Mesh and Open Policy Agent: https://bit.ly/3o8Cq4U

#CICD #DevOps #GitOps #Konnect #deck #API

A

Hi there,, my name is ross mcdonald., I'm a solutions engineer here at kong.

A

Today, we'll be doing a quick demonstration of how you can approach apiops with an end-to-end automation, framework.

A

During this demo, we'll show how you can leverage kong's declarative configuration tool (deck) to update your api configurations, smooth and automation, friendly way.

A

From there, we'll show how you can tie deck into a ci/cd framework for automating updates. In the same way, you update and deliver code.

A

The goal here is not only just to show how easy it is, automate these updates,, but also that you can consistently and fearlessly deploy services with a few simple commands using.

A

The tools you already use, today.

A

with the automation out of the way,, we'll then show how you can apply policy and govern your services in the exact same way..

A

With that,, let's get started.

A

Now, before we jump in the cli,, I wanted to do a very brief introduction to deck.

A

Deck is kong's, declarative configuration too.

A

And this is what allows you to capture the state of your configuration in yaml. Format, allows you to detect any changes between your local configuration and the one running and.

A

Konnect, and then lastly, it allows you to synchronize your configuration with the konnect version.

A

As you can see here on the diagram,, we have four discrete steps.

A

First is to capture the snapshot of our konnect configuration.

A

We're going to then update that state file that gets persisted with the changes we want to make.

A

That could be creating a new service, updating, a plugin configuration, or anything that lives within the konnect interface.

A

We can then run a deck diff command to compare what we have locally versus, what's inside, of konnect, to ensure that the configurations have not drifted in an.

A

Unexpected way., then lastly,, assuming we didn't, identify anything problematic, we'll synchronize those changes back into the control plane,, which will then.

A

Push those changes to the data planes,, which are the api gateways running the actual traffic.

A

So the goal is to take these simple building: blocks: capture, update,, compare and synchronize, and tie them into our automation, pipeline.

A

Which you can then include into your existing source, control and automation, tooling, to tie even further into existing change management and governance processes that you already.

A

Have in place. so for a quick example of how we can tie these basic pieces together.

A

Let's say we want to update a configuration for one of our plugins.

A

I'm going to go over here to konnect.

A

Look at one of my payment services, here.

A

Here is the service definition for this version..

A

You can see we have a number of plugins enabled.

A

Let's say we wanted to disable one of the plugins.

A

So for that,, I'm going to open up a visual studio, code.

A

From here, I can run a deck konnect dump command.

A

This is going to capture the state of the configuration as it lives inside of konnect and put it right into a local yaml file.

A

If I open up this yaml file,, we can see the state that we have persisted inside of the konnect control plane.

A

So here are the services that I have to find..

A

I've got a number of versions for the payment service.

A

As well as a number of plugins.

A

and as an example,, let's say I want to disable the bot detection, plugin.

A

So under enabled I'll simply set that to false.

A

Save the file. jumping back to our diagram,. I've just performed an update.

A

Now,, let's compare those changes with what's currently living konnect, to make sure that the things we want to have updated are actually going to be updated.

A

For that, I can run a diff command.

A

Here you can see that we've detected one change.

A

Enabled true was set previously.. Now it's enabled false.. We have one artifact, that's being updated.

A

that looks good.. Let's save it.

A

To synchronize our changes,, which is the last step, here, we're going to run a deck konnect sync command.

A

All right,, the change has been persisted.

A

Now,, if I refresh the screen in the konnect interface and go down to my plugins, you'll, see the pod detection. Plugin is now disabled.

A

So just as we've shown, we've captured the state as it lives inside of konnect.

A

We've performed an update., we ran a comparison.

A

And then we synchronize the changes.

A

For a more concrete example of what this might look like,, I have a github repository configured with github's action, ci/cd functionality that we can use for pushing a policy.

A

Update to konnect. so imagine I'm a stakeholder for the payments api service, currently deployed.

A

After speaking, with our operations team,, it turns out the backend service is struggling to keep up with the current request. Load.

A

So they've asked that we lower the rate limit to ensure stability of the backend service .

A

Easy enough. for that,, I'm going to start by opening up visual studio, code.

A

Here we can see the state file as it was pulled from konnect.

A

I found my payment service. and here's my rate limit plugin..

A

If I expand this,, I can see the configuration.

A

you'll note that it's currently set to five per second.

A

Let's say we wanted to lower this to two per second.

A

First, I'll update the state file.

A

As you can, see, we've just made a change from five to two.

A

As part of the repository settings,, I can't push to the deploy branch specifically, so we'll have to create a pull request.

A

So I'll say chore/reduce-rate-limit.

A

Going to add my changes.

A

Commit them. and then pushing them to github.

A

With my changes pushed,, I can then open a pull request.

A

But before I do that,, I wanted to take a quick look at the github workflow that we have to find.

A

So you can see here, we're using a self-hosted runner,, which I have running here in the background,. Just for example, purposes.

A

And all we're actually doing is running a deck, konnect sync.

A

So very easy and straightforward pipeline for updating the changes.

A

You can also include drift detection inside of the pipeline here to ensure that no changes have been made out of band?.

A

But, for example, here today, we're just going to apply the change via pull request.

A

Here's my branch. going to change this to deploy branch.

A

And here is my change.

A

Create the pull request.

A

in this case,, I could have enforced reviewers as well as different checks to ensure that this was being done. Properly.

A

However,, since that's just me in this repository, I'll go ahead and merge.

A

If I jump back to my runner here in the background.

A

As it receives the notification for the deploy,, it's going to automatically run the series of steps.

A

In this case, just applying that deck configuration.

A

So if I jump over here to the konnect interface.

A

Look at my rate limiting plugin,, I can see. The rate limit has now been reduced to two per second,, just like I'd asked.

A

If I go back to my service, version, you'll start to see already that the change has been taking effect.

A

And now clients are starting to see 429 errors being returned.

A

So what have we done? well,? We've shown how you can leverage the deck cli tool to declaratively capture,, compare and apply updates to your konnect configuration.

A

Which then gets persisted to the run times..

A

We then showed how you can tie that back into your ci/cd framework for performing end-toend updates, while keeping your configuration within a source code repository.

A

This allows you to leverage your existing change, control processes already in place and deliver policy updates and other configuration changes,. Just like you deliver code.

A

This, in turn, improves governance, consistency and stability for your teams without any of the hassle.

A

Thank you so much for watching this quick time of kong, konnect.

A

for more information, go to konghq.com.

A

Until next time.