mirror of
https://github.com/ostreedev/ostree.git
synced 2025-01-03 05:18:24 +03:00
8fbf19c9f5
Currently the API that allows P2P operations (e.g. pulling an ostree ref from a LAN or USB source) is hidden behind the configure flag --enable-experimental-api. This commit makes the API public and makes that flag essentially a no-op (leaving it in place in case we want to use it again in the future). The P2P API has been tested over the last several months and proven to work. This means that since we're no longer using the "experimental" feature flag, P2P builds of Flatpak will fail when using versions of OSTree from this commit onwards, until Flatpak is patched in the near future. If you want to build Flatpak < 0.11.8 with P2P enabled and link against OSTree 2018.6, you'll have to patch Flatpak. However, since Flatpak won't yet have a hard dependency on OSTree 2018.6, it needs a new way to determine if the P2P API in OSTree is available, so this commit adds a "p2p" feature flag. This way the feature set is more semantically correct than if we had continued to use the "experimental" feature flag. In addition to making the P2P API public, this commit makes the P2P unit tests run by default, removes the f27-experimental CI instance that's no longer needed, changes a few man pages to reflect the changes, and updates the bash completion script to accept the new commands and options. Closes: #1596 Approved by: cgwalters
138 lines
5.0 KiB
XML
138 lines
5.0 KiB
XML
<?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 2018 Matthew Leeds <matthew.leeds@endlessm.com>
|
|
|
|
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, write to the
|
|
Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
Boston, MA 02111-1307, USA.
|
|
-->
|
|
|
|
<refentry id="ostree">
|
|
|
|
<refentryinfo>
|
|
<title>ostree find-remotes</title>
|
|
<productname>OSTree</productname>
|
|
|
|
<authorgroup>
|
|
<author>
|
|
<contrib>Developer</contrib>
|
|
<firstname>Matthew</firstname>
|
|
<surname>Leeds</surname>
|
|
<email>matthew.leeds@endlessm.com</email>
|
|
</author>
|
|
</authorgroup>
|
|
</refentryinfo>
|
|
|
|
<refmeta>
|
|
<refentrytitle>ostree find-remotes</refentrytitle>
|
|
<manvolnum>1</manvolnum>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>ostree-find-remotes</refname>
|
|
<refpurpose>Find remotes to serve the given refs</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv>
|
|
<cmdsynopsis>
|
|
<command>ostree find-remotes</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">COLLECTION-ID</arg> <arg choice="req">REF</arg> <arg choice="opt" rep="repeat">COLLECTION-ID REF</arg>
|
|
</cmdsynopsis>
|
|
</refsynopsisdiv>
|
|
|
|
<refsect1>
|
|
<title>Description</title>
|
|
|
|
<para>
|
|
OSTree has the ability do pulls not just from configured remote
|
|
servers but also from peer computers on the LAN and from mounted
|
|
filesystems such as USB drives. This functionality requires the use
|
|
of collection IDs and GPG verification.
|
|
</para>
|
|
<para>
|
|
The <command>find-remotes</command> command searches for remotes
|
|
which claim to provide one or more of the given COLLECTION-ID REF
|
|
pairs and prints information about them, with remotes sorted by
|
|
latency (Mounts > LAN > Internet). By default, OSTree searches for
|
|
remotes in configuration files, on mounted filesystems (in a
|
|
well-known location), and on the LAN using Avahi. Searching for LAN
|
|
remotes requires OSTree to have been compiled with Avahi support,
|
|
and it requires an Avahi daemon to be running. You can override the
|
|
default set of finders (sources for remotes) using the
|
|
<option>--finders</option> option documented below.
|
|
</para>
|
|
<para>
|
|
The <command>create-usb</command> command is the recommended way to
|
|
put refs on a USB such that <command>find-remotes</command> will
|
|
discover them. See
|
|
<citerefentry><refentrytitle>ostree-create-usb</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>Options</title>
|
|
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><option>--disable-fsync</option></term>
|
|
|
|
<listitem><para>
|
|
Do not invoke fsync().
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><option>--finders</option>=FINDERS</term>
|
|
|
|
<listitem><para>
|
|
Use the specified comma separated list of finders rather than
|
|
the default set. Possible values: <literal>config</literal>,
|
|
<literal>lan</literal>, and <literal>mount</literal> (or any
|
|
combination thereof).
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><option>--pull</option></term>
|
|
|
|
<listitem><para>
|
|
Pull the most recent commit found for each ref.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>Example</title>
|
|
<para><command>$ ostree find-remotes --finders=mount,lan com.exampleos.Os exampleos/x86_64/standard</command></para>
|
|
<programlisting>
|
|
Result 0: http://10.0.64.202:43381/0
|
|
- Finder: OstreeRepoFinderAvahi
|
|
- Keyring: exampleos.trustedkeys.gpg
|
|
- Priority: 60
|
|
- Summary last modified: 2018-01-12T19:00:28Z
|
|
- Refs:
|
|
- (com.exampleos.Os, exampleos/x86_64/standard) = c91acd964b3fda561b87bfb7f7c80e36220d76b567f0ce90c0e60742ef33c360
|
|
|
|
1/1 refs were found.
|
|
</programlisting>
|
|
</refsect1>
|
|
</refentry>
|