Skip to content
This repository has been archived by the owner on May 8, 2024. It is now read-only.

Commit

Permalink
basic spellchecking
Browse files Browse the repository at this point in the history
  • Loading branch information
@jtl-novatec
jtl-novatec committed Apr 16, 2024
1 parent 671745b commit 07c0b8a
Show file tree
Hide file tree
Showing 2 changed files with 63 additions and 69 deletions.
42 changes: 18 additions & 24 deletions tutorial/content/labs/introduction/_index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,49 +5,47 @@ weight = 1
+++

## How to use this lab
The entire lab consists of one git repo, which contains all necessary things to run it within different environments as independent of the underlying hardware as possible.
This repository consists of two main parts - the tutorial and the hands-on labs. In the tutorial everything you need to know on how to use OpenTelemetry for the labs will get explained. The labs give a hands-on experience on how to use OpenTelemetry in your applications.
The lab is housed in a single Git repository, which contains everything needed to run it across various environments.
Within this repository, you'll find two main sections: the tutorial and the hands-on labs.
The tutorial is a static website that explains key concepts and guides you through the practical exercises.
The hands-on labs provide interactive experiences to help you grasp how to integrate OpenTelemetry into your applications.
It's worth noting that these exercises focus on teaching concepts rather than replicating real-world deployment scenarios.

{{< figure src="images/lab_tutorial_setup.png" width=700 caption="Lab Architecture" >}}

The repository utilizes VS Code [Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers) to provide a consistent developer experience across platforms.



### Running the lab remotely

For running the lab in cloud based dev environment you can either use [GitHub Codespaces](https://codespaces.new/JenSeReal/otel-getting-started) or in [Gitpod](https://gitpod.io/#https://github.com/JenSeReal/otel-getting-started).

A requirement to run the lab remotely is a personal GitHub account. You can use this with either Codespaces or Gitpod.

With both options a VS Instance in your browser will be opened automatically and you are immediately ready to go.
To run the lab in a cloud-based development environment, you have two options: [GitHub Codespaces](https://codespaces.new/JenSeReal/otel-getting-started) or [Gitpod](https://gitpod.io/#https://github.com/JenSeReal/otel-getting-started).
To utilize either option, you'll need a personal GitHub account.
In both cases, a VSCode Instance in your browser will be opened automatically and you are immediately ready to go.

### Running the lab locally

In order to run the lab on your machine you need a local [Docker](https://docs.docker.com/engine/install/), [VS Code](https://code.visualstudio.com/download) and the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)

When using this repo with a locally installed VS Code instance you will be greeted by a prompt in the bottom right corner.
To run the lab on your local machine, you'll need to have [Docker](https://docs.docker.com/engine/install/), [VS Code](https://code.visualstudio.com/download), and the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) installed.
When you open this repository with a locally installed VS Code instance, you'll see a prompt in the bottom right corner.
![Prompt to open the repo inside a Dev container](images/prompt.png)

Press `Reopen in Container` to allow VS Code to use the [devcontainer.json](.devcontainer.json) specification to set up the IDE. If you missed the prompt hit <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> (on Mac <kbd>Command</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd>) and type `Dev Containers: Rebuild and Reopen in Container`.
Press `Reopen in Container` to allow VS Code to use the [devcontainer.json](.devcontainer.json) specification to set up the IDE. If you missed the prompt, hit <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> (on Mac <kbd>Command</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd>) and type `Dev Containers: Rebuild and Reopen in Container`.

After that the [devcontainer spec](.devcontainer.json) will run the [docker-compose.yml](docker-compose.yml) and pull all needed dependencies and build the [Docker Image](Dockerfile) for the application in which we will work on the lab content. To pull all Images and build all containers can take a second, so be patient.
Once you do that, the [devcontainer spec](https://chat.openai.com/c/.devcontainer.json) will execute the [docker-compose.yml](https://chat.openai.com/c/docker-compose.yml) and pull all necessary dependencies, building the [Docker Image](https://chat.openai.com/c/Dockerfile) for the application you'll be working on in the lab. This process might take a moment, so please be patient.
If the terminal is not visible, you can open it under `View/Terminal`.

If the terminal is not visible open it under `View/Terminal`
![Open the terminal](images/open-terminal.png)

When you run an application that exposes a port, VS Code will notify you that it is accessible. To open the application just click `Open in Browser` or open your Browser manually and type the URL yourself.
When you run an application that exposes a port, VS Code will notify you that it is accessible.
To open the application, just click `Open in Browser` or open your Browser manually and type the URL yourself.
![Open the browser](images/open-port.png)

When you missed the prompt you can see the open ports in the `PORTS` tab.
![Where to find the forwarded ports](images/ports.png)

## Important differences between local and remote way of running the lab

Even though the experience with using a local or browser based VS Code is fairly similar, one thing you need to take care of is the variation in hostnames and ports.
Whereas on a local environment you can use the combination of `localhost` and the corresponding port. In a remote environment this will not work when trying to access endpoints via a browser.
Even though the experience with using a local or browser-based VS Code is fairly similar, one thing you need to take care of is the variation in hostnames and ports. In a local environment, you can use the combination of `localhost` and the corresponding port. In a remote environment, this will not work when trying to access endpoints via a browser.

This is the ports tab of local VS Code environment:
This is the ports tab of a local VS Code environment:

![VS Code ports](images/vscode_ports.png)

Expand All @@ -59,8 +57,4 @@ This is the ports tab of a GitHub Codespaces environment:

![Gitpod ports](images/gitpod_ports.png)

Here you can see that they look almost identical. In some case you might have to hover over the address to reveal a link, sometime




You can see that they look almost identical. In some cases, you might have to hover over the address to reveal a link.
Loading

0 comments on commit 07c0b8a

Please sign in to comment.