add "how it works" and "tools" sections #2548
Conversation
Signed-off-by: Raphael Reyna <raphaelreyna@protonmail.com>
raphaelreyna
force-pushed
the
raphaelreyna/update-dev-docs
branch
from
1fc8acd
to
4585c94
Compare
|
|
||
| 1. Ensures Traffic Manager is installed in the cluster. | ||
| 2. Looks for the relevant subnets in the kubernetes cluster. | ||
| 3. Creates a virtual network device called a _TUN device_ and names it `tel0`. |
There was a problem hiding this comment.
The device is named tun0 on macOS (or tun1, tun2, etc. whichever is available) so using "tel0" in the text can be confusing for a Mac user.
|
|
||
| When a locally running application makes a network request to a service in the cluster, Telepresence will resolve the name to an address within the cluster. | ||
| The operating system then sees that the TUN device has an address in the same subnet as the address of the outgoing packets and sends them to `tel0`. | ||
| Telepresence is on the other side of `tel0` and picks up the packets, injecting them into the cluster through a gRPC connection with Traffic Manager. |
There was a problem hiding this comment.
The packets aren't really "injected". The data of the packages are tunneled over a stream (in packets that are much larger than the TCP packets). I suggest you use different wording here unless you want to go into detail on how that works. How about "The operating system then sees that the address is covered by one of the TUN device's subnets, which means that telepresence will route the traffic to the cluster through a gRPC connection with the Traffic Manager"?
|
@raphaelreyna can you please rebase and update this one so that we can merge it? |
|
could you also put some explanation about the DNS? How the domain names are resolved by coreDNS outside of the cluster? |
thallgren
force-pushed
the
release/v2
branch
2 times, most recently
from
0c10946
to
cb1d0d6
Compare
thallgren
force-pushed
the
release/v2
branch
from
8a2d77b
to
8a4471c
Compare
Description
A few sentences describing the overall goals of the pull request's commits.
Checklist
./CHANGELOG.md.DEVELOPING.mdwith any any special dev tricks I had to use to work on this code efficiently.TELEMETRY.mdif I added, changed, or removed a metric name.