Skip to content
Snippets Groups Projects
Commit 632c8eb4 authored by Martyn Welch's avatar Martyn Welch Committed by Emanuele Aina
Browse files

Move ostree doc to guides


Document covers how to use OSTree, which is still relevant. Move it to the
guides section.

Signed-off-by: default avatarMartyn Welch <martyn.welch@collabora.com>
parent ef21216b
Branches
No related tags found
1 merge request!39Wip/martyn/website updates
......@@ -2,17 +2,13 @@
date = "2019-01-08"
weight = 100
title = "OSTree"
title = "OSTree updates and rollback"
aliases = [
"/old-wiki/Docs/OSTree"
]
+++
# OSTree updates and rollback
## Introduction
With the 18.03 release of Apertis, a new set of images have appeared.
Apertis is now delivered in two variants: apt images and OSTree images.
......@@ -24,7 +20,7 @@ specific images will support OSTree commands for updates and rollback.
Note that \`apt-get\` and the debian packages are not available in
OSTree images.
## Updating the host with Apertis Update Manager (AUM)
# Updating the host with Apertis Update Manager (AUM)
AUM has been added into Apertis starting from 18.12. It allows to do
automatic and manual updates. Updates with USB mass storage devices are
......@@ -34,7 +30,7 @@ daemon.
AUM logs are available with command \`journalctl --unit
apertis-update-manager\`
### OTA update
## OTA update
By default OTA updates are switched off.
......@@ -48,35 +44,35 @@ To enable OTA updates permanently please add into the configuration file
[Manager]
UpdateFromNetwork=true
### Offline update
## Offline update
Starting from Apertis 18.12 files for offline updates are generated and
available for download (check files with extention "\*.delta").
#### Automatic offline update
### Automatic offline update
It is enough to copy such file to the root of USB mass storage device
with special name \`static-update.bundle\` and attach that device into
the target system. AUM will automatically detect the update file and try
to use it for the system upgrade.
#### Manual offline update
### Manual offline update
It is possible to update the system manually from local file with CLI,
for instance to update SabreLite device manually to 18.12 release:
updatectl --apply-static-delta apertis_ostree_18.12-minimal-armhf-mx6qsabrelite_18.12.0.delta
### Automatic rollback
## Automatic rollback
With 19.03 release Apertis is able to automatically detect the rollback
situation for incorrect upgrade and revert the system to the previous
state. More details are available in [manual test of
rollback](https://qa.apertis.org/apertis-update-manager-rollback.html).
## Updating the host with \`ostree\` tool
# Updating the host with \`ostree\` tool
### OTA updates
## OTA updates
To trigger an update, it is simply needed to run the update command
below and reboot.
......@@ -89,7 +85,7 @@ below and reboot.
(ostree upgrade:719): OSTree-WARNING **: Couldn't unlink ostree-0-1.conf
Transaction complete; bootconfig swap: yes deployment count change: 1
## Locally available deployments
# Locally available deployments
OSTree can show the deployments available. This can be though of as
seeing the branches in a call to \`git branch\`. The star symbol
......@@ -113,7 +109,7 @@ that was in use before the update.
apertis 398824a16a766149a9c025311745472739f85d310fd6b1346456050dc112671a.0 (rollback)
origin refspec: origin:apertis/18.06/amd64-uefi/minimal
## Switching to the previous release
# Switching to the previous release
After an update, OSTree kept a reference to the previous release that
was deployed. It is possible to switch to this release by using the
......@@ -138,7 +134,7 @@ Warning: This is not a real rollback\! The worst case where a rollback
is needed occurs when the OS didn't boot. In this situation, the only
component able to handle the rollback is the bootloader.
## Temporary modifications on the filesystem
# Temporary modifications on the filesystem
OSTree filesystems are read-only (with the exception of /var and /etc).
For development purposes, it is possible to modify files on the
......@@ -148,7 +144,7 @@ filesystem will be lost at reboot.
sudo ostree admin unlock
## References
# References
OSTree reference documentation: <https://ostree.readthedocs.io/>
......
......
......@@ -22,7 +22,7 @@ one used in production, reducing the value of testing.
Changing the rootfs is also impossible or very cumbersome to do with
some deployment systems such as
[dm-verity](https://source.android.com/security/verifiedboot/dm-verity)
or [OSTree]( {{< ref "/docs/ostree.md" >}} ). Other systems may simply not ship
or [OSTree]( {{< ref "/guides/ostree.md" >}} ). Other systems may simply not ship
package management systems like `apt`/`dpkg` due to size constraints,
making package dependencies not viable.
......
......
......@@ -187,7 +187,7 @@ be used in verified boot solutions.
### Examples of key OSTree commands for Apertis images
A few OSTree commands have been collected in
[Docs/OSTree]( {{< ref "/docs/ostree.md" >}} ) to provide a reference of
[Docs/OSTree]( {{< ref "/guides/ostree.md" >}} ) to provide a reference of
important operations for developers:
- updating the system
......
......
......@@ -54,7 +54,7 @@ of the tests themselves as the tested system diverged significantly from
the original image.
With the introduction in the recent releases of images with immutable
rootfs based on [OSTree]( {{< ref "/docs/ostree.md" >}} ) the approach above was
rootfs based on [OSTree]( {{< ref "/guides/ostree.md" >}} ) the approach above was
entirely not viable as it relies on mutating the base rootfs.
A set of high priority tests has now been converted to be self-contained
......
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment