Skip to content

Commit

Permalink
pages/auto-updates: add section on configuring rollout_wariness (core…
Browse files Browse the repository at this point in the history
  • Loading branch information
dustymabe committed Dec 4, 2019
1 parent b997712 commit 3870d05
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion modules/ROOT/pages/auto-updates.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,31 @@ 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.

== Configuring Update/Rollout Wariness

The Zincati service runs on a Fedora CoreOS node and checks with the remote Cincinnati service to see when updates are available. It can be configured with a custom "rollout wariness" value (see https://github.com/coreos/zincati/blob/0.0.6/docs/usage/auto-updates.md#phased-rollouts-client-wariness-canaries[documentation]) to let the server know how eager, or how risk-averse the node is to receiving updates. `rollout_wariness` can be a floating point value between `0.0` (most eager) and `1.0` (most conservative). In order to receive updates very early in the phased rollout cycle, a node can be configured with a low `rollout_wariness` value (e.g. `0.001`). This can be done during provisioning by using the https://github.com/coreos/fcct[FCCT] configuration snippet shown below:

.Example FCC adding a file to configure rollout_wariness
[source,yaml]
----
variant: fcos
version: 1.0.0
passwd:
users:
- name: core
ssh_authorized_keys:
- ssh-rsa AAA...
storage:
files:
- path: /etc/zincati/config.d/51-rollout-wariness.toml
contents:
inline: |
[identity]
rollout_wariness = 0.001
----

To see how to use the config snippet above and provision a machine see the xref:getting-started.adoc[Getting Started Guide].

== OS-update finalization

In order to finalize an OS update, a machine needs to perform a reboot.
Expand All @@ -17,4 +42,4 @@ 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].
For further documentation on how to configure updates finalization, check Zincati documentation on https://github.com/coreos/zincati/blob/0.0.6/docs/usage/updates-strategy.md[updates strategy].

0 comments on commit 3870d05

Please sign in to comment.