First steps using debusine

Introduction

Set up the pre-requisites using Setting up a Debusine server, Setting up a Debusine worker and Setting up a Debusine client, before following the next steps.

This section gives an overview of creating and enabling tokens, submitting a job to Debusine and how to track its status.

Adding and enabling a new worker

Follow Debusine worker instructions to add a new worker.

Once the worker has connected to debusine-server, the debusine-admin should enable the new worker.

Enable a new worker on the server based on the worker’s name

The Debusine admin should find the worker, for example:

$ sudo -u debusine-server debusine-admin list_workers

An output example:

Name        Registered                        Connected                         Token                                                             Enabled
----------  --------------------------------  --------------------------------  ----------------------------------------------------------------  ---------
saturn      2022-06-13T09:10:21.143146+00:00  2022-06-13T10:26:09.184059+00:00  627ee89ee9b7157295c3acd0461d179ee260eaf4244b82216de3b1a502a15658  True
mars        2022-06-13T14:25:47.727794+00:00  2022-06-16T07:54:44.288758+00:00  6d5baf211fd96920650495391058bb43e7eb6e12b7510c4fa39c0ac1abf6755e  True
mercury     2022-06-16T07:54:42.139968+00:00  -                                 93f1b0e9ad2e0ad1fd550f5fdf4ab809594fe1b38ffd37c5b3aa3858062ce0ab  False

In this case, the worker mercury is the newest addition according to the available information: it has the latest registered time and is the only one that is not enabled.

The default name of the worker is the FQDN of the worker.

To enable the new worker on the server:

$ sudo -u debusine-server debusine-admin manage_worker enable mercury

The worker then will be able to connect and process tasks.

Enable a new worker on the server based on the token

It is also possible for the debusine-worker admin to send the token associated to the worker, to the debusine-server admin. This would allow the debusine-server admin to enable the worker.

The token can be found in the worker’s installation system in the file /etc/debusine/worker/token or in the logs (by default, it is in /var/log/debusine/worker/worker.log).

The debusine-server admin could then enable the token using the command:

$ sudo -u debusine-server debusine-admin manage_token enable 93f1b0e9ad2e0ad1fd550f5fdf4ab809594fe1b38ffd37c5b3aa3858062ce0ab

Creating a token for a Debusine client

To create a token for a debusine client, the name of the token owner is needed. This is a free text to keep track of the owners of the tokens. An optional comment can be added. For example:

$ sudo -u debusine-server debusine-admin create_token john-smith --comment "Testing Debusine"

The token will be printed to the standard output. The token can be sent to john-smith and then refer to the section Debusine client instructions to set the token on the client side.

Listing commands

The command list_tokens lists all tokens by default. It is possible to filter tokens by the owner or the token itself, using the options --owner or --token, for example:

$ sudo -u debusine-server debusine-admin list-tokens --owner OWNER
$ sudo -u debusine-server debusine-admin list-tokens --token TOKEN

The command list_workers does not have filtering options.

Remove tokens

Tokens can be removed using the remove_tokens command. By default, it asks for interactive confirmation unless --yes is used. See the options using:

$ sudo -u debusine-server debusine-admin remove_tokens --help

Other commands

There are other commands that can be explored using --help options, for example:

$ sudo -u debusine-server edit_worker_metadata --help

Submit a work request

Instructions for submitting and checking a work request can be found in the submitting a work request section.