Documentation updates for Active/Standby #1994
Merged
Conversation
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
shreddedbacon
added
the
7-documentation-examples
AlannaBurke
requested changes
Jun 25, 2020
docs/using_lagoon/active_standby.md
Outdated
|
|
||
| ## Notes | ||
|
|
||
| When the active/standby trigger has been executed, the `productionEnvironment` and `standbyProductionEnvironments` will switch within the Lagoon API. Both environments are still classed as `production` environment types. We use the `productionEnvironment` to determine which one is labelled as `active`. |
There was a problem hiding this comment.
Maybe we should link to the Environment Types page and say something like "for more information on the difference between production and development environments, read the documentation on environment types." I'm worried this could be confusing otherwise.
There was a problem hiding this comment.
Ahh good idea :D I will make some changes.
docs/using_lagoon/active_standby.md
Outdated
| @@ -6,7 +6,7 @@ Lagoon supports Active/Standby (also known as blue/green) deployments. | |||
| To change an existing project to support active/standby you'll need to configure some project settings in the Lagoon API | |||
There was a problem hiding this comment.
Need some periods after these first 3 sentences, a little hard to read.
| @@ -52,10 +53,14 @@ production_routes: | |||
|
|
|||
| > Note: Any routes that are under the section `environments.<branch>.routes` will not be moved as part of active/standby, these routes will always be attached to the environment as defined. Ensure that if you do need a specific route to be migrated during an active/standby switch, that you remove them from the `environments` section and place them under the `production_routes` section specific to if it should be an `active` or `standby` route. | |||
|
|
|||
| ## Triggering a switch event | |||
| ## Triggering the active/standby switch | |||
| ### via the UI | |||
There was a problem hiding this comment.
The current button is very much an interim feature while we wait to get some UX over it to determine the best way to implement the switch.
AlannaBurke
approved these changes
Jun 25, 2020
| @@ -52,10 +53,14 @@ production_routes: | |||
|
|
|||
| > Note: Any routes that are under the section `environments.<branch>.routes` will not be moved as part of active/standby, these routes will always be attached to the environment as defined. Ensure that if you do need a specific route to be migrated during an active/standby switch, that you remove them from the `environments` section and place them under the `production_routes` section specific to if it should be an `active` or `standby` route. | |||
|
|
|||
| ## Triggering a switch event | |||
| ## Triggering the active/standby switch | |||
| ### via the UI | |||
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Checklist
Some updates for the active/standby documentation
Closing issues
Put
closes #XXXXin your comment to auto-close the issue that your PR fixes (if such).