Skip to content

Commit 2a159a0

Browse files
committed
docs: Add vscode documentaiton in main retina repo.
1 parent 75600a6 commit 2a159a0

File tree

5 files changed

+26
-2
lines changed

5 files changed

+26
-2
lines changed

docs/01-Introduction/02-architecture.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ To collect this data, Retina observes and hooks on to system events within the k
1010

1111
This section discusses how Retina collects its raw data. More specifically, it discusses how the eBPF programs and plugins are used.
1212

13-
The plugins have a very specific scope by design, and Retina is designed to be extendable, meaning it is easy to add in additional plugins if necessary. If there is a plugin missing for your use case, you can create your own! See our [Development page](../07-Contributing/02-development.md) for details on how to get started.
13+
The plugins have a very specific scope by design, and Retina is designed to be extendable, meaning it is easy to add in additional plugins if necessary. If there is a plugin missing for your use case, you can create your own! See our [Development page](../08-Contributing/02-development.md) for details on how to get started.
1414

1515
The plugins are responsible for installing the eBPF programs into the host kernel during startup. These eBPF programs collect metrics from events in the kernel level, which are then passed to the user space where they are parsed and converted into a `flow` data structure. Depending on the Control Plane being used, the data will either be sent to a Retina Enricher, or written to an external channel which is consumed by a Hubble observer - more on this in the [Control Plane](#control-plane) section below. It is not required for a plugin to use eBPF, it can also use syscalls or other API calls. In either case, the plugins will implement the same [interface](https://github.com/microsoft/retina/blob/main/pkg/plugin/registry/registry.go).
1616

docs/07-Consumingtools/vscode.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Retina Integration in AKS VS Code Extension
2+
3+
## Overview
4+
5+
Retina is a powerful feature integrated into the Azure Kubernetes Service (AKS) VS Code extension, enabling users to capture and analyze workloads efficiently. This integration simplifies debugging and troubleshooting by providing deep insights into Kubernetes applications.
6+
7+
## Integration Details
8+
9+
The AKS VS Code extension incorporates Retina to enhance cluster observability by capturing snapshots of workloads, logs, and events in real time. Users can:
10+
11+
- Capture workload snapshots directly within VS Code.
12+
- Analyze Kubernetes resources and identify issues.
13+
- Improve troubleshooting efficiency with detailed insights.
14+
15+
## How to Use Retina in the AKS VS Code Extension
16+
17+
1. Install the **Azure Kubernetes Service** extension in VS Code.
18+
2. Connect to an AKS cluster.
19+
3. Navigate to the **Retina Capture** feature.
20+
4. Capture and analyze workloads seamlessly within the VS Code environment.
21+
22+
For a detailed guide on using Retina in AKS, visit:
23+
[Retina Capture in AKS VS Code Extension](https://azure.github.io/vscode-aks-tools/features/retina-capture.html)
24+
File renamed without changes.
File renamed without changes.

site/docusaurus.config.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ const config = {
142142
items: [
143143
{
144144
label: "Contribute",
145-
href: "https://github.com/microsoft/retina/tree/main/docs/07-Contributing",
145+
href: "https://github.com/microsoft/retina/tree/main/docs/08-Contributing",
146146
},
147147
{
148148
label: "Github",

0 commit comments

Comments
 (0)