1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
|
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
Copyright 2011,2013 Colin Walters <walters@verbum.org>
SPDX-License-Identifier: LGPL-2.0+
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library. If not, see <https://www.gnu.org/licenses/>.
-->
<refentry id="ostree">
<refentryinfo>
<title>ostree</title>
<productname>OSTree</productname>
<authorgroup>
<author>
<contrib>Developer</contrib>
<firstname>Colin</firstname>
<surname>Walters</surname>
<email>walters@verbum.org</email>
</author>
</authorgroup>
</refentryinfo>
<refmeta>
<refentrytitle>ostree</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>ostree</refname>
<refpurpose>Manage multiple bootable versioned filesystem trees</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree</command>
<arg choice="req">COMMAND</arg> <arg choice="opt" rep="repeat">OPTIONS</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
OSTree is a tool for managing multiple bootable
versioned filesystem trees, or just "tree" for
short. In the OSTree model, operating systems no
longer live in the physical "/" root directory.
Instead, they parallel install to the new toplevel
<filename>/ostree</filename> directory. Each
installed system gets its own
<filename>/ostree/deploy/<replaceable>stateroot</replaceable></filename>
directory. (<literal>stateroot</literal> is the
newer term for <literal>osname</literal>).
</para>
<para>
Unlike <literal>rpm</literal> or
<literal>dpkg</literal>, OSTree is only aware of
complete filesystem trees. It has no built-in
knowledge of what components went into creating the
filesystem tree.
</para>
<para>
It is possible to use OSTree in several modes; the
most basic form is to replicate pre-built trees from
a build server. Usually, these pre-built trees are
derived from packages. You might also be using
OSTree underneath a higher level tool which computes
filesystem trees locally.
</para>
<para>
It must be emphasized that OSTree only supports
<emphasis>read-only</emphasis> trees. To change to
a different tree (upgrade, downgrade, install
software), a new tree is checked out, and a 3-way
merge of configuration is performed. The currently
running tree is not ever modified; the new tree will
become active on a system reboot.
</para>
<para>
To see the man page for a command run <command>man ostree <replaceable>COMMAND</replaceable></command> or <command>man ostree-admin <replaceable>COMMAND</replaceable></command>
</para>
</refsect1>
<refsect1>
<title>Options</title>
<para>The following options are understood:</para>
<variablelist>
<varlistentry>
<term><option>--repo</option></term>
<listitem><para>
For most commands, a repository is
required. If unspecified, the current
directory is used if it appears to be an
OSTree repository. If it isn't, either
the <envar>OSTREE_REPO</envar>
environment variable is used, or the
system repository located at
<filename>/sysroot/ostree/repo</filename>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-v, --verbose</option></term>
<listitem><para>
Produce debug level output.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--version</option></term>
<listitem><para>
Print version information, including the features enabled
at compile time, and exit.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Commands</title>
<para>System administrators will primarily interact
with OSTree via the subcommand <command>ostree
admin</command>.</para>
<variablelist>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-admin-cleanup</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Delete untagged
deployments and repository objects.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-admin-config-diff</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
See changes to
<filename>/etc</filename> as compared
to the current default (from
<filename>/usr/etc</filename>).
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-admin-deploy</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Takes a particular
commit or revision, and sets it up for
the next boot.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-admin-init-fs</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Initialize a root filesystem
in a specified path.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-admin-instutil</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Utility functions intended primarily for operating system installation programs
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-admin-os-init</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Initialize the
deployment location for an operating
system with a specified name.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-admin-status</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Show and list the deployments.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-admin-switch</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Choose a different ref
to track from the same remote as the
current tree.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-admin-undeploy</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Remove the previously
<replaceable>INDEX</replaceable>
deployed tree from the bootloader
configuration.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-admin-upgrade</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Download the latest version for the
current ref, and deploy it.
</para></listitem>
</varlistentry>
</variablelist>
<para>Both administrators and operating system
builders may interact with OSTree via the regular
filesystem manipulation commands.
</para>
<variablelist>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-cat</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Concatenate contents of files
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-checkout</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Check out a commit into a filesystem tree.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-checksum</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Gives checksum of any file.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-commit</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Given one or more
trees, create a new commit using those contents.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-config</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Change settings.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-create-usb</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Put the given refs on an external drive for P2P distribution.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-diff</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Concisely list
differences between the given refs.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-find-remotes</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Find remotes to serve the given refs.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-fsck</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Check a repository for consistency.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-init</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Initialize a new repository.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-log</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Show revision log.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-ls</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
List the contents of a given commit.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-prune</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Search for unreachable objects.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-pull-local</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Copy data from source-repo.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-pull</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Download data from remote repo. If you have libsoup.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-refs</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
List refs.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-remote</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Manipulate remote archive configuration.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-reset</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Reset a ref to a previous commit.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-rev-parse</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Show the SHA256 corresponding to a given rev.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-show</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Given an OSTree SHA256 checksum, display its contents.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-static-delta</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Manage static delta files.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-summary</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Regenerate the repository summary metadata.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ostree-trivial-httpd</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Simple webserver.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Examples</title>
<para>
For specific examples, please see the man page regarding the specific ostree command. For example:
</para>
<para>
<command>man ostree init</command> or <command>man ostree-admin status</command>
</para>
</refsect1>
<refsect1>
<title>GPG verification</title>
<para>
OSTree supports signing commits with GPG. Operations on the system
repository by default use keyring files in
<filename>/usr/share/ostree/trusted.gpg.d</filename>. Any
public key in a keyring file in that directory will be
trusted by the client. No private keys should be present
in this directory.
</para>
<para>
In addition to the system repository, OSTree supports two
other paths. First, there is a
<literal>gpgkeypath</literal> option for remotes, which must point
to the filename of an ASCII-armored GPG key, or a directory containing
ASCII-armored GPG keys to import. Multiple file and directory paths
to import from can be specified, as a comma-separated list of paths. This option
may be specified by using <command>--set</command> in <command>ostree remote add</command>.
</para>
<para>
Second, there is support for a per-remote
<filename><replaceable>remotename</replaceable>.trustedkeys.gpg</filename>
file stored in the toplevel of the repository (alongside
<filename>objects/</filename> and such). This is
particularly useful when downloading content that may not
be fully trusted (e.g. you want to inspect it but not
deploy it as an OS), or use it for containers. This file
is written via <command>ostree remote add
--gpg-import</command>.
</para>
</refsect1>
<refsect1>
<title>Terminology</title>
<para>
The following terms are commonly used throughout the man pages. Terms in upper case letters
are literals used in command line arguments.
</para>
<glosslist>
<glossentry><glossterm><literal>BRANCH</literal></glossterm>
<glossdef>
<para>
Branch name. Part of a <glossterm><literal>REF</literal></glossterm>.
</para>
</glossdef>
</glossentry>
<glossentry><glossterm><literal>CHECKSUM</literal></glossterm>
<glossdef>
<para>
A SHA256 hash of a object stored in the OSTree repository. This can be a content,
a dirtree, a dirmeta or a commit object. If the SHA256 hash of a commit object is
meant, the term <glossterm><literal>COMMIT</literal></glossterm> is used.
</para>
</glossdef>
</glossentry>
<glossentry><glossterm><literal>COMMIT</literal></glossterm>
<glossdef>
<para>
A SHA256 hash of a commit object.
</para>
</glossdef>
</glossentry>
<glossentry><glossterm><literal>REF</literal></glossterm>
<glossdef>
<para>
A reference to a particular commit. References are text files stored in
<filename>refs/</filename> that name (refer to) a particular commit. A
reference can only be the branch name part, in which case a local reference
is used (e.g. <literal>mybranch/stable</literal>). If a remote branch
is referred to, the remote name followed by a colon and the branch name
needs to be used (e.g. <literal>myremote:mybranch/stable</literal>).
</para>
</glossdef>
</glossentry>
<glossentry><glossterm><literal>REV</literal></glossterm> <glossterm><literal>REFSPEC</literal></glossterm>
<glossdef>
<para>
A specific revision, a commit. This can be anything which can be resolved to a
commit, e.g. a <glossterm><literal>REF</literal></glossterm> or a
<glossterm><literal>COMMIT</literal></glossterm>.
</para>
</glossdef>
</glossentry>
<glossentry><glossterm>SHA256</glossterm>
<glossdef>
<para>
A cryptographic hash function used to store objects in the OSTree
repository. The hashes have a length of 256 bites and are typically
shown and passed to ostree in its 64 ASCII character long hexadecimal
representation
(e.g. 0fc70ed33cfd7d26fe99ae29afb7682ddd0e2157a4898bd8cfcdc8a03565b870).
</para>
</glossdef>
</glossentry>
</glosslist>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry><refentrytitle>ostree.repo</refentrytitle><manvolnum>5</manvolnum></citerefentry>
</para>
</refsect1>
</refentry>
|