ostreeOSTreeDeveloperColinWalterswalters@verbum.orgostree1ostreeManage multiple bootable versioned filesystem treesostree COMMANDOPTIONSDescription
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
/ostree directory. Each
installed system gets its own
/ostree/deploy/osname
directory.
Unlike rpm or
dpkg, OSTree is only aware of
complete filesystem trees. It has no built-in
knowledge of what components went into creating the
filesystem tree.
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.
It must be emphasized that OSTree only supports
read-only 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.
OptionsThe following options are understood:For most commands,
when run as non-root, repository is
required. If
ostree is run as
root, it is assumed operations will be
performed on the
/sysroot/ostree/repo
repository.
System administrators will primarily interact
with OSTree via the subcommand ostree
admin.admin os-init NAMEInitialize the
deployment location for an operating
system with name
NAME. Each
deployment location is comprised of a
single shared var
and a set of
deployments (chroots).admin init-fs PATHInitialize a root filesystem
in PATH by creating top level directories with
proper permissions.admin deployThis is a relatively
low level command - takes a particular
commit or revision, and sets it up for
the next boot.admin undeploy INDEXRemove the previously
INDEX
deployed tree from the bootloader
configuration.admin cleanupDelete untagged
deployments and repository objects.admin upgradeIf you are replicating
from a build server, this command will
download the latest version for the
current ref, and deploy it. Reboot
the system for the changes to take
effect.admin statusShow and list the deployments.
admin switchChoose a different ref
to track from the same remote as the
current tree.admin config-diffSee changes to
/etc as compared
to the current default (from
/usr/etc).
Both administrators and operating system
builders may interact with OSTree via the regular
filesystem manipulation commands.
initInitialize a new
repository. Must be given the path to
an existing (empty) directory. If you
want to serve a repository over plain
HTTP, use
archive-z2 for
diffConcisely list
differences between the given refs,
without checking them out into the
physical filesystem. If only one ref
is provided, the parent commit will be
assumed to be the diff source.
commitGiven one or more
trees (from the local filesystem, a
tarball, or a specified revision for
example), create a new commit using those contents.
logShow revision log.lsList the contents of a given commit.fsckCheck a repository for consistency.remoteManipulate remote archive configuration.rev-parseShow the SHA256 corresponding to a given rev.showGiven an OSTree SHA256 checksum, display its contents.GPG verificationOSTree supports signing commits with GPG. The
set of trusted keys is stored as keyring files in
/usr/share/ostree/trusted.gpg.d. Any key in
any keyring in that directory may be used to sign commits.
See Alsoostree.repo5