From 1da2046af5c554a290479f056c1b2cf257f383b4 Mon Sep 17 00:00:00 2001 From: Thomas Hallgren Date: Wed, 11 Dec 2024 17:51:27 +0100 Subject: [PATCH] Add entry about performance improvement in list command. Signed-off-by: Thomas Hallgren --- CHANGELOG.yml | 5 +++++ docs/reference/docker-run.md | 5 +++++ docs/release-notes.md | 6 ++++++ docs/release-notes.mdx | 4 ++++ 4 files changed, 20 insertions(+) diff --git a/CHANGELOG.yml b/CHANGELOG.yml index 64fe084c11..b55463960b 100644 --- a/CHANGELOG.yml +++ b/CHANGELOG.yml @@ -180,6 +180,11 @@ items: the agents. Therefore the `--agents` flag was made redundant and whatever arguments that are given to the command must be name of workloads that have an agent installed unless the `--all-agents` is used, in which case no arguments are allowed. + - type: change + title: Performance improvement for the telepresence list command + body: >- + The `telepresence list` command will now retrieve its data from the traffic-manager, which significantly + improves its performance when used on namespaces that have a lot of workloads. - type: change title: During an intercept, the local port defaults to the targeted port of the intercepted container instead of 8080. body: >- diff --git a/docs/reference/docker-run.md b/docs/reference/docker-run.md index b702a50df7..1a6003fce5 100644 --- a/docs/reference/docker-run.md +++ b/docs/reference/docker-run.md @@ -34,6 +34,11 @@ To achieve this, Telepresence temporarily adds the necessary network to the cont container to join the same network. Additionally, Telepresence starts extra socat containers to handle port mappings, ensuring that the desired ports are exposed to the local environment. +> [!NOTE] +> If you use `telepresence docker-run` to run a command that lasts longer than the `telepresence connect --docker` that +> was in effect when it started, then it will lose its network. In other words, when using `telepresence docker-run`, +> you must always rerun after a `telepresence quit`/`telepresence connect --docker`. + ### The ingest/intercept --docker-run flag If you want your ingest or intercept to use another Docker container, you can use the `--docker-run` flag. It creates the ingest or intercept, runs your container in the foreground, then automatically ends the ingest or intercept when the container exits. diff --git a/docs/release-notes.md b/docs/release-notes.md index 83edc42f43..6811d8d452 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -112,6 +112,12 @@ Telepresence client is now available for Windows ARM64. Updated the release work The `telepresence uninstall` was once capable of uninstalling the traffic-manager as well as traffic-agents. This behavior has been deprecated for some time now and in this release, the command is all about uninstalling the agents. Therefore the `--agents` flag was made redundant and whatever arguments that are given to the command must be name of workloads that have an agent installed unless the `--all-agents` is used, in which case no arguments are allowed. +##
change
Performance improvement for the telepresence list command
+
+ +The `telepresence list` command will now retrieve its data from the traffic-manager, which significantly improves its performance when used on namespaces that have a lot of workloads. +
+ ##
change
During an intercept, the local port defaults to the targeted port of the intercepted container instead of 8080.
diff --git a/docs/release-notes.mdx b/docs/release-notes.mdx index 5df771178e..41bfb7a503 100644 --- a/docs/release-notes.mdx +++ b/docs/release-notes.mdx @@ -84,6 +84,10 @@ These recursions can now be prevented by setting the client configuration proper The --agents flag to telepresence uninstall is now the default. The `telepresence uninstall` was once capable of uninstalling the traffic-manager as well as traffic-agents. This behavior has been deprecated for some time now and in this release, the command is all about uninstalling the agents. Therefore the `--agents` flag was made redundant and whatever arguments that are given to the command must be name of workloads that have an agent installed unless the `--all-agents` is used, in which case no arguments are allowed. + + Performance improvement for the telepresence list command + The `telepresence list` command will now retrieve its data from the traffic-manager, which significantly improves its performance when used on namespaces that have a lot of workloads. + During an intercept, the local port defaults to the targeted port of the intercepted container instead of 8080. Telepresence mimics the environment of a target container during an intercept, so it's only natural that the default for the local port is determined by the targeted container port rather than just defaulting to 8080.