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

Creating Fuzzfiles

Fuzzfiles Describe Workflows

Fuzzball runs workflows that are composed of one or more jobs. Each job in a workflow runs some specified command(s), executes within an environment consisting of a container, volumes, environment variables, etc., and requires some set of computational resources. Jobs within a workflow may run independently or may be dependant upon one another.

These and other specifications are detailed in a special YAML file called a Fuzzfile. Like any other text file, Fuzzfiles can be created manually in a suitable text editor. You can consult the Fuzzfile syntax guide for a complete overview of available options.

But there is a simpler way!

Using the Workflow Editor

Creating Fuzzfiles from scratch can be challenging. That’s why the Fuzzball GUI includes an interactive Workflow Editor. This allows you to create jobs by dragging and dropping them into your workflow, describe dependencies by drawing connections, and edit job commands, environments, and resources with easy-to-use menus!

The Workflow Editor generates Fuzzfiles for you. Many users find it convenient to use the Workflow Editor to create a Fuzzfile describing the general arrangement of jobs and their requirements, and then to generate a Fuzzfile and fill in the details manually using a text editor. This can be a particularly powerful approach and allows you to learn the YAML syntax at your own pace.