Managing Satellites
Last updated
Was this helpful?
Earthly 0.6
Last updated
Was this helpful?
This feature is part of the Earthly Satellites paid plan.
Important
This feature is currently in Beta stage
The feature may break or change significantly in future versions of Earthly.
Give us feedback on
This page describes how to manage .
In order to manage Earthly Satellites, you must have an Earthly account and an Earthly organization, and you must request access to the Satellite private beta program. For more information, see the and the .
To launch a new satellite, run:
The Satellite name can be any arbitrary string.
If you are part of multiple Earthly organizations, you may have to specify the org name under which you would like to launch the satellite:
Once the satellite is created it will be automatically selected for use as part of your builds. The selection takes place by Earthly adding some information in your Earthly config file (usually located under ~/.earthly/config.yml).
To remove a satellite, you can run:
To list the satellites available in your organization, run:
Selecting a satellite causes Earthly to use that satellite for any builds from that point onwards.
To select a satellite for use, run:
Unselecting a satellite will cause Earthly to run builds locally from that point onwards.
To unselect a satellite, run:
Checking the status of a satellite allows you to view information about a satellite's current state, including whether it is being used right now, how much cache space has been used, version information and other information.
To check the status of a satellite, you can run:
Here is some example output of an inspect command:
To clear the cache of a satellite, run the following while a satellite is selected:
Currently, satellites do not have an auto-update mechanism built in. In order to get a newer version of a satellite, you need to manually remove and re-launch the satellite. Note that this operation resets the cache.
The newly launched satellite will always get the latest version available.
To save costs, satellites automatically enter a sleep state after 30 min of inactivity. While a satellite is asleep, you are not billed for any compute minutes.
The satellite will automatically wake up when a new build is started while it's in a sleep state. This is visible during the Init phase of the Earthly log.
If you want more fine-grain control over your Satellite's state, you can also manually put it to sleep using the command:
Similarly, a Satellite can be manually woken up using:
Currently, all users who are part of an organization are allowed to use any satellite in the organization. To invite another user to join your org, run:
Note the slashes around the org name. Also, please note that the user must have an account on Earthly before they can be invited. (This is a temporary limitation which will be addressed in the future.)
The source IP address of the satellite for all internet traffic is 35.160.176.56. This can be used for granting access to private resources or to production environments.
Note that the command will show you if a Satellite is currently awake or asleep.
Once a user has been invited, you can forward them a link to the page for them to get started.