Skip to content

Commit

Permalink
Merge branch 'lukeshu/personal/products/telepresence/v2.4' into lukes…
Browse files Browse the repository at this point in the history
…hu/personal/products/telepresence/master
  • Loading branch information
LukeShu committed Aug 9, 2021
2 parents 4acfc3a + 2e6b817 commit 98c9485
Show file tree
Hide file tree
Showing 14 changed files with 117 additions and 266 deletions.
24 changes: 12 additions & 12 deletions faqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: "Learn how Telepresence helps with fast development and debugging i

** Why Telepresence?**

Modern microservices-based applications that are deployed into Kubernetes often consist of tens or hundreds of services. The resource constraints and number of these services means that it is often difficult to impossible to run all of this on a local development machine, which makes fast development and debugging very challenging. The fast [inner development loop](../concepts/devloop/) from previous software projects is often a distant memory for cloud developers.
Modern microservices-based applications that are deployed into Kubernetes often consist of tens or hundreds of services. The resource constraints and number of these services means that it is often difficult to impossible to run all of this on a local development machine, which makes fast development and debugging very challenging. The fast [inner development loop](../concepts/devloop/) from previous software projects is often a distant memory for cloud developers.

Telepresence enables you to connect your local development machine seamlessly to the cluster via a two way proxying mechanism. This enables you to code locally and run the majority of your services within a remote Kubernetes cluster -- which in the cloud means you have access to effectively unlimited resources.

Expand All @@ -22,7 +22,7 @@ Telepresence currently works natively on macOS, Linux, and WSL 2. Starting with

** What protocols can be intercepted by Telepresence?**

All HTTP/1.1 and HTTP/2 protocols can be intercepted. This includes:
All HTTP/1.1 and HTTP/2 protocols can be intercepted. This includes:

- REST
- JSON/XML over HTTP
Expand All @@ -35,7 +35,7 @@ If you need another protocol supported, please [drop us a line](https://www.geta

Yes, you can either set the pod's environment variables on your machine or write the variables to a file to use with Docker or another build process. Please see [the environment variable reference doc](../reference/environment) for more information.

** When using Telepresence to intercept a pod, can the associated pod volume mounts also be mounted my local machine?**
** When using Telepresence to intercept a pod, can the associated pod volume mounts also be mounted by my local machine?**

Yes, please see [the volume mounts reference doc](../reference/volume/) for more information.

Expand All @@ -53,11 +53,11 @@ You can connect to databases or middleware running in the cluster, such as MySQL

** When connected to a Kubernetes cluster via Telepresence, can I access cloud-based services and data stores via their DNS name?**

You can connect to cloud-based data stores and services that are directly addressable within the cluster (e.g. when using an [ExternalName](https://kubernetes.io/docs/concepts/services-networking/service/#externalname) Service type), such as AWS RDS, Google pub-sub, or Azure SQL Database.
You can connect to cloud-based data stores and services that are directly addressable within the cluster (e.g. when using an [ExternalName](https://kubernetes.io/docs/concepts/services-networking/service/#externalname) Service type), such as AWS RDS, Google pub-sub, or Azure SQL Database.

** What types of ingress does Telepresence support for the preview URL functionality?**

The preview URL functionality should work with most ingress configurations, including straightforward load balancer setups.
The preview URL functionality should work with most ingress configurations, including straightforward load balancer setups.

Telepresence will discover/prompt during first use for this info and make its best guess at figuring this out and ask you to confirm or update this.

Expand All @@ -71,31 +71,31 @@ Telepresence will discover/prompt during first use for this info and make its be

** Will Telepresence be able to intercept workloads running on a private cluster or cluster running within a virtual private cloud (VPC)?**

Yes. The cluster has to have outbound access to the internet for the preview URLs to function correctly, but it doesn’t need to have a publicly accessible IP address.
Yes. The cluster has to have outbound access to the internet for the preview URLs to function correctly, but it doesn’t need to have a publicly accessible IP address.

The cluster must also have access to an external registry in order to be able to download the traffic-manager and traffic-agent images that are deployed when connecting with Telepresence.

** Why does running Telepresence require sudo access for the local daemon?**

The local daemon needs sudo to create iptable mappings. Telepresence uses this to create outbound access from the laptop to the cluster.
The local daemon needs sudo to create iptable mappings. Telepresence uses this to create outbound access from the laptop to the cluster.

On Fedora, Telepresence also creates a virtual network device (a TUN network) for DNS routing. That also requires root access.

** What components get installed in the cluster when running Telepresence?**

A single `traffic-manager` service is deployed in the `ambassador` namespace within your cluster, and this manages resilient intercepts and connections between your local machine and the cluster.
A single `traffic-manager` service is deployed in the `ambassador` namespace within your cluster, and this manages resilient intercepts and connections between your local machine and the cluster.

A Traffic Agent container is injected per pod that is being intercepted. The first time a workload is intercepted all pods associated with this workload will be restarted with the Traffic Agent automatically injected.

** How can I remove all of the Telepresence components installed within my cluster?**

You can run the command `telepresence uninstall --everything` to remove the `traffic-manager` service installed in the cluster and `traffic-agent` containers injected into each pod being intercepted.
You can run the command `telepresence uninstall --everything` to remove the `traffic-manager` service installed in the cluster and `traffic-agent` containers injected into each pod being intercepted.

Running this command will also stop the local daemon running.

** What language is Telepresence written in?**

All components of the Telepresence application and cluster components are written using Go.
All components of the Telepresence application and cluster components are written using Go.

** How does Telepresence connect and tunnel into the Kubernetes cluster?**

Expand All @@ -117,8 +117,8 @@ More authentication mechanisms and identity provider support will be added soon.

** Is Telepresence open source?**

Telepresence will be open source soon, in the meantime it is free to download. We prioritized releasing the binary as soon as possible for community feedback, but are actively working on the open sourcing logistics.
Telepresence will be open source soon, in the meantime it is free to download. We prioritized releasing the binary as soon as possible for community feedback, but are actively working on the open sourcing logistics.

** How do I share my feedback on Telepresence?**

Your feedback is always appreciated and helps us build a product that provides as much value as possible for our community. You can chat with us directly on our [feedback page](https://www.getambassador.io/feedback/), or you can [join our Slack channel](https://a8r.io/Slack) to share your thoughts.
Your feedback is always appreciated and helps us build a product that provides as much value as possible for our community. You can chat with us directly on our [feedback page](https://www.getambassador.io/feedback/), or you can [join our Slack channel](https://a8r.io/Slack) to share your thoughts.
4 changes: 2 additions & 2 deletions howtos/preview-urls.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,11 +123,11 @@ Need a sample app to try with preview URLs? Check out the <a href="../../quick-
7. Share with a teammate.

You can collaborate with teammates by sending your preview URL to
them. They will be asked to log in to Ambassador Cloud if they are
them. They will be asked to log in to Ambassador Cloud if they are
not already. Upon login they must select the same identity
provider and org as you are using; that is how they are authorized
to access the preview URL (see the [list of supported identity
providers](../../faqs/#idps)). When they visit the preview URL,
providers](../../faqs/#idps)). When they visit the preview URL,
they will see the intercepted service running on your laptop.

<Alert severity="success">
Expand Down
7 changes: 3 additions & 4 deletions install/migrate-from-legacy.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Migrate from legacy Telepresence

Telepresence (formerly referenced as Telepresence 2, which is the current major version) has different mechanics and requires a different mental model from [legacy Telepresence 1](/docs/v1/) when working with local instances of your services.
Telepresence (formerly referenced as Telepresence 2, which is the current major version) has different mechanics and requires a different mental model from [legacy Telepresence 1](https://www.telepresence.io/docs/v1/) when working with local instances of your services.

In legacy Telepresence, a pod running a service was swapped with a pod running the Telepresence proxy. This proxy received traffic intended for the service, and sent the traffic onward to the target workstation or laptop. We called this mechanism "swap-deployment".

Expand Down Expand Up @@ -65,7 +65,6 @@ are supported).
|--------------------------------------------------|--------------------------------------------|
| --swap-deployment $workload | intercept $workload |
| --expose localPort[:remotePort] | intercept --port localPort[:remotePort] |
| --expose localPort[:remotePort] | intercept --port localPort[:remotePort] |
| --swap-deployment $workload --run-shell | intercept $workload -- bash |
| --swap-deployment $workload --run $cmd | intercept $workload -- $cmd |
| --swap-deployment $workload --docker-run $cmd | intercept $workload --docker-run -- $cmd |
Expand All @@ -87,7 +86,7 @@ by [creating an issue](https://github.com/telepresenceio/telepresence/issues) an

## Telepresence changes

Telepresence installs a traffic-manager in the cluster and Traffic Agents alongside workloads when performing intercepts (including
Telepresence installs a Traffic Manager in the cluster and Traffic Agents alongside workloads when performing intercepts (including
with `--swap-deployment`) and leaves them. If you use `--swap-deployment`, the intercept will be left once the process
dies, but the agent will remain. There's no harm in leaving the agent running alongside your service, but when you
want to remove them from the cluster, the following Telepresence command will help:
Expand All @@ -106,5 +105,5 @@ Flags:
-n, --namespace string If present, the namespace scope for this CLI request
```

Since the new architecture deploys a traffic-manager into the Ambassador namespace, please take a look at
Since the new architecture deploys a Traffic Manager into the Ambassador namespace, please take a look at
our [rbac guide](../../reference/rbac) if you run into any issues with permissions while upgrading to Telepresence.
Loading

0 comments on commit 98c9485

Please sign in to comment.