Skip to content

Latest commit

 

History

History
77 lines (55 loc) · 5.31 KB

README.md

File metadata and controls

77 lines (55 loc) · 5.31 KB
Raw

Skaha

A container based science platform in CANFAR.

CI: Linting CI: Testing CD: Edge Build CD: Release Build OpenSSF Scorecard

Table of Contents

CANFAR Science Portal Documentation

User documentation for the CANFAR Science Portal and Platform can be found here: Official CANFAR Science Platform Documentation

Acknowledgements

This project has been funded in part by:

  • The ALMA Cycle 7 development study with support from the National Radio Astronomy Observatory and the North American ALMA Science Centre
  • The CANARIE Research Software Program Competitive Funding Call 3: Research Software Platform Re-Use
  • The National Research Council Canada

Overview

Skaha is a general purpose online platform for running science containers interactively. It is part of the CANFAR Science Platform. In the architecture diagram below, skaha is the main API to the Science Platform.

science-platform-architecture The CANFAR Science Platform Architecture. canfar-architecture Skaha is the API to the Science Platform box.

Deployment

Skaha runs on Kubernetes and and is deployed using Helm. See the Deployment Guide for more information.

System Components

Components of skaha are containers that can be scaled out on a cluster of nodes to meet the storage and processing demands of the scientific software containers.

skaha

The skaha module provides the API for:

  • Listing published container images that the calling user is allowed to run
  • Creating skaha sessions from published container images
  • Launching container images to be displayed in desktop sessions

The complete API of skaha can be viewed here: https://ws-uv.canfar.net/skaha

The CANFAR Science Platform, a web interface to skaha, is here: https://www.canfar.net

Session Containers

Session containers are HTML5/websocket applications that can run in shaka. Currently this consists of Jupyter Labs, CARTA Visualization, and NoVNC desktops. More information on session containers and how they can be used in skaha can be found in the science-containers github repository.

Software Containers

These are some of the astronomy science containers that have been built for skaha. They run as applications within skaha. The graphical aspects of the containers are displayed in skaha-desktop by sending the DISPLAY to skaha-desktop.

More information on software containers can be found in the science-containers github repository.

Dependencies

skaha relies on a number of other opencadc modules to operate.

  • registry (reg) web service (https://github.com/opencadc/reg) -- A registry service will be used to read the capabilities and locations of other web services used by skaha.
  • access control (ac) web service (https://github.com/opencadc/ac) -- If the IdentityManager implementation is configured to use cadc-access-control-server for authentication an operational ac web service is required to be running.
  • credential delegation (cdp) web service (https://github.com/opencadc/cdp) -- The cdp service is used to obtain users' delegated proxy certificates.
  • cavern -- skaha is complimented by having the cavern VOSpace implementation mounted as a shared POSIX file system. (https://github.com/opencadc/vos/tree/master/cavern). cavern is a vospace implementation where both the data and metadata are based on the contents of a file system. If the software-containers have access to the cavern file system the contents of that file system can be accessed and shared through the cavern web service.
  • posix/sssd -- Containers in skaha are always run as the user and with the users' group memberships. If skaha-desktop and software-containers are run with a SSSD configuration that points to the same LDAP instance as used by ac, the names of those uids and gids can be resolved.