Fuzzball Documentation
Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Back to homepage

A First Basic Workflow

This page creates a job that uses a lolcow image from Docker Hub to run the fortune command and produce a random quotation. It builds the simplest workflow possible; later pages build on that workflow to make something more complex.

After logging in to Fuzzball, navigate to Workflows by selecting the menu item on the left, open the Runs tab, then select New Workflow.

image of workflow editor starting screen

Workflows are composed of one or more jobs, so start by adding a job to this workflow. Drag a job from the toolbox at the top of the canvas and drop it into the central grid. The new job appears as a card, and you can name it in the Name field of the panel on the right.

the new job card and its Name field in the properties panel

The properties panel on the right opens, showing several tabs.

Add a script in the Job tab. Add the fortune command:

new text box allowing addition of the command fortune

Open the Environment tab to configure the environment this job runs in.

The Environment tab of the job’s Properties panel

The only required field is a URI to a container image that supports your job. This example uses the lolcow image from Docker Hub because it includes the fortune command. The field also accepts oras://, fb://, and fuzzball:// URIs for images held elsewhere, including SIF images.

Enter the following text to pull the correct container:

docker://wresch/lolcow

dialog box showing the path to the lolcow image on Docker Hub

Open the Resources tab to set the compute resources the job needs.

The Resources tab of the job’s Properties panel

The minimum configuration is a number of cores and an amount of memory. One core and 1 GB of memory are enough to run the fortune command.

the resources tab with 1 core and 1GB memory set

If no units are specified in your memory request, Fuzzball defaults to bytes. You should always specify units for memory requests in the web UI. Prefer binary units (GiB, MiB, KiB); Fuzzball also accepts the base 10 equivalents (GB, MB, KB).

At this point you can run the job with the Start button at the top right of the editor. After optionally naming your workflow, you can proceed to the workflow status page. When completed, you will see something like the following:

the completed fortune workflow with logs

You can see the Fuzzfile at any time from the Workflow Editor by selecting the YAML tab in the panel on the right. On a workflow’s status page, select the Fuzzfile tab in the Workflow Details pane to view the workflow definition as read-only YAML. In the example here, the Fuzzfile that is generated by the Workflow Editor looks like this.

version: v4
jobs:
  fortune:
    image:
      uri: docker://wresch/lolcow
    script: |
      #!/bin/sh
      fortune
    resource:
      cpu:
        cores: 1
      memory:
        size: 1GB
Preview workflow in web UI

New workflows created in the web UI default to version: v4, and this guide uses v4 syntax throughout. For the differences between v3 and v4, see the V4 Breaking Changes guide, written for administrators.
When writing simple shell commands like this, you can omit the shebang line and Fuzzball will assume #!/bin/sh. For scripts requiring bash-specific features or other interpreters, include an explicit shebang like #!/bin/bash or #!/usr/bin/python3.
To reproduce any workflow in this guide without building it in the Workflow Editor, copy the text above into a file and open that file in the Workflow Editor, or paste it into the YAML tab of the panel on the right.

Notes on Containers covers the container URI syntax used above in more detail. After that, Adding Dependent Jobs and Volumes expands this basic Fuzzfile into a workflow that runs multiple dependent jobs and adds a volume to share data between them.