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

Minor updates for clarity #1601

Merged
merged 3 commits into from
Jan 28, 2025
Merged
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
10 changes: 5 additions & 5 deletions docs/pages/getting-started/install.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import CodeBlock from '@theme/CodeBlock';

In order to get started with DevPod, you can choose between the DevPod Desktop application and DevPod CLI.
To get started with DevPod, choose either the [DevPod Desktop](#install-devpod) application or the [DevPod CLI](#install-devpod-cli).

## Install DevPod

Expand All @@ -19,7 +19,7 @@ Download DevPod Desktop:
- [Linux Targz](https://github.com/loft-sh/devpod/releases/latest/download/DevPod_linux_x86_64.tar.gz)

:::info Previous Releases
For previous releases, please take a look at the [Github releases page](https://github.com/loft-sh/devpod/releases)
For earlier versions, visit the [GitHub releases page](https://github.com/loft-sh/devpod/releases)
:::

:::info Linux Packages
Expand All @@ -40,7 +40,7 @@ Make sure you have the following dependencies installed for the Appimage to work
- `sudo dnf install fuse fuse-libs libglvnd-egl libglvnd-opengl libglvnd-glx harfbuzz fontconfig fribidi libthai`
- `sudo zypper in fuse libfuse2 libharfbuzz0 libfribidi0 libthai0`

Note that these are generally needed for AppImage to work, they are not specific to DevPod
These are generally needed for AppImage to work; they are not specific to DevPod.
:::

:::info Windows Packages
Expand Down Expand Up @@ -71,9 +71,9 @@ correct functioning of the program:
- librust-glib-sys-dev
:::

## Optional: Install DevPod CLI
## Install DevPod CLI

DevPod CLI can be very useful to control DevPod from a terminal. Select one of the installation methods below. You can also install it later from within the Desktop App.
Alternatively, you can also use the CLI instead of the desktop application. The DevPod CLI is useful for managing DevPod directly from a terminal. Choose an installation method below, or install it later from the Desktop App."

<Tabs values={[
{label: 'MacOS Silicon/ARM', value: 'macarm64'},
Expand Down
21 changes: 12 additions & 9 deletions docs/pages/how-it-works/deploy-machines.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,21 @@ title: How it works using VMs
sidebar_label: Deploying machines
---

Machines to DevPod are the infrastructure that ultimately run your devcontainer. Some providers such as gcloud, aws, digitalocean are "machine" providers since
they first setup a VM to deploy you container to.

When DevPod starts a workspace, such as `devpod up`, DevPod uses the provider selected and starts your devcontainer. If using a machine provider, DevPod will check if it should create a VM first.
If so it uses your local environments credentials and the associated CLI tool, such as `aws` or `az` to create the infrastructure. Once started DevPod connects to the VM using the provider's specified tunnel, below
are some examples of providers and there secure tunnels.
In DevPod, machines are the infrastructure that run your devcontainer. Providers like GCP, AWS, and DigitalOcean are considered "machine" providers because they first set up a virtual machine (VM) to host your container.

When you start a workspace with DevPod, such as running `devpod up`, DevPod uses a selected provider and starts your devcontainer.
If the provider requires a virtual machine (VM), DevPod determines whether to create one. It uses your local environment's credentials and the corresponding CLI tool (e.g., `aws` for AWS or `az` for Azure) to set up the VM.
Once the VM is running, DevPod connects to it through the provider's secure tunnel. Below are examples of providers and their secure tunnels.

- AWS: [Instance Connect](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-connect-set-up.html)
- Google Cloud (GCP): [Cloud IAP (Identity-Aware Proxy)](https://cloud.google.com/security/products/iap)
- Azure: [Azure Bastion](https://learn.microsoft.com/en-us/azure/bastion/bastion-overview)

:::note
Alternatively, you can use [SSH tunneling](https://www.ssh.com/academy/ssh/tunneling-example) to connect to your machines, if supported by your setup.
:::

- AWS: Instance connect
- GCloud:
- Azure:

The dedvpod agent starts a SSH server using the STDIO of the secure tunnel in order for you local DevPod CLI/UI to forward ports over the SSH connection. Once this is done DevPod starts your local
IDE and connects it to the devcontainer via SSH.

Expand Down
6 changes: 3 additions & 3 deletions docs/pages/managing-machines/what-are-machines.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ title: What are Machines?
sidebar_label: What are Machines?
---

When using a [Machine Provider](../managing-providers/what-are-providers.mdx), providers will use machines (in the cloud provider case VMs) to host your workspace.
These VMs are the Machines managed by DevPod during the creation/deletion of a workspace.
A [Machine Provider](../managing-providers/what-are-providers.mdx) is responsible for provisioning machines to host your workspace.
For cloud providers, these machines are typically virtual machines (VMs). DevPod manages the lifecycle of these machines, including creation and deletion of a workspace.

If you want, you can directly manage all the machines in the various workspaces using:
You can directly manage all the machines in the various workspaces using:

```sh
devpod machine
Expand Down
Loading