New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: upgrade guide improvements #2166
Closed
Closed
Changes from all commits
Commits
Show all changes
43 commits
Select commit
Hold shift + click to select a range
b61cfe2
upgrade work in progress
TheMiniDriver c07f046
small whitespace edits
TheMiniDriver 4c3e8f6
added new structure
TheMiniDriver 855de28
separated old guide to pull in relevant parts to new structure
TheMiniDriver 4e26ff8
structuring
TheMiniDriver 7926212
red /green, thinking about upgrades
TheMiniDriver fb5e355
added around versions and configs
TheMiniDriver 03c4b40
updated index and added images
TheMiniDriver 419fabb
remove old new guides
sixhobbits 3d1c6d0
fix header, note, image
sixhobbits 6719f53
Upgrading language edit
worktheclock a5469cc
Merge pull request #84 from ritza-co/upgrading-language-edit
sixhobbits 9a67833
Update site/docs/v1/tech/admin-guide/upgrade.adoc
sixhobbits a0a35e7
Update site/docs/v1/tech/admin-guide/upgrade.adoc
sixhobbits a776910
Update site/docs/v1/tech/admin-guide/upgrade.adoc
sixhobbits 6a4b877
Update site/docs/v1/tech/admin-guide/upgrade.adoc
sixhobbits 8020b05
Update site/docs/v1/tech/admin-guide/upgrade.adoc
sixhobbits 62db04c
Update site/docs/v1/tech/admin-guide/upgrade.adoc
sixhobbits 48ee59a
Update site/docs/v1/tech/admin-guide/upgrade.adoc
sixhobbits b63000a
Update site/docs/v1/tech/admin-guide/upgrade.adoc
sixhobbits 980b979
Update site/docs/v1/tech/admin-guide/upgrade.adoc
sixhobbits e875078
Update site/docs/v1/tech/admin-guide/upgrade.adoc
sixhobbits 9249695
feedback updates
rideam c13a834
-theme upgrade additions
TheMiniDriver ccca5bb
text updates
rideam 31fd276
Theme upgrade language edit
worktheclock 77093fc
Merge pull request #94 from ritza-co/theme-upgrade-language-edit
sixhobbits 0064566
added default theme ID in text
TheMiniDriver 6b06c53
outstanding change requests
TheMiniDriver 612e054
Upgrade Guide change requests language edit
worktheclock a939e62
Merge pull request #96 from ritza-co/upgrade-guide-change-requests-la…
sixhobbits 20d03d5
simplified and removed duplication from main database section
TheMiniDriver 5f7e405
fix table of contents
rideam 7d81910
removed second db update section, added backup warning to out of band…
TheMiniDriver 5f42c72
fix note
rideam 72d7e3f
Update site/docs/v1/tech/admin-guide/upgrade.adoc
sixhobbits 8c9f209
Apply suggestions from code review
sixhobbits 7e06f34
Merge branch 'master' into 1951-upgrade-guide
rideam d2e1bdc
feedback updates
rideam 259bbc1
added rollback info and removed vistigal note
TheMiniDriver 143b37c
added intro and links for silent mode
TheMiniDriver 0029d16
Updated upgrade guide language edit
worktheclock 620e1fe
Merge pull request #120 from ritza-co/updated-upgrade-guide-language-…
sixhobbits File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
22 changes: 22 additions & 0 deletions
22
site/_diagrams/docs/admin-guide/blue_green_upgrade.plantuml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
@startuml | ||
!include ../../_config.plantuml | ||
|
||
actor "Users" as u | ||
agent "Load Balancer" as lb | ||
|
||
rectangle "Blue Deployment (old version)" as f1 { | ||
[Node 1]#lightblue | ||
[Node 2]#lightblue | ||
[Node 3]#blue;text:white | ||
} | ||
|
||
rectangle "Green Deployment (new version)" as f2 { | ||
[Node #1]#lightgreen | ||
[Node #2]#lightgreen | ||
[Node #3]#lightgreen | ||
} | ||
|
||
u -> lb | ||
lb -> f1 | ||
lb ..> f2 : Switch traffic when ready | ||
@enduml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
@startuml | ||
!include ../../_config.plantuml | ||
|
||
actor "Users" as u | ||
agent "Load Balancer" as lb | ||
component "Node 1" as n1 #lightgreen | ||
component "Node 2" as n2 #lightblue | ||
component "Node 3" as n3 #lightblue | ||
|
||
u -> lb | ||
lb ..> n1 : Switch traffic when ready \n (Upgrade one node at a time) | ||
lb --> n2 | ||
lb -> n3 | ||
@enduml |
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
**Q:** What is runtime mode and how does it affect upgrades? + | ||
**A:** FusionAuth runtime mode can be either `production` or `development`. When in the `development` runtime mode, Maintenance Mode will interactively assist you to configure the database and connect to Elasticsearch, if configured. Once you move FusionAuth into production, it is recommended that you modify the runtime mode to `production`. When in `production` runtime mode, Maintenance Mode will no longer be available to you, which means you can be certain that your end users will not find themselves on the database upgrade panel during an upgrade. When in `production` mode, you will either need to leverage Silent Mode to automatically apply database migrations or you will need to apply the database migrations yourself (either by hand or via a script of some sort). For more on runtime modes, see the link:/docs/v1/tech/installation-guide/fusionauth-app#runtime-modes[FusionAuth Installation Guide]. | ||
|
||
**Q:** What is Maintenance Mode? + | ||
**A:** Maintenance Mode is a special admin interface for FusionAuth installations in development environments. Maintenance Mode helps you to interactively upgrade FusionAuth or set up database connections. You can switch to Maintenance Mode by switching to the `development` runtime mode and setting Silent Mode to false. Note that Maintenance Mode should never be used in production. | ||
|
||
**Q:** What is Silent Mode? + | ||
**A:** link:/docs/v1/tech/guides/silent-mode[Silent Mode] is a feature of FusionAuth that automatically applies database migrations. This is useful for automated deployments. Silent Mode can be enabled in the `development` runtime mode and as of version `1.19.0`, in the `production` runtime mode too. Silent Mode will attempt to perform database migrations on startup. If the database migrations fail, FusionAuth will display an error message on the login page. You should always test your database migrations in a non-production or staging environment before deploying to production. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
If you initially installed FusionAuth using Homebrew, you can also use Homebrew to upgrade to the latest version of FusionAuth. | ||
|
||
To upgrade FusionAuth using brew, first stop services. | ||
|
||
``` | ||
brew services stop fusionauth-search | ||
brew services stop fusionauth-app | ||
``` | ||
|
||
Next, upgrade services. | ||
|
||
:code_id: homebrew-upgrade-script | ||
[source] | ||
---- | ||
brew upgrade fusionauth-app fusionauth-search | ||
---- | ||
:code_id!: | ||
|
||
Start the services. | ||
|
||
[source] | ||
---- | ||
brew services start fusionauth-search | ||
brew services start fusionauth-app | ||
---- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
To upgrade FusionAuth when running with `docker-compose`: | ||
|
||
. Stop the instance: `docker-compose down`. | ||
. Modify the `docker-compose.yml` file to point to the version of FusionAuth you want. You can see https://hub.docker.com/r/fusionauth/fusionauth-app[available tags]. | ||
. Start it up: `docker-compose up`. | ||
. Login to the administrative UI. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These don't render for me, as I don't have graphviz. Now that we have mermaid available, can you please do these as mermaid diagrams?