docs: upgrade guide improvements #2166

sixhobbits · 2023-05-12T08:27:39Z

based on #1951

@mooreds - sorry this one took a while - there is still a lot more we could add, but want to check if this is in the right direction as it's pretty different from the other posts we have done.

NOTES:

We haven't done the theme upgrade tooling
We can still show a step-by-step guide for a Kubernetes cluster in the more practical second section
The diagrams are images, but we can do plantuml versions still

Upgrading language edit

site/docs/v1/tech/admin-guide/upgrade.adoc

mooreds · 2023-05-26T22:45:34Z

site/docs/v1/tech/admin-guide/upgrade.adoc


-To upgrade to the latest version of FusionAuth using Docker go link:/docs/v1/tech/installation-guide/docker[here].
+To upgrade to the latest version of FusionAuth using Docker, go link:/docs/v1/tech/installation-guide/docker[here].

 If you want to use manual mode, download the latest version of FusionAuth and follow the instructions below. See https://fusionauth.io/download[Downloads].
 ====



Missing cloud update and k8s update.

I think we're okay leaving k8s update off, but can you link to the cloud upgrade section: https://fusionauth.io/docs/v1/tech/installation-guide/cloud#upgrading-a-deployment

mooreds · 2023-05-26T22:49:47Z

site/docs/v1/tech/admin-guide/upgrade.adoc


 [NOTE]
 ====
 *Readme*

-To upgrade to the latest version of FusionAuth using the FastPath installation go link:/docs/v1/tech/installation-guide/fast-path[here].
+To upgrade to the latest version of FusionAuth using the FastPath installation, go link:/docs/v1/tech/installation-guide/fast-path[here].


Should probably get rid of this, since we advise against using FastPath in prod below.

mooreds · 2023-05-26T22:50:16Z

site/docs/v1/tech/admin-guide/upgrade.adoc


-To upgrade to the latest version of FusionAuth using Homebrew go link:/docs/v1/tech/installation-guide/homebrew[here].
+To upgrade to the latest version of FusionAuth using Homebrew, go link:/docs/v1/tech/installation-guide/homebrew[here].


Should we extract out the homebrew upgrade instructions to a shared file and include them here and there?

mooreds · 2023-05-26T22:50:23Z

site/docs/v1/tech/admin-guide/upgrade.adoc


-To upgrade to the latest version of FusionAuth using Docker go link:/docs/v1/tech/installation-guide/docker[here].
+To upgrade to the latest version of FusionAuth using Docker, go link:/docs/v1/tech/installation-guide/docker[here].


Should we extract out the docker upgrade instructions to a shared file and include them here and there?

mooreds · 2023-05-26T22:50:56Z

site/docs/v1/tech/admin-guide/upgrade.adoc


-== Database
+=== Database


Is this duplicative?

mooreds · 2023-05-26T22:55:15Z

This is a great start. Themes are tough. Here's what I'd do:

pull down the default theme from your current version
pull down the default theme from your target version
diff them
see what changes you need to make to your customized theme (adding messages, files, parameters)

Should probably add in a support CTA (forums, account.fusionauth.io/account/support).

Co-authored-by: Dan Moore <dan@fusionauth.io>

mooreds · 2023-06-15T23:45:30Z

Is this ready for re-review @sixhobbits ?

sixhobbits · 2023-06-16T08:02:42Z

@mooreds no sorry we are still figuring out the theme import stuff.

mooreds · 2023-06-16T11:57:38Z

@sixhobbits Awesome, no worries, wanted to check on status. Feel free to ask questions here and in slack; I remember we talked about how some of the upgrade guide was pretty domain specific.

FYI, there's a node cli @ColinFrick wrote that makes the theme upload/download much easier. Would prefer if you'd use that: https://github.com/FusionAuth/fusionauth-node-cli rather than write your own or use curl.

Theme upgrade language edit

sixhobbits · 2023-06-22T07:19:54Z

dependent on FusionAuth/fusionauth-theme-helper#8

…nguage-edit Upgrade Guide change requests language edit

… section

sixhobbits · 2023-06-29T15:11:45Z

@mooreds we have implemented all the feedback now.

Still outstanding is Cloud + Kubernetes, but as discussed on Slack we can do that as a follow on as it will be quite a big project too to test everything out.

mooreds

Getting closer!

site/docs/v1/tech/admin-guide/upgrade.adoc

mooreds · 2023-07-29T14:10:38Z

site/docs/v1/tech/admin-guide/upgrade.adoc


-To upgrade to the latest version of FusionAuth using the FastPath installation go link:/docs/v1/tech/installation-guide/fast-path[here].
+The timing of the database upgrade is also important to note. When an upgraded node is started and connects to the database, it will lock the database immediately if configured for Silent Mode and the database requires upgrading. This means that the database will be unavailable to other nodes in the cluster until the upgrade is complete.


This is the first mention of Silent Mode and might be confusing. Can you talk about modes before this so folks don't get confused? The two modes that need to be covered are silent mode and runtime mode.

site/docs/v1/tech/admin-guide/upgrade.adoc

mooreds · 2023-07-29T14:52:52Z

site/docs/v1/tech/admin-guide/upgrade.adoc


-To upgrade to the latest version of FusionAuth using Docker go link:/docs/v1/tech/installation-guide/docker[here].
+To upgrade to the latest version of FusionAuth using Docker, go link:/docs/v1/tech/installation-guide/docker[here].

 If you want to use manual mode, download the latest version of FusionAuth and follow the instructions below. See https://fusionauth.io/download[Downloads].
 ====



I think we're okay leaving k8s update off, but can you link to the cloud upgrade section: https://fusionauth.io/docs/v1/tech/installation-guide/cloud#upgrading-a-deployment

site/docs/v1/tech/installation-guide/_theme-upgrade.adoc

Co-authored-by: Dan Moore <dan@fusionauth.io>

# Conflicts: # site/docs/v1/tech/installation-guide/docker.adoc

mooreds · 2023-08-02T14:53:14Z

Please let me know when this is ready for re-review.

…edit Updated upgrade guide language edit

mooreds

Going to close under #2461

TheMiniDriver and others added 12 commits April 17, 2023 08:36

upgrade work in progress

b61cfe2

small whitespace edits

c07f046

added new structure

4c3e8f6

separated old guide to pull in relevant parts to new structure

855de28

structuring

4e26ff8

red /green, thinking about upgrades

7926212

added around versions and configs

fb5e355

updated index and added images

03c4b40

remove old new guides

419fabb

fix header, note, image

3d1c6d0

Upgrading language edit

6719f53

Merge pull request #84 from ritza-co/upgrading-language-edit

a5469cc

Upgrading language edit

sixhobbits requested a review from mooreds May 12, 2023 08:28

mooreds added the content large piece of content label May 16, 2023

mooreds requested changes May 26, 2023

View reviewed changes

sixhobbits and others added 11 commits June 1, 2023 10:16

Update site/docs/v1/tech/admin-guide/upgrade.adoc

9a67833

Co-authored-by: Dan Moore <dan@fusionauth.io>

Update site/docs/v1/tech/admin-guide/upgrade.adoc

a0a35e7

Co-authored-by: Dan Moore <dan@fusionauth.io>

Update site/docs/v1/tech/admin-guide/upgrade.adoc

a776910

Co-authored-by: Dan Moore <dan@fusionauth.io>

Update site/docs/v1/tech/admin-guide/upgrade.adoc

6a4b877

Co-authored-by: Dan Moore <dan@fusionauth.io>

Update site/docs/v1/tech/admin-guide/upgrade.adoc

8020b05

Co-authored-by: Dan Moore <dan@fusionauth.io>

Update site/docs/v1/tech/admin-guide/upgrade.adoc

62db04c

Co-authored-by: Dan Moore <dan@fusionauth.io>

Update site/docs/v1/tech/admin-guide/upgrade.adoc

48ee59a

Co-authored-by: Dan Moore <dan@fusionauth.io>

Update site/docs/v1/tech/admin-guide/upgrade.adoc

b63000a

Co-authored-by: Dan Moore <dan@fusionauth.io>

Update site/docs/v1/tech/admin-guide/upgrade.adoc

980b979

Co-authored-by: Dan Moore <dan@fusionauth.io>

Update site/docs/v1/tech/admin-guide/upgrade.adoc

e875078

Co-authored-by: Dan Moore <dan@fusionauth.io>

feedback updates

9249695

TheMiniDriver and others added 4 commits June 21, 2023 00:31

-theme upgrade additions

c13a834

text updates

ccca5bb

Theme upgrade language edit

31fd276

Merge pull request #94 from ritza-co/theme-upgrade-language-edit

77093fc

Theme upgrade language edit

sixhobbits requested a review from mooreds June 22, 2023 07:20

TheMiniDriver and others added 8 commits June 22, 2023 17:32

added default theme ID in text

0064566

outstanding change requests

6b06c53

Upgrade Guide change requests language edit

612e054

Merge pull request #96 from ritza-co/upgrade-guide-change-requests-la…

a939e62

…nguage-edit Upgrade Guide change requests language edit

simplified and removed duplication from main database section

20d03d5

fix table of contents

5f7e405

removed second db update section, added backup warning to out of band…

7d81910

… section

fix note

5f42c72

mooreds requested changes Jul 29, 2023

View reviewed changes

sixhobbits and others added 4 commits August 1, 2023 10:11

Update site/docs/v1/tech/admin-guide/upgrade.adoc

72d7e3f

Co-authored-by: Dan Moore <dan@fusionauth.io>

Apply suggestions from code review

8c9f209

Co-authored-by: Dan Moore <dan@fusionauth.io>

Merge branch 'master' into 1951-upgrade-guide

7e06f34

# Conflicts: # site/docs/v1/tech/installation-guide/docker.adoc

feedback updates

d2e1bdc

TheMiniDriver and others added 4 commits August 10, 2023 09:55

added rollback info and removed vistigal note

259bbc1

added intro and links for silent mode

143b37c

Updated upgrade guide language edit

0029d16

Merge pull request #120 from ritza-co/updated-upgrade-guide-language-…

620e1fe

…edit Updated upgrade guide language edit

sixhobbits requested a review from mooreds August 11, 2023 11:05

mooreds mentioned this pull request Aug 16, 2023

Mooreds/1951 upgrade guide #2461

Merged

mooreds reviewed Aug 16, 2023

View reviewed changes

mooreds closed this Aug 16, 2023

mooreds mentioned this pull request Sep 22, 2023

Refresh upgrade guide #1951

Closed

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: upgrade guide improvements #2166

docs: upgrade guide improvements #2166

sixhobbits commented May 12, 2023 •

edited

mooreds May 26, 2023

mooreds Jul 29, 2023

mooreds May 26, 2023

mooreds May 26, 2023

mooreds May 26, 2023

mooreds May 26, 2023

mooreds commented May 26, 2023

mooreds commented Jun 15, 2023

sixhobbits commented Jun 16, 2023

mooreds commented Jun 16, 2023

sixhobbits commented Jun 22, 2023

sixhobbits commented Jun 29, 2023

mooreds left a comment

mooreds Jul 29, 2023

mooreds Jul 29, 2023

mooreds commented Aug 2, 2023

mooreds left a comment


		To upgrade to the latest version of FusionAuth using Homebrew go link:/docs/v1/tech/installation-guide/homebrew[here].
		To upgrade to the latest version of FusionAuth using Homebrew, go link:/docs/v1/tech/installation-guide/homebrew[here].


		To upgrade to the latest version of FusionAuth using the FastPath installation go link:/docs/v1/tech/installation-guide/fast-path[here].
		The timing of the database upgrade is also important to note. When an upgraded node is started and connects to the database, it will lock the database immediately if configured for Silent Mode and the database requires upgrading. This means that the database will be unavailable to other nodes in the cluster until the upgrade is complete.

docs: upgrade guide improvements #2166

docs: upgrade guide improvements #2166

Conversation

sixhobbits commented May 12, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mooreds commented May 26, 2023

mooreds commented Jun 15, 2023

sixhobbits commented Jun 16, 2023

mooreds commented Jun 16, 2023

sixhobbits commented Jun 22, 2023

sixhobbits commented Jun 29, 2023

mooreds left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mooreds commented Aug 2, 2023

mooreds left a comment

Choose a reason for hiding this comment

sixhobbits commented May 12, 2023 •

edited