lxc restore help is unclear

[James Troup]

| $ lxc help restore
| Set the current state of a resource back to what it was when it was snapshotted.
|
| lxc restore [remote:]<resource> <snapshot name> [--stateful]
| $

The use of 'resource' is confusing as it's not used anywhere else
except for in 'help list'. Can anything other than a container be
restored?

--stateful is mentioned but not documented/explained.

Lastly it's not obvious what '<snapshot name>' means, especially given
the output of 'lxc list':

| $ lxc list
| +-------------------+---------+------------+------+-----------+-----------+
| | NAME | STATE | IPV4 | IPV6 | EPHEMERAL | SNAPSHOTS |
| +-------------------+---------+------------+------+-----------+-----------+
| | unvisceral-samira | RUNNING | 10.0.3.193 | | NO | 1 |
| +-------------------+---------+------------+------+-----------+-----------+
| Snapshots:
| /1.0/containers/unvisceral-samira/snapshots/snap0
| $

I tried several variations before finding 'snap0' is what was
expected.

[Tycho Andersen (tycho-s)]

Hi James,

On Wed, Jan 06, 2016 at 10:32:48PM -0000, James Troup wrote:
> Public bug reported:
>
> | $ lxc help restore
> | Set the current state of a resource back to what it was when it was snapshotted.
> |
> | lxc restore [remote:]<resource> <snapshot name> [--stateful]
> | $
>
> The use of 'resource' is confusing as it's not used anywhere else
> except for in 'help list'. Can anything other than a container be
> restored?
>
> --stateful is mentioned but not documented/explained.
>
> Lastly it's not obvious what '<snapshot name>' means, especially given
> the output of 'lxc list':
>
> | $ lxc list
> | +-------------------+---------+------------+------+-----------+-----------+
> | | NAME | STATE | IPV4 | IPV6 | EPHEMERAL | SNAPSHOTS |
> | +-------------------+---------+------------+------+-----------+-----------+
> | | unvisceral-samira | RUNNING | 10.0.3.193 | | NO | 1 |
> | +-------------------+---------+------------+------+-----------+-----------+
> | Snapshots:
> | /1.0/containers/unvisceral-samira/snapshots/snap0
> | $
>
> I tried several variations before finding 'snap0' is what was
> expected.

Thanks, I've posted an update to the help here:

https://github.com/lxc/lxd/pull/1480

Does that seem reasonable?

[Stéphane Graber (stgraber)]

I'll cherry-pick the fix, hopefully later today.

[Launchpad Janitor (janitor)]

This bug was fixed in the package lxd - 0.27-0ubuntu1

---------------
lxd (0.27-0ubuntu1) xenial; urgency=medium

  * New upstream release (0.27)
    - Support for container disk quota (zfs and btrfs only)
    - Download progress during image copy and container launch (LP: #1530414)
    - Initial work on a LXC to LXD script (supports almost every
      configuration except for unprivileged containers)
    - New linux.kernel_modules container property (list of modules to
      load before starting the container)
    - New core.https_allowed_origin server property (controls the
      Access-Control-Allow-Origin header)
    - Profile changes are now live-applied to all affected containers
    - "lxc config edit" now works against servers too
    - Changes to security.nesting are now live-applied
    - Support for xfs with the lvm backend
    - "lxc image list" now supports filtering (by name, hash and properties)
    - Improved bash completion profile
    - The default remote is now visible in "lxc remote list"
    - "lxc info" now indicates whether a container is ephemeral or persistent
    - Various improvement to help messages
      (LP: #1531643, LP: #1530413, LP: #1531357)
    - A lot of bugfixes and other performance improvement, see:
      https://linuxcontainers.org/lxd/news/

 -- Stéphane Graber <email address hidden> Wed, 20 Jan 2016 09:53:05 -0500