Getting Started - sakura-team/sakura GitHub Wiki

The Sakura project provides the software you need to deploy or use a Sakura Platform.

Setting up client tools

Let's consider you want to use a sakura platform which is already available on your network. Use the following:

$ sudo pip3 install --upgrade pip wheel setuptools
$ sudo pip3 install --upgrade sakura-py

(we require python version >= 3.5)

You can now use sakura-shell, sakura-op-skeleton and sakura-sandbox programs right away.

Setting up a platform

Deploying a Sakura Platform means deploying the following components in your own IT infrastructure:

  • The Sakura Hub (required) which is the central component and the platform access point for the users
  • A set of Sakura Daemons installed on each server or platform you want to link to Sakura. The data processing is handled by daemons by using a set of operators.

The following image presents a sample deployment of Sakura, at the LIG laboratory (click on it for fullscreen): Archi Sakura

The Hub software must be deployed, configured and run on a Linux server running systemd, by typing (as root):

$ pip3 install --upgrade pip wheel setuptools
$ pip3 install --upgrade sakura-py[hub]
$ mkdir /etc/sakura && vi /etc/sakura/hub.conf  # see below (1) 
$ sakura-hub --setup-systemd
$ systemctl start sakura-hub

(1): see Configuration page.

Similarly, the Daemon software can be deployed, configured and run on a Linux server running systemd, by typing (as root):

$ pip3 install --upgrade pip wheel setuptools
$ pip3 install --upgrade sakura-py[daemon]
$ mkdir /etc/sakura && vi /etc/sakura/daemon.conf  # (1) see above
$ sakura-daemon --setup-systemd
$ systemctl start sakura-daemon

Additional notes:

  • If you want to run the hub and a daemon on the same machine or virtual environment, use the following command when installing sakura python package: pip3 install --upgrade sakura-py[hub,daemon]