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

Previous Meeting

Next Meeting

⏯

youtube image

►

From YouTube: Cleanup and Documentation: 8-Part APISecOps Tutorial ROSA and Kong Konnect in Openshift | Part 8/8

Description

APISecOps - Insomnia, Kong Konnect, Tekton - on ROSA

Part 8 of 8 Kong Partner Engineering's APISecOps Tutorial ROSA and Kong Konnect in the Red Hat Openshift Ecosystem: Cleanup and Documentation.

In part 8 we wrap up this tutorial we search for, test and clean up documentation in Service Hub.

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

Cleanup
Kongratulations on completing the workshop! Now its time to delete the infrastructure you’ve created in order to work through the material.

Delete Konnect Gateways

Run the unistall playbook to tear down the konnect gateways deployed on the cluster:

Delete ROSA Cluster

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 this video we're gonna wrap up with the last Concept in API secops, which is documentation, and in order to do that, we actually need to understand what uh its service, Hub and Dev portal and connect provide us here on the left.

A

So the dev portal is intended is, is intended for developers or API consumers to find access or and test our apis.

A

So from the dev portal taking on their Persona of a developer, I should be able to search for API documentation and then, when I find it test it out right then, and there so in order to publish an API to the dev portal, we actually have to have a service created in service hub, so service Hub allows us to catalog all of our services, as in a single system of record, it's intended to provide a way to track any changes to the implementation of the service and track those Implement track those changes over its lifetime.

A

So you can see in this context, like really briefly on the tab that we have a service called disputes and it actually has a version Associated to it.

A

For your open up service Hub and take a look at the service versions, what's really interesting, as you can see right off the bat that it's Associated to a specific runtime group, it has a type and a status.

A

So if we open up that service version, we can see even we can see more details about the back end. So we we know the Upstream URL.

A

We have the route information. If there was a service level plug-in, we would have also seen it here. So we can basically see that the service version is tied to a specific configure configuration and in part of that configuration is also the API spec, so the associated documentation. So right here on the right, you can see a spot where we can upload the open, API spec associated to this version.

A

Okay, so this is this is basically the entry point into getting our documentation into developer portal. So uh what the question is, what API dot spec? Should we upload here and during the last pipeline we execute the third pipeline. Let me go ahead and navigate down to that step.

A

Here we go in this third pipeline, where we published the API spec to the dev runtime group. They would actually step in the pipeline to prep the API spec for the dev portal, because there was certain information we needed to scrub and we also needed to correct what the server was.

A

So there's a couple of activities, tasks that happened in this step here and then that this API spec got version controlled on the dev branch, so which means, if we go over to the git repository in Getty and navigate to API Ops Gateway repo, we're going to go to the dev branch navigate down into API disputes directory navigate one more time down into the dev portal, and you see this API spec here so here you know: we've got the the server is the URL to our Gateway, because the dev portal is going to actually hit our Gateway and the Gateway is going to router to the back end.

A

And so this is the API spec. We want to go ahead and download so just download that file and now we'll go back to service Hub, and we can just drag and drop it in to upload it.

A

Now that it's uploaded, we should be able to access it from Dev portal, so go to Dev portal and you want to select the connect portal URL so hit that link and I have my Dev portal publicly facing uh just so so it doesn't require any credentials to log in.

A

You may have to set up credential login, we're gonna skip that for now and assume it's public facing, so I can go ahead and select this service, so this is a this is a cattle disputes catalog, and we can see that this is the API spec that we indeed just uploaded.

A

um We can also test it out from this uh now that we're here we can just go ahead and test it out. So the first thing we need to do is to authorize and remember this is if we look at the list of servers, this is our Dev run it's pointing at our Dev runtime group. So we know that there's a key on that there's an API key, so I'm going to go ahead and type in the API key.

A

The values, connect and authorize close that and then I'm just going to execute this first test or this first API and see what happens so when I, execute I did get a type error failed to fetch, and the reason is that we have from the browser's perspective we have. We have to trust this request, URL, because it's not on https. So what I'm going to do is I'm just going to copy this request.

A

Url open up a new tab in my browser paste that in but Swap this to https- and you should get your connection- is not private, that's good! You want to go ahead and advance that and then proceed to trust it, and then you should. You should hit a con error. No API key found request so once you've hit that that's what that's the expectation so close that Tab and navigate back to the dev portal and re-execute the request, and you should see a 200.

A

cool, that's and that's exactly actually what we saw in insomnia, so just as a sanity check, we'll execute the second request as well, just as a reminder from insomnia.

A

It in fact gave us a 404 as well, which is so that is the expectation and that's it for this video. So we covered how to get our documentation up in Dev portal via connects and service hub.

A

I will see you all later.