Skip to content

Commit 12a56dc

Browse files
committed
Temp update to catch up with relesase/v2.21 branch.
Signed-off-by: Thomas Hallgren <thomas@tada.se>
1 parent 385ca6b commit 12a56dc

File tree

6 files changed

+92
-62
lines changed

6 files changed

+92
-62
lines changed

versioned_docs/version-2.21/concepts/faster.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,5 +27,3 @@ The dev loop can be jump-started with the right development environment and Kube
2727
A rapid and continuous feedback loop is essential for productivity and speed; Telepresence enables the fast, efficient feedback loop to ensure that developers can access the rapid local development loop they rely on without disrupting their own or other developers' workflows. Telepresence safely intercepts traffic from the production cluster and enables near-instant testing of code and local debugging in production.
2828

2929
Telepresence works by deploying a two-way network proxy in a pod running in a Kubernetes cluster. This pod proxies data from the Kubernetes environment (e.g., TCP/UDP connections, environment variables, volumes) to the local process. This proxy can intercept traffic meant for the service and reroute it to a local copy, which is ready for further (local) development.
30-
31-
The intercept proxy works thanks to context propagation, which is most frequently associated with distributed tracing but also plays a key role in controllable intercepts.

versioned_docs/version-2.21/howtos/intercepts.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ network telepresence, and remote mounts must be made relative to a specific moun
4949

5050
3. Get the name of the port you want to intercept on your service:
5151
`kubectl get service &lt;service name&gt; --output yaml`.
52-
52+
5353
If we assume that the service and deployment use the same name:
5454

5555
```console
@@ -85,7 +85,7 @@ network telepresence, and remote mounts must be made relative to a specific moun
8585
```
8686
8787
5. &lt;a name="start-local-instance"&gt;&lt;/a&gt;Start your local application using the environment variables retrieved in the previous step.
88-
The following are some examples of how to pass the environment variables to your local process:
88+
The following are some examples of how to pass the environment variables to your local process:
8989
* **Visual Studio Code:** specify the path to the environment variables file in the `envFile` field of your configuration.
9090
* **JetBrains IDE (IntelliJ, WebStorm, PyCharm, GoLand, etc.):** use the [EnvFile plugin](https://plugins.jetbrains.com/plugin/7861-envfile).
9191
@@ -148,9 +148,9 @@ present challenges in terms of toolchain integration, debugging, and the overall
148148
telepresence intercept &lt;workload-name&gt; --port [&lt;local-port&gt;][:&lt;remote-port&gt;] --docker-run -- &lt;your local container&gt;.
149149
```
150150
151-
* For `--port`: If the intercepted service exposes multiple ports, specify the service port you want to intercept after a colon.
152-
The local port can be empty to default to the same as the targeted container port.
153-
151+
* For `--port`: If the intercepted service exposes multiple ports, specify the service port you want to intercept after a colon.
152+
The local port can be empty to default to the same as the targeted container port.
153+
154154
The example below shows Telepresence intercepting traffic going to deployment `example-app`. The local container inherits
155155
the environment and the volume mounts from the targeted container, and requests to the service on port `http` in the
156156
cluster get routed to the local container and the environment variables of the service are written to `~/example-app-intercept.env`.
@@ -183,7 +183,7 @@ but you don't wish to intercept any traffic intended for the targeted workload.
183183
comes into play. Just like intercept, it will make the environment and mounted containers of the targeted container available locally,
184184
but it will not intercept any traffic.
185185
186-
This example assumes that you have the `example-app`
186+
This example assumes that you have the `example-app`
187187
188188
### Running everything directly on the workstation
189189

versioned_docs/version-2.21/install/manager.md

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,13 @@ hide_table_of_contents: true
55

66
# Install/Uninstall the Traffic Manager
77

8-
Telepresence uses a traffic manager to send/receive cloud traffic to the user. Telepresence uses [Helm](https://helm.sh) under the hood to install the traffic manager in your cluster. The `telepresence` binary embeds both `helm` and a helm-chart for a traffic-manager that is of the same version as the binary.
8+
Telepresence uses a traffic manager to send/receive cloud traffic to the user. Telepresence uses [Helm](https://helm.sh) under the
9+
hood to install the traffic manager in your cluster. The `telepresence` binary embeds both `helm` and a helm-chart for a
10+
traffic-manager that is of the same version as the binary.
11+
12+
The Telepresence Helm chart documentation is published at [ArtifactHUB](https://artifacthub.io/packages/helm/telepresence-oss/telepresence-oss).
13+
14+
You can also use `helm` command directly, see [Install With Helm](#install-with-helm) for more details.
915

1016
## Prerequisites
1117

@@ -180,3 +186,36 @@ Telepresence Traffic Manager does require some [RBAC](../reference/rbac.md) for
180186
To make it easier for operators to introspect / manage RBAC separately, you can use `rbac.only=true` to
181187
only create the rbac-related objects.
182188
Additionally, you can use `clientRbac.create=true` and `managerRbac.create=true` to toggle which subset(s) of RBAC objects you wish to create.
189+
190+
## Install with Helm
191+
192+
Before you begin, you must ensure that the [helm command](https://helm.sh/docs/intro/install/) is installed.
193+
194+
The Telepresence Helm chart is published at GitHub in the ghcr.io repository.
195+
196+
### Installing
197+
198+
Install the latest stable version of the traffic-manager into the default "ambassador" namespace with the following command:
199+
200+
```bash
201+
helm install --create-namespace --namespace ambassador traffic-manager oci://ghcr.io/telepresenceio/telepresence-oss
202+
```
203+
204+
### Upgrading/Downgrading
205+
206+
Use this command if you installed the Traffic Manager into the "ambassador" namespace, and you just wish to upgrade it
207+
to the latest version without changing any configuration values:
208+
209+
```bash
210+
helm upgrade --namespace ambassador --reuse-values traffic-manager oci://ghcr.io/telepresenceio/telepresence-oss
211+
```
212+
213+
If you want to upgrade (or downgrade) the Traffic Manager to a specific version, add a `--version` flag with the version
214+
number to the upgrade command, e.g.: `--version v2.20.3`.
215+
216+
### Uninstalling
217+
218+
Use the following command to uninstall the Traffic Manager:
219+
```bash
220+
helm uninstall --namespace ambassador traffic-manager
221+
```

0 commit comments

Comments
 (0)