Skip to content

Update sidebar styles #231

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

Merged
merged 10 commits into from
Apr 22, 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
2 changes: 1 addition & 1 deletion docs/fine-tune/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Fine Tune a model
title: Fine-tune a model
description: "Learn how to Fine Tune a model using Axolotl"
sidebar_position: 1
---
Expand Down
22 changes: 10 additions & 12 deletions docs/overview.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Overview
title: Introduction
description: "RunPod is a cloud computing platform for AI, machine learning, and general compute, offering GPU and CPU resources, serverless computing, and a Command Line Interface for easy deployment and development."
sidebar_position: 1
---
Expand Down Expand Up @@ -27,28 +27,26 @@ Use Serverless to:
- Build and expose **REST API endpoints** with autoscaling.
- Queue jobs efficiently **without managing infrastructure**.

### Get started with Serverless
Get started with Serverless:

- [Build your first Serverless app](/serverless/get-started)
- [Run any LLM as an endpoint using vLLM workers](/serverless/vllm/get-started)
- [Tutorial: Create a Serverless endpoint with Stable Diffusion](/tutorials/serverless/gpu/run-your-first)
- [Build your first Serverless app.](/serverless/get-started)
- [Run any LLM as an endpoint using vLLM workers.](/serverless/vllm/get-started)
- [Tutorial: Create a Serverless endpoint with Stable Diffusion.](/tutorials/serverless/gpu/run-your-first)

## Pods

[Pods](/pods/overview) allow you to run **containerized workloads** on dedicated GPU or CPU instances.

RunPod offers two types of Pods:
RunPod offers [two types of Pods](/references/faq/#secure-cloud-vs-community-cloud).

- **Secure Cloud:** Operates in T3/T4 data centers, providing high reliability and security.
- **Community Cloud**: Connects individual compute providers to users through a vetted, secure peer-to-peer system.

For more info, see [Secure Cloud vs. Community Cloud](/references/faq/#secure-cloud-vs-community-cloud).
Get started with Pods:

### Get started with Pods

- [Deploy your first Pod](/get-started)
- [Choose the right Pod](/pods/choose-a-pod)
- [Tutorial: Connect to a Pod instance with VSCode](/tutorials/pods/connect-to-vscode)
- [Deploy your first Pod.](/get-started)
- [Choose the right Pod.](/pods/choose-a-pod)
- [Tutorial: Connect to a Pod instance with VSCode.](/tutorials/pods/connect-to-vscode)

## RunPod CLI

Expand Down
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/serverless/endpoints/_category_.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
"position": 6,
"link": {
"type": "generated-index",
"description": "Learn how to customize the serverless functions used by in your applications."
"description": "Learn how to customize the Serverless endpoints used by your applications."
}
}
117 changes: 117 additions & 0 deletions docs/tutorials/introduction/containers/containers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
---
title: Intro to containers
sidebar_position: 2
description: "Discover the world of containerization with Docker, a platform for isolated environments that package applications, frameworks, and libraries into self-contained containers for consistent and reliable deployment across diverse computing environments."
---

## What are containers?

> A container is an isolated environment for your code. This means that a container has no knowledge of your operating system, or your files. It runs on the environment provided to you by Docker Desktop. Containers have everything that your code needs in order to run, down to a base operating system.

[From Docker's website](https://docs.docker.com/guides/walkthroughs/what-is-a-container/#:~:text=A%20container%20is%20an%20isolated,to%20a%20base%20operating%20system)

Developers package their applications, frameworks, and libraries into a Docker container. Then, those containers can run outside their development environment.

### Why use containers?

> Build, ship, and run anywhere.

Containers are self-contained and run anywhere Docker runs. This means you can run a container on-premises or in the cloud, as well as in hybrid environments.
Containers include both the application and any dependencies, such as libraries and frameworks, configuration data, and certificates needed to run your application.

In cloud computing, you get the best cold start times with containers.

## What are images?

Docker images are fixed templates for creating containers. They ensure that applications operate consistently and reliably across different environments, which is vital for modern software development.

To create Docker images, you use a process known as "Docker build." This process uses a Dockerfile, a text document containing a sequence of commands, as instructions guiding Docker on how to build the image.

### Why use images?

Using Docker images helps in various stages of software development, including testing, development, and deployment. Images ensure a seamless workflow across diverse computing environments.

### Why not use images?

You must rebuild and push the container image, then edit your endpoint to use the new image each time you iterate on your code. Since development requires changing your code every time you need to troubleshoot a problem or add a feature, this workflow can be inconvenient.

For a streamlined development workflow, check out [RunPod projects](/docs/runpodctl/projects/overview.md). When you're done with development, you can create a Dockerfile from your project to reduce initialization overhead in production.

### What is Docker Hub?

After their creation, Docker images are stored in a registry, such as Docker Hub.
From these registries, you can download images and use them to generate containers, which make it easy to widely distribute and deploy applications.

Now that you've got an understanding of Docker, containers, images, and whether containerization is right for you, let's move on to installing Docker.

## Installing Docker

For this walkthrough, install Docker Desktop.
Docker Desktop bundles a variety of tools including:

- Docker GUI
- Docker CLI
- Docker extensions
- Docker Compose

The majority of this walkthrough uses the Docker CLI, but feel free to use the GUI if you prefer.

For the best installation experience, see Docker's [official documentation](https://docs.docker.com/get-docker/).

### Running your first command

Now that you've installed Docker, open a terminal window and run the following command:

```command
docker version
```

You should see something similar to the following output.

```text
docker version
Client: Docker Engine - Community
Version: 24.0.7
API version: 1.43
Go version: go1.21.3
Git commit: afdd53b4e3
Built: Thu Oct 26 07:06:42 2023
OS/Arch: darwin/arm64
Context: desktop-linux

Server: Docker Desktop 4.26.1 (131620)
Engine:
Version: 24.0.7
API version: 1.43 (minimum version 1.12)
Go version: go1.20.10
Git commit: 311b9ff
Built: Thu Oct 26 09:08:15 2023
OS/Arch: linux/arm64
Experimental: false
containerd:
Version: 1.6.25
GitCommit: abcd
runc:
Version: 1.1.10
GitCommit: v1.1.10-0-g18a0cb0
docker-init:
Version: 0.19.0
```

If at any point you need help with a command, you can use the `--help` flag to see documentation on the command you're running.

```command
docker --help
```

Let's run `busybox` from the command line to print out today's date.

```command
docker run busybox sh -c 'echo "The time is: $(date)"'
# The time is: Thu Jan 11 06:35:39 UTC 2024
```

- `busybox` is a lightweight Docker image with the bare minimum Linux utilities installed, including `echo`
- The `echo` command prints the container's uptime.

You've successfully installed Docker and run your first commands.
119 changes: 8 additions & 111 deletions docs/tutorials/introduction/containers/overview.md
Original file line number Diff line number Diff line change
@@ -1,117 +1,14 @@
---
title: Containers overview
title: Overview
sidebar_position: 1
description: "Discover the world of containerization with Docker, a platform for isolated environments that package applications, frameworks, and libraries into self-contained containers for consistent and reliable deployment across diverse computing environments."
description: Learn how to build and deploy applications on the RunPod platform with this set of tutorials, covering tools, technologies, and deployment methods, including Containers, Docker, and Serverless implementation.
---

## What are containers?
This set of tutorials is meant to provide a deeper understanding of the tools that surround the RunPod platform.
These tutorials help you understand how to use the RunPod platform to build and deploy your applications.

> A container is an isolated environment for your code. This means that a container has no knowledge of your operating system, or your files. It runs on the environment provided to you by Docker Desktop. Containers have everything that your code needs in order to run, down to a base operating system.
While the documentation around the introduction section gives a holistic view and enough information to get started with RunPod, for more detailed information on the various of these tools or technologies, reach out to the source material.

[From Docker's website](https://docs.docker.com/guides/walkthroughs/what-is-a-container/#:~:text=A%20container%20is%20an%20isolated,to%20a%20base%20operating%20system)

Developers package their applications, frameworks, and libraries into a Docker container. Then, those containers can run outside their development environment.

### Why use containers?

> Build, ship, and run anywhere.

Containers are self-contained and run anywhere Docker runs. This means you can run a container on-premises or in the cloud, as well as in hybrid environments.
Containers include both the application and any dependencies, such as libraries and frameworks, configuration data, and certificates needed to run your application.

In cloud computing, you get the best cold start times with containers.

## What are images?

Docker images are fixed templates for creating containers. They ensure that applications operate consistently and reliably across different environments, which is vital for modern software development.

To create Docker images, you use a process known as "Docker build." This process uses a Dockerfile, a text document containing a sequence of commands, as instructions guiding Docker on how to build the image.

### Why use images?

Using Docker images helps in various stages of software development, including testing, development, and deployment. Images ensure a seamless workflow across diverse computing environments.

### Why not use images?

You must rebuild and push the container image, then edit your endpoint to use the new image each time you iterate on your code. Since development requires changing your code every time you need to troubleshoot a problem or add a feature, this workflow can be inconvenient.

For a streamlined development workflow, check out [RunPod projects](/docs/runpodctl/projects/overview.md). When you're done with development, you can create a Dockerfile from your project to reduce initialization overhead in production.

### What is Docker Hub?

After their creation, Docker images are stored in a registry, such as Docker Hub.
From these registries, you can download images and use them to generate containers, which make it easy to widely distribute and deploy applications.

Now that you've got an understanding of Docker, containers, images, and whether containerization is right for you, let's move on to installing Docker.

## Installing Docker

For this walkthrough, install Docker Desktop.
Docker Desktop bundles a variety of tools including:

- Docker GUI
- Docker CLI
- Docker extensions
- Docker Compose

The majority of this walkthrough uses the Docker CLI, but feel free to use the GUI if you prefer.

For the best installation experience, see Docker's [official documentation](https://docs.docker.com/get-docker/).

### Running your first command

Now that you've installed Docker, open a terminal window and run the following command:

```command
docker version
```

You should see something similar to the following output.

```text
docker version
Client: Docker Engine - Community
Version: 24.0.7
API version: 1.43
Go version: go1.21.3
Git commit: afdd53b4e3
Built: Thu Oct 26 07:06:42 2023
OS/Arch: darwin/arm64
Context: desktop-linux

Server: Docker Desktop 4.26.1 (131620)
Engine:
Version: 24.0.7
API version: 1.43 (minimum version 1.12)
Go version: go1.20.10
Git commit: 311b9ff
Built: Thu Oct 26 09:08:15 2023
OS/Arch: linux/arm64
Experimental: false
containerd:
Version: 1.6.25
GitCommit: abcd
runc:
Version: 1.1.10
GitCommit: v1.1.10-0-g18a0cb0
docker-init:
Version: 0.19.0
```

If at any point you need help with a command, you can use the `--help` flag to see documentation on the command you're running.

```command
docker --help
```

Let's run `busybox` from the command line to print out today's date.

```command
docker run busybox sh -c 'echo "The time is: $(date)"'
# The time is: Thu Jan 11 06:35:39 UTC 2024
```

- `busybox` is a lightweight Docker image with the bare minimum Linux utilities installed, including `echo`
- The `echo` command prints the container's uptime.

You've successfully installed Docker and run your first commands.
- If you are looking for an understanding of Containers and Docker, see [Container overview](/tutorials/introduction/containers).
- If you are looking to run your first Pod with RunPod, see [Run your first Fast Stable Diffusion with Jupyter Notebook](/tutorials/pods/run-your-first).
- For Serverless implementation, see [Run your first serverless endpoint with Stable Diffusion](/tutorials/serverless/gpu/run-your-first).
Loading