Home
Contribute Contact Us Browse all meetings
Home Contribute Contact Us Browse all meetings
solo.io / SoloCon 2022 / 5 May 2022
solo.io / SoloCon 2022 / 5 May 2022
Previous Meeting Next Meeting
⏯
Add meeting Rate page Subscribe
youtube image
►
From YouTube: SoloCon 2022 [Lightning Talk]: Envoy UI Tool Demo

Description

SoloCon 2022:
[Lightning Talk] Envoy UI tool demo

Speaker:
Denis Jannot
Director of Field Engineering, Solo.io

Abstract:
EnvoyUI lets you upload a raw Envoy config dump to easily understand the overall configuration (listeners, matchers, routes, clusters, ...). The file is analyzed in your browser, so it never leaves your computer. In this lightning talk, we'll go through an Envoy config dump generated by Istio to demonstrate how this tool can be used to troubleshoot an issue.

Track:
Edge and API Gateway

A

Hi welcome to today's lightning talks. I'm nikki ruda. I work in product marketing here at solo. I o I'm excited to welcome our first lightning talk speaker for the day. So please help me extend a warm welcome to denise he'll, be showing us how to troubleshoot with envoy over to you denny.

B

I'm donijano director of the field engineering team at in this talk, I'm going to speak about how you can use our envoy ui tool uh online to analyze some envoy confidence um and you have can have like uh obviously android configures when you use istio, but also when you use our api gateway glue edge in that talk, I'm going to use an example on istio and for that I'm I've deployed like an istio cluster, where I have the book info application deployed.

B

You can see here in this book info namespace. I have the different components if you are not familiar with the booking for application and that's a navigation that is composed of multiple micro services.

B

The front end is the product page and this front end talk to different back-end services, the review service and the detail service, and you can see in the review service. You have multiple versions, v1, v2 and so on. Here I just deployed v1 and v2. So if I go to this application, you see, v1 is no stars and v2 has black stars right. So if I go there, you can see mostly half of the time. I get.

B

No stars or black stars right and it's just because I have no specific holes right now. So let's say I want to apply something like that right traffic shift, so that 90 percent of my request goes through v1 and 10 percent to v2 right. So, if I just try to apply this, then I will see that it doesn't work right. It doesn't work why it doesn't work. I could look at the configuration by myself.

B

We could find that out using the envoy ui tool, but um you don't need it right. Basically, you can use just the uh istio kettle analyze to get some insight here. So I analyze my book info namespace and I can see that it tells me that the there is no destination rule for this subset here. So what I need is just to go and apply this right.

B

So I just applied this destination wall, and now everything should be good right. I will have no stars most of the time so 90 of the time, and sometimes I will get black stars okay. So in that example, I don't need to go into the config dump, but now, let's take a look at an example where I would need to go through this configure, because the analyze could not help me. So let's say here.

B

If I let's say I change the port here, so it doesn't break the configuration because it tells me if a request come on port 80, not 9080, then I will do a split between these two subsets here right and if I apply it.

B

Obviously for istio everything is fine right, because there is nothing wrong in this policy right. But if I go there as a user, I can see that half of the time I get black stars and half of the time I don't get them. I get like v1 alpha time, v2 and here it's a little bit more difficult to troubleshoot, because I don't know exactly what could be the problem and the analyze tells me that everything is fine, which is normal because in istio itself it's it's fine right, uh so you can use uh other thing.

B

You can have like this proxy config command line. That can give you insight about this product page, and it tells you like many things right. The proxy all shows you like information about the roots, the clusters- and you can see here, for example, that you have like multiple clusters. You know with the subset, so everything seems fine, you can, you know, have a look at the different routes and that doesn't tell you much more right.

B

If you want to get much more, then you have to do something like exporting in json right and then you get the full config, the full config dump from the envoy proxy, which is very useful right, but it's a lot of data right. So if I store it in, let's restore it here.

B

And I look at the number of line.

B

You see that's more than 10 000 lines right, so that's a lot to digest right. So the other thing you can do is that you can use a tool that is basically uh a little bit the same as this android ui and that's the first thing I did. I built that first and then I I built this ui around it. So with this tool, which is you can you can download it's open source and voice curtail? Basically, you can pipe this config dump to take a look at it in a kind of table format right.

B

So obviously it's a lot of information depending on you know your screen, you just change it and you see that you have multiple entries there and you could look at you see this the listener, the roots. You know the domain and you see you have like for each target right. You have different entries right. So one of the things I can do here is just add this option, so I filter only on the domain that start with review.

B

So it's a lot better already right. I can see that I have two entries right and I can see that I have this route here for the reviews on port 80, which is doing this traffic shift. So, okay, that makes sense everything seems fine, but I can see that I have this other route on 1980 and that doesn't have the traffic shift. So it gives me this information.

B

Oh I have these two routes. Do I expect that right? No, I don't expect that in fact it's because I should not have this through the iit. I wanted to apply this to the existing route right. So that's a way to help you right. So it's uh one thing you can do that way right, but you can also because I exported the config dump.

B

You can also directly go there and find your config dump and it will load it in the same format and you can do even more filtering there and you can see the same thing right.

B

You can see here that I have like uh these two entries, one for the port 80, where I have my traffic shift and one for the port 9080, where I don't have the traffic shift right and that's one thing you can do, but you can also do much more and you know, search for you know just one of these name here, for example, and just put it here and you can search inside this config dump and find out. You know like: what's what could be wrong right?

B

You can take a look at you know for here I have an entry cluster entry for this name, and you know you can go down and look at you know all the reference for one specific name and you know search through the full dump. um For the you know, cluster entries the listener.

B

You know many many different things right. So that's uh that's also uh quite useful. So now that I know that's what's wrong here that I I wanted to have this shift on this root and not on the 480. I can let me like put it bigger now.

B

I can just go back here and say: oh yeah, that's that's here, because I have this port 80. Now, if I apply this instead and I run the same commands than before and again I just reduce it a little bit then I can see I have only one entry for the port 9080 and I have this traffic shield right. So it's an example right. It's obviously uh not always easy to find good examples. When you try to break things, uh um you know intentionally right, but that's.

B

That was a way for me to to show you uh the fact that you can get this representation of your config dump and you can go through it and browse and filter and so on. I can help you to understand, what's going on, why you have the specific behavior right for a specific route and uh you can do uh much more uh than that.

B

Obviously you could also see you know like why you have a specific timeout or you could see in the dump that you have a specific time out and you didn't expect it and then you can research about why you have this specific behavior. Another thing I wanted to highlight is that here and let me just open the the browser developer tool so that it really makes sense.

B

So here, when I refresh you see the all the http request right that to load this page right, but what's really important that when I browse and upload a file like this config dump, you can see here that no communication has happened right because everything is done in the browser. So we don't get access to your config them you we did. They are not sent to the internet right. They just stay on your border. So that's a very important thing, because in this config dump you can have some sensitive information right.

B

You will not have like highly sensitive one, but you could have even like just having your domain name and pass and configuration. It is sensitive information right. So um just you know be reassured that here everything is done in the browser and that you, you don't have any any risk in using this tool. So.

A

I hope it was useful.

B

And I hope you'll use it. You can give us feedback on slack. You can also give feedback by you know creating issue in this in this repo. If, if that makes sense thanks, everyone have a good conference.

A

All right well, thank you denny, for those of you attending. If you have any questions, be sure to drop them in the chat here or post them in our slack room, um be sure to check out the other tracks for our next lightning talks by clicking on reception at the top left of your window, and thanks for joining us today,.