From df1c00114619089b8a99310fc99bec1c46574d69 Mon Sep 17 00:00:00 2001 From: Francesco Siddi <francesco.siddi@gmail.com> Date: Mon, 6 Feb 2017 19:41:37 +0100 Subject: [PATCH] Docs: update to User Manual --- docs/docs/index.md | 3 ++- docs/docs/user_docs/basics.md | 46 --------------------------------- docs/docs/user_manual/basics.md | 23 +++++++++++++++++ 3 files changed, 25 insertions(+), 47 deletions(-) delete mode 100644 docs/docs/user_docs/basics.md create mode 100644 docs/docs/user_manual/basics.md diff --git a/docs/docs/index.md b/docs/docs/index.md index 78f3fed5..881218d9 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -20,4 +20,5 @@ tested for Blender jobs, but it is quite trivial to add more. We are currently updating the documentation after a large rewrite of Flamenco, therefore the user manual is not available, and the developer docs are work in progress. We have -removed any legacy content though, so everything that can be found here is up to date. +removed any legacy content though, so everything that can be found here is up to date, +or has been highlighted as upcoming functionality. diff --git a/docs/docs/user_docs/basics.md b/docs/docs/user_docs/basics.md deleted file mode 100644 index a4a952e9..00000000 --- a/docs/docs/user_docs/basics.md +++ /dev/null @@ -1,46 +0,0 @@ -# Getting Started with Flamenco - -Flamenco is a Network Renderer for Blender that can leverage Cycles and GPU rendering. - -There are five main components to know about when working with Flamenco. Four of the components are server-side services that run outside of Blender. -The fifth component is a Blender Add-on and this is used to send an animation to the render farm. - -All Flamenco components can run on Windows, OS X, and Linux. - -Flamenco has also been designed to work on a single network or multiple networks. There are two major use cases; running a render farm in one physical location, and running a render farm in multiple physical locations. -Which components are needed differ based on the use case, and that information is explained below. - -## Flamenco components - -- **Worker** - The 'Worker' is the one service that is ran on all of the computers that will do any rendering. This can include the main server computer as well. - -- **Manager** - The 'Manager' is the component that listens on port 7777. The 'Manager' is what the 'Workers' connect to in order to get the jobs that they have been assigned. - One 'Manager' is needed for each network in the render farm. - -- **Server** - The 'Server' is the component that listens on port 9999. Only one 'Server' total is needed. Run this component on the main render farm server. All of the 'Managers' - talk to this component. - -- **Dashboard** - The 'Dashboard' is the component that listens on port 8888. Only one 'Dashboard' is needed. This is the web interface that is used to manage all of the Jobs. - -- **Add-on: render_flamenco.py** - This Blender Add-on runs on the instance of Blender that the animation was created on and it connects to the single 'Server'. This is used to send a job to the render farm. - - -## Network Architecture Use cases - - -### Use case 1: Running Flamenco on one network - -This use case is for a either a single home render farm or a render farm in a single datacenter. - -* **Main computer**: The main computer runs all 5 components. It acts as the main server and it renders jobs as well. -* **Worker computers**: These components only run the 'Worker' component. - - -### Use case 2: Running Flamenco on multiple networks - -On the main network the 'Server', and 'Dashboard' components are needed at a minimum. On any other networks that will be running 'Workers', one 'Manager' is needed and any 'Workers' connect to that 'Manger'. diff --git a/docs/docs/user_manual/basics.md b/docs/docs/user_manual/basics.md new file mode 100644 index 00000000..7e3b07f5 --- /dev/null +++ b/docs/docs/user_manual/basics.md @@ -0,0 +1,23 @@ +# Installation + +Flamenco is still under development, therefore this installation guide is rather technical. +In the future it will be a straightforward process, in two variants. + +## Using the cloud.blender.org Server +**Note: This feature is not yet available** + +In this case, only two components of the stack are controlled by the user: Manager and +Workers. The setup: + +- On Blender Cloud: create and initialize a Project to be used with Flamenco +- On Blender Cloud: Create a Manager (and collect the identification token) +- Download the Manager binary, add the identification token to the configuration, start +the Manager (it will automatically connect with Blender Cloud) +- Download the Worker bundle and start it (it will automatically connect with the Manager) + +## Using a self-provisioned Server +**Note: This feature is not yet available** + +- Download and start the server (using Docker) +- Follow the steps for setting up with Blender Cloud, updating the configuration to point +to the self-provisioned Server, rather than cloud.blender.org -- GitLab