shaba/ostree
1
0
Fork 0
mirror of https://github.com/ostreedev/ostree.git synced 2024-12-22 17:35:55 +03:00
Code Issues Projects Releases Wiki Activity
37466ec35b
ostree/man/ostree-admin-deploy.xml

195 lines
6.5 KiB
XML
Raw Normal View History

manpage: Add separate manpages for each command Using docker as a model, this update creates separate manpages for each OSTree command, such that the main manpage is not cluttered and the separate pages can provide more in-depth detail and exanples that might be useful to a user. Each page includes synopsis, description, example, and a list of options if needd. This update also alphabetizes the usage error output for ostree and ostree admin so that it matches the list on the manpage.
2014-06-17 23:24:08 +04:00
<?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 2014 Anne LoVerso <anne.loverso@students.olin.edu>
Add SPDX-License-Identifier to source files SPDX License List is a list of (common) open source licenses that can be referred to by a “short identifier”. It has several advantages compared to the common "license header texts" usually found in source files. Some of the advantages: * It is precise; there is no ambiguity due to variations in license header text * It is language neutral * It is easy to machine process * It is concise * It is simple and can be used without much cost in interpreted environments like java Script, etc. * An SPDX license identifier is immutable. * It provides simple guidance for developers who want to make sure the license for their code is respected See http://spdx.org for further reading. Signed-off-by: Marcus Folkesson <marcus.folkesson@gmail.com> Closes: #1439 Approved by: cgwalters
2018-01-30 22:26:26 +03:00
SPDX-License-Identifier: LGPL-2.0+
manpage: Add separate manpages for each command Using docker as a model, this update creates separate manpages for each OSTree command, such that the main manpage is not cluttered and the separate pages can provide more in-depth detail and exanples that might be useful to a user. Each page includes synopsis, description, example, and a list of options if needd. This update also alphabetizes the usage error output for ostree and ostree admin so that it matches the list on the manpage.
2014-06-17 23:24:08 +04:00
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
Update FSF license notices to use URL instead of address
2021-12-07 04:20:55 +03:00
License along with this library. If not, see <https://www.gnu.org/licenses/>.
manpage: Add separate manpages for each command Using docker as a model, this update creates separate manpages for each OSTree command, such that the main manpage is not cluttered and the separate pages can provide more in-depth detail and exanples that might be useful to a user. Each page includes synopsis, description, example, and a list of options if needd. This update also alphabetizes the usage error output for ostree and ostree admin so that it matches the list on the manpage.
2014-06-17 23:24:08 +04:00
-->
<refentry id="ostree">
<refentryinfo>
<title>ostree admin deploy</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 admin deploy</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>ostree-admin-deploy</refname>
<refpurpose>Checkout a revision as the new default deployment</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
docs: Fix a pile of Docbook validation errors At least now validates with RNG mode in Emacs.
2014-11-29 20:15:21 +03:00
<command>ostree admin deploy</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">REFSPEC</arg>
manpage: Add separate manpages for each command Using docker as a model, this update creates separate manpages for each OSTree command, such that the main manpage is not cluttered and the separate pages can provide more in-depth detail and exanples that might be useful to a user. Each page includes synopsis, description, example, and a list of options if needd. This update also alphabetizes the usage error output for ostree and ostree admin so that it matches the list on the manpage.
2014-06-17 23:24:08 +04:00
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Takes a commit or revision REFSPEC, and queues the new deployment as default upon reboot.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<variablelist>
admin-deploy: Add `--stateroot` as alias for `--os` To further help deprecate the confusing "osname" terminology.
2023-08-17 23:48:05 +03:00
<varlistentry>
<term><option>--stateroot</option>="STATEROOT"</term>
<listitem><para>
Use a different operating system stateroot than the current one.
</para></listitem>
</varlistentry>
manpage: Add separate manpages for each command Using docker as a model, this update creates separate manpages for each OSTree command, such that the main manpage is not cluttered and the separate pages can provide more in-depth detail and exanples that might be useful to a user. Each page includes synopsis, description, example, and a list of options if needd. This update also alphabetizes the usage error output for ostree and ostree admin so that it matches the list on the manpage.
2014-06-17 23:24:08 +04:00
<varlistentry>
Rename "osname" → "stateroot" I never really liked the term "osname". I feel "stateroot" is a *lot* clearer, since the osname/stateroot mostly just holds `/var`. Further it avoids the `os` prefix which is already overloaded. Some of the existing docs already talked about "operating system state", which further reinforces this. There's *lot* more things than this which reference the term "osname", but I don't want to change *everything* yet in this patch in case we decide to do something different - this just gets the highlights. Closes: #794 Approved by: jlebon
2017-04-14 17:34:38 +03:00
<term><option>--os</option>="STATEROOT"</term>
manpage: Add separate manpages for each command Using docker as a model, this update creates separate manpages for each OSTree command, such that the main manpage is not cluttered and the separate pages can provide more in-depth detail and exanples that might be useful to a user. Each page includes synopsis, description, example, and a list of options if needd. This update also alphabetizes the usage error output for ostree and ostree admin so that it matches the list on the manpage.
2014-06-17 23:24:08 +04:00
<listitem><para>
admin-deploy: Add `--stateroot` as alias for `--os` To further help deprecate the confusing "osname" terminology.
2023-08-17 23:48:05 +03:00
Alias for <literal>--stateroot</literal>.
manpage: Add separate manpages for each command Using docker as a model, this update creates separate manpages for each OSTree command, such that the main manpage is not cluttered and the separate pages can provide more in-depth detail and exanples that might be useful to a user. Each page includes synopsis, description, example, and a list of options if needd. This update also alphabetizes the usage error output for ostree and ostree admin so that it matches the list on the manpage.
2014-06-17 23:24:08 +04:00
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--origin-file</option>="FILENAME"</term>
<listitem><para>
Use FILENAME as the origin, which is where OSTree will look for updated versions of the tree.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--retain</option></term>
<listitem><para>
Do not delete previous deployment.
</para></listitem>
</varlistentry>
ostree-sysroot: make simple_write_deployment smarter This is a follow-up to https://github.com/ostreedev/ostree/pull/1097. We make simple_write_deployment smart enough so that it can be used for rpm-ostree's purposes. This is mostly an upstreaming of logic that already existed there. Notably we correctly append NOT_DEFAULT deployments *after* the booted deployment and we now support RETAIN_PENDING and RETAIN_ROLLBACK flags to have more granularity on deployment pruning. Expose these new flags on the CLI using new options (as well as expose the previously existing NOT_DEFAULT flag as --not-as-default). I couldn't add tests for --retain-pending because the merge deployment is always the topmost one. Though I did check that it worked in a VM. Closes: #1110 Approved by: cgwalters
2017-08-23 19:15:46 +03:00
<varlistentry>
<term><option>--retain-pending</option></term>
<listitem><para>
Do not delete pending deployments.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--retain-rollback</option></term>
<listitem><para>
Do not delete rollback deployments.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--not-as-default</option></term>
<listitem><para>
Append rather than prepend new deployment.
</para></listitem>
</varlistentry>
sysroot: Stabilize deployment finalization, add API and CLI It's about time we do this; deployment finalization locking is a useful feature. An absolutely key thing here is that we've slowly been moving towards the deployments as the primary "source of truth". Specifically in bootc for example, we will GC container images not referenced by a deployment. This is then neecessary to support a "pull but don't apply automatically" model. This stabilizes the existing `ostree admin deploy --lock-finalization` CLI, and adds a new `ostree admin unlock-finalization`. We still check the old lock file path, but there's a new boolean value as part of the staged deployment data which is intended to be the source of truth in the future. At some point then we can drop the rpm-ostree lockfile handling. Closes: https://github.com/ostreedev/ostree/issues/3025
2023-11-09 01:19:19 +03:00
<varlistentry>
<term><option>--lock-finalization</option></term>
<listitem><para>
The deployment will not be "finalized" by default on shutdown; to later
man: Two finalization fixes From PR review.
2023-11-27 21:50:07 +03:00
queue it, use <literal>ostree admin lock-finalization --unlock</literal>.
sysroot: Stabilize deployment finalization, add API and CLI It's about time we do this; deployment finalization locking is a useful feature. An absolutely key thing here is that we've slowly been moving towards the deployments as the primary "source of truth". Specifically in bootc for example, we will GC container images not referenced by a deployment. This is then neecessary to support a "pull but don't apply automatically" model. This stabilizes the existing `ostree admin deploy --lock-finalization` CLI, and adds a new `ostree admin unlock-finalization`. We still check the old lock file path, but there's a new boolean value as part of the staged deployment data which is intended to be the source of truth in the future. At some point then we can drop the rpm-ostree lockfile handling. Closes: https://github.com/ostreedev/ostree/issues/3025
2023-11-09 01:19:19 +03:00
</para></listitem>
</varlistentry>
manpage: Add separate manpages for each command Using docker as a model, this update creates separate manpages for each OSTree command, such that the main manpage is not cluttered and the separate pages can provide more in-depth detail and exanples that might be useful to a user. Each page includes synopsis, description, example, and a list of options if needd. This update also alphabetizes the usage error output for ostree and ostree admin so that it matches the list on the manpage.
2014-06-17 23:24:08 +04:00
<varlistentry>
<term><option>--karg-proc-cmdline</option></term>
<listitem><para>
Import current /proc/cmdline.
</para></listitem>
</varlistentry>
<varlistentry>
Various manpage / usage blurb improvements Corrections, clarifications, consistency. Not a comprehensive overhaul of the manpages; they do still need work. These are just flaws I've noted while studying the ostree command syntax. https://bugzilla.gnome.org/show_bug.cgi?id=740097
2014-11-11 05:28:43 +03:00
<term><option>--karg</option>="NAME=VALUE"</term>
manpage: Add separate manpages for each command Using docker as a model, this update creates separate manpages for each OSTree command, such that the main manpage is not cluttered and the separate pages can provide more in-depth detail and exanples that might be useful to a user. Each page includes synopsis, description, example, and a list of options if needd. This update also alphabetizes the usage error output for ostree and ostree admin so that it matches the list on the manpage.
2014-06-17 23:24:08 +04:00
<listitem><para>
Set kernel argument, like root=/dev/sda1; this overrides any earlier argument with the same name.
</para></listitem>
</varlistentry>
<varlistentry>
Various manpage / usage blurb improvements Corrections, clarifications, consistency. Not a comprehensive overhaul of the manpages; they do still need work. These are just flaws I've noted while studying the ostree command syntax. https://bugzilla.gnome.org/show_bug.cgi?id=740097
2014-11-11 05:28:43 +03:00
<term><option>--karg-append</option>="NAME=VALUE"</term>
manpage: Add separate manpages for each command Using docker as a model, this update creates separate manpages for each OSTree command, such that the main manpage is not cluttered and the separate pages can provide more in-depth detail and exanples that might be useful to a user. Each page includes synopsis, description, example, and a list of options if needd. This update also alphabetizes the usage error output for ostree and ostree admin so that it matches the list on the manpage.
2014-06-17 23:24:08 +04:00
<listitem><para>
Append kernel argument; useful with e.g. console= that can be used multiple times.
</para></listitem>
</varlistentry>
doc: add `ostree admin deploy` option `--karg-delete`
2023-10-17 15:23:07 +03:00
<varlistentry>
<term><option>--karg-delete</option>="NAME=VALUE"</term>
<listitem><para>
Delete kernel argument if exists, can be used multiple times.
</para></listitem>
</varlistentry>
manpage: Add separate manpages for each command Using docker as a model, this update creates separate manpages for each OSTree command, such that the main manpage is not cluttered and the separate pages can provide more in-depth detail and exanples that might be useful to a user. Each page includes synopsis, description, example, and a list of options if needd. This update also alphabetizes the usage error output for ostree and ostree admin so that it matches the list on the manpage.
2014-06-17 23:24:08 +04:00
</variablelist>
</refsect1>
<refsect1>
<title>Example</title>
<para><command>$ ostree admin status</command></para>
docs: Fix a pile of Docbook validation errors At least now validates with RNG mode in Emacs.
2014-11-29 20:15:21 +03:00
<programlisting>
manpage: Add separate manpages for each command Using docker as a model, this update creates separate manpages for each OSTree command, such that the main manpage is not cluttered and the separate pages can provide more in-depth detail and exanples that might be useful to a user. Each page includes synopsis, description, example, and a list of options if needd. This update also alphabetizes the usage error output for ostree and ostree admin so that it matches the list on the manpage.
2014-06-17 23:24:08 +04:00
* gnome-ostree 67e382b11d213a402a5313e61cbc69dfd5ab93cb07.0
*: rename master to main in tests & examples
2021-05-07 17:42:37 +03:00
origin refspec: gnome-ostree/buildmain/x86_64-runtime
manpage: Add separate manpages for each command Using docker as a model, this update creates separate manpages for each OSTree command, such that the main manpage is not cluttered and the separate pages can provide more in-depth detail and exanples that might be useful to a user. Each page includes synopsis, description, example, and a list of options if needd. This update also alphabetizes the usage error output for ostree and ostree admin so that it matches the list on the manpage.
2014-06-17 23:24:08 +04:00
gnome-ostree ce19c41036cc45e49b0cecf6b157523c2105c4de1ce3.0
*: rename master to main in tests & examples
2021-05-07 17:42:37 +03:00
origin refspec: gnome-ostree/buildmain/x86_64-runtime
docs: Fix a pile of Docbook validation errors At least now validates with RNG mode in Emacs.
2014-11-29 20:15:21 +03:00
</programlisting>
manpage: Add separate manpages for each command Using docker as a model, this update creates separate manpages for each OSTree command, such that the main manpage is not cluttered and the separate pages can provide more in-depth detail and exanples that might be useful to a user. Each page includes synopsis, description, example, and a list of options if needd. This update also alphabetizes the usage error output for ostree and ostree admin so that it matches the list on the manpage.
2014-06-17 23:24:08 +04:00
*: rename master to main in tests & examples
2021-05-07 17:42:37 +03:00
<para><command>$ ostree admin deploy gnome-ostree/buildmain/x86_64-runtime</command></para>
docs: Fix a pile of Docbook validation errors At least now validates with RNG mode in Emacs.
2014-11-29 20:15:21 +03:00
<programlisting>
manpage: Add separate manpages for each command Using docker as a model, this update creates separate manpages for each OSTree command, such that the main manpage is not cluttered and the separate pages can provide more in-depth detail and exanples that might be useful to a user. Each page includes synopsis, description, example, and a list of options if needd. This update also alphabetizes the usage error output for ostree and ostree admin so that it matches the list on the manpage.
2014-06-17 23:24:08 +04:00
ostadmin: Creating deployment /ostree/deploy/gnome-ostree/deploy/7e382b11d213a402a5313e61cbc69dfd5ab93cb07.1
ostadmin: Processing /etc: 3 modified, 0 removed, 29 added
Transaction complete: bootconfig swap: no deployment count change: 0)
docs: Fix a pile of Docbook validation errors At least now validates with RNG mode in Emacs.
2014-11-29 20:15:21 +03:00
</programlisting>
manpage: Add separate manpages for each command Using docker as a model, this update creates separate manpages for each OSTree command, such that the main manpage is not cluttered and the separate pages can provide more in-depth detail and exanples that might be useful to a user. Each page includes synopsis, description, example, and a list of options if needd. This update also alphabetizes the usage error output for ostree and ostree admin so that it matches the list on the manpage.
2014-06-17 23:24:08 +04:00
<para><command>$ ostree admin status</command></para>
docs: Fix a pile of Docbook validation errors At least now validates with RNG mode in Emacs.
2014-11-29 20:15:21 +03:00
<programlisting>
manpage: Add separate manpages for each command Using docker as a model, this update creates separate manpages for each OSTree command, such that the main manpage is not cluttered and the separate pages can provide more in-depth detail and exanples that might be useful to a user. Each page includes synopsis, description, example, and a list of options if needd. This update also alphabetizes the usage error output for ostree and ostree admin so that it matches the list on the manpage.
2014-06-17 23:24:08 +04:00
gnome-ostree 67e382b11d213a402a5313e61cbc69dfd5ab93cb07.1
*: rename master to main in tests & examples
2021-05-07 17:42:37 +03:00
origin refspec: gnome-ostree/buildmain/x86_64-runtime
manpage: Add separate manpages for each command Using docker as a model, this update creates separate manpages for each OSTree command, such that the main manpage is not cluttered and the separate pages can provide more in-depth detail and exanples that might be useful to a user. Each page includes synopsis, description, example, and a list of options if needd. This update also alphabetizes the usage error output for ostree and ostree admin so that it matches the list on the manpage.
2014-06-17 23:24:08 +04:00
* gnome-ostree 67e382b11d213a402a5313e61cbc69dfd5ab93cb07.0
*: rename master to main in tests & examples
2021-05-07 17:42:37 +03:00
origin refspec: gnome-ostree/buildmain/x86_64-runtime
docs: Fix a pile of Docbook validation errors At least now validates with RNG mode in Emacs.
2014-11-29 20:15:21 +03:00
</programlisting>
manpage: Add separate manpages for each command Using docker as a model, this update creates separate manpages for each OSTree command, such that the main manpage is not cluttered and the separate pages can provide more in-depth detail and exanples that might be useful to a user. Each page includes synopsis, description, example, and a list of options if needd. This update also alphabetizes the usage error output for ostree and ostree admin so that it matches the list on the manpage.
2014-06-17 23:24:08 +04:00
</refsect1>
</refentry>
Reference in New Issue Copy Permalink