Sykube

The sykube, singularity-cri and wlm-operator projects were created by Sylabs to explore interaction between the Kubernetes and HPC worlds. In 2020, rather than dilute our efforts over a large number of projects, we have focused on Singularity itself and our supporting services. We're also looking forward to introducing new features and technologies in 2021.

At this point we have archived the repositories to indicate that they aren't under active development or maintenance. We recognize there is still interest in singularity-cri and wlm-operator, and we'd like these projects to find a home within a community that can further develop and maintain them. The code is open-source under the Apache License 2.0, to be compatible with other projects in the k8s ecosystem.

Please reach out to us via community@sylabs.io if you are interested in establishing a new home for the projects.

Sykube is inspired by Minikube and allows to quickly deploy a localized multi-node K8S cluster (2 nodes by default) on a single machine. The K8S cluster is setup with the help of Singularity-CRI and Singularity OCI.

It's easy to use and automatically install a Kubernetes dashboard.

Quick start

Sykube requires Singularity (a version >= 3.2 is recommended).

Sykube installation

To install sykube on your machine, just run:

sudo singularity run library://sykube

The above command does two things, it downloads and cache the image used by Sykube and install sykube binary in /usr/local/bin path

Setup a K8S cluster

To start a K8S cluster installation, just type:

sykube init

May take few minutes depending of your internet bandwidth.

If you are familiar with K8S, you can generate a kubectl alias with:

sykube kubectl

To inject a kubectl alias into your current shell session.

You can also access to K8S dashboard with:

sykube dashboard

If you have xdg-open installed, it will automatically open your default internet browser, and if xclip is also installed the token will be automatically set in your clipboard, then you would just have to paste in the corresponding token page field.

From source

To build it from this repository:

git clone https://github.com/sylabs/sykube
cd sykube
sudo singularity build /tmp/sykube.sif sykube.def
sudo singularity run /tmp/sykube.sif
sykube init --local-image /tmp/sykube.sif