1OSTREE(1) ostree OSTREE(1)
2
6 ostree - Manage multiple bootable versioned filesystem trees
7
9 ostree {COMMAND} [OPTIONS...]
10
12 OSTree is a tool for managing multiple bootable versioned filesystem
13 trees, or just "tree" for short. In the OSTree model, operating systems
14 no longer live in the physical "/" root directory. Instead, they
15 parallel install to the new toplevel /ostree directory. Each installed
16 system gets its own /ostree/deploy/stateroot directory. (stateroot is
17 the newer term for osname).
18 Unlike rpm or dpkg, OSTree is only aware of complete filesystem trees.
20 It has no built-in knowledge of what components went into creating the
21 filesystem tree.
22 It is possible to use OSTree in several modes; the most basic form is
24 to replicate pre-built trees from a build server. Usually, these
25 pre-built trees are derived from packages. You might also be using
26 OSTree underneath a higher level tool which computes filesystem trees
27 locally.
28 It must be emphasized that OSTree only supports read-only trees. To
30 change to a different tree (upgrade, downgrade, install software), a
31 new tree is checked out, and a 3-way merge of configuration is
32 performed. The currently running tree is not ever modified; the new
33 tree will become active on a system reboot.
34 To see the man page for a command run man ostree COMMAND or man
36 ostree-admin COMMAND
37
39 The following options are understood:
40 --repo
42 For most commands, a repository is required. If unspecified, the
43 current directory is used if it appears to be an OSTree repository.
44 If it isn't, either the OSTREE_REPO environment variable is used,
45 or the system repository located at /sysroot/ostree/repo.
46 -v, --verbose
48 Produce debug level output.
49 --version
51 Print version information, including the features enabled at
52 compile time, and exit.
53
55 System administrators will primarily interact with OSTree via the
56 subcommand ostree admin.
57 ostree-admin-cleanup(1)
59 Delete untagged deployments and repository objects.
60 ostree-admin-config-diff(1)
62 See changes to /etc as compared to the current default (from
63 /usr/etc).
64 ostree-admin-deploy(1)
66 Takes a particular commit or revision, and sets it up for the next
67 boot.
68 ostree-admin-init-fs(1)
70 Initialize a root filesystem in a specified path.
71 ostree-admin-instutil(1)
73 Utility functions intended primarily for operating system
74 installation programs
75 ostree-admin-os-init(1)
77 Initialize the deployment location for an operating system with a
78 specified name.
79 ostree-admin-status(1)
81 Show and list the deployments.
82 ostree-admin-switch(1)
84 Choose a different ref to track from the same remote as the current
85 tree.
86 ostree-admin-undeploy(1)
88 Remove the previously INDEX deployed tree from the bootloader
89 configuration.
90 ostree-admin-upgrade(1)
92 Download the latest version for the current ref, and deploy it.
93 Both administrators and operating system builders may interact with
95 OSTree via the regular filesystem manipulation commands.
96 ostree-cat(1)
98 Concatenate contents of files
99 ostree-checkout(1)
101 Check out a commit into a filesystem tree.
102 ostree-checksum(1)
104 Gives checksum of any file.
105 ostree-commit(1)
107 Given one or more trees, create a new commit using those contents.
108 ostree-config(1)
110 Change settings.
111 ostree-create-usb(1)
113 Put the given refs on an external drive for P2P distribution.
114 ostree-diff(1)
116 Concisely list differences between the given refs.
117 ostree-find-remotes(1)
119 Find remotes to serve the given refs.
120 ostree-fsck(1)
122 Check a repository for consistency.
123 ostree-init(1)
125 Initialize a new repository.
126 ostree-log(1)
128 Show revision log.
129 ostree-ls(1)
131 List the contents of a given commit.
132 ostree-prune(1)
134 Search for unreachable objects.
135 ostree-pull-local(1)
137 Copy data from source-repo.
138 ostree-pull(1)
140 Download data from remote repo. If you have libsoup.
141 ostree-refs(1)
143 List refs.
144 ostree-remote(1)
146 Manipulate remote archive configuration.
147 ostree-reset(1)
149 Reset a ref to a previous commit.
150 ostree-rev-parse(1)
152 Show the SHA256 corresponding to a given rev.
153 ostree-show(1)
155 Given an OSTree SHA256 checksum, display its contents.
156 ostree-static-delta(1)
158 Manage static delta files.
159 ostree-summary(1)
161 Regenerate the repository summary metadata.
162
164 For specific examples, please see the man page regarding the specific
165 ostree command. For example:
166 man ostree init or man ostree-admin status
168
170 OSTree supports signing commits with GPG. Operations on the system
171 repository by default use keyring files in
172 /usr/share/ostree/trusted.gpg.d. Any public key in a keyring file in
173 that directory will be trusted by the client. No private keys should be
174 present in this directory.
175 In addition to the system repository, OSTree supports two other paths.
177 First, there is a gpgkeypath option for remotes, which must point to
178 the filename of an ASCII-armored GPG key, or a directory containing
179 ASCII-armored GPG keys to import. Multiple file and directory paths to
180 import from can be specified, as a comma-separated list of paths. This
181 option may be specified by using --set in ostree remote add.
182 Second, there is support for a per-remote remotename.trustedkeys.gpg
184 file stored in the toplevel of the repository (alongside objects/ and
185 such). This is particularly useful when downloading content that may
186 not be fully trusted (e.g. you want to inspect it but not deploy it as
187 an OS), or use it for containers. This file is written via ostree
188 remote add --gpg-import.
189
191 The following terms are commonly used throughout the man pages. Terms
192 in upper case letters are literals used in command line arguments.
193 BRANCH
195 Branch name. Part of a REF.
196 CHECKSUM
198 A SHA256 hash of a object stored in the OSTree repository. This can
199 be a content, a dirtree, a dirmeta or a commit object. If the
200 SHA256 hash of a commit object is meant, the term COMMIT is used.
201 COMMIT
203 A SHA256 hash of a commit object.
204 REF
206 A reference to a particular commit. References are text files
207 stored in refs/ that name (refer to) a particular commit. A
208 reference can only be the branch name part, in which case a local
209 reference is used (e.g. mybranch/stable). If a remote branch is
210 referred to, the remote name followed by a colon and the branch
211 name needs to be used (e.g. myremote:mybranch/stable).
212 REV, REFSPEC
214 A specific revision, a commit. This can be anything which can be
215 resolved to a commit, e.g. a REF or a COMMIT.
216 SHA256
218 A cryptographic hash function used to store objects in the OSTree
219 repository. The hashes have a length of 256 bites and are typically
220 shown and passed to ostree in its 64 ASCII character long
221 hexadecimal representation (e.g.
222 0fc70ed33cfd7d26fe99ae29afb7682ddd0e2157a4898bd8cfcdc8a03565b870).
223
225 ostree.repo(5)
226OSTree OSTREE(1)