Add entry about performance improvement in list command.

Signed-off-by: Thomas Hallgren <thomas@tada.se>
telepresenceio · Dec 11, 2024 · 1da2046 · 1da2046
1 parent fd89d66
commit 1da2046
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 0 deletions.
diff --git 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
@@ -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
@@ -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.
 </div>
 
+## <div style="display:flex;"><img src="images/change.png" alt="change" style="width:30px;height:fit-content;"/><div style="display:flex;margin-left:7px;">Performance improvement for the telepresence list command</div></div>
+<div style="margin-left: 15px">
+
+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.
+</div>
+
 ## <div style="display:flex;"><img src="images/change.png" alt="change" style="width:30px;height:fit-content;"/><div style="display:flex;margin-left:7px;">During an intercept, the local port defaults to the targeted port of the intercepted container instead of 8080.</div></div>
 <div style="margin-left: 15px">
 

diff --git 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
 	<Title type="change">The --agents flag to telepresence uninstall is now the default.</Title>
 	<Body>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.</Body>
 </Note>
+<Note>
+	<Title type="change">Performance improvement for the telepresence list command</Title>
+	<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.</Body>
+</Note>
 <Note>
 	<Title type="change">During an intercept, the local port defaults to the targeted port of the intercepted container instead of 8080.</Title>
 	<Body>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.