createBackup function in admin_actions.py needs detail on how to restore and semantics

[Michael Fork]

There is no details on how a backup taken with createBackup should be restored and the semantics (i.e. is network info retained?)

[Michael Fork (mjfork)]

From an IRC chat between a colleague and bcwaldon, sounds like rebuildServer is the right mechanism (guessing with the backup UUID as the image?).

[Tom Fifield (fifieldt)]

Hi Michael,

I'm confused - can you add some context for me?

[Michael Fork (mjfork)]

The only detail could find on "createBackup" is on the API page under "Admin Actions" at http://api.openstack.org/:

POSTv2/{tenant_id}/servers/{server_id}/action
Backup a server instance.

  close
Request parameters
Parameter Description
tenant_id
The ID for the tenant or account in a multi-tenancy cloud.

server_id
The UUID for the server of interest to you.

name
Name of the backup image.

backup_type
The backup type, like 'daily' or 'weekly'.

rotation
Int parameter representing how many backups to keep around.

Request: JSON
{
    'createBackup': {
        'name': 'Backup 1',
        'backup_type': 'daily',
        'rotation': 1
    }
}

No mention of this function is in any of the guides that I could find. Seems like it should document how it works, how to "restore" a backup, etc.

[Tom Fifield (fifieldt)]

Thanks Michael

[Tom Fifield (fifieldt)]

./nova/api/openstack/compute/contrib/admin_actions.py

backup:
196
197 Images now have an `image_type` associated with them, which can be
198 'snapshot' or the backup type, like 'daily' or 'weekly'.
199
200 If the image_type is backup-like, then the rotation factor can be
201 included and that will cause the oldest backups that exceed the
202 rotation factor to be deleted.
203

There is no restore, but as noted above - since backups are images, you just rebuild or start a new instance with this image ID

[Tom Fifield (fifieldt)]

Personally, I'd love to know if the backups actually work and would recommend testing before writing this doc.

[Richard Raseley (richard-raseley)]

I know this is an old bug, but I wanted to pick of some low-hanging fruit to get my feet wet on the openstack-manuals project and I thought this would be a good option.

As it isn't linked in the ticket, but I am assuming the desired content would eventually live here:

http://docs.openstack.org/api/openstack-compute/2/content/POST_os-admin-actions-v2_createBackup_v2__tenant_id__servers__server_id__action_ext-os-admin-actions.html

?

[Anne Gentle (annegentle)]

I'd prefer to see it in an end user guide, in
openstack-manuals/doc/end-user-guide. The document you link to is basically
a "spec" for the Compute API and is used for python devs to know what to
implement. Also the other clue is ex-os-admin-actions means it's an API
extension. If you can figure out how to do backups in Dashboard and CLI,
start there to fix this bug. Thanks for asking!

On Sat, Jan 18, 2014 at 3:38 PM, Richard Raseley <email address hidden>wrote:

> I know this is an old bug, but I wanted to pick of some low-hanging
> fruit to get my feet wet on the openstack-manuals project and I thought
> this would be a good option.
>
> As it isn't linked in the ticket, but I am assuming the desired content
> would eventually live here:
>
> http://docs.openstack.org/api/openstack-compute/2/content/POST_os-admin-
> actions-v2_createBackup_v2__tenant_id__servers__server_id__action_ext-
> os-admin-actions.html
>
> ?
>
> ** Changed in: openstack-manuals
> Assignee: (unassigned) => Richard Raseley (richard-raseley)
>
> --
> You received this bug notification because you are subscribed to
> OpenStack.
> https://bugs.launchpad.net/bugs/1069986
>
> Title:
> createBackup function in admin_actions.py needs detail on how to
> restore and semantics
>
> Status in OpenStack Manuals:
> Triaged
>
> Bug description:
> There is no details on how a backup taken with createBackup should be
> restored and the semantics (i.e. is network info retained?)
>
> To manage notifications about this bug go to:
> https://bugs.launchpad.net/openstack-manuals/+bug/1069986/+subscriptions
>

[Richard Raseley (richard-raseley)]

Anne, thanks for your comments. I'll nail down the CLI and Dashboard processes and then start building the relevant documentation.

[Andreas Jaeger (jaegerandi)]

I see the following documentation, can we close this bug now as fixed?

http://docs.openstack.org/admin-guide-cloud/content/volume-backup-restore.html

[Tom Fifield (fifieldt)]

Hi Andreas,

I think this refers to the nova feature, rather than the cinder feature.

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/155720

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/155720
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=0fc41defc1f70a0fc5c062d86443755fa930e4ea
Submitter: Jenkins
Branch: master

commit 0fc41defc1f70a0fc5c062d86443755fa930e4ea
Author: OlgaGusarenko <email address hidden>
Date: Fri Feb 13 13:34:12 2015 +0200

    Adds the Create a backup section (nova, CLI)

    Images now have an `image_type` associated with them, which can be
    snapshot or the backup type, like 'daily' or 'weekly'.

    If the image_type is backup-like, then the rotation factor can be
    included, and that causes the oldest backups that exceed the
    rotation factor to be deleted.

    This patch explains the usage of the nova backup command,
    and the rotation mechanisms.

    As Dashboard does not provide a user with this possibility,
    so, the section is included to the Manage images section
    which is related to CLI only.

    Change-Id: I58ad41375ae5724b90d3c993395f318f8417e498
    Closes-Bug: #1069986

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/openstack-manuals 15.0.0 release.