Skip to content

Commit 122fb7f

Browse files
committed
chore: update tools list and enhance interactive terminal documentation
Signed-off-by: hortison <160366376+hortison@users.noreply.github.com>
1 parent d17c23e commit 122fb7f

File tree

3 files changed

+12
-16
lines changed

3 files changed

+12
-16
lines changed

.github/agents/documentation.agent.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
name: "Diátaxis Documentation Expert"
3-
agent: 'agent'
4-
tools: ['edit/editFiles', 'search', 'fetch']
3+
tools: ['search/changes', 'search/codebase', 'edit/editFiles', 'vscode/extensions', 'web/fetch', 'web/githubRepo', 'vscode/getProjectSetupInfo', 'vscode/installExtension', 'vscode/newWorkspace', 'vscode/runCommand', 'vscode/openSimpleBrowser', 'read/problems', 'execute/getTerminalOutput', 'execute/runInTerminal', 'read/terminalLastCommand', 'read/terminalSelection', 'execute/createAndRunTask', 'execute', 'execute/runTask', 'execute/runTests', 'search', 'search/searchResults', 'read/terminalLastCommand', 'read/terminalSelection', 'execute/testFailure', 'search/usages', 'vscode/vscodeAPI', 'github/*']
54
description: 'Diátaxis Documentation Expert. An expert technical writer specializing in creating high-quality software documentation, guided by the principles and structure of the Diátaxis technical documentation authoring framework.'
65
---
76

content/en/kanvas/operator/_index.md

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,4 @@ Using the search bar, you can search for specific resources and select them. The
2525
Operator supports connecting to Kubernetes pods via the following methods.
2626

2727
- [Log Streaming](/kanvas/operator/log-streaming): Learn how to live-tail logs from your Kubernetes pods and containers directly within the visual topology.
28-
29-
### Understanding Interactive Terminal
30-
31-
The interactive terminal behaves in a fashion similar to similar to the behavior of the `kubectl exec` command, but web-based.
32-
33-
{{< alert type="note" title="Distinct Capabilities" >}} Note that each component offers its own capabilities, and that these capabilities differ between Designer mode and Operator mode. For example, in operator mode, if you right-click (and hold) on a Kubernetes pod, you will see actions unique to the Pod component, which are to open either an interactive terminal to one or all of the containers in the pod or to start streaming logs from any/all of the containers in the pod. {{< /alert >}}
34-
35-
While using using the interactive terminal, understand that you can only open one session per container. Each session's data is streamed via Meshery Broker (NATS) from MeshSync to Meshery Server / Kanvas. The GraphQL subscription between your web browser running Kanvas and Meshery Server provides isolation between other users who might be concurrently sharing an interactive terminal. Each connection established a unique session ID.
36-
37-
<!-- {{< figure src="images/interactive-terminal-sequence-diagram.svg" link="images/interactive-terminal-sequence-diagram.svg" width="100%" alt="interactive-terminal-sequence-diagram" >}} -->
38-
39-
![interactive-terminal-sequence-diagram](images/interactive-terminal-sequence-diagram.svg)
28+
- [Interactive Terminal](/kanvas/operator/interactive-terminal): Learn how to establish an interactive shell session with your containers.

content/en/kanvas/operator/interactive-terminal.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ When operating cloud native infrastructure, deep diagnostics often require direc
99

1010
## Overview
1111

12-
The Kanvas Interactive Terminal allows operators to establish a secure, low-latency shell session with one or more pods simultaneously. This feature is essential for "last mile" debugging where metrics and logs alone are insufficient.
12+
The Kanvas Interactive Terminal allows operators to establish a secure, low-latency shell session with one or more pods simultaneously. This feature is essential for "last mile" debugging where metrics and logs alone are insufficient. The interactive terminal behaves in a fashion similar to the behavior of the `kubectl exec` command, but web-based.
1313

1414
### Key Features
1515

@@ -20,7 +20,7 @@ The Kanvas Interactive Terminal allows operators to establish a secure, low-late
2020

2121
## How to Access the Terminal
2222

23-
To use the Interactive Terminal, ensure you are in **Operator Mode** (Visualizer) and have a connected Kubernetes cluster.
23+
To use the Interactive Terminal, ensure you are in **Operator Mode** and have a connected Kubernetes cluster.
2424

2525
1. **Navigate to Visualizer:** Open Kanvas and switch to **Operator** mode to view your active cluster resources.
2626
2. **Select a Workload:** Click on a **Pod** or **Deployment** node within your design.
@@ -65,6 +65,14 @@ The Interactive Terminal is built on an event-driven architecture designed for s
6565
3. **Data Transport:** Input and output data are streamed via **NATS** through the Meshery Broker. Shell output is preprocessed and transcribed before being delivered to the UI.
6666
4. **Session Isolation:** Each terminal session is mapped to a unique topic ID within the subscription, ensuring that data streams for multiple open terminals do not overlap.
6767

68+
{{< alert type="note" title="Distinct Capabilities" >}} Note that each component offers its own capabilities, and that these capabilities differ between Designer mode and Operator mode. For example, in operator mode, if you right-click (and hold) on a Kubernetes pod, you will see actions unique to the Pod component, which are to open either an interactive terminal to one or all of the containers in the pod or to start streaming logs from any/all of the containers in the pod. {{< /alert >}}
69+
70+
While using the interactive terminal, understand that you can only open one session per container. Each session's data is streamed via Meshery Broker (NATS) from MeshSync to Meshery Server / Kanvas. The GraphQL subscription between your web browser running Kanvas and Meshery Server provides isolation between other users who might be concurrently sharing an interactive terminal. Each connection establishes a unique session ID.
71+
72+
<!-- {{< figure src="images/interactive-terminal-sequence-diagram.svg" link="images/interactive-terminal-sequence-diagram.svg" width="100%" alt="interactive-terminal-sequence-diagram" >}} -->
73+
74+
![interactive-terminal-sequence-diagram](images/interactive-terminal-sequence-diagram.svg)
75+
6876
***
6977

7078
### See Also

0 commit comments

Comments
 (0)