-
Notifications
You must be signed in to change notification settings - Fork 123
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: initial auto-updates and rollbacks pages (#14)
This adds two initial pages on OS updates, covering: * auto-updates * manual rollbacks
- Loading branch information
Luca Bruno
authored and
Andrew Jeddeloh
committed
Oct 9, 2019
1 parent
a6708bc
commit c13c9ea
Showing
5 changed files
with
37 additions
and
5 deletions.
There are no files selected for viewing
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 |
---|---|---|
@@ -1,5 +1,9 @@ | ||
* User guides | ||
** xref:getting-started.adoc[Getting Started] | ||
** xref:getting-started.adoc[Getting started] | ||
** xref:faq.adoc[FAQ] | ||
** OS updates | ||
*** xref:auto-updates.adoc[Auto-updates] | ||
** Troubleshooting | ||
*** xref:manual-rollbacks.adoc[Manual rollbacks] | ||
* Reference pages | ||
** xref:platforms.adoc[Platforms] |
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,20 @@ | ||
= Auto-updates | ||
|
||
Fedora CoreOS provides atomic updates and rollbacks via https://ostree.readthedocs.io/en/latest/[OSTree] deployments. | ||
|
||
By default, the OS performs continuous auto-updates via two components: | ||
|
||
* https://github.com/coreos/rpm-ostree[rpm-ostree] handles multiple on-disk OSTree deployments, and it can switch between them at boot-time. | ||
* https://github.com/coreos/zincati[Zincati] continuously checks for OS updates and applies them via rpm-ostree. | ||
|
||
== OS-update finalization | ||
|
||
In order to finalize an OS update, a machine needs to perform a reboot. | ||
As this is an invasive action which may cause service disruption, Zincati allows the cluster administrator to control when nodes are allowed to reboot in order to finalize updates. | ||
|
||
The following finalization strategies are available: | ||
|
||
* immediately reboot to apply an update, as soon as it is downloaded and staged locally | ||
* use an external lock-manager to reboot a fleet of machines in a coordinated way | ||
|
||
For further documentation on how to configure updates finalization, check Zincati documentation on https://github.com/coreos/zincati/blob/master/docs/usage/updates-strategy.md[updates strategy]. |
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,12 @@ | ||
= Manual rollbacks | ||
|
||
In case of a misbehaving OS update, it is possible to temporarily or permanently switch back to the previous working OS version. | ||
This is a manual operation which requires human intervention and console access. | ||
|
||
Upon updates, the previous OS deployment is kept on disk so that it can be used as a fallback if something goes wrong. | ||
|
||
In order to temporarily boot into the previous OS deployment, hold down `Shift` during OS bootup and select the relevant OS entry in the bootloader menu. | ||
The default boot configuration is not affected by this action, and the next reboot will select again the updated OS. | ||
|
||
In order to permanently revert to the previous OS deployment, login to the target node and run `rpm-ostree rollback -r`. | ||
This operation will update boot-loader configuration, marking the previous OS deployment as the default one and immediately rebooting into it. |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.