Local Deployment Guides
These guides are intended for administrators who wish to deploy Fuzzball in an on-premises cluster.
The documents in the Local Deployment Guides are unlikely to be useful to you (and may be confusing) if you are using and/or administrating Fuzzball in a cloud environment. Deployment tasks differ between these types of environments.
Fuzzball can be deployed locally in two ways. Each guide in this section — Requirements, Deployment, and Updating Fuzzball — is organized into Kubernetes Operator and Docker Compose tabs so you can follow the method that matches your environment.
Fuzzball can be deployed as a Kubernetes Operator. This requires you to have an existing Kubernetes cluster. This guide will cover a basic deployment.
The deployment takes place across 2 groups of nodes:
- An odd number (commonly 1 or 3) of Server node(s) that run Fuzzball Orchestrate.
- One or more Compute node(s) that run Fuzzball Substrate. These will be responsible for running workflows.
For simplicity, this guide assumes 1 Server node and 1 Compute node. In a production environment you may want to install Fuzzball across a pool of 3 nodes for better reliability and performance. The process of setting up a production-ready, high availability (HA) Orchestrate cluster is largely the same as installing Fuzzball on a single server node. Where they differ, special instructions for setting up a 3 node HA cluster are also included throughout the guide.
fuzzball cluster docker-compose subcommands and
requires only a working Docker installation with the Compose plugin.Cluster administrators can temporarily assume the identity of any user to troubleshoot issues or verify permissions. See Impersonating Users for Troubleshooting for detailed instructions.