Skip to content

Commit

Permalink
docs: Add vscode documentation in main retina repo. (#1326)
Browse files Browse the repository at this point in the history
### **Documentation: Retina Integration in AKS VS Code Extension**  

This PR adds documentation for the integration of **Retina** in the
**AKS VS Code Extension**. It provides an overview of how Retina
enhances the extension's capabilities, enabling seamless capture and
visualization of cluster telemetry. This PR should suffice:
#274

I am open to any suggestions as well please, the reason I moved
contribution down is because its a standard practices to keep that way,
thanks!

Additionally, it includes a reference to the official Retina feature
page: [Retina Capture in AKS VS Code
Extension](https://azure.github.io/vscode-aks-tools/features/retina-capture.html).

#### **Changes Included:**  

- Overview of Retina integration in the AKS VS Code Extension  
- Usage details and key benefits  
- Link to official documentation for further reference  

This update aims to improve discoverability and provide users with a
clear understanding of how to leverage Retina within their AKS
development workflow.

## Checklist

- [x] I have read the [contributing
documentation](https://retina.sh/docs/contributing).
- [x] I signed and signed-off the commits (`git commit -S -s ...`). See
[this
documentation](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification)
on signing commits.
- [x] I have correctly attributed the author(s) of the code.
- [x] I have tested the changes locally.
- [x] I have followed the project's style guidelines.
- [x] I have updated the documentation, if necessary.
- [ ] I have added tests, if applicable.

## Screenshots (if applicable) or Testing Completed

<img width="720" alt="Screenshot 2025-02-10 at 8 23 59 AM"
src="https://github.com/user-attachments/assets/da03dfec-d9c4-482a-8399-5c2ff50ede2c"
/>

<img width="1348" alt="Screenshot 2025-02-10 at 8 24 25 AM"
src="https://github.com/user-attachments/assets/daffae21-c47e-4d24-881f-fac56634bb15"
/>
  • Loading branch information
Tatsinnit authored Feb 10, 2025
1 parent f0b5ae5 commit 819a9ee
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/01-Introduction/02-architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ To collect this data, Retina observes and hooks on to system events within the k

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

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.
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.

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).

Expand Down
23 changes: 23 additions & 0 deletions docs/07-Consumingtools/vscode.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Retina Integration in AKS VS Code Extension

## Overview

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.

## Integration Details

The AKS VS Code extension incorporates Retina to enhance cluster observability by capturing snapshots of workloads, logs, and events in real time. Users can:

- Capture workload snapshots directly within VS Code.
- Analyze Kubernetes resources and identify issues.
- Improve troubleshooting efficiency with detailed insights.

## How to Use Retina in the AKS VS Code Extension

1. Install the **[Azure Kubernetes Service](https://marketplace.visualstudio.com/items?itemName=ms-kubernetes-tools.vscode-aks-tools)** extension in VS Code.
2. Connect to an AKS cluster.
3. Navigate to the **Retina Capture** feature.
4. Capture and analyze workloads seamlessly within the VS Code environment.

For a detailed guide on using Retina in AKS, visit:
[Retina Capture in AKS VS Code Extension](https://azure.github.io/vscode-aks-tools/features/retina-capture.html)
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion site/docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ const config = {
items: [
{
label: "Contribute",
href: "https://github.com/microsoft/retina/tree/main/docs/07-Contributing",
href: "https://github.com/microsoft/retina/tree/main/docs/08-Contributing",
},
{
label: "Github",
Expand Down

0 comments on commit 819a9ee

Please sign in to comment.