Skip to content

Create overview.mdx - #864

Open
lavanya-gunreddi wants to merge 11 commits into
mainfrom
lg-hybrid-cloud
Open

lavanya-gunreddi wants to merge 11 commits into
mainfrom
lg-hybrid-cloud

Conversation

@lavanya-gunreddi

Copy link
Copy Markdown
Contributor

No description provided.

@mintlify

mintlify Bot commented Sep 28, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
runpod-docs 🟢 Ready View Preview Oct 19, 2026, 7:07 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

@prestwick prestwick left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Handful of suggested changes and nitpicks.

Comment thread hybrid-cloud/deploy.mdx Outdated
In the GPU picker, find the **External compute** section. It lists the GPU types available on your organization's online machines. Select the GPU you want.
</Step>
<Step title="Configure and deploy">
Configure the rest of the Pod the way you normally would, including the template, storage, and environment variables. Then click **Deploy**.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Is there a doc with the workflow we reference that can be linked here?

Comment thread hybrid-cloud/deploy.mdx Outdated

## How placement works

When you deploy on external compute, Runpod places the Pod on one of your organization's online machines that matches the GPU you selected. Pods deployed on your machines stay within your organization. Other Runpod customers can't deploy on them.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Suggested change
When you deploy on external compute, Runpod places the Pod on one of your organization's online machines that matches the GPU you selected. Pods deployed on your machines stay within your organization. Other Runpod customers can't deploy on them.
When you deploy on external compute, Runpod places the Pod on one of your organization's online machines that matches the GPU you selected. Pods deployed on your machines stay within your organization. Other Runpod customers can't deploy to them.

Comment thread hybrid-cloud/overview.mdx
Comment thread hybrid-cloud/overview.mdx Outdated
Comment thread hybrid-cloud/overview.mdx Outdated
Comment thread hybrid-cloud/setup.mdx
Comment thread hybrid-cloud/setup.mdx Outdated
In the Runpod console, go to **Resources → External compute** and click **Add compute**.
</Step>
<Step title="Describe the machine">
Select your machine type, such as an on-prem server, enter a name for the machine, and click **Next**.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

In my testing there was some limitation on the hostnames we could give the machines. Our generated hostnames use underscores by default, and I had to change those to hyphens to get things working. I'm going to escalate this to Mike and Audry, but this may require some mention.

From https://man7.org/linux/man-pages/man7/hostname.7.html

Each element of the hostname must be from 1 to 63 characters long
and the entire hostname, including the dots, can be at most 253
characters long. Valid characters for hostnames are ASCII(7)
letters from a to z, the digits from 0 to 9, and the hyphen (-).
A hostname may not start nor end with a hyphen.

Comment thread hybrid-cloud/setup.mdx Outdated
Comment thread hybrid-cloud/setup.mdx

This page covers the most common problems when you connect and use external compute, and what to do about each.

## Verification failed

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

There is also a "verification timed out" state. When I was testing this was because sshd wasn't listening on all interfaces and therefore Nebula the Runpod control plane couldn't make an SSH connection to the machine. This likely could be generalized as the machine couldn't complete the network connection to the control plane.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Added a “Verification timed out” section, written generally as Runpod not being able to reach the machine, with the sshd fix as the first step. Also added it to the status table on the setup page.

Comment thread hybrid-cloud/overview.mdx Outdated

## Requirements

Runpod Hybrid Cloud is available to organizations only. The Runpod team must enable External Compute for your org account before the feature appears in your console. [Contact us](https://www.runpod.io/everywhere) to get set up.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

the term 'external compute' is being debated and might be changed, fyi. TBD if it changes to 'private compute'.

Comment thread hybrid-cloud/overview.mdx
## How it works

<Steps>
<Step title="Add your machine">

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

'machine' vs 'compute

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Let's use compute. Lines up better with the planned terminology changes.

Comment thread hybrid-cloud/overview.mdx
<Step title="Add your machine">
In the console, go to **Resources → External compute** and click **Add compute**. Select your machine type (on-prem server, AWS EC2 instance, or any cloud VM), give it a name, and click **Next**.
</Step>
<Step title="Install the host agent">

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

will need to align on how to refer to "host agent". i think we might refer to it as "Runpod agent" preferrably, but let's get a decision memorialized then we can mass update. @prestwick

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Current recommendation is Host connector.

Comment thread hybrid-cloud/overview.mdx Outdated
In the console, go to **Resources → External compute** and click **Add compute**. Select your machine type (on-prem server, AWS EC2 instance, or any cloud VM), give it a name, and click **Next**.
</Step>
<Step title="Install the host agent">
Copy the install command that appears and paste it into an SSH session on your machine. This installs the Runpod host agent, a small program that connects your machine to Runpod over an outbound-only encrypted connection. No inbound ports are opened. Set your public and private IPs, open the required firewall ports, then reboot. For full instructions, see [Set up external compute](/hybrid-cloud/setup).

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

'machine' vs 'compute'

Comment thread hybrid-cloud/setup.mdx
Comment thread hybrid-cloud/setup.mdx

- An [organization](/organizations/orgs-overview) with external compute enabled. During alpha, the Runpod team enables this for you.
- An organization role that allows you to add compute. See [Roles](/organizations/org-roles).
- A single machine with at least one GPU. Multi-node machines connected by InfiniBand or a similar fabric aren't supported yet.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

@maltmanRP you good with this language? thinking we could leave it more open ended like "talk to runpod" if they need multinode usecase.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

I like this phrasing. Customer feedback on this will help with prioritization.

2. Check that the machine can make outbound connections to the internet.
3. Confirm that you rebooted the machine after you configured networking.

## Machine stuck in verification in progress

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

fyi @prestwick it will timeout after 15 min and retry once, then if that fails again, will end in Verification failed state. don't know if we need to expose all the nitty gritty but we have sweepers and retries that will make sure these land in some terminal state after ~30 minutes.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Good to know. Maybe we state here that verification should complete within 30 minutes. Otherwise contact support.

Comment thread hybrid-cloud/deploy.mdx
- At least one machine with the **Online** status. See [Set up external compute](/hybrid-cloud/setup).
- Membership in the organization that owns the machine, with permission to deploy Pods. See [Roles](/organizations/org-roles).

## Deploy a Pod

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

also supported in serverless

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

The completeness of the setup workflows for serverless are mixed at the moment. For example the quick deploy and deploy from hub options currently lack the External compute option.

Comment thread hybrid-cloud/setup.mdx
| Docker disk | A dedicated disk of at least 600 GB. |
| Disk throughput | At least 150 MB/s. |
| Outbound network | All TCP, UDP 4242 (Runpod control plane), UDP 53 (DNS), UDP 123 (time sync), and ICMP echo. |
| Inbound network | TCP 10000–60000. |

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Suggested change
| Inbound network | TCP 10000–60000. |
| Inbound network | TCP 10000 and 20000. |

Apologies my original guidance was incorrect. I've validated we don't need this large range. Only these two ports are checked during verification.

2. Check that the machine can make outbound connections to the internet.
3. Confirm that you rebooted the machine after you configured networking.

## Machine stuck in verification in progress

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Good to know. Maybe we state here that verification should complete within 30 minutes. Otherwise contact support.

Comment thread hybrid-cloud/deploy.mdx
- At least one machine with the **Online** status. See [Set up external compute](/hybrid-cloud/setup).
- Membership in the organization that owns the machine, with permission to deploy Pods. See [Roles](/organizations/org-roles).

## Deploy a Pod

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

The completeness of the setup workflows for serverless are mixed at the moment. For example the quick deploy and deploy from hub options currently lack the External compute option.

Comment thread hybrid-cloud/overview.mdx

## Get started

Runpod Hybrid Cloud is available to early customers, and the Runpod team works with you directly to set up your machines. [Request a demo](https://www.runpod.io/hybrid-cloud) to get started.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Maybe nitpick, I feel this "early customers" reads a little bit wierd.

How about "Runpod Hybrid Cloud is in alpha and available to select customers, ..."?

This branch was successfully deployed

1 active deployment
staging — 80bdc381 Deployed Oct 19, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants