summaryrefslogtreecommitdiff
path: root/man/ostree-admin-deploy.xml
blob: fbb8b96ac1a89c05964fa9c71930cc8d541b7dcf (plain)
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
<?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>

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 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>
                <command>ostree admin deploy</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">REFSPEC</arg>
            </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>
            <varlistentry>
                <term><option>--os</option>="STATEROOT"</term>

                <listitem><para>
                    Use a different operating system root than the current one.
                </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>

            <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>

            <varlistentry>
                <term><option>--karg-proc-cmdline</option></term>

                <listitem><para>
                    Import current /proc/cmdline.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>--karg</option>="NAME=VALUE"</term>

                <listitem><para>
                    Set kernel argument, like root=/dev/sda1; this overrides any earlier argument with the same name.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>--karg-append</option>="NAME=VALUE"</term>

                <listitem><para>
                    Append kernel argument; useful with e.g. console= that can be used multiple times.
                </para></listitem>
            </varlistentry>
        </variablelist>
    </refsect1>

    <refsect1>
        <title>Example</title>
        <para><command>$ ostree admin status</command></para>
<programlisting>
        * gnome-ostree 67e382b11d213a402a5313e61cbc69dfd5ab93cb07.0
            origin refspec: gnome-ostree/buildmain/x86_64-runtime
          gnome-ostree ce19c41036cc45e49b0cecf6b157523c2105c4de1ce3.0
            origin refspec: gnome-ostree/buildmain/x86_64-runtime
</programlisting>

<para><command>$ ostree admin deploy gnome-ostree/buildmain/x86_64-runtime</command></para>
<programlisting>
        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)
</programlisting>

<para><command>$ ostree admin status</command></para>
<programlisting>
          gnome-ostree 67e382b11d213a402a5313e61cbc69dfd5ab93cb07.1
            origin refspec: gnome-ostree/buildmain/x86_64-runtime
        * gnome-ostree 67e382b11d213a402a5313e61cbc69dfd5ab93cb07.0
            origin refspec: gnome-ostree/buildmain/x86_64-runtime
</programlisting>
    
    </refsect1>
</refentry>