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

First rough draft of BYOC docs #4126

Draft
wants to merge 14 commits into
base: main
Choose a base branch
from
Draft

First rough draft of BYOC docs #4126

wants to merge 14 commits into from

Conversation

dchw
Copy link
Collaborator

@dchw dchw commented May 17, 2024

No description provided.

@@ -0,0 +1,70 @@
# Bring Your Own Cloud

"Bring Your Own Cloud" (BYOC) satellites **Experimental** are a hybrid between [self hosted](../self-hosted.md) and [earthly-managed](../../satellites.md) satellites. These satellites are managed by Earthly; just like our managed offering, but within your infrastructure. This blends the ease-of-use of managed satellites with the security benefits that self hosting can bring.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
"Bring Your Own Cloud" (BYOC) satellites **Experimental** are a hybrid between [self hosted](../self-hosted.md) and [earthly-managed](../../satellites.md) satellites. These satellites are managed by Earthly; just like our managed offering, but within your infrastructure. This blends the ease-of-use of managed satellites with the security benefits that self hosting can bring.
"Bring Your Own Cloud" (BYOC) satellites **Experimental** are a hybrid between [Self-Hosted](../self-hosted.md) and [Cloud](../../satellites.md) satellites. These satellites are managed by Earthly; just like our managed offering, but within your infrastructure. This blends the ease-of-use of managed satellites with the security benefits that self hosting can bring.

We tend to call these "Cloud" satellites in our pricing page and in other doc pages.

Copy link
Contributor

Choose a reason for hiding this comment

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

I still think we should be consistent with how we name these products in our docs and pricing page. We haven't referred to Earthly-Managed in the other pages, so it might get confusing.

I also think the term Earthly-managed could include BYOC because Earthly manages those clouds too.

@brandonSc
Copy link
Contributor

I left some minor comments, but I think the docs are great overall! I like all the screenshots, that should make it easy to follow along with, especially when not familiar with CloudFormation.

@brandonSc
Copy link
Contributor

Should we update the table on this page?
https://docs.earthly.dev/docs/remote-runners

docs/cloud/satellites/byoc/byoc.md Outdated Show resolved Hide resolved
docs/cloud/satellites/byoc/byoc.md Outdated Show resolved Hide resolved
docs/cloud/satellites/byoc/byoc.md Show resolved Hide resolved
docs/cloud/satellites/byoc/byoc.md Outdated Show resolved Hide resolved
docs/cloud/satellites/byoc/byoc.md Outdated Show resolved Hide resolved
docs/cloud/satellites/byoc/byoc.md Outdated Show resolved Hide resolved
dchw and others added 9 commits May 22, 2024 13:26
Co-authored-by: Brandon Schurman <brandon@earthly.dev>
Co-authored-by: Brandon Schurman <brandon@earthly.dev>
Co-authored-by: Brandon Schurman <brandon@earthly.dev>
Co-authored-by: Brandon Schurman <brandon@earthly.dev>
Co-authored-by: Vlad A. Ionescu <446771+vladaionescu@users.noreply.github.com>
Co-authored-by: Vlad A. Ionescu <446771+vladaionescu@users.noreply.github.com>
Co-authored-by: Vlad A. Ionescu <446771+vladaionescu@users.noreply.github.com>
| ✅ The satellite lives in your infrastructure, next to your tools | ❌ You cannot manually provision satellites |
| ✅ You pay for the usage the satellite incurs | ❌ You must allow Earthly access to at least some portion of an AWS account you control |
| | ❌ You pay the cloud provider, not Earthly, for the compute usage |
| | ❌ You are responsible for the Satellites monitoring and reliability |
Copy link
Member

Choose a reason for hiding this comment

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

Reading through these tables again, I'm realizing that it's pretty hard to follow along. e.g. the difference "you are responsible for monitoring" isn't clear whether that refers to BYOC or self-hosted.

I think that these tables could be better represented like this:

BYOC vs Cloud

Earthly Cloud Earthly BYOC
Who is responsible for monitoring and reliability of the Satellite ✅ Earthly ✅ Earthly
Satellites are deployed within your internal network ❌ No ✅ Yes
Earthly Cloud and Earthly staff are prevented from accessing your internal network ✅ N/A ✅ Yes
How is compute billed ✅ Zero-margin compute via Earthly ✅ Supported by you via your cloud provider
Automatic updates ✅ Yes ✅ Yes
Auto-sleep to drastically reduce compute cost ✅ Yes ✅ Yes
Automatic management and GCing of cache volumes ✅ Yes ✅ Yes
Users can launch and remove satellites via the earthly sat CLI ✅ Yes ✅ Yes
Requires access to a set of limited AWS capabilities ✅ No ❌ Yes

BYOC vs Self-Hosted

Earthly Self-Hosted Earthly BYOC
Who is responsible for monitoring and reliability of the Satellite ❌ You ✅ Earthly
Satellites are deployed within your internal network ✅ Yes ✅ Yes
Earthly Cloud and Earthly staff are prevented from accessing your internal network ✅ Yes ✅ Yes
Compute is billed directly to you from your cloud provider ✅ Yes ✅ Yes
Automatic updates ❌ No ✅ Yes
Auto-sleep to drastically reduce compute cost ❌ No ✅ Yes
Automatic management and GCing of cache volumes ❌ No ✅ Yes
Users can launch and remove satellites via the earthly sat CLI ❌ No ✅ Yes
Requires access to a set of limited AWS capabilities ✅ No ❌ Yes

Markdown for this:

### BYOC vs Cloud

| | Earthly Cloud | Earthly BYOC |
|-------|-------|-------|
| Who is responsible for monitoring and reliability of the Satellite | ✅ Earthly | ✅ Earthly |
| Satellites are deployed within your internal network | ❌ No | ✅ Yes |
| Earthly Cloud and Earthly staff are prevented from accessing your internal network | ✅ N/A | ✅ Yes |
| How is compute billed | ✅ Zero-margin compute via Earthly | ✅ Supported by you via your cloud provider |
| Automatic updates | ✅ Yes | ✅ Yes |
| Auto-sleep to drastically reduce compute cost | ✅ Yes | ✅ Yes |
| Automatic management and GCing of cache volumes | ✅ Yes | ✅ Yes |
| Users can launch and remove satellites via the `earthly sat` CLI | ✅ Yes | ✅ Yes |
| Requires access to a set of limited AWS capabilities | ✅ No | ❌ Yes |


### BYOC vs Self-Hosted

| | Earthly Self-Hosted | Earthly BYOC |
|-------|-------|-------|
| Who is responsible for monitoring and reliability of the Satellite | ❌ You | ✅ Earthly |
| Satellites are deployed within your internal network | ✅ Yes | ✅ Yes |
| Earthly Cloud and Earthly staff are prevented from accessing your internal network | ✅ Yes | ✅ Yes |
| Compute is billed directly to you from your cloud provider | ✅ Yes | ✅ Yes |
| Automatic updates | ❌ No | ✅ Yes |
| Auto-sleep to drastically reduce compute cost | ❌ No | ✅ Yes |
| Automatic management and GCing of cache volumes | ❌ No | ✅ Yes |
| Users can launch and remove satellites via the `earthly sat` CLI | ❌ No | ✅ Yes |
| Requires access to a set of limited AWS capabilities | ✅ No | ❌ Yes |

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

None yet

3 participants