solo.io Gloo Platform, 30 Aug 2023

Previous Meeting

Next Meeting

⏯

youtube image

►

From YouTube: Catalog and expose your APIs through a Developer Portal

Description

No description was provided for this meeting.
If this is YOUR meeting, an easy way to fix this is to add a description to your video, wherever mtngs.io found it (probably YouTube).

A

A

This developer portal, so we have two components here: the first one is this glue mesh portal server, which is a back end that provides a well-defined API. That's going to be used by the developer portal content to know which API to show which user when they've been authenticated. So we first need to configure this component and to expose this API provided by this component. So we can go ahead and create this route table for sending requests to this portal server. We see another nice feature of these route tables where you can define a default destination.

A

That's going to be used by all the different routes, so so that I don't need to again Define that many times and here I said that I want to expose the API through the slash V1 path and send this path for the back end, but expose it to this portal server, slash V1, but if there is a cookie that is provided by the user, then I basically want to follow this oauth workflow, so that I can extract the information from redis and other locations as well.

A

So, basically, to summarize I want to expose the back end API, both securely and publicly, so that if there is a quest that is coming from a user who is not authenticated in the portal, it's going to follow these specific routes and I'm going to show you the public apis I want to expose these apis publicly and if a user goes through this route and they are authenticated, then we're good. Then I want to demonstrate to them that the API that they should have access to.

A

So that's, basically what this route table is doing and now that I see that if I send a request to this backend API I can see an error that tells me there is no portal config created so I'm going to create this portal object that defines the portal backend I want to use, which is the one I have shown you before before I Define, this usage plan, the way I want them to be displayed to my end user and which apis I want to expose which are in my route table.

A

So it's kind of the API product so I want to expose my API that is composed of the open, library.org and the product page API stitched together. So that's my portal object and now again you can basically send the same request that I sent before. In that case, you see I'm, not authenticated, so I don't see any sort of apis returned.

A

It's just that there is no public, API and I didn't configure any of these apis to be public, so that's normal and if I send a request to this back-end server without authentication I actually get no result.

A

So now I'm going to create what we call a portal group, so we Define some users and what kind of access they have to which resources here I'm going to say if a user is authenticated with the oidc workflow, and we also receive this jot token, with a value name key in a group and a value users, then I want to provide access to the you to the API that these Port, that these portal users equals true, which is a label and I, want to assign this usage plan gold.

A

So I'm, just creating this and later on, you will see that I can authenticate later with a user. That's called user1 that is part of this users group. So you will have access to this API that we created before, because we had these labels on it and we'll have access to this usage plan.

A

What I need to do now is to deploy the front end, so the front end is provided as a node.js application as a template that you have the ability to fully customize.

A

So we can go ahead and customize this template now, if I open that link, you can see that it's a public repo and you can fully customize this portal. The way you need to.

A

So in my case, I already downloaded it so I don't need to really do anything.

A

You can also access this with npx and you have other ways to download it and get access to it as well.

A

If you need to you, can customize it with a special logo and do various other things, and then you can proceed to go ahead and build it.

A

I I'll just go ahead and create a Docker image for it and I'm just going to push this to a local registry, but obviously, in your case you're, probably not going to use a local registry. You probably have a public registry like Docker Hub or the GitHub container registry, I already compiled it and then and then I'm going to go ahead and deploy this application. Just like a standard kubernetes deployment now here in my kubernetes cluster I can even deploy it in the glue mesh add-ons namespace, but it could really be deployed anywhere.

A

So if I go to my first cluster I can see that there is this front end being initialized, and now I can expose this content so again using a route table. You start to see, what's really used and then we can also go ahead and Define different paths and we Define which one we want to authenticate the user.

A

So if the users click on a login button, then I want to send the request to the portal front end, but I want to have authentication with oidc, otherwise, I don't need to authenticate the request, so I can go ahead and apply this route table and now I should be able to go over to this main page here and if we give it a few seconds should I should be redirected to this developer portal that I just deployed.

A

We can see that right now, I don't have any apis that are public, so I cannot see any API and I can also see that right now we use this secret for applying the oauth workflow, because we also want to secure. If you remember here, I said, if the requests go to this path with the with the login. So if the user goes ahead and clicks on the login button, I want to make sure that it's going to be authenticated.

A

That's why I went ahead and added this oauth equals true, so I'm going to configure the oidc workflow for the front end. So if you've already watched the video where I explain how to do that for the HTTP bin, it's following the exact same example in principle. Applying this to the wrap table with oauth equals true and defining different different parameters for key globe. So I can go ahead and secure access here and I can go ahead and create the xdoth server again.

A

I have just one in this cluster, which is generally the most common pattern we'll find, and now that I have the xdoth policy. Enforced I should be able to access the portal securely.

A

So if I click on the login button, I'm automatically redirected to key cloak and I can see here that I can go ahead and sign in and now I can access. My API and I can see this API because I'm successfully, authenticated and I can witness that I have access to the book info.

A