LogoLogo
HomeBlogGitHubGet Started FreeLogin
Earthly 0.8
Earthly 0.8
  • 👋Introduction
  • 💻Install Earthly
  • 🎓Learn the basics
    • Part 1: A simple Earthfile
    • Part 2: Outputs
    • Part 3: Adding dependencies With Caching
    • Part 4: Args
    • Part 5: Importing
    • Part 6: Using Docker In Earthly
    • Part 7: Using remote runners
    • Part 8a: Using Earthly in your current CI
    • Final words
  • ⭐Featured guides
    • Rust
  • 📖Docs
    • Guides
      • Importing
      • Build arguments and variables
      • Secrets
      • Functions
      • Using Docker in Earthly
      • Multi-platform builds
      • Authenticating Git and image registries
      • Integration Testing
      • Debugging techniques
      • Podman
      • Configuring registries
        • AWS ECR
        • GCP Artifact Registry
        • Azure ACR
        • Self-signed certificates
      • Using the Earthly Docker Images
        • earthly/earthly
        • earthly/buildkitd
      • ✅Best practices
    • Caching
      • Caching in Earthfiles
      • Managing cache
      • Caching via remote runners
    • Remote runners
    • Earthfile reference
      • Builtin args
      • Excluding patterns
      • Version-specific features
    • The earthly command
    • Earthly lib
    • Configuration reference
    • Examples
    • Misc
      • Alternative installation
      • Data collection
      • Definitions
      • Public key authentication
  • 🔧CI Integration
    • Overview
    • Use the Earthly CI Image
    • Build your own Earthly CI Image
    • Pull-Through Cache
    • Remote BuildKit
    • Vendor-Specific Guides
      • GitHub Actions
      • Circle CI
      • GitLab CI/CD
      • Jenkins
      • AWS CodeBuild
      • Google Cloud Build
      • Bitbucket Pipelines
      • Woodpecker CI
      • Kubernetes
  • ☁️Earthly Cloud
    • Overview
    • Managing permissions
    • Cloud secrets
    • Earthly Satellites
      • Managing Satellites
      • Using Satellites
      • Self-Hosted Satellites
      • GitHub runners
      • Best Practices
      • Bring Your Own Cloud (BYOC)
        • AWS
          • Requirements
          • CloudFormation
          • Terraform
          • Manual
        • VPN
          • Tailscale
Powered by GitBook
On this page
  • Networking
  • Cloud
  • On Your Machine

Was this helpful?

Edit on GitHub
  1. Earthly Cloud
  2. Earthly Satellites
  3. Bring Your Own Cloud (BYOC)
  4. AWS

Requirements

PreviousAWSNextCloudFormation

Last updated 10 months ago

Was this helpful?

This page documents the requirements to install in AWS. Additional requirements may apply depending on your chosen installation method.

Networking

Because every configuration is different, using BYOC within your organization will require you to configure your networking to match your use case. You'll need to ensure that:

  • Traffic from Earthly clients, including CI build runners and developer workstations, can reach the satellites directly.

  • Traffic to any required resources (e.g. private repositories, the internet, etc) are allowed.

  • Internal AWS DNS names (or IP addresses) must resolve to an address reachable on the network.

These can all be accomplished with most VPN technologies. We recommend and have direct experience with . If you need help configuring other networking scenarios, !

Cloud

Configuring BYOC in your AWS account requires:

  • A VPC,

  • and a chosen subnet that Earthly will place its satellites into. Take note of the CIDR block, you may need it later.

Right now, BYOC is only supported in the us-west-2 (Oregon) region.

On Your Machine

You'll need to finish the installation at the command line. To do this, ensure that is installed on your system.

☁️
BYOC Satellites
Tailscale
please reach out to us
Earthly