Add Upgrading ACA-Py document #2200
Conversation
Signed-off-by: Stephen Curran <[email protected]>
UpgradingACA-Py.md
Outdated
|
|
||
| If the Maintainers of ACA-Py recognize a case where ACA-Py must be upgraded while | ||
| offline, a new Upgrade feature will be added that will prevent the "auto upgrade" | ||
| process from executing. See [Issue XXXX] for the status of that feature. |
| If the Maintainers of ACA-Py recognize a case where ACA-Py must be upgraded while | ||
| offline, a new Upgrade feature will be added that will prevent the "auto upgrade" | ||
| process from executing. See [Issue XXXX] for the status of that feature. | ||
|
|
There was a problem hiding this comment.
I think we should also mention:
There are 2 flavours of this explicit upgrade mechanism, "critical" and "warning". With critical, it will stop the "auto upgrade" process, raise an exception and force users to do the upgrade offline first. With warning, it will stop the "auto upgrade" process, log a warning but allows ACA-Py to startup normally. In this case, the version is not updated in secure storage and it will only update when doing the upgrade offline.
There was a problem hiding this comment.
I've referenced the docs. We'll update this once when the merge of the #2204 is done -- perhaps as part of that PR, even.
UpgradingACA-Py.md
Outdated
| ### Forcing an upgrade | ||
|
|
||
| If you would like to force an upgrade from a given version, a pair of ACA-Py | ||
| configuration arguments can be used together. If you specify "`--from-version |
There was a problem hiding this comment.
Maybe mention an example for clarity:
For instance, if the version in secure storage has been set as v0.8.0 but for some reason you want to apply upgrades from >=v0.7.2, then you can specify "--from-version v0.7.2" and "--force-upgrade".
There was a problem hiding this comment.
Done. Confirming @shaangill025 that the "v" is needed in "--from-version". I've put it in, but is that right?
There was a problem hiding this comment.
Yes, as we use "v" in config too.
Signed-off-by: Stephen Curran <[email protected]>
|
Kudos, SonarCloud Quality Gate passed!
|
Signed-off-by: Stephen Curran [email protected]