Kong APISecOps ROSA and Kong Konnect in the Red Hat Openshift, 31 Jan 2023

Previous Meeting

⏯

youtube image

►

From YouTube: Part 7/8 - Publish: 8-Part APISecOps Tutorial ROSA and Kong Konnect in the Red Hat Openshift

Description

APISecOps - Insomnia, Kong Konnect, Tekton - on ROSA

Part 7 of 8 Kong Partner Engineering's APISecOps Tutorial ROSA and Kong Konnect in the Red Hat Openshift Ecosystem: Publish API to Konnect-Dev Gateway Environment

In part 7 we execute the final pipeline and finish step 4 of our devops procedures.

Follow along in GitHub: https://github.com/Kong/kong-apisecops-redhat#introduction

4. Publish API to Konnect-Dev Gateway Environment
Publish API to Dev Gateway Env

This pipeline is for the Operations Personas

The development team has deployed the disputes microservice to its dev environment, and now ready to allow others to consume the API, this means publishing the API to the konnect dev gateway instances and document the API Service Hub. This pipeline will:

Prepare deck config for dev environment.
Add the Service Hub tag to the deck config.
Prepare a APISpec for the Dev Portal
Remove any plugin references
Correct the server reference to point at the konnect-dev gateway loadbalancer
Deck sync to the Konnect Control Plane.

Validation

Now that the API spec has been synced/published to the Konnect control plane you can validate via Insomnia that the gateway is exposing the API's correctly.

For the dev environment, the gatey configuration has been setup to proxy requests to the dispute microservice running in the disputes-dev namespace.

Open the Debug Tab in Insomnia
Change to the Konnect-Dev Environment
Execute the disputes requests to validate the behavior. You should see new responses, and possibly a 404 on /disputes/{id} (because it's in Dev and still in testing 😆).

Find all the resources you need in our self-paced demo on GitHub: https://github.com/Kong/kong-apisecops-redhat#introduction

A

Okay, so in the previous video we just finished deploying our API spec to the sandbox runtime group and did the validation there. So in this video we're going to go with the last pipeline, which is going to promote and or publish our API to the dev runtime group and connect once we get that published, we're then also going to go back into insomnia and do the validation.

A

So if you're, following along in the git repository we're on step four, so we're going to go ahead and execute so yeah before we go into the execution. Let's talk about what's going to happen in this pipeline, it's pretty similar to The Sandbox one, but we're not going to do any governance, we're just going to clean it up for the dev environment, the deck itself, we're actually also going to prep the API spec for the dev portal as well. uh The reason being is that we want to remove.

A

um If we take a look at the API spec, we want to remove all of these customizations in there. We don't find it as best practice to be in there, because the dev portal is where we have our API spec documentation, and we really don't need our customizations to be client facing.

A

So there's that and then um once we once we've done that cleanup. We think also that then we're going to push it up, we're going to execute that deck sync and open up a PR to the adev branch in the apiops Gateway Repository.

A

Okay. So with that, let's go ahead and copy this command to execute the final Pipeline and head over to the terminal clean. This up have that.

A

Okay: let's go over to openshift I left where I was here. We go so we're in the API Ops Gateway project, I'm, going to click on this task or I'm in this pipeline run, and we can see what's going on so we're fetching the repository in this case I'm I'm prepping, my deck for the dev runtime group and for the dev portal.

A

At the same time, then we executed the deck seat, so you can see we had some tasks running in parallel once that's all ready now I'm going to create that branch and open up a PR in the apiops Gateway Repository.

A

So we'll just let that finish.

A

Okay, so this pipeline finish so we're going to move over to the uh get repo to see what happened um so a PR was open, but I had instantly already closed it and it was the one into the dev Branch. So let's take a look at that real, quick I'm going to take a look at the files changed, uh so we still have our original disputes. Api spec that we committed to sandbox. Then we've got this second file is the deck config, but it's actually been updated for Dev.

A

So it's got the dev runtime group label in there, and also you can see that the back end has been converted has been shifted over to the kubernetes service that we're actually running in our browser cluster and then um we've also stripped out the mocking plug-in has been taken out as well, and then we have one more file. We have another API spec, but this one has been very specifically catered For.

A

The dev portal, where we intend on publishing our documentation and one of the two main changes that we talked about, um is one of them we didn't mention is actually we updated the server, because this server needs to be pointing at our Gateway running in openshift. So this is our. This is our Cooper. This is our Kong Dev, Gateway load, balancer and then the other thing. The second thing is what we already discussed is we moved any custom customizations so that custom plug-in configuration is all been stripped out.

A

So this is ready to be published to the dev portal.

A

And then, when I was ready, I merged in the commit and deleted the branch okay, so we should be able to go into insomnia and go watch before we go into insomnia. Let's actually go into connect and test and read. What's going on so make sure you're in the dev runtime group.

A

Let's look at the Gateway service, we still have a disputes Gateway service, but now the host has been changed. It's pointing to the kubernetes service running in openshift.

A

We also have routes. The routes have the options method on them. That's been the one tweak. The reason being is that we need those enabled for the dev portal.

A

If we look at the plugins, uh the only thing that's really changed is remove. The mocking plugin has been cleaned up, so it's no longer listed here and actually just for transparency. We have the cores plug-in and the options enabled in the route for us to work with the dev portal that we'll do the next video, and so that is what connect looks like now.

A

Let's go into insomnia and test our API, so make sure for your environment that you've got the dev runtime group selected I'm, and now, when you got that selected, we can go ahead and execute this first request, and what we should be able to see is that the responses change slightly because now we're pointing to the actual microservice running in the disputes Dev name space right. So this is actual data return being returned from the microservice.

A

If we go to the second endpoint and make this call, uh it is intentionally, uh you should have gotten a 404, and this is just kind of equip. You know it's microservice, it's a Dev. It's found a bug so yeah. This is actually working as expected.

A

Okay, perfect, so with that, um just to summarize what we've done so far, so I'm gonna go to the uh slide. Just to summarize, what we've done so far is that we've gone end to end with the API Stack Up solution. We started out as developers and updating the API spec in insomnia.

A

We think that committed that to Source control and executed uh three tecton Pipelines one was really for internal review was the first one and to open up a PR uh and then the second one was to take that PR execute some governance assessment and then prep that spec and deploy it to the sandbox runtime group and connects.

A

We then went into insomnia and they were able to hit this Gateway and we have no back-end microservice right. We, it was the mock and plug-in configuration that was actually returning responses.

A

Once we finish testing in sandbox, we then executed the third tecton pipeline, which then took our spec and deck, cleaned them up and then deployed them to the dev runtime group and deployed that API spec itself as documentation to service Hub and Dev portal.

A

We haven't gotten to this. Yet we'll do the we'll we'll discuss this in the uh in the next video. Once we've finished this deployment in this tecton pipeline, we then went back into insomnia and hit this Gateway. It was able to hit the back end disputes microservice running in the dispute, step name space and saw that book.

A

Okay, so that's it for this video in the next video we're actually going to finish up with the documentation piece, we're going to go into service Hub and connects and go ahead and and prep and publish our spec to the dev portal. So I will see you over there.