Stations Guide

Stations are a Galileo feature that make it quick and simple to manage permissioned access and user quotas for nearly any kind of computational asset with an internet connection. They also provide a built-in queueing/scheduling mechanism so that resource administrators can provide fair access to limited computational devices without spending hours setting up access rules and priority queues.

Creating Your Own Galileo Station

A Station can be created both in the web-based UI and through the Python SDK. In order to create a station through the UI, start by clicking on the Stations tab once you’ve logged into your account from a web browser.

_images/stations_tab.png

Next, click the ‘Create Station’ button in the upper right corner of the screen.

_images/stations_create.png

This will bring up a configuration window. Here, you must name the Station and optionally provide a description (which can be useful for conveying important information to Station members).

_images/stations_name.png

After clicking the final “Create Station” button, you will see a new station appear in your Stations tab. At this point, you canF proceed with additional configuration of your Station, such as attaching Landing Zones, inviting collaborators, and assigning them permissioned roles.

Adding a Landing Zone to Your Station

Now that you have created an empty Station, lets add a Landing Zone to it. First, go here to see instructions for setting up your own Landing Zone and authenticating it against your account.

Click on the Station box in the Stations tab. Then, to add an LZ, click the LZ button in the top-center of the Station view.

_images/stations_add_lz.png

This will bring up a list for you to choose which LZ to add (or remove) from this Station context. Click the “+” button next to the LZ(s) you wish to attach to the Station.

_images/stations_add_lz_2.png

Now that you have attached a Landing Zone to your Station, you can submit jobs to it. To learn more about launching jobs in Galileo, go here. Galileo will automatically queue jobs if your LZ resources are fully utilized. Once sufficient resources on an LZ open up, queued jobs will be dispatched.

Note: If you remove an LZ from a Station while it is still running a job, the job will continue to run until completion unless you explicity cancel or kill the job.

Inviting Collaborators

To invite other Galileo users to your new Galileo Station so that they can run jobs or even contribute their own LZs (should their user role permit), start by opening the Station settings page by clicking the “+” button next to the User Count statistic.

_images/stations_add_user_button.png

This will open the “USER MANAGEMENT” tab where you can add and remove Station members as well as assign them specific roles.

_images/stations_user_management.png

Click the small “+” button to the right of the search field to invite a new user and set their role (a user’s role can be changed at anytime).

User Roles and Resource Settings

By default, there are three user roles available upon the creation of a new Station: Admin, Contributor, and Launcher.

_images/stations_role_management.png

The capabilities of these roles can be customized by clicking the edit button on the role you wish to modify. Specific role permissions can be toggled on and off. These role permissions apply to the current Station context only.

_images/stations_user_role_permissions.png

In addition to the role capabilities, resource limitations and usage quotas can be customized for each role by clicking the “resoures” tab next to “permissions”. Values specified here will apply to any user assigned with the associated role. These values can be left empty if you do not wish to apply custom role-specific resource/quota limitations.

_images/stations_user_role_resources.png

In the example pictured above, any user with the Launcher role can use at most 10 CPUs and 10 GB of RAM at one time and each individual job can use at most 5 CPUs and 5 GB of RAM. Every CPU-hour will cost 4 credits and each GB-hour will cost 1 credit, so if the user runs a job for 1 hour that uses 1 CPU and 1 GB of RAM, it will cost them 5 credits which is subracted from their quota. A quota can be set for the daily, weekly, and monthly time frame. For example, in the screen shot above, the Launcher role can use 10 credits per day, 500 credits per week, 1000 credits per month, or 10000 credits per year. As soon as the user hits one of these credit limits, they will not be able to run more jobs until the associated time period resets (so if they use up 10 credits before the end of a day, they will have to wait for the next 24 hour period for their daily credit quota to reset).

Basic Station Settings and Resource Limits

To get to the Station-level settings page, click the three dots in the upper right corner of the Station main page.

_images/stations_settings_button.png

In the Basic Info tab of Station Settings, admins can edit the Station name and description. Descriptions must be limited to 250 characters.

_images/stations_basic_info.png

Additionally, basic resource limitations can be set that will apply to all users in the Station context. These limitations can be left empty if you do not wish to impose limitations at the Station level. The Station-level resource and quota limitations are applied to a job if there are no role-level resource/quota limitations associated with the user who submitted the job. See User Roles and Resource Settings for more information about setting resource and quotas.

Station Volumes

Station administrators can expose volumes to jobs run within the context of a station. This can be useful in situations such as:

  • running licensed software that expects a license file to exist in a particular location

  • exposing networked filesystems

  • sharing data between jobs running on the same LZ

When a volume is added to a Station, it will only be attached to jobs that where submitted to that specific Station. An LZ attached to multiple Stations will not expose volumes to a job if it is not associated with a Station that has been configured to have a volume.

A volume can be added to a Station by clicking the volume icon in the context of the relevant station.

_images/stations_volume.png

The volume must be given a name consisting of alpha-numeric characters and a unique mount path within the container. You must also choose if the volume will have write access via the supplied check box.

_images/stations_volume_mount_path.png

Optionally, a host path may be specified if you wish to expose a location on your host machine’s hard drive that is running an LZ. First navigate to the Host Paths settings.

_images/stations_volume_add_host_path.png

Then specify the path on the host machine that you wish to expose at the mount path that was already set above.

_images/stations_volume_set_host_path.png

Note: Every job that is submitted within this Station context will mount all volumes specified here (this is why the mount path for a volume must be unique for a given Station). If you specifiy a host path for a volume, be sure that this path exists on all hosts running an LZ that is attached to this station. Otherwise, jobs submitted to LZ’s on machines in which the specified host path does not exist will error at container run time.

Note: If you are running windows containers, you must provide mount paths that are Windows compatible, e.g. C:\Users\Public or D: if you want to mount the entire D drive. For example, if you want to expose your E: drive as a volume, your mount path and host path should both be entered as E: with no trailing slash.

Station Queues

Jobs that are submitted to a Station are entered into a queue. If a job is submitted and there are sufficient resources on the Station’s associated LZ’s, then the job will be assigned and deployed immediately, otherwise it will remain in the queued state until a slot opens or more LZs are added.