You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@libcloud.apache.org by an...@apache.org on 2016/01/05 11:19:38 UTC
[20/26] libcloud git commit: Update code after code review on PR by
@Kami
Update code after code review on PR by @Kami
Project: http://git-wip-us.apache.org/repos/asf/libcloud/repo
Commit: http://git-wip-us.apache.org/repos/asf/libcloud/commit/f0cc015f
Tree: http://git-wip-us.apache.org/repos/asf/libcloud/tree/f0cc015f
Diff: http://git-wip-us.apache.org/repos/asf/libcloud/diff/f0cc015f
Branch: refs/heads/trunk
Commit: f0cc015f437d5119e223c47cd09566735c6dd362
Parents: 98899b1
Author: anthony-shaw <an...@gmail.com>
Authored: Wed Dec 30 21:33:10 2015 +1100
Committer: anthony-shaw <an...@gmail.com>
Committed: Wed Dec 30 21:33:10 2015 +1100
----------------------------------------------------------------------
docs/examples/backup/create_backup_from_node.py | 12 ++--
libcloud/backup/base.py | 75 ++++++++++----------
2 files changed, 45 insertions(+), 42 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/libcloud/blob/f0cc015f/docs/examples/backup/create_backup_from_node.py
----------------------------------------------------------------------
diff --git a/docs/examples/backup/create_backup_from_node.py b/docs/examples/backup/create_backup_from_node.py
index ec7c2d6..3c6bea2 100644
--- a/docs/examples/backup/create_backup_from_node.py
+++ b/docs/examples/backup/create_backup_from_node.py
@@ -1,13 +1,15 @@
import time
from pprint import pprint
-from libcloud.backup.types import Provider, BackupTargetJobStatusType
+from libcloud.backup.types import BackupTargetJobStatusType
+from libcloud.backup.types import Provider as BackupProvider
from libcloud.backup.providers import get_driver as get_backup_driver
from libcloud.compute.providers import get_driver as get_compute_driver
+from libcloud.compute.types import Provider as ComputeProvider
-backup_driver = get_backup_driver(Provider.AZURE)('username', 'api key')
-compute_driver = get_compute_driver(Provider.AZURE)('username', 'api key')
+backup_driver = get_backup_driver(BackupProvider.AZURE)('username', 'api key')
+compute_driver = get_compute_driver(ComputeProvider.AZURE)('username', 'api key')
nodes = compute_driver.list_nodes()
@@ -27,10 +29,10 @@ while True:
else:
job = backup_driver.get_target_job(job.id)
- print('Job is now at %s percent complete' % job.progress)
+ print('Job is now at %s percent complete' % (job.progress))
time.sleep(20)
-print('Job is completed with status- %s' % job.status)
+print('Job is completed with status- %s' % (job.status))
print('Getting a list of recovery points')
recovery_points = backup_driver.list_recovery_points(new_target)
http://git-wip-us.apache.org/repos/asf/libcloud/blob/f0cc015f/libcloud/backup/base.py
----------------------------------------------------------------------
diff --git a/libcloud/backup/base.py b/libcloud/backup/base.py
index f57f5d8..8b91068 100644
--- a/libcloud/backup/base.py
+++ b/libcloud/backup/base.py
@@ -41,10 +41,10 @@ class BackupTarget(object):
:type address: ``str``
:param type: Backup target type (Physical, Virtual, ...).
- :type type: :class:`BackupTargetType`
+ :type type: :class:`.BackupTargetType`
:param driver: BackupDriver instance.
- :type driver: :class:`BackupDriver`
+ :type driver: :class:`.BackupDriver`
:param extra: (optional) Extra attributes (driver specific).
:type extra: ``dict``
@@ -97,10 +97,10 @@ class BackupTargetJob(object):
:type progress: ``int``
:param target: BackupTarget instance.
- :type target: :class:`BackupTarget`
+ :type target: :class:`.BackupTarget`
:param driver: BackupDriver instance.
- :type driver: :class:`BackupDriver`
+ :type driver: :class:`.BackupDriver`
:param extra: (optional) Extra attributes (driver specific).
:type extra: ``dict``
@@ -142,10 +142,10 @@ class BackupTargetRecoveryPoint(object):
:type date: :class:`datetime.datetime`
:param target: BackupTarget instance.
- :type target: :class:`BackupTarget`
+ :type target: :class:`.BackupTarget`
:param driver: BackupDriver instance.
- :type driver: :class:`BackupDriver`
+ :type driver: :class:`.BackupDriver`
:param extra: (optional) Extra attributes (driver specific).
:type extra: ``dict``
@@ -163,7 +163,7 @@ class BackupTargetRecoveryPoint(object):
:param path: The part of the recovery point to recover (optional)
:type path: ``str``
- :rtype: Instance of :class:`BackupTargetJob`
+ :rtype: Instance of :class:`.BackupTargetJob`
"""
return self.driver.recover_target(target=self.target,
recovery_point=self, path=path)
@@ -173,12 +173,12 @@ class BackupTargetRecoveryPoint(object):
Recover this recovery point out of place
:param recovery_target: Backup target with to recover the data to
- :type recovery_target: Instance of :class:`BackupTarget`
+ :type recovery_target: Instance of :class:`.BackupTarget`
:param path: The part of the recovery point to recover (optional)
:type path: ``str``
- :rtype: Instance of :class:`BackupTargetJob`
+ :rtype: Instance of :class:`.BackupTargetJob`
"""
return self.driver.recover_target_out_of_place(
target=self.target,
@@ -241,7 +241,7 @@ class BackupDriver(BaseDriver):
"""
List all backuptargets
- :rtype: ``list`` of :class:`BackupTarget`
+ :rtype: ``list`` of :class:`.BackupTarget`
"""
raise NotImplementedError(
'list_targets not implemented for this driver')
@@ -263,7 +263,7 @@ class BackupDriver(BaseDriver):
:param extra: (optional) Extra attributes (driver specific).
:type extra: ``dict``
- :rtype: Instance of :class:`BackupTarget`
+ :rtype: Instance of :class:`.BackupTarget`
"""
raise NotImplementedError(
'create_target not implemented for this driver')
@@ -271,7 +271,8 @@ class BackupDriver(BaseDriver):
def create_target_from_node(self, node, type=BackupTargetType.VIRTUAL,
extra=None):
"""
- Creates a new backup target from an existing node
+ Creates a new backup target from an existing node.
+ By default, this will use the first public IP of the node
:param node: The Node to backup
:type node: ``Node``
@@ -282,14 +283,14 @@ class BackupDriver(BaseDriver):
:param extra: (optional) Extra attributes (driver specific).
:type extra: ``dict``
- :rtype: Instance of :class:`BackupTarget`
+ :rtype: Instance of :class:`.BackupTarget`
"""
return self.create_target(name=node.name,
address=node.public_ips[0],
type=type,
extra=None)
- def create_target_from_container(self, container,
+ def create_target_from_storage_container(self, container,
type=BackupTargetType.OBJECT,
extra=None):
"""
@@ -304,7 +305,7 @@ class BackupDriver(BaseDriver):
:param extra: (optional) Extra attributes (driver specific).
:type extra: ``dict``
- :rtype: Instance of :class:`BackupTarget`
+ :rtype: Instance of :class:`.BackupTarget`
"""
return self.create_target(name=container.name,
address=container.get_cdn_url(),
@@ -316,7 +317,7 @@ class BackupDriver(BaseDriver):
Update the properties of a backup target
:param target: Backup target to update
- :type target: Instance of :class:`BackupTarget`
+ :type target: Instance of :class:`.BackupTarget`
:param name: Name of the target
:type name: ``str``
@@ -327,7 +328,7 @@ class BackupDriver(BaseDriver):
:param extra: (optional) Extra attributes (driver specific).
:type extra: ``dict``
- :rtype: Instance of :class:`BackupTarget`
+ :rtype: Instance of :class:`.BackupTarget`
"""
raise NotImplementedError(
'update_target not implemented for this driver')
@@ -337,7 +338,7 @@ class BackupDriver(BaseDriver):
Delete a backup target
:param target: Backup target to delete
- :type target: Instance of :class:`BackupTarget`
+ :type target: Instance of :class:`.BackupTarget`
"""
raise NotImplementedError(
'delete_target not implemented for this driver')
@@ -347,7 +348,7 @@ class BackupDriver(BaseDriver):
List the recovery points available for a target
:param target: Backup target to delete
- :type target: Instance of :class:`BackupTarget`
+ :type target: Instance of :class:`.BackupTarget`
:param start_date: The start date to show jobs between (optional)
:type start_date: :class:`datetime.datetime`
@@ -355,7 +356,7 @@ class BackupDriver(BaseDriver):
:param end_date: The end date to show jobs between (optional)
:type end_date: :class:`datetime.datetime``
- :rtype: ``list`` of :class:`BackupTargetRecoveryPoint`
+ :rtype: ``list`` of :class:`.BackupTargetRecoveryPoint`
"""
raise NotImplementedError(
'list_recovery_points not implemented for this driver')
@@ -365,15 +366,15 @@ class BackupDriver(BaseDriver):
Recover a backup target to a recovery point
:param target: Backup target to delete
- :type target: Instance of :class:`BackupTarget`
+ :type target: Instance of :class:`.BackupTarget`
:param recovery_point: Backup target with the backup data
- :type recovery_point: Instance of :class:`BackupTarget`
+ :type recovery_point: Instance of :class:`.BackupTarget`
:param path: The part of the recovery point to recover (optional)
:type path: ``str``
- :rtype: Instance of :class:`BackupTargetJob`
+ :rtype: Instance of :class:`.BackupTargetJob`
"""
raise NotImplementedError(
'recover_target not implemented for this driver')
@@ -384,13 +385,13 @@ class BackupDriver(BaseDriver):
Recover a backup target to a recovery point out-of-place
:param target: Backup target with the backup data
- :type target: Instance of :class:`BackupTarget`
+ :type target: Instance of :class:`.BackupTarget`
:param recovery_point: Backup target with the backup data
- :type recovery_point: Instance of :class:`BackupTarget`
+ :type recovery_point: Instance of :class:`.BackupTarget`
:param recovery_target: Backup target with to recover the data to
- :type recovery_target: Instance of :class:`BackupTarget`
+ :type recovery_target: Instance of :class:`.BackupTarget`
:param path: The part of the recovery point to recover (optional)
:type path: ``str``
@@ -405,10 +406,10 @@ class BackupDriver(BaseDriver):
Get a specific backup job by ID
:param target: Backup target with the backup data
- :type target: Instance of :class:`BackupTarget`
+ :type target: Instance of :class:`.BackupTarget`
:param id: Backup target with the backup data
- :type id: Instance of :class:`BackupTarget`
+ :type id: Instance of :class:`.BackupTarget`
:rtype: :class:`BackupTargetJob`
"""
@@ -420,9 +421,9 @@ class BackupDriver(BaseDriver):
List the backup jobs on a target
:param target: Backup target with the backup data
- :type target: Instance of :class:`BackupTarget`
+ :type target: Instance of :class:`.BackupTarget`
- :rtype: ``list`` of :class:`BackupTargetJob`
+ :rtype: ``list`` of :class:`.BackupTargetJob`
"""
raise NotImplementedError(
'list_target_jobs not implemented for this driver')
@@ -432,7 +433,7 @@ class BackupDriver(BaseDriver):
Create a new backup job on a target
:param target: Backup target with the backup data
- :type target: Instance of :class:`BackupTarget`
+ :type target: Instance of :class:`.BackupTarget`
:param extra: (optional) Extra attributes (driver specific).
:type extra: ``dict``
@@ -447,10 +448,10 @@ class BackupDriver(BaseDriver):
Resume a suspended backup job on a target
:param target: Backup target with the backup data
- :type target: Instance of :class:`BackupTarget`
+ :type target: Instance of :class:`.BackupTarget`
:param job: Backup target job to resume
- :type job: Instance of :class:`BackupTargetJob`
+ :type job: Instance of :class:`.BackupTargetJob`
:rtype: ``bool``
"""
@@ -462,10 +463,10 @@ class BackupDriver(BaseDriver):
Suspend a running backup job on a target
:param target: Backup target with the backup data
- :type target: Instance of :class:`BackupTarget`
+ :type target: Instance of :class:`.BackupTarget`
:param job: Backup target job to suspend
- :type job: Instance of :class:`BackupTargetJob`
+ :type job: Instance of :class:`.BackupTargetJob`
:rtype: ``bool``
"""
@@ -477,10 +478,10 @@ class BackupDriver(BaseDriver):
Cancel a backup job on a target
:param target: Backup target with the backup data
- :type target: Instance of :class:`BackupTarget`
+ :type target: Instance of :class:`.BackupTarget`
:param job: Backup target job to cancel
- :type job: Instance of :class:`BackupTargetJob`
+ :type job: Instance of :class:`.BackupTargetJob`
:rtype: ``bool``
"""