Website: Write the Flamenco Upgrading Guide #104324

New Issue

Mateus Abelli · 2024-07-07T16:07:22+02:00

Mateus Abelli commented

2024-07-07 16:07:22 +02:00

While navigating on the website I noticed that the upgrading docs has a TODO text in it.
I'd like to write it, this is a draft that I'd like to propose and discuss:

Upgrading Flamenco

As a safety measure, make sure to finish all jobs before proceeding.
Download the latest version of Flamenco.
Run the newer version of the Flamenco Manager executable.
3.1 Inside the Manager, in the top-right corner download the new Blender addon.
3.2 In Blender, reinstall the addon. After intalling it, you should see the version change.
3.2.1 In the addon panel, check your preferences and press the refresh button on the Manager URL field.
Stop and replace the workers executables on each computer with the newer version.
4.1 Run them again, so they get registred on the Manager.
Send your jobs to your updated render farm.

While navigating on the website I noticed that the [upgrading docs](https://flamenco.blender.org/usage/upgrading/) has a TODO text in it. I'd like to write it, this is a draft that I'd like to propose and discuss: **Upgrading Flamenco** 1. As a safety measure, make sure to finish all jobs before proceeding. 2. Download the [latest version](https://flamenco.blender.org/download/) of Flamenco. 3. Run the newer version of the Flamenco Manager executable. 3.1 Inside the Manager, in the top-right corner download the new Blender addon. 3.2 In Blender, reinstall the addon. After intalling it, you should see the version change. 3.2.1 In the addon panel, check your preferences and press the refresh button on the Manager URL field. 4. Stop and replace the workers executables on each computer with the newer version. 4.1 Run them again, so they get registred on the Manager. 5. Send your jobs to your updated render farm.

Mateus Abelli added the

Type

To Do

label 2024-07-07 16:07:22 +02:00

Sybren A. Stüvel commented

2024-07-08 13:53:46 +02:00

I'd like to write it, this is a draft that I'd like to propose and discuss:

Thanks!

As a safety measure, make sure to finish all jobs before proceeding.

I wouldn't call this a "safety measure", as it scares away people from upgrading. I've already had to close bug reports because they were reporting things that were already fixed, but the reporters didn't know because they hadn't upgraded.

Something like "To ensure jobs are rendered consistently, …" would be a bit friendlier.

Run the newer version of the Flamenco Manager executable.

Before Manager should be run, the downloaded ZIP file needs to be extracted somewhere. Where this is done is kinda vital, as doing it in any place but the original location will make the Manager not find its config nor its database, and thus think it's a brand new setup.

Stop and replace the workers executables on each computer with the newer version.

I would recommend stopping the entire farm, so Manager + Workers, in one go. And then upgrade the files, then restart them.

4.1 Run them again, so they get registred on the Manager.

They should not have to register. If the upgrade is done well, they can just sign in with the existing credentials.

> I'd like to write it, this is a draft that I'd like to propose and discuss: Thanks! > 1. As a safety measure, make sure to finish all jobs before proceeding. I wouldn't call this a "safety measure", as it scares away people from upgrading. I've already had to close bug reports because they were reporting things that were already fixed, but the reporters didn't know because they hadn't upgraded. Something like "To ensure jobs are rendered consistently, …" would be a bit friendlier. > 3. Run the newer version of the Flamenco Manager executable. Before Manager should be run, the downloaded ZIP file needs to be extracted somewhere. Where this is done is kinda vital, as doing it in any place but the original location will make the Manager not find its config nor its database, and thus think it's a brand new setup. > 4. Stop and replace the workers executables on each computer with the newer version. I would recommend stopping the entire farm, so Manager + Workers, in one go. And then upgrade the files, then restart them. > 4.1 Run them again, so they get registred on the Manager. They should not have to register. If the upgrade is done well, they can just sign in with the existing credentials.

Mateus Abelli commented

2024-07-09 19:27:53 +02:00

Hi, I updated the steps with your feedback and changed it a bit to make it more clear.

I also added new steps such as a backup option if the user would like to keep their previous version installed. Its a practice that I usually do myself, I always append something like "old" or "backup" at the end of the file or folder in case I need to quickly revert.

Upgrading Flamenco

To ensure your current jobs are rendered consistently, make sure to finish them before proceeding.
Download the latest version of Flamenco.
Stop the Flamenco Manager and Workers in all computers.
If you'd like to keep a backup of your previous version, rename the directory or executables before replacing them.
Extract the downloaded ZIP and replace its contents on the same location as you previously installed Flamenco Manager.
Run the newer version of the Flamenco Manager executable.
6.1 Inside the Manager, in the top-right corner download the updated Blender addon.
In Blender, reinstall the addon. After intalling it, you should see the version change.
7.1 Inside the addon panel, check your preferences and press the refresh button on the Manager URL field.
Replace the Workers executables on each computer with the newer version.
8.1 Run them again, they should reuse their stored credentials and sign in to the Manager.
Send your jobs to your updated render farm.

Hi, I updated the steps with your feedback and changed it a bit to make it more clear. I also added new steps such as a backup option if the user would like to keep their previous version installed. Its a practice that I usually do myself, I always append something like "old" or "backup" at the end of the file or folder in case I need to quickly revert. **Upgrading Flamenco** 1. To ensure your current jobs are rendered consistently, make sure to finish them before proceeding. 2. Download the [latest version](https://flamenco.blender.org/download/) of Flamenco. 3. Stop the Flamenco Manager and Workers in all computers. 4. If you'd like to keep a backup of your previous version, rename the directory or executables before replacing them. 5. Extract the downloaded ZIP and replace its contents on the same location as you previously installed Flamenco Manager. 6. Run the newer version of the Flamenco Manager executable. 6.1 Inside the Manager, in the top-right corner download the updated Blender addon. 7. In Blender, reinstall the addon. After intalling it, you should see the version change. 7.1 Inside the addon panel, check your preferences and press the refresh button on the Manager URL field. 8. Replace the Workers executables on each computer with the newer version. 8.1 Run them again, they should reuse their stored credentials and sign in to the Manager. 9. Send your jobs to your updated render farm.

Sybren A. Stüvel commented

2024-07-11 10:15:27 +02:00

Getting better! Thanks for putting in the effort.

rename the directory [...] before replacing them.

This is going to cause issues, because renaming the directory means that your new install is going to run from a directory that doesn't have the task logs, sqlite file, etc.

I think it's a good idea to describe how to create backups of a Flamenco install. I think it'll be clearer when that is done in a section of its own. This guide can then link to that for reference. But for now, just skip the backup part -- once it's written, it's easy enough to add a link here.

Extract the downloaded ZIP and replace its contents on the same location as you previously installed Flamenco Manager.

"replace" → "place". You're not replacing the contents of the ZIP, you're replacing something else with the contents of that ZIP.

Run the newer version of the Flamenco Manager executable.

One thing that I've seen people confused by (well, to be fair, only one person) is that after the initial run of Flamenco Manager, it doesn't automatically open a webbrowser any more. So maybe add something like "Open the Flamenco webapp in your browser" or something along those lines.

After intalling it

"installing"

they should reuse their stored credentials

I think this can be removed. Generally people don't know that there are credentials at all anyway. Maybe something like "Run them again, they should sign in to the Manager like before" is enough.

Getting better! Thanks for putting in the effort. > rename the directory [...] before replacing them. This is going to cause issues, because renaming the directory means that your new install is going to run from a directory that doesn't have the task logs, sqlite file, etc. I think it's a good idea to describe how to create backups of a Flamenco install. I think it'll be clearer when that is done in a section of its own. This guide can then link to that for reference. But for now, just skip the backup part -- once it's written, it's easy enough to add a link here. > Extract the downloaded ZIP and replace its contents on the same location as you previously installed Flamenco Manager. "replace" → "place". You're not replacing the contents of the ZIP, you're replacing _something else_ with the contents of that ZIP. > Run the newer version of the Flamenco Manager executable. One thing that I've seen people confused by (well, to be fair, only one person) is that after the initial run of Flamenco Manager, it doesn't automatically open a webbrowser any more. So maybe add something like "Open the Flamenco webapp in your browser" or something along those lines. > After intalling it "in**s**talling" > they should reuse their stored credentials I think this can be removed. Generally people don't know that there are credentials at all anyway. Maybe something like "Run them again, they should sign in to the Manager like before" is enough.

Mateus Abelli commented

2024-07-18 02:02:34 +02:00

Getting better! Thanks for putting in the effort.

👍 Nice, thanks!!

This is going to cause issues, because renaming the directory means that your new install is going to run from a directory that doesn't have the task logs, sqlite file, etc.

I agree, I wasn't thinking very thoroughly when I wrote about renaming the directory, so I installed Flamenco in a virtual machine to follow along with the steps to see if they made sense and indeed renaming the manager directory would be a bad idea.

I think it's a good idea to describe how to create backups of a Flamenco install. I think it'll be clearer when that is done in a section of its own. This guide can then link to that for reference. But for now, just skip the backup part -- once it's written, it's easy enough to add a link here.

Cool, I'll wait until we polish our final version of the upgrade guide to write backup methods and them link it as suggested.

"replace" → "place". You're not replacing the contents of the ZIP, you're replacing something else with the contents of that ZIP.

I updated with place, what I meant before with replace would be a overwrite, that you should extract and overwrite the contents with the ones from the ZIP, I'm not sure if that would sound better?

One thing that I've seen people confused by (well, to be fair, only one person) is that after the initial run of Flamenco Manager, it doesn't automatically open a webbrowser any more. So maybe add something like "Open the Flamenco webapp in your browser" or something along those lines.

Got it, yeah I remember seeing that issue report.

"installing"

😅 Oops I read it multiple times and still missed that, this time I processed the text with the help of a online grammar tool.

I think this can be removed. Generally people don't know that there are credentials at all anyway. Maybe something like "Run them again, they should sign in to the Manager like before" is enough.

Done, I went with "...to the Manager as usual" because I thought it would sound a bit nicer but please let know what you think.

Upgrading Flamenco

To ensure your current jobs are rendered consistently, make sure to finish them before proceeding.
Download the latest version of Flamenco.
Stop the Flamenco Manager and Workers on all computers.
Extract the downloaded ZIP and place its contents in the same location as the previously installed Flamenco Manager.
Run the newer version of the Flamenco Manager executable and open the web app in your browser.
5.1 Inside the Manager, in the top-right corner, download the updated Blender add-on.
In Blender, reinstall the add-on. After installing it, you should see the version change.
6.1 Inside the add-on panel, check your preferences and press the refresh button on the Manager URL field.
Replace the Workers executables on each computer with the newer version.
7.1 Run them again, they should sign in to the Manager as usual.
Send your jobs to your updated render farm.

> Getting better! Thanks for putting in the effort. 👍 Nice, thanks!! > This is going to cause issues, because renaming the directory means that your new install is going to run from a directory that doesn't have the task logs, sqlite file, etc. I agree, I wasn't thinking very thoroughly when I wrote about renaming the directory, so I installed Flamenco in a virtual machine to follow along with the steps to see if they made sense and indeed renaming the manager directory would be a bad idea. > I think it's a good idea to describe how to create backups of a Flamenco install. I think it'll be clearer when that is done in a section of its own. This guide can then link to that for reference. But for now, just skip the backup part -- once it's written, it's easy enough to add a link here. Cool, I'll wait until we polish our final version of the upgrade guide to write backup methods and them link it as suggested. > "replace" → "place". You're not replacing the contents of the ZIP, you're replacing _something else_ with the contents of that ZIP. I updated with place, what I meant before with replace would be a overwrite, that you should extract and overwrite the contents with the ones from the ZIP, I'm not sure if that would sound better? > One thing that I've seen people confused by (well, to be fair, only one person) is that after the initial run of Flamenco Manager, it doesn't automatically open a webbrowser any more. So maybe add something like "Open the Flamenco webapp in your browser" or something along those lines. Got it, yeah I remember seeing that issue report. > "in**s**talling" 😅 Oops I read it multiple times and still missed that, this time I processed the text with the help of a online [grammar tool](https://languagetool.org/). > I think this can be removed. Generally people don't know that there are credentials at all anyway. Maybe something like "Run them again, they should sign in to the Manager like before" is enough. Done, I went with "...to the Manager as usual" because I thought it would sound a bit nicer but please let know what you think. **Upgrading Flamenco** 1. To ensure your current jobs are rendered consistently, make sure to finish them before proceeding. 2. Download the [latest version](https://flamenco.blender.org/download/) of Flamenco. 3. Stop the Flamenco Manager and Workers on all computers. 4. Extract the downloaded ZIP and place its contents in the same location as the previously installed Flamenco Manager. 5. Run the newer version of the Flamenco Manager executable and open the web app in your browser. 5.1 Inside the Manager, in the top-right corner, download the updated Blender add-on. 6. In Blender, reinstall the add-on. After installing it, you should see the version change. 6.1 Inside the add-on panel, check your preferences and press the refresh button on the Manager URL field. 7. Replace the Workers executables on each computer with the newer version. 7.1 Run them again, they should sign in to the Manager as usual. 8. Send your jobs to your updated render farm.

Sybren A. Stüvel commented

2024-09-05 11:46:47 +02:00

what I meant before with replace would be a overwrite, that you should extract and overwrite the contents with the ones from the ZIP, I'm not sure if that would sound better?
...
4. Extract the downloaded ZIP and place its contents in the same location as the previously installed Flamenco Manager.

Yeah, I think you're right, it'll be nice if this describes that it should overwrite the existing files.

Run the newer version of the Flamenco Manager executable

For me "the newer version" sounds like there is also an option to run "the older version", but that's not there any more. I think it's fine to just say "Run the Flamenco Manager executable". Or maybe "Run the updated Flamenco Manager executable", or something along those lines.

and open the web app in your browser.

Would this make sense as a "5.1" step? And then what is now "5.1" can become "5.2".

I like the sub-steps, because it helps to separate the "this is what you do with the Manager", "then Blender", "then the Worker".

> what I meant before with replace would be a overwrite, that you should extract and overwrite the contents with the ones from the ZIP, I'm not sure if that would sound better? > ... > 4. Extract the downloaded ZIP and place its contents in the same location as the previously installed Flamenco Manager. Yeah, I think you're right, it'll be nice if this describes that it should overwrite the existing files. > 5. Run the newer version of the Flamenco Manager executable For me "the newer version" sounds like there is also an option to run "the older version", but that's not there any more. I think it's fine to just say "Run the Flamenco Manager executable". Or maybe "Run the updated Flamenco Manager executable", or something along those lines. > and open the web app in your browser. Would this make sense as a "5.1" step? And then what is now "5.1" can become "5.2". I like the sub-steps, because it helps to separate the "this is what you do with the Manager", "then Blender", "then the Worker".

Sign in to join this conversation.