Skip to content

Spin

Spin is a container-based platform at NERSC designed for you to deploy your own science gateways, workflow managers, databases, API endpoints, and other network services to support your scientific projects. Services in Spin are built with Docker containers and can easily access NERSC systems and storage.

The system underlying Spin, called Rancher, is a management and orchestration framework for Kubernetes clusters. The current Rancher system offers many of the same features that users of Kubernetes will find familiar, but with an intuitive web-based user interface. Provided alongside Rancher is a container image registry based on the popular Harbor system.

Why Use Spin?

The flexibility of Docker makes Spin useful for many projects. A few examples include the following:

  • The Dark Energy Spectroscopic Instrument (DESI) project operates databases and tools for data movement that support continuous workflows.
  • ESS-DIVE is a data repository that facilitates sharing and discovery of earth sciences data sets using the Metacat research data catalog system atop NERSC storage.
  • The LZ Dark Matter Experiment has built custom workflow tools and science gateways that help collaborators organize the experiment and analyze and visualize notable detector events.
  • Phytozome, a project of the Joint Genome Institute, offers a comprehensive library of plant genomics data.
  • ScienceSearch provides deep search into research data sets by generating robust metadata from ML techniques that incorporate user tagging and training.
  • NERSC also uses Spin as a frontend for some of its most popular services, such as Jupyter.

If your project needs a persistent service to help with workflow operations, manage or disseminate project data, or otherwise interact with NERSC systems, Spin may be for you.

Access Spin

Users must have an active NERSC account and complete an instructor-led workshop or self-guided training for access to Spin. (See "Get Started" for more.)

The Rancher system is available at https://rancher2.spin.nersc.gov/.

The NERSC container image registry, used in conjunction with Rancher, is available at https://registry.nersc.gov/.

Get Started

In most cases, you must complete the two-part instructor-led SpinUp Workshop for New Users before accessing Spin. These workshops are scheduled at regular intervals throughout the year.

You may be able to substitute a self-guided training if one of the following less-common circumstances apply:

  1. You are joining a project team of well-established Spin users, you need urgent access, and you have received approval from NERSC to substitute interactive training. To ask for approval, log in to the NERSC help portal and open a ticket.
  2. You already attended a workshop for the legacy Rancher 1 system. No approval required.

SpinUp Workshop for New Users

SpinUp Workshops are designed to help NERSC users learn how to build their own services. The instructor-led workshop is designed for those new to Spin or wanting a thorough refresher. It is comprised of two sessions,

  1. A seminar with interactive exercises and
  2. An unstructured hack-a-thon.

Participants will learn about the Spin platform by deploying a simple service in the seminar. Then, in the hack-a-thon, they will work in small groups to try projects of their own. Instruction also covers basic maintenance and troubleshooting.

Download the workshop slides to preview the topics covered.

Prerequisites

To attend the SpinUp Workshop, you must have an active NERSC user account. We recommend a basic understanding of Docker technology as well.

Refer to NERSC's training pages for current workshop schedules and registration and attendance details.

Self-guided Training

This do-it-yourself program is designed for those who have a time-sensitive need for access and are joining a project team of well-established Spin users, subject to NERSC approval. Those who have already attended a workshop using the legacy Rancher 1 system may also take this training in lieu of attending the SpinUp workshop and hack-a-thon.

The self-guided module includes hands-on exercises. To get help from NERSC staff, users are welcome to make an appointment during Spin office hours held Fridays 10 a.m. - 12 p.m., Pacific Time via Zoom.

Download the self-guided module to preview the topics covered.

Submit a ticket indicating your NERSC project(s) to get access to the Spin Rancher 2 instance.

Get Help

Spin Office Hours

Spin office hours are held via Zoom on Fridays 10 a.m. - 12 p.m. Pacific Time. All active Spin users are welcome to make an appointment for hands-on help deploying or troubleshooting their apps during office hours.

NERSC Help Portal

As with all NERSC systems and services, users can request help via NERSC's help website (requires login).

External Resources

When developing containerized applications, there are several external resources and communities to draw knowledge from. Here are a few starting places.