Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs update #1557

Open
wants to merge 18 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/instrumentations/golang/golang.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ Odigos uses the official [opentelemetry-go-instrumentation](https://github.com/o

- Go runtime versions **1.17** and above are supported.

<Info>
Odigos enterprise data collection is done using eBPF, so Odigos requires, at minimum, platforms that have underlying Linux kernel versions of 5.4.0.
</Info>

## Traces

Odigos will automatically instrument your golang services to record and collect spans for distributed tracing, by utilizing the OpenTelemetry go official auto Instrumentation Libraries.
Expand Down
4 changes: 4 additions & 0 deletions docs/instrumentations/java/ebpf.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ The following JVM runtimes are continuously tested and verified:
| Azul Zulu | 11 |
| Azul Zulu | 17 |

<Info>
Odigos enterprise data collection is done using eBPF, so Odigos requires, at minimum, platforms that have underlying Linux kernel versions of 5.4.0.
</Info>

## Instrumentation Libraries

The following packages will be auto instrumented by Odigos:
Expand Down
1 change: 1 addition & 0 deletions docs/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@
{
"group": "Quickstart",
"pages": [
"quickstart/prerequisites",
"quickstart/introduction",
"quickstart/installation",
"quickstart/building-a-pipeline",
Expand Down
34 changes: 32 additions & 2 deletions docs/quickstart/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,38 @@ is a single binary that can be installed on any Linux, MacOS or Windows machine.
```
</Tab>
<Tab title="GitHub Releases">
Download the latest release from the [GitHub Releases](https://github.com/odigos-io/odigos/releases)
page and extract the binary to a directory in your `PATH`.
1. Download the Latest Version: Head over to the [Odigos GitHub Releases](https://github.com/odigos-io/odigos/releases) page and click on the latest version available. You’ll see a list of files—choose the one that matches your operating system (Windows, macOS, or Linux).

2. Extract the Downloaded File: Once the file is downloaded, it will likely be in a compressed format like `.zip` or `.tar.gz`. To use the program, you’ll first need to extract (or unzip) it. Right-click on the file and select "Extract Here" or use a similar option, depending on your operating system.

3. Move the File to a Folder in Your `PATH`. You’ll need to move this file to a folder where your computer looks for programs, known as your "PATH".

- For Windows: Move the extracted file to a folder like `C:\Windows\System32` or any folder listed in your system’s PATH. You can find out where by typing echo `%PATH%` in Command Prompt.

- For macOS/Linux: Move the file to a folder like `/usr/local/bin/` or `/usr/bin/`, both of which are common folders included in the PATH. You can check your PATH by opening the terminal and typing `echo $PATH`.

4. Verify It’s Working: Once the file is in the correct folder, open a terminal or command prompt and type the name of the program (e.g., odigos). If it runs, you’ve successfully installed it! If not, double-check that you moved the file to a folder included in your PATH.
</Tab>
<Tab title="Windows">
1. Download the Latest Version: Go to the [Odigos GitHub Releases](https://github.com/odigos-io/odigos/releases) page. Look for the latest version and download the file that matches your system (typically, this will be a `.zip` file for Windows).

2. Extract the Downloaded File: Once the download is complete, locate the `.zip` file in your Downloads folder. Right-click on it and choose "Extract All." Select a location on your computer where you'd like to save the extracted files.

3. Move the Binary to a Folder in Your PATH: Windows has specific folders where it looks for programs to run, called the "PATH". To make Odigos work from anywhere on your system, you’ll need to move the program (binary) into one of these folders. Here’s how:

- **Option 1**:
Move the file to a folder already in the PATH, such as `C:\Windows\System32`. Simply drag the extracted file (often named something like `odigos.exe`) into that folder.

- **Option 2**:
Add the folder containing the extracted binary to your PATH manually:
1. Right-click the **Start** button and select **System**.
2. Click **Advanced system settings** on the left.
3. In the **System Properties** window, click **Environment Variables** at the bottom.
4. In the **System Variables** section, scroll down and find the variable named `Path`. Select it and click **Edit**.
5. In the **Edit Environment Variables** window, click **New**, and then add the folder where you saved the extracted file.
6. Click **OK** to close all windows.

4. Verify Installation: Open the **Command Prompt** by searching for `cmd` in the Start menu. Type the name of the program, like `odigos.exe`, and press Enter. If the program runs, then you’ve successfully installed it. If it doesn’t, double-check that you either moved the file to a folder in your PATH or correctly added the folder where the file is located.

</Tab>
</Tabs>
Expand Down
239 changes: 239 additions & 0 deletions docs/quickstart/prerequisites.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,239 @@
---
title: "Prerequisites"
sidebarTitle: "Prerequisites"
---

This guide is perfect for you if:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"This guide" is only for the "Prerequisites" page, right?
As this will be the first page of the "quickstart", I think many people might think that this refer to the quickstart itself and might skip it


* You're new to tech tools but curious about ways to understand how your computer systems work. Maybe you've heard about "observability" and want to see what it's all about, without getting lost in technical jargon.
* You're a software developer or work in IT, and while you're comfortable with computers, you're new to Odigos. You're looking for a clear, step-by-step guide that doesn't assume you're already an expert.
* You're simply interested in Odigos and want to give it a try. This guide will walk you through the process without assuming any prior knowledge.
Comment on lines +8 to +10
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think most of the people that will read our docs do not belong to these categories
should we suggest them to jump to the next step without needing to read all this text?


Before installing Odigos, you need to set up some tools on your computer. These are one-time installations that prepare your computer for running Odigos.
You will only need to install these tools once on your computer. Next time you want to run the demo, you can skip this step and go directly to the next one.


<Tabs>
<Tab title="Mac OS">

<Warning>
Please avoid using Docker Desktop built-in Kubernetes cluster as it [does not](https://docs.docker.com/storage/bind-mounts/#configure-bind-propagation) support bind propagation.
</Warning>

1. Install Homebrew

Homebrew is a package manager for macOS that simplifies the installation of software packages. We will use Homebrew to install Docker Desktop, KinD (Kubernetes in Docker), and the odigos CLI.

a. Locate and open the Terminal application:

- Click on the magnifying glass icon (🔍) in the top right corner of your screen.
- Type "Terminal" into the search bar that appears.
- Click on the Terminal application icon (it looks like a black box with a command prompt ">_").

b. When the Terminal window opens, you'll see a prompt where you can type commands. It might look something like this:

```
YourComputerName:~ YourUsername$
```

c. Check if Homebrew is Installed

```
brew --version
```

If you see a version number being displayed, Homebrew is already installed and you can skip to the next step. If not, you will need to install Homebrew:


d. Copy the following command (you can select it with your mouse and use Command+C to copy):

```
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
```

e. Paste this command into the Terminal (use Command+V to paste) and press the `Enter` key.

f. The Terminal will start showing some text as it runs the command. This is normal.

g. At some point, you may be asked to enter your computer's password. When you type your password, you won't see any characters appear – this is a security feature. Just type your password and press `Enter`.

h. The installation may take several minutes. You'll know it's done when you see the command prompt again (like in step b).

i. After the installation is complete, close the Terminal window by clicking the red circle in the top left corner.

k. Open a new Terminal window (repeat step a) to ensure the installation takes effect.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

as brew is not in the system PATH, I think this is not expected to work.

The brew installation script will add instructions on how to add it to PATH at the end of the script


#### 2. Install Docker Desktop

Docker Desktop creates a special environment on your computer where Odigos can run.

a. In the new Terminal window, copy and paste the following command, then press `Enter`:

```
brew install --cask docker
```

b. Wait for the installation to complete. You'll know it's done when you see the command prompt again.

c. Once the installation is complete, you need to open Docker Desktop:

- Click on the magnifying glass icon (🔍) in the top right corner of your screen.
- Type "Docker" into the search bar.
- Click on the Docker application icon (it looks like a whale carrying boxes).

d. When Docker starts for the first time, you may see a box asking for your computer's password. Enter your password and click `OK`.

e. You may see a welcome screen or tutorial from Docker. You can close this or click through it.
Comment on lines +84 to +86
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it might request to create an account and login when it's the first time


f. Wait until you see a green dot next to "Docker Desktop is running" in the Docker Dashboard.

#### 3. Install KinD

KinD (Kubernetes in Docker) helps set up a test environment for Odigos.

a. Go back to your Terminal window (or open a new one if you closed it).

b. Copy and paste the following command, then press `Enter`:

```
brew install kind
```

c. Wait for the installation to complete. You'll know it's done when you see the command prompt again.

### Installing Odigos
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is under quickstart/prerequisites but these steps are covered in the next pages.


#### 1. Set up a test environment

a. In the Terminal, copy and paste the following command and press `Enter`:

```
kind delete cluster --name odigos-demo
```

This removes any existing test environment with the same name. If this is your first time, you'll see a message saying the cluster doesn't exist, which is fine.

b. Now, copy and paste this command and press `Enter`:

```
kind create cluster --name odigos-demo
```

This creates a new test environment.

c. You'll see a lot of text appear in the Terminal. This is normal. Wait until you see a message that says "Your Kubernetes control-plane has initialized successfully!" and the command prompt appears again.

#### 2. Install the Odigos CLI tool

The Odigos CLI (Command Line Interface) tool allows you to manage Odigos from the Terminal.

a. In the Terminal, copy and paste the following command and press `Enter`:

```
brew install odigos-io/homebrew-odigos-cli/odigos
```

b. Wait for the installation to complete. You'll know it's done when you see the command prompt again.

#### 3. Install Odigos in your test environment

a. In the Terminal, copy and paste the following command and press `Enter`:

```
odigos install
```

b. This step may take several minutes. You'll see a lot of text appear in the Terminal – this is normal.

c. You'll know it's done when you see a message saying "SUCCESS: Odigos installed." and the command prompt appears again.

#### 4. Open the Odigos control panel

a. In the Terminal, copy and paste the following command and press `Enter`:

```
odigos ui
```

After you run this command, the Terminal will look like it's frozen. This is normal – it's running a program in the background.

b. Open your web browser (like Safari or Chrome).

c. In the address bar at the top of the browser window, type exactly this:

```
http://localhost:3000
```

Then press `Enter`.

d. The Odigos control panel should now open in your browser. It might take a few seconds to load.

#### 5. Set up Odigos

a. In the Odigos control panel, you'll see a page titled "Select Sources". Sources are the things Odigos can monitor.

b. Click the checkbox next to each Source you want to monitor. If you're not sure, you can select all of them.

c. Click the blue "Next" button at the bottom right of the page.

d. You'll now see a page titled "Add Destinations". Destinations are places where Odigos can send its information.

e. Click on one of the destination options (for example, "Jaeger").

f. Fill in any required information. If you're not sure what to enter, consult the Odigos documentation or ask for help.

g. Click the blue "Create Destination" button.

h. You should now see an overview page showing your selected Sources and Destinations.

Congratulations! You've now installed and set up Odigos on your Mac.

</Tab>

<Tab title="Linux">

**Docker**: Creates a space on your computer where Odigos can run.
- Open a terminal window.
- Copy and paste these commands, pressing `Enter` after each:
```
sudo apt-get update
sudo apt-get install docker.io
sudo systemctl start docker
sudo systemctl enable docker
```

**KinD**: Helps set up a test environment for Odigos.
- In the terminal, copy and paste these commands, pressing `Enter` after each:
```
curl -Lo ./kind https://kind.sigs.k8s.io/dl/v0.11.1/kind-linux-amd64
chmod +x ./kind
sudo mv ./kind /usr/local/bin/kind
```
</Tab>


<Tab title="Windows">
**Docker Desktop**: Creates a space on your computer where Odigos can run.
- Download Docker Desktop from the [official website](https://www.docker.com/products/docker-desktop).
- Run the installer and follow the on-screen instructions.
- Once installed, start Docker Desktop from the Start menu.

**Windows Subsystem for Linux (WSL)**: Allows you to run Linux tools on Windows.
- Open PowerShell as Administrator (right-click on PowerShell in the Start menu and select "Run as administrator").
- Type this command and press `Enter`:
```
wsl --install
```
- Restart your computer when prompted.

**KinD**: Helps set up a test environment for Odigos.
- Open PowerShell.
- Type these commands and press `Enter` after each:
```
curl.exe -Lo kind-windows-amd64.exe https://kind.sigs.k8s.io/dl/v0.11.1/kind-windows-amd64
move kind-windows-amd64.exe C:\Windows\system32\kind.exe
```
</Tab>
</Tabs>

38 changes: 36 additions & 2 deletions docs/setup/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ There are 2 ways to install odigos in your kubernetes cluster:
Both install methods will deploy and configure resources in the active Kubernetes cluster as per the current context.
Before proceeding with the installation, ensure that you are targeting the correct cluster with `kubectl config current-context`.

<Info>
Odigos enterprise data collection is done using eBPF, so Odigos requires, at minimum, platforms that have underlying Linux kernel versions of 5.4.0.
</Info>

## Odigos CLI

### Install the CLI
Expand All @@ -29,8 +33,38 @@ Before proceeding with the installation, ensure that you are targeting the corre
```
</Tab>
<Tab title="GitHub Releases">
Download the latest release from the [GitHub Releases](https://github.com/odigos-io/odigos/releases)
page and extract the binary to a directory in your `PATH`.
1. Download the Latest Version: Head over to the [Odigos GitHub Releases](https://github.com/odigos-io/odigos/releases) page and click on the latest version available. You’ll see a list of files—choose the one that matches your operating system (Windows, macOS, or Linux).

2. Extract the Downloaded File: Once the file is downloaded, it will likely be in a compressed format like `.zip` or `.tar.gz`. To use the program, you’ll first need to extract (or unzip) it. Right-click on the file and select "Extract Here" or use a similar option, depending on your operating system.

3. Move the File to a Folder in Your `PATH`. You’ll need to move this file to a folder where your computer looks for programs, known as your "PATH".

- For Windows: Move the extracted file to a folder like `C:\Windows\System32` or any folder listed in your system’s PATH. You can find out where by typing echo `%PATH%` in Command Prompt.

- For macOS/Linux: Move the file to a folder like `/usr/local/bin/` or `/usr/bin/`, both of which are common folders included in the PATH. You can check your PATH by opening the terminal and typing `echo $PATH`.

4. Verify It’s Working: Once the file is in the correct folder, open a terminal or command prompt and type the name of the program (e.g., odigos). If it runs, you’ve successfully installed it! If not, double-check that you moved the file to a folder included in your PATH.
</Tab>
<Tab title="Windows">
1. Download the Latest Version: Go to the [Odigos GitHub Releases](https://github.com/odigos-io/odigos/releases) page. Look for the latest version and download the file that matches your system (typically, this will be a `.zip` file for Windows).

2. Extract the Downloaded File: Once the download is complete, locate the `.zip` file in your Downloads folder. Right-click on it and choose "Extract All." Select a location on your computer where you'd like to save the extracted files.

3. Move the Binary to a Folder in Your PATH: Windows has specific folders where it looks for programs to run, called the "PATH". To make Odigos work from anywhere on your system, you’ll need to move the program (binary) into one of these folders. Here’s how:

- **Option 1**:
Move the file to a folder already in the PATH, such as `C:\Windows\System32`. Simply drag the extracted file (often named something like `odigos.exe`) into that folder.

- **Option 2**:
Add the folder containing the extracted binary to your PATH manually:
1. Right-click the **Start** button and select **System**.
2. Click **Advanced system settings** on the left.
3. In the **System Properties** window, click **Environment Variables** at the bottom.
4. In the **System Variables** section, scroll down and find the variable named `Path`. Select it and click **Edit**.
5. In the **Edit Environment Variables** window, click **New**, and then add the folder where you saved the extracted file.
6. Click **OK** to close all windows.

4. Verify Installation: Open the **Command Prompt** by searching for `cmd` in the Start menu. Type the name of the program, like `odigos.exe`, and press Enter. If the program runs, then you’ve successfully installed it. If it doesn’t, double-check that you either moved the file to a folder in your PATH or correctly added the folder where the file is located.

</Tab>
</Tabs>
Expand Down
Loading
Loading