Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
3a44b64
commit ed440b0
Showing
3 changed files
with
70 additions
and
49 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
import Alert from '@material-ui/lab/Alert'; | ||
import QSTabs from '../quick-start/qs-tabs' | ||
|
||
# Install Telepresence | ||
|
||
Install Telepresence by running the commands below for your OS. | ||
|
||
<QSTabs/> | ||
|
||
## <img class="os-logo" src="../../images/logo.png"/> What's Next? | ||
|
||
Follow one of our [quick start guides](../quick-start/) to start using Telepresence, either with our sample app or in your own environment. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
--- | ||
description: "How to upgrade your installation of Telepresence and install previous versions." | ||
--- | ||
|
||
import QSTabs from '../quick-start/qs-tabs' | ||
|
||
# Upgrade Telepresence | ||
|
||
<div class="docs-article-toc"> | ||
<h3>Contents</h3> | ||
|
||
* [Upgrade Process](#upgrade-process) | ||
* [Installing Older Versions of Telepresence](#installing-older-versions-of-telepresence) | ||
* [Migrating from Telepresence 1 to Telepresence 2](#migrating-from-telepresence-1-to-telepresence-2) | ||
|
||
</div> | ||
|
||
## Upgrade Process | ||
The Telepresence CLI will periodically check for new versions and notify you when an upgrade is available. Running the same commands used for installation will replace your current binary with the latest version. | ||
|
||
<QSTabs/> | ||
|
||
After upgrading your CLI, the Traffic Manager **must be uninstalled** from your cluster. This can be done using `telepresence uninstall --everything` or by `kubectl delete svc,deploy traffic-manager`. The next time you run a `telepresence` command it will deploy an upgraded Traffic Manager. | ||
|
||
## Installing Older Versions of Telepresence | ||
|
||
Use the following URLs to install an older version, replacing `x.x.x` with the version you want. | ||
|
||
``` | ||
# macOS | ||
https://app.getambassador.io/download/tel2/darwin/amd64/x.x.x/telepresence | ||
# Linux | ||
https://app.getambassador.io/download/tel2/linux/amd64/x.x.x/telepresence | ||
``` | ||
|
||
|
||
Curl the following URLs to find the current latest version number. | ||
|
||
``` | ||
# macOS | ||
https://app.getambassador.io/download/tel2/darwin/amd64/stable.txt | ||
# Linux | ||
https://app.getambassador.io/download/tel2/linux/amd64/stable.txt | ||
``` | ||
|
||
## Migrating from Telepresence 1 to Telepresence 2 | ||
|
||
Telepresence 2 (the current major version) has different mechanics and requires a different mental model from [Telepresence 1](https://www.telepresence.io/) when working with local instances of your services. | ||
|
||
In Telepresence 1, a pod running a service is swapped with a pod running the Telepresence proxy. This proxy receives traffic intended for the service, and sends the traffic onward to the target workstation or laptop. We called this mechanism "swap-deployment". | ||
|
||
In practice, this mechanism, while simple in concept, had some challenges. Losing the connection to the cluster would leave the deployment in an inconsistent state. Swapping the pods would take time. | ||
|
||
Telepresence 2 introduces a [new architecture](../../reference/architecture/) built around "intercepts" that addresses this problem. With Telepresence 2, a sidecar proxy is injected onto the pod. The proxy then intercepts traffic intended for the pod and routes it to the workstation/laptop. The advantage of this approach is that the service is running at all times, and no swapping is used. By using the proxy approach, we can also do selective intercepts, where certain types of traffic get routed to the service while other traffic gets routed to your laptop/workstation. | ||
|
||
Please see [the Telepresence quick start](../../quick-start/) for an introduction to running intercepts and [the intercept reference doc](../../reference/intercepts/) for a deep dive into intercepts. |