Skip to content

Commit 501e333

Browse files
committed
fixup! First shot at rpm-ostree command reference
1 parent a259969 commit 501e333

File tree

1 file changed

+85
-10
lines changed

1 file changed

+85
-10
lines changed

references/rpm_ostree_command_ref.adoc

Lines changed: 85 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ kernel modules, or userspace driver daemons such as `pcsc-lite-ccid`.
151151
While most software should go into a container, you have full flexibilty
152152
to use packages where it suits.
153153

154-
See the link:../using_ostree/ostree_mutations/package_layering.adoc[package layering section] for more information on package layering.
154+
See the link:../using_ostree/rebasing/package_layering.html[package layering section] for more information on package layering.
155155

156156

157157
=== `rpm-ostree install/uninstall <pkg>`
@@ -220,34 +220,109 @@ of the initramfs after its configuration has changed or a kernel driver has been
220220
You can query the state of initramfs regeneration by using the command without any
221221
options.
222222

223-
Or you can enable/disable the regeneration by using the `--enable` or `--disable`
223+
You can enable/disable the regeneration by using the `--enable` or `--disable`
224224
options respectively.
225225

226226
=== `rpm-ostree reload`
227227

228+
The `rpm-ostree reload` command is used to reload the `rpm-ostreed` daemon that runs
229+
on a system. This should be done when configuration of the daemon changes, for example
230+
when something a remote configuration in `/etc/ostree/remotes.d` has been modified.
231+
228232

229233
== Querying the RPM database
230234

231-
=== `rpm-ostree db diff`
235+
The `rpm-ostree db` command allows the user to inspect RPM data of the ostree commit/deployment.
236+
237+
=== `rpm-ostree db diff <commit> <commit>`
238+
239+
The `rpm-ostree db diff` command allows the user to compare the differences of the package
240+
set between two commits. By default, the output will show the packages which have been
241+
upgrade, downgraded, added, or removed between the commits.
242+
243+
Example output on Fedora 26 Atomic Host:
232244

233-
=== `rpm-ostree db list`
245+
....
246+
# rpm-ostree db diff 080cf9c61a5e 13ed0f241c | head -n 10
247+
ostree diff commit old: 080cf9c61a5e (080cf9c61a5e38f8101290db5025a71fc6cfb189a9393785ba347d006d6285ee)
248+
ostree diff commit new: 13ed0f241c (13ed0f241c9945fd5253689ccd081b5478e5841a71909020e719437bbeb74424)
249+
Upgraded:
250+
glibc 2.25-7.fc26.x86_64 -> 2.25-8.fc26.x86_64
251+
glibc-all-langpacks 2.25-7.fc26.x86_64 -> 2.25-8.fc26.x86_64
252+
glibc-common 2.25-7.fc26.x86_64 -> 2.25-8.fc26.x86_64
253+
krb5-libs 1.15.1-21.fc26.x86_64 -> 1.15.1-22.fc26.x86_64
254+
libcrypt-nss 2.25-7.fc26.x86_64 -> 2.25-8.fc26.x86_64
255+
python2-setuptools 36.2.0-1.fc26.noarch -> 36.2.0-2.fc26.noarch
256+
python3 3.6.2-1.fc26.x86_64 -> 3.6.2-5.fc26.x86_64
257+
....
258+
259+
=== `rpm-ostree db list <commit>`
260+
261+
The `rpm-ostree db list` command will list all the packages and their versions that are
262+
contained in a commit.
263+
264+
Example output from Fedora 26 Atomic Host:
265+
266+
....
267+
# rpm-ostree db list 080cf9c61a5e | head -n 10
268+
ostree commit: 080cf9c61a5e (080cf9c61a5e38f8101290db5025a71fc6cfb189a9393785ba347d006d6285ee)
269+
GeoIP-1.6.11-1.fc26.x86_64
270+
GeoIP-GeoLite-data-2017.07-1.fc26.noarch
271+
NetworkManager-1:1.8.2-1.fc26.x86_64
272+
NetworkManager-libnm-1:1.8.2-1.fc26.x86_64
273+
NetworkManager-team-1:1.8.2-1.fc26.x86_64
274+
acl-2.2.52-15.fc26.x86_64
275+
atomic-1.18.1-5.fc26.x86_64
276+
atomic-devmode-0.3.7-1.fc26.noarch
277+
atomic-registries-1.18.1-5.fc26.x86_64
278+
....
234279

235-
=== `rpm-ostree db version`
280+
=== `rpm-ostree db version <commit>`
236281

282+
The `rpm-ostree db version` command will display the version of the RPM database for the
283+
ostree commit provided.
284+
285+
Example output from Fedora 26 Atomic Host:
286+
287+
....
288+
# rpm-ostree db version 080cf9c61a5e
289+
ostree commit: 080cf9c61a5e (080cf9c61a5e38f8101290db5025a71fc6cfb189a9393785ba347d006d6285ee)
290+
rpmdbv is: 463:0a72e882be36a47eb580d89f0304a9876660f751
291+
....
237292

238293
== Composing an ostree commit
239294

240-
=== `rpm-ostree compose tree`
295+
The `rpm-ostree` command has support for generating an ostree commit that can be used by
296+
existing Atomic Hosts. The only input required is a JSON formatted 'treefile' which defines
297+
how the compose will be constructed.
241298

299+
See the section on link:../using_ostree/creating_own_distribution/ostree_compose.html[ostree compose] for more details.
242300

243-
== Experimental interface
301+
=== `rpm-ostree compose tree <treefile>`
302+
303+
The `rpm-ostree compose tree` command will install RPMs into a filesystem and commit that filesystem via ostree.
244304

245-
There is a generic `rpm-ostree ex` command that offers experimental features.
305+
== Experimental interface
246306

247-
=== `rpm-ostree ex container`
307+
There is a generic `rpm-ostree ex` command that offers experimental features. These features are not production read
308+
and should be treated as such. These commands may or may not be promoted to supported, which means they may be dropped
309+
from the tool altogether in the future.
248310

249311
=== `rpm-ostree ex livefs`
250312

313+
The `rpm-ostree ex livefs` command will apply any pending changes (for example, a package layered via `rpm-ostree install`)
314+
to the currently booted deployment. This allows the user to install packages and begin using them without having to reboot the
315+
system.
316+
251317
=== `rpm-ostree ex override`
252318

253-
=== `rpm-ostree ex unpack`
319+
The `rpm-ostree ex override` command allows the user to override the current package set of a deployment by removing or replacing
320+
packages from the base package set. Using these overrides requires that ther user reboot the system, as `rpm-ostree ex livefs` only
321+
supports packages that have been added via `rpm-ostree install`.
322+
323+
`rpm-ostree ex override remove` will remove a package from the base package set of a deployment.
324+
325+
`rpm-ostree ex override replace` will replace a package in the base package set of a deployment.
326+
327+
`rpm-ostree ex override reset` will reset any package overrides that have been made.
328+

0 commit comments

Comments
 (0)