feat: Migrations & related checks can be disabled #5140
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
aldeed
approved these changes
Apr 22, 2019
|
Thanks for the lint fix @aldeed! I can squash the commits down to a single, signed commit once the test/lint suites pass. |
brent-hoover
approved these changes
Apr 23, 2019
There was a problem hiding this comment.
This looks good to me but we should have @manueldelreal give it a test
|
@ticean Sign your commits and let's get this merged. 🎉 |
|
Oops, sorry I did the lint fix on github and forgot to add my signature. A signed squash sounds good @ticean |
The checks that verify the migration state are important to run the application in a safe and sane way. However, in some emergency circumstances it can be necessary to disable checks so that the application may be started when the migration versions don't line up. An example scenario might be an emergency release rollback. Running in such a mode is inherently unsafe! It is the operator's responsibility to decide if it is OK to run in this mode. The difference between the target and existing migration state should be examined carefully. New environment variables: - `MIGRATION_BYPASS_ENABLED`, boolean, not required, default: false Signed-off-by: Ticean Bennett <ticean@reactioncommerce.com>
ticean
force-pushed
the
feat-disable-migrations-and-checks
branch
from
a10520a
to
5c25072
Compare
|
All squashed with no changes. The DCO is passing. |
Merged
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.
Resolves N/A
Impact: minor
Type: feature
Issue
The checks that verify the migration state are important to run the application in a safe and sane way. However, in some emergency circumstances it can be necessary to disable checks so that the application may be started when the migration versions don't line up.
An example scenario might be an emergency release rollback.
Solution
Adds new environment variables to flag the migration feature.
MIGRATION_BYPASS_ENABLED, boolean, not required, default: falseCode changes disable migrations and checks when the flag is true.
Breaking changes
None.
Testing
Flag disabled
Migrations are Enabled
MIGRATION_BYPASS_ENABLEDflag is falseMigration Checks are Enabled
MIGRATION_BYPASS_ENABLEDflag is falseFlag enabled
Migrations are Disabled
MIGRATION_BYPASS_ENABLEDflag is true"DANGER: MIGRATION_BYPASS_ENABLED is true and all migration activity is bypassed. This is a dangerous mode and may result in data corruption."Migration Checks are Disabled
MIGRATION_BYPASS_ENABLEDflag is true