Skip to content

Commit 32eefbc

Browse files
Apply suggestions from code review
Co-authored-by: Thomas Gran <[email protected]>
1 parent 5aeeffa commit 32eefbc

File tree

1 file changed

+7
-10
lines changed

1 file changed

+7
-10
lines changed

docs/Migrating-Configuration.md

+7-10
Original file line numberDiff line numberDiff line change
@@ -16,22 +16,19 @@ to be a configuration error, perhaps because the schema was changed. In such a c
1616
consult the [feature](Configuration.md#otp-features), [router](RouterConfiguration.md) or
1717
[build configuration documentation](BuildConfiguration.md) to find out what the new schema looks like.
1818

19-
By default, OTP starts up even when unknown configuration parameters have been found. This is there
20-
to support the style deployment where old config parameters remain in the file for a certain migration
21-
period.
22-
23-
This allows you to roll back the OTP version without the need to roll back the OTP configuration.
19+
By default, OTP starts up even if unknown configuration parameters exists. This supports forward and backwards
20+
migration of config parameters independent if the OTP version. This allow the configuration to follow the lifecycle of the environment and still be able to roll back OTP. Combined with the config parameter substitution it also allows using the same configuration in different environments. Tip! Rolling out the configuration before rolling out a new
21+
version of OTP, ensure you that you are safe and can roll back later.
2422

2523
An example: you change the location of the graphs, a critical error occurs afterwards and you need to
2624
roll back. Any member of the dev-ops team should then be confident that they can roll back without
27-
risk - even if the environment changed.
25+
risk - even if the environment changed since the last OTP version was rolled out.
2826

2927
### Aborting on invalid configuration
3028

3129
If you want OTP to abort the startup when encountering unknown configuration parameters, you can add
3230
the flag `--abortOnUnknownConfig` to your regular OTP CLI commands.
3331

34-
This should of course be used wisely as it can also accidentally make your production instances refuse
35-
to start up.
36-
Therefore, we recommend that you use it only in a separate pre-production step, perhaps during graph
37-
build.
32+
This should of course be used wisely as it can also accidentally make your production instances refuse to start up.
33+
For some deployments this is a good solution - especially if the config substitution feature is used to inject
34+
environment specific information. Using this feature in the graph-build phase is less risky, than in the OTP serve phase.

0 commit comments

Comments
 (0)