Skip to content
Snippets Groups Projects
Commit 61850fa2 authored by Walter Lozano's avatar Walter Lozano
Browse files

Fix formatting in ostree guide


Fix some formatting issues, remarks and command names.

Signed-off-by: default avatarWalter Lozano <walter.lozano@collabora.com>
parent 10669d13
No related branches found
No related tags found
1 merge request!150Fix formating in ostree guide
Pipeline #182638 passed
...@@ -19,22 +19,22 @@ With the 18.03 release of Apertis, a new set of images have appeared. ...@@ -19,22 +19,22 @@ 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. Apertis is now delivered in two variants: apt images and OSTree images.
The standard images are a debian derivative. The OSTree images are The standard images are a debian derivative. The OSTree images are
prefixed \`apertis_ostree\`. There is no OSTree images for the SDK. The prefixed `apertis_ostree`. There is no OSTree images for the SDK. The
SDK includes a tool for creating or manipulating OSTree repositories, SDK includes a tool for creating or manipulating OSTree repositories,
but it is not using OSTree as a way to update itself. Only OSTree but it is not using OSTree as a way to update itself. Only OSTree
specific images will support OSTree commands for updates and rollback. specific images will support OSTree commands for updates and rollback.
Note that \`apt-get\` and the debian packages are not available in Note that `apt-get` and the debian packages are not available in
OSTree images. 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 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 automatic and manual updates. Updates with USB mass storage devices are
supported as well. CLI utility \`updatectl\` is aimed to manage the AUM supported as well. CLI utility `updatectl` is aimed to manage the AUM
daemon. daemon.
AUM logs are available with command \`journalctl --unit AUM logs are available with command `journalctl --unit
apertis-update-manager\` apertis-update-manager`
## OTA update ## OTA update
...@@ -45,7 +45,7 @@ To enable OTA updates for one time: ...@@ -45,7 +45,7 @@ To enable OTA updates for one time:
gdbus call -y -d org.apertis.ApertisUpdateManager -o / -m org.freedesktop.DBus.Properties.Set org.apertis.ApertisUpdateManager UpdatesFromNetwork "<true>" gdbus call -y -d org.apertis.ApertisUpdateManager -o / -m org.freedesktop.DBus.Properties.Set org.apertis.ApertisUpdateManager UpdatesFromNetwork "<true>"
To enable OTA updates permanently please add into the configuration file To enable OTA updates permanently please add into the configuration file
\`/etc/apertis-update-manager.ini\` following: `/etc/apertis-update-manager.ini` following:
[Manager] [Manager]
UpdateFromNetwork=true UpdateFromNetwork=true
...@@ -58,7 +58,7 @@ available for download (check files with extention "\*.delta"). ...@@ -58,7 +58,7 @@ 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 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 with special name `static-update.bundle` and attach that device into
the target system. AUM will automatically detect the update file and try the target system. AUM will automatically detect the update file and try
to use it for the system upgrade. to use it for the system upgrade.
...@@ -76,7 +76,7 @@ situation for incorrect upgrade and revert the system to the previous ...@@ -76,7 +76,7 @@ situation for incorrect upgrade and revert the system to the previous
state. More details are available in [manual test of state. More details are available in [manual test of
rollback](https://qa.apertis.org/apertis-update-manager-rollback.html). 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
...@@ -94,10 +94,10 @@ below and reboot. ...@@ -94,10 +94,10 @@ below and reboot.
# Locally available deployments # Locally available deployments
OSTree can show the deployments available. This can be though of as OSTree can show the deployments available. This can be though of as
seeing the branches in a call to \`git branch\`. The star symbol seeing the branches in a call to `git branch`. The star symbol
(\`\*\`) is attached to the commit currently in use. (`\*`) is attached to the commit currently in use.
Immediately after a call to \`ostree admin update\`, the \`(pending)\` Immediately after a call to `ostree admin update`, the `(pending)`
label is attached to the commit to use on next boot. label is attached to the commit to use on next boot.
$ sudo ostree admin status $ sudo ostree admin status
...@@ -106,7 +106,7 @@ label is attached to the commit to use on next boot. ...@@ -106,7 +106,7 @@ label is attached to the commit to use on next boot.
* apertis 398824a16a766149a9c025311745472739f85d310fd6b1346456050dc112671a.0 * apertis 398824a16a766149a9c025311745472739f85d310fd6b1346456050dc112671a.0
origin refspec: origin:apertis/18.06/amd64-uefi/minimal origin refspec: origin:apertis/18.06/amd64-uefi/minimal
After the reboot, the \`(rollback)\` label is attached to the commit After the reboot, the `(rollback)` label is attached to the commit
that was in use before the update. that was in use before the update.
$ sudo ostree admin status $ sudo ostree admin status
...@@ -119,8 +119,8 @@ that was in use before the update. ...@@ -119,8 +119,8 @@ that was in use before the update.
After an update, OSTree kept a reference to the previous release that 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 was deployed. It is possible to switch to this release by using the
commit id that was returned in a call to \`OSTree admin status\` (with commit id that was returned in a call to `ostree admin status` (with
the \`.0\` extension removed). the `.0` extension removed).
$ sudo ostree admin upgrade --allow-downgrade --deploy-only $ sudo ostree admin upgrade --allow-downgrade --deploy-only
--override-commit=398824a16a766149a9c025311745472739f85d310fd6b1346456050dc112671a -r --override-commit=398824a16a766149a9c025311745472739f85d310fd6b1346456050dc112671a -r
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment