You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@libcloud.apache.org by to...@apache.org on 2017/09/10 19:51:50 UTC
[1/8] libcloud git commit: Re-enable strict checks (treat warnings as
errors) when building sphinx docs.
Repository: libcloud
Updated Branches:
refs/heads/trunk f1bff4814 -> e2d99e154
Re-enable strict checks (treat warnings as errors) when building sphinx
docs.
This allows us to catch broken / invalid docstrings and other
documentation related issues.
Closes #1105
Project: http://git-wip-us.apache.org/repos/asf/libcloud/repo
Commit: http://git-wip-us.apache.org/repos/asf/libcloud/commit/b01cf371
Tree: http://git-wip-us.apache.org/repos/asf/libcloud/tree/b01cf371
Diff: http://git-wip-us.apache.org/repos/asf/libcloud/diff/b01cf371
Branch: refs/heads/trunk
Commit: b01cf3719d3c49781793575926a4bc01425f2c49
Parents: f1bff48
Author: Tomaz Muraus <to...@tomaz.me>
Authored: Wed Sep 6 16:57:53 2017 +0200
Committer: Tomaz Muraus <to...@tomaz.me>
Committed: Sun Sep 10 21:51:20 2017 +0200
----------------------------------------------------------------------
tox.ini | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/libcloud/blob/b01cf371/tox.ini
----------------------------------------------------------------------
diff --git a/tox.ini b/tox.ini
index a4e54a9..bc180e2 100644
--- a/tox.ini
+++ b/tox.ini
@@ -47,7 +47,7 @@ deps = sphinx
lockfile
changedir = docs
commands = python ../contrib/generate_provider_feature_matrix_table.py
- sphinx-build -b html -d {envtmpdir}/doctrees . _build/html
+ sphinx-build -W -b html -d {envtmpdir}/doctrees . _build/html
[testenv:scrape-ec2-prices]
deps = requests
[6/8] libcloud git commit: Add orphan tag to copyright doc.
Posted by to...@apache.org.
Add orphan tag to copyright doc.
Project: http://git-wip-us.apache.org/repos/asf/libcloud/repo
Commit: http://git-wip-us.apache.org/repos/asf/libcloud/commit/da9508f5
Tree: http://git-wip-us.apache.org/repos/asf/libcloud/tree/da9508f5
Diff: http://git-wip-us.apache.org/repos/asf/libcloud/diff/da9508f5
Branch: refs/heads/trunk
Commit: da9508f5b37f03e69427c5793097550f4a4a9142
Parents: 36b5a70
Author: Tomaz Muraus <to...@tomaz.me>
Authored: Wed Sep 6 17:17:45 2017 +0200
Committer: Tomaz Muraus <to...@tomaz.me>
Committed: Sun Sep 10 21:51:29 2017 +0200
----------------------------------------------------------------------
docs/copyright.rst | 2 ++
1 file changed, 2 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/libcloud/blob/da9508f5/docs/copyright.rst
----------------------------------------------------------------------
diff --git a/docs/copyright.rst b/docs/copyright.rst
index d8b1317..c5c7549 100644
--- a/docs/copyright.rst
+++ b/docs/copyright.rst
@@ -1,3 +1,5 @@
+:orphan:
+
Copyright
=========
[7/8] libcloud git commit: No need for a semi colon.
Posted by to...@apache.org.
No need for a semi colon.
Project: http://git-wip-us.apache.org/repos/asf/libcloud/repo
Commit: http://git-wip-us.apache.org/repos/asf/libcloud/commit/e2d99e15
Tree: http://git-wip-us.apache.org/repos/asf/libcloud/tree/e2d99e15
Diff: http://git-wip-us.apache.org/repos/asf/libcloud/diff/e2d99e15
Branch: refs/heads/trunk
Commit: e2d99e1540d36151f5092303b7b13dbc9c86d8e3
Parents: a212c3d
Author: Tomaz Muraus <to...@tomaz.me>
Authored: Sun Sep 10 21:43:58 2017 +0200
Committer: Tomaz Muraus <to...@tomaz.me>
Committed: Sun Sep 10 21:51:29 2017 +0200
----------------------------------------------------------------------
tox.ini | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/libcloud/blob/e2d99e15/tox.ini
----------------------------------------------------------------------
diff --git a/tox.ini b/tox.ini
index 6553720..685325d 100644
--- a/tox.ini
+++ b/tox.ini
@@ -36,7 +36,7 @@ deps = sphinx
changedir = docs
commands = python ../contrib/generate_provider_feature_matrix_table.py
sphinx-apidoc -d 4 ../libcloud/ -o apidocs/
- /bin/bash -c "ls apidocs/modules.rst && (grep orphan apidocs/modules.rst || sed -i '1i :orphan:\n' apidocs/modules.rst) || (exit 0)" ;
+ /bin/bash -c "ls apidocs/modules.rst && (grep orphan apidocs/modules.rst || sed -i '1i :orphan:\n' apidocs/modules.rst) || (exit 0)"
sphinx-build -W -b html -d {envtmpdir}/doctrees . _build/html
[testenv:docs-travis]
@@ -48,7 +48,7 @@ deps = sphinx
lockfile
changedir = docs
commands = python ../contrib/generate_provider_feature_matrix_table.py
- /bin/bash -c "ls apidocs/modules.rst && (grep orphan apidocs/modules.rst || sed -i '1i :orphan:\n' apidocs/modules.rst) || (exit 0)" ;
+ /bin/bash -c "ls apidocs/modules.rst && (grep orphan apidocs/modules.rst || sed -i '1i :orphan:\n' apidocs/modules.rst) || (exit 0)"
sphinx-build -W -b html -d {envtmpdir}/doctrees . _build/html
[testenv:scrape-ec2-prices]
[8/8] libcloud git commit: Only insert ":orphan" note if
apidocs/modules.rst file exists.
Posted by to...@apache.org.
Only insert ":orphan" note if apidocs/modules.rst file exists.
Project: http://git-wip-us.apache.org/repos/asf/libcloud/repo
Commit: http://git-wip-us.apache.org/repos/asf/libcloud/commit/a212c3d4
Tree: http://git-wip-us.apache.org/repos/asf/libcloud/tree/a212c3d4
Diff: http://git-wip-us.apache.org/repos/asf/libcloud/diff/a212c3d4
Branch: refs/heads/trunk
Commit: a212c3d4765d1bf9d00b5facada117cf7b1cdb0b
Parents: 1b8d594
Author: Tomaz Muraus <to...@tomaz.me>
Authored: Sun Sep 10 21:42:14 2017 +0200
Committer: Tomaz Muraus <to...@tomaz.me>
Committed: Sun Sep 10 21:51:29 2017 +0200
----------------------------------------------------------------------
tox.ini | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/libcloud/blob/a212c3d4/tox.ini
----------------------------------------------------------------------
diff --git a/tox.ini b/tox.ini
index fb1ced3..6553720 100644
--- a/tox.ini
+++ b/tox.ini
@@ -36,7 +36,7 @@ deps = sphinx
changedir = docs
commands = python ../contrib/generate_provider_feature_matrix_table.py
sphinx-apidoc -d 4 ../libcloud/ -o apidocs/
- /bin/bash -c "grep orphan apidocs/modules.rst || sed -i '1i :orphan:\n' apidocs/modules.rst"
+ /bin/bash -c "ls apidocs/modules.rst && (grep orphan apidocs/modules.rst || sed -i '1i :orphan:\n' apidocs/modules.rst) || (exit 0)" ;
sphinx-build -W -b html -d {envtmpdir}/doctrees . _build/html
[testenv:docs-travis]
@@ -48,7 +48,7 @@ deps = sphinx
lockfile
changedir = docs
commands = python ../contrib/generate_provider_feature_matrix_table.py
- /bin/bash -c "grep orphan apidocs/modules.rst || sed -i '1i :orphan:\n' apidocs/modules.rst"
+ /bin/bash -c "ls apidocs/modules.rst && (grep orphan apidocs/modules.rst || sed -i '1i :orphan:\n' apidocs/modules.rst) || (exit 0)" ;
sphinx-build -W -b html -d {envtmpdir}/doctrees . _build/html
[testenv:scrape-ec2-prices]
[3/8] libcloud git commit: Fix broken docstrings breaking the sphinx
docs build.
Posted by to...@apache.org.
Fix broken docstrings breaking the sphinx docs build.
Project: http://git-wip-us.apache.org/repos/asf/libcloud/repo
Commit: http://git-wip-us.apache.org/repos/asf/libcloud/commit/8ea38d9f
Tree: http://git-wip-us.apache.org/repos/asf/libcloud/tree/8ea38d9f
Diff: http://git-wip-us.apache.org/repos/asf/libcloud/diff/8ea38d9f
Branch: refs/heads/trunk
Commit: 8ea38d9f6e675abeb5746c0a59dbb38baa2f0c0c
Parents: b01cf37
Author: Tomaz Muraus <to...@tomaz.me>
Authored: Wed Sep 6 17:10:13 2017 +0200
Committer: Tomaz Muraus <to...@tomaz.me>
Committed: Sun Sep 10 21:51:29 2017 +0200
----------------------------------------------------------------------
libcloud/compute/drivers/oneandone.py | 131 +++++------------------------
1 file changed, 22 insertions(+), 109 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/libcloud/blob/8ea38d9f/libcloud/compute/drivers/oneandone.py
----------------------------------------------------------------------
diff --git a/libcloud/compute/drivers/oneandone.py b/libcloud/compute/drivers/oneandone.py
index f95eb1e..5f2bcbb 100644
--- a/libcloud/compute/drivers/oneandone.py
+++ b/libcloud/compute/drivers/oneandone.py
@@ -805,20 +805,14 @@ class OneAndOneNodeDriver(NodeDriver):
def ex_create_firewall_policy(self, name, rules, description=None):
"""
- Creates a firewall Policy
+ Creates a firewall Policy.
+
:param name:
:param description:
:param rules:
- :rtype 'dict': [
- {
- 'protocol': 'TCP',
- 'port_from': 80,
- 'port_to': 80,
- 'source': '0.0.0.0'
- }
- ]
+ :rtype: `dict`
+ :return: `dict` firewall policy
- :return: 'dict' firewall policy
"""
body = {
'name': name
@@ -1033,48 +1027,34 @@ class OneAndOneNodeDriver(NodeDriver):
"""
:param name: Name of the load balancer
- :rtype:``str``
:param method: Load balancer method
- :rtype:``str``
:param rules: Load balancer rules
- :rtype: ``list`` of ``dict``
- 'rules': [
- {
- 'protocol': 'TCP',
- 'port_balancer': 80,
- 'port_server': 80,
- 'source': '0.0.0.0'
- },
- {
- 'protocol': 'TCP',
- 'port_balancer': 9999,
- 'port_server': 8888,
- 'source': '0.0.0.0'
- }
- ]
+ :type rules: ``list`` of ``dict``
+
:param persistence: Indictes if persistance is set
- :rtype: ``boolean``
+ :type persistence: ``boolean``
:param persistence_time: Persistance time
- :rtype: ``int``
+ :type persistence_time: ``int``
:param health_check_test: Type of test
- :rtype:``str``
+ :type health_check_test:``str``
:param health_check_interval: Interval of the check
:param health_check_path: Path
- :rtype:``str``
+ :type health_check_path: ``str``
+
:param health_check_parser: Parser
- :rtype:``str``
+ :type health_check_parser:``str``
:param datacenter_id: Data center id
- :rtype:``str``
+ :type datacenter_id:``str``
:param description: Description of load balancer
- :rtype:``str``
+ :type description:``str``
:return: ``dict``
"""
@@ -1708,92 +1688,25 @@ class OneAndOneNodeDriver(NodeDriver):
Creates a monitoring policy
:param name: Name for the monitoring policy
- :rtype: ``str``
+ :type name: ``str``
:param thresholds: Thresholds for the monitoring policy
- :rtype: ``dict``
- {
- 'cpu':{
- 'warning':{
- 'value':90,
- 'alert':false
- },
- 'critical':{
- 'value':95,
- 'alert':false
- }
- },
- 'ram':{
- 'warning':{
- 'value':90,
- 'alert':false
- },
- 'critical':{
- 'value':95,
- 'alert':false
- }
- },
- 'disk':{
- 'warning':{
- 'value':80,
- 'alert':false
- },
- 'critical':{
- 'value':90,
- 'alert':false
- }
- },
- 'transfer':{
- 'warning':{
- 'value':1000,
- 'alert':false
- },
- 'critical':{
- 'value':2000,
- 'alert':false
- }
- },
- 'internal_ping':{
- 'warning':{
- 'value':50,
- 'alert':false
- },
- 'critical':{
- 'value':100,
- 'alert':false
- }
- }
- }
- :param ports: Monitoring policies for ports
- :rtype: ``dict``
- [
- {
- 'protocol':'TCP',
- 'port':'22',
- 'alert_if':'RESPONDING',
- 'email_notification':true
- }
- ]
+ :type thresholds: ``dict``
+ :param ports: Monitoring policies for ports
+ :type ports: ``list`` of ``dict``
:param processes: Processes to be monitored
- :rtype: ``dict``
- [
- {
- 'process':'test',
- 'alert_if':'NOT_RUNNING',
- 'email_notification':true
- }
- ]
+ :type processes: ``list`` of ``dict``
:param description: Description for the monitoring policy
- :rtype: ``str``
+ :type description: ``str``
:param email: Email for notifications
- :rtype: ``str``
+ :type email: ``str``
:param agent: Indicates if agent application will be installed
- :rtype: ``boolean``
+ :type agent: ``boolean``
:return: Newly created instance of monitofing policy
:rtype: ``dict``
[4/8] libcloud git commit: Insert ":orphan:" strict to doc files
which are not included anywhere.
Posted by to...@apache.org.
Insert ":orphan:" strict to doc files which are not included anywhere.
Project: http://git-wip-us.apache.org/repos/asf/libcloud/repo
Commit: http://git-wip-us.apache.org/repos/asf/libcloud/commit/36b5a703
Tree: http://git-wip-us.apache.org/repos/asf/libcloud/tree/36b5a703
Diff: http://git-wip-us.apache.org/repos/asf/libcloud/diff/36b5a703
Branch: refs/heads/trunk
Commit: 36b5a703bd243e336fb35f9b82f8a7016c9a399a
Parents: 8ea38d9
Author: Tomaz Muraus <to...@tomaz.me>
Authored: Wed Sep 6 17:14:19 2017 +0200
Committer: Tomaz Muraus <to...@tomaz.me>
Committed: Sun Sep 10 21:51:29 2017 +0200
----------------------------------------------------------------------
tox.ini | 2 ++
1 file changed, 2 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/libcloud/blob/36b5a703/tox.ini
----------------------------------------------------------------------
diff --git a/tox.ini b/tox.ini
index bc180e2..fb1ced3 100644
--- a/tox.ini
+++ b/tox.ini
@@ -36,6 +36,7 @@ deps = sphinx
changedir = docs
commands = python ../contrib/generate_provider_feature_matrix_table.py
sphinx-apidoc -d 4 ../libcloud/ -o apidocs/
+ /bin/bash -c "grep orphan apidocs/modules.rst || sed -i '1i :orphan:\n' apidocs/modules.rst"
sphinx-build -W -b html -d {envtmpdir}/doctrees . _build/html
[testenv:docs-travis]
@@ -47,6 +48,7 @@ deps = sphinx
lockfile
changedir = docs
commands = python ../contrib/generate_provider_feature_matrix_table.py
+ /bin/bash -c "grep orphan apidocs/modules.rst || sed -i '1i :orphan:\n' apidocs/modules.rst"
sphinx-build -W -b html -d {envtmpdir}/doctrees . _build/html
[testenv:scrape-ec2-prices]
[5/8] libcloud git commit: Ignore "more than one target found for
cross-reference" false positive sphinx build errors.
Posted by to...@apache.org.
Ignore "more than one target found for cross-reference" false positive
sphinx build errors.
Project: http://git-wip-us.apache.org/repos/asf/libcloud/repo
Commit: http://git-wip-us.apache.org/repos/asf/libcloud/commit/1927c806
Tree: http://git-wip-us.apache.org/repos/asf/libcloud/tree/1927c806
Diff: http://git-wip-us.apache.org/repos/asf/libcloud/diff/1927c806
Branch: refs/heads/trunk
Commit: 1927c806efb9e5f2c0f3ee30c3c5d130a9a969ee
Parents: da9508f
Author: Tomaz Muraus <to...@tomaz.me>
Authored: Wed Sep 6 17:24:11 2017 +0200
Committer: Tomaz Muraus <to...@tomaz.me>
Committed: Sun Sep 10 21:51:29 2017 +0200
----------------------------------------------------------------------
docs/conf.py | 14 ++++++++++++++
1 file changed, 14 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/libcloud/blob/1927c806/docs/conf.py
----------------------------------------------------------------------
diff --git a/docs/conf.py b/docs/conf.py
index 3e0c983..94a2b76 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -21,6 +21,8 @@ from sphinx.environment import BuildEnvironment
from sphinx.ext.autodoc import AutoDirective
from sphinx.ext.autodoc import AutodocReporter
+from sphinx.domains.python import PythonDomain
+
BASE_DIR = os.path.dirname(os.path.abspath(__file__))
BASE_DIR = os.path.abspath(BASE_DIR)
@@ -303,3 +305,15 @@ AutoDirective.warn = noop
AutodocReporter.warning = mock_warning
BuildEnvironment.warn_node = ignore_more_than_one_target_found_errors
+
+# Ignore "more than one target found for cross-reference" errors which are false
+# positives
+class PatchedPythonDomain(PythonDomain):
+ def resolve_xref(self, env, fromdocname, builder, typ, target, node, contnode):
+ if 'refspecific' in node:
+ del node['refspecific']
+ return super(PatchedPythonDomain, self).resolve_xref(
+ env, fromdocname, builder, typ, target, node, contnode)
+
+def setup(sphinx):
+ sphinx.override_domain(PatchedPythonDomain)
[2/8] libcloud git commit: Fix more broken / invalid docstrings in
the 1&1 driver.
Posted by to...@apache.org.
Fix more broken / invalid docstrings in the 1&1 driver.
Project: http://git-wip-us.apache.org/repos/asf/libcloud/repo
Commit: http://git-wip-us.apache.org/repos/asf/libcloud/commit/1b8d594c
Tree: http://git-wip-us.apache.org/repos/asf/libcloud/tree/1b8d594c
Diff: http://git-wip-us.apache.org/repos/asf/libcloud/diff/1b8d594c
Branch: refs/heads/trunk
Commit: 1b8d594cfc5ab80a98d61fbcd1c703295b0c66d6
Parents: 1927c80
Author: Tomaz Muraus <to...@tomaz.me>
Authored: Wed Sep 6 17:36:58 2017 +0200
Committer: Tomaz Muraus <to...@tomaz.me>
Committed: Sun Sep 10 21:51:29 2017 +0200
----------------------------------------------------------------------
libcloud/compute/drivers/oneandone.py | 267 +++++++++++++++--------------
1 file changed, 136 insertions(+), 131 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/libcloud/blob/1b8d594c/libcloud/compute/drivers/oneandone.py
----------------------------------------------------------------------
diff --git a/libcloud/compute/drivers/oneandone.py b/libcloud/compute/drivers/oneandone.py
index 5f2bcbb..79d7d33 100644
--- a/libcloud/compute/drivers/oneandone.py
+++ b/libcloud/compute/drivers/oneandone.py
@@ -199,48 +199,41 @@ class OneAndOneNodeDriver(NodeDriver):
Creates a node.
:param name: The name of the new node
- :type `str`
-
- :param image: Image from list_images
- :rtype: image:
+ :type name: `str`
:param ex_fixed_instance_size_id:
Fixed instance size ID from list_sizes
- :rtype: ``str``
+ :type ex_fixed_instance_size_id: ``str``
:param location: 1&1 Data center Location
- :type `NodeLocation`
-
- :param auth: SSH key or root password
- :type: :class:`NodeAuthSSHKey` or :class:`NodeAuthPassword`
+ :type location: `NodeLocation`
:param ex_ip: IP address
- :type `str`
+ :type ex_ip: `str`
:param ex_ssh_key: SSH Key
- :type `str`
+ :type ex_ssh_key: `str`
:param password: Password
- :type `str`
+ :type password: `str`
:param ex_monitoring_policy_id:
- :type `str`
+ :type ex_firewall_policy_id: `str`
:param ex_firewall_policy_id:
- :type `str`
+ :type ex_firewall_policy_id: `str`
:param ex_loadbalancer_id:
- :type `str`
+ :type ex_loadbalancer_id: `str`
:param ex_description:
- :type `str`
+ :type ex_description: `str`
:param ex_power_on:
- :type `bool`
-
+ :type ex_power_on: `bool`
:return: Instance of class ``Node``
- :rtype: :class: `Node`
+ :rtype: :class:`Node`
"""
body = {
@@ -352,11 +345,12 @@ class OneAndOneNodeDriver(NodeDriver):
"""
Renames the server
:param server_id: ID of the server you want to rename
+
:param name: New name of the server
- :rtype: ``str``
+ :type: ``str``
:param description: New description of the server
- :rtype: ``str``
+ :type: ``str``
:return: Instance of class ``Node``
:rtype: :class: `Node`
@@ -381,7 +375,7 @@ class OneAndOneNodeDriver(NodeDriver):
Gets all server hardware
:param server_id: Id of the server
- :rtype: ``str``
+ :type: ``str``
:return: Server's hardware
:rtype: ``dict``
@@ -403,22 +397,22 @@ class OneAndOneNodeDriver(NodeDriver):
Modifies server's hardware
:param server_id:
- :rtype: ``str``
+ :type: ``str``
:param fixed_instance_size_id: Id of the fixed instance size
- :rtype: ``str``
+ :type: ``str``
:param vcore: Virtual cores count
- :rtype: ``int``
+ :type: ``int``
:param cores_per_processor: Count of cores per procesor
- :rtype: ``int``
+ :type: ``int``
:param ram: Amount of ram for the server
- :rtype: ``int``
+ :type: ``int``
:return: Instance of class ``Node``
- :rtype: :class: `Node`
+ :type: :class: `Node`
"""
body = {}
@@ -449,14 +443,13 @@ class OneAndOneNodeDriver(NodeDriver):
Modifies server hard disk drives
:param server_id: Id of the server
- :rtype: ``str``
+ :type: ``str``
:param hdd_id: Id of the hard disk
- :rtype: ``str``
+ :type: ``str``
:param size: Size of the hard disk
- :rtype: ``str``
-
+ :type: ``str``
:return: Instance of class ``Node``
:rtype: :class: `Node`
@@ -480,16 +473,16 @@ class OneAndOneNodeDriver(NodeDriver):
Add a hard disk to the server
:param server_id: Id of the server
- :rtype: ``str``
+ :type: ``str``
:param size: Size of the new disk
- :rtype: ``str``
+ :type: ``str``
:param is_main: Indicates if the disk is going to be the boot disk
- :rtype: ``boolean``
+ :type: ``boolean``
:return: Instance of class ``Node``
- :rtype: :class: `Node`
+ :type: :class: `Node`
"""
body = {
'size': size,
@@ -509,10 +502,10 @@ class OneAndOneNodeDriver(NodeDriver):
Removes existing hard disk
:param server_id: Id of the server
- :rtype: ``str``
+ :type: ``str``
:param hdd_id: Id of the hard disk
- :rtype: ``str``
+ :type: ``str``
:return: Instance of class ``Node``
:rtype: :class: `Node`
@@ -548,7 +541,8 @@ class OneAndOneNodeDriver(NodeDriver):
Gets a server
:param server_id: Id of the server to be retrieved
- :rtype: ``str``
+ :type: ``str``
+
:return: Instance of class ``Node``
:rtype: :class: `Node`
"""
@@ -565,7 +559,7 @@ class OneAndOneNodeDriver(NodeDriver):
Shuts down the server
:param server_id: Id of the server to be shut down
- :rtype: ``str``
+ :type: ``str``
:param method: Method of shutting down "SOFTWARE" or "HARDWARE"
@@ -593,7 +587,7 @@ class OneAndOneNodeDriver(NodeDriver):
Gets server image
:param server_id: Id of the server
- :rtype: ``str``
+ :type: ``str``
:return: Server image
:rtype: ``dict``
@@ -610,10 +604,10 @@ class OneAndOneNodeDriver(NodeDriver):
Installs a new image on the server
:param server_id: Id of the server
- :rtype: ``str``
+ :type: ``str``
:param image_id: Id of the image (Server Appliance)
- :rtype: ``str``
+ :type: ``str``
:param password: New password for the server
@@ -644,7 +638,7 @@ class OneAndOneNodeDriver(NodeDriver):
Gets all server IP objects
:param server_id: Id of the server
- :rtype: ``str``
+ :type: ``str``
:return: List of server IP objects
:rtype: ``list`` of ``dict``
@@ -661,10 +655,10 @@ class OneAndOneNodeDriver(NodeDriver):
Get a single server IP object
:param server_id: Id of the server
- :rtype: ``str``
+ :type: ``str``
:param ip_id: ID of the IP address
- :rtype: ``str``
+ :type: ``str``
:return: IP address object
:rtype: ``dict``
@@ -681,10 +675,10 @@ class OneAndOneNodeDriver(NodeDriver):
Assigns a new IP address to the server
:param server_id: Id of the server
- :rtype: ``str``
+ :type: ``str``
:param ip_type: Type of the IP address [IPV4,IPV6]
- :rtype: ``str``
+ :type: ``str``
:return: ``Node`` instance
:rtype: ``Node``
@@ -707,14 +701,14 @@ class OneAndOneNodeDriver(NodeDriver):
Removes an IP address from the server
:param server_id: Id of the server
- :rtype: ``str``
+ :type: ``str``
:param ip_id: ID of the IP address
- :rtype: ``str``
+ :type: ``str``
:param keep_ip: Indicates whether IP address will be removed from
- the Cloud Panel
- :rtype: ``boolean``
+ the Cloud Panel
+ :type: ``boolean``
:return: ``Node`` instance
:rtype: ``Node``
@@ -735,11 +729,12 @@ class OneAndOneNodeDriver(NodeDriver):
def ex_get_server_firewall_policies(self, server_id, ip_id):
"""
Gets a firewall policy of attached to the server's IP
+
:param server_id: Id of the server
- :rtype: ``str``
+ :type: ``str``
:param ip_id: ID of the IP address
- :rtype: ``str``
+ :type: ``str``
:return: IP address object
:rtype: ``dict``
@@ -757,10 +752,10 @@ class OneAndOneNodeDriver(NodeDriver):
Removes a firewall policy from server's IP
:param server_id: Id of the server
- :rtype: ``str``
+ :type: ``str``
:param ip_id: ID of the IP address
- :rtype: ``str``
+ :type: ``str``
:return: ``Node`` instance
:rtype: ``Node``
@@ -777,13 +772,13 @@ class OneAndOneNodeDriver(NodeDriver):
Adds a firewall policy to the server's IP address
:param server_id: Id of the server
- :rtype: ``str``
+ :type: ``str``
:param ip_id: ID of the IP address
- :rtype: ``str``
+ :type: ``str``
:param firewall_id: ID of the firewall policy
- :rtype: ``str``
+ :type: ``str``
:return: ``Node`` instance
:rtype: ``Node``
@@ -810,6 +805,7 @@ class OneAndOneNodeDriver(NodeDriver):
:param name:
:param description:
:param rules:
+
:rtype: `dict`
:return: `dict` firewall policy
@@ -839,6 +835,7 @@ class OneAndOneNodeDriver(NodeDriver):
def ex_list_firewall_policies(self):
""""
List firewall policies
+
:return: 'dict'
"""
@@ -852,6 +849,7 @@ class OneAndOneNodeDriver(NodeDriver):
def ex_get_firewall_policy(self, fw_id):
"""
Gets firewall policy
+
:param fw_id: ID of the firewall policy
:return: 'dict'
"""
@@ -866,6 +864,7 @@ class OneAndOneNodeDriver(NodeDriver):
def ex_delete_firewall_policy(self, fw_id):
"""
Deletes firewall policy
+
:param fw_id: ID of the Firewall
:return: 'dict'
"""
@@ -937,7 +936,7 @@ class OneAndOneNodeDriver(NodeDriver):
Removes a shared storage
:param storage_id: Id of the shared storage
- :rtype: ``str``
+ :type: ``str``
:return: Instnace of shared storage
:rtype: ``list`` of ``dict``
@@ -996,10 +995,10 @@ class OneAndOneNodeDriver(NodeDriver):
Detaches a server from shared storage
:param storage_id: Id of the shared storage
- :rtype: ``str``
+ :type: ``str``
:param server_id: Id of the server
- :rtype: ``str``
+ :type: ``str``
:return: Instance of shared storage
:rtype: ``dict``
@@ -1128,10 +1127,10 @@ class OneAndOneNodeDriver(NodeDriver):
Adds server's IP address to load balancer
:param lb_id: Load balancer ID
- :rtype: ``str``
+ :type: ``str``
:param server_ips: Array of server IP IDs
- :rtype: ``list`` of ``str``
+ :type: ``list`` of ``str``
:return: Instance of load balancer
:rtype: ``dict``
@@ -1153,10 +1152,10 @@ class OneAndOneNodeDriver(NodeDriver):
Removes server's IP from load balancer
:param lb_id: Load balancer ID
- :rtype: ``str``
+ :type: ``str``
:param server_ip: ID of the server IP
- :rtype: ``str``
+ :type: ``str``
:return: Instance of load balancer
:rtype: ``dict``
@@ -1252,7 +1251,7 @@ class OneAndOneNodeDriver(NodeDriver):
Gets a single load balancer
:param lb_id: ID of the load balancer
- :rtype: ``str``
+ :type lb_id: ``str``
:return: Instance of load balancer
:rtype: ``dict``
@@ -1269,7 +1268,7 @@ class OneAndOneNodeDriver(NodeDriver):
List balanced server IP addresses
:param lb_id: ID of the load balancer
- :rtype: ``str``
+ :type lb_id: ``str``
:return: Array of IP address IDs
:rtype: ``dict``
@@ -1286,10 +1285,10 @@ class OneAndOneNodeDriver(NodeDriver):
Gets load balanced server id
:param lb_id: ID of the load balancer
- :rtype: ``str``
+ :type lb_id: ``str``
:param server_ip: ID of the server IP
- :rtype: ``str``
+ :type server_ip: ``str``
:return: Server IP
:rtype: ``dict``
@@ -1306,7 +1305,7 @@ class OneAndOneNodeDriver(NodeDriver):
Lists loadbalancer rules
:param lb_id: ID of the load balancer
- :rtype: ``str``
+ :type lb_id: ``str``
:return: Lists of rules
:rtype: ``list`` of ``dict``
@@ -1323,10 +1322,10 @@ class OneAndOneNodeDriver(NodeDriver):
Get a load balancer rule
:param lb_id: ID of the load balancer
- :rtype: ``str``
+ :type lb_id: ``str``
:param rule_id: Rule ID
- :rtype: ``str``
+ :type rule_id: ``str``
:return: A load balancer rule
:rtype: ``dict``
@@ -1343,10 +1342,10 @@ class OneAndOneNodeDriver(NodeDriver):
Deletes a load balancer rule
:param lb_id: ID of the load balancer
- :rtype: ``str``
+ :type lb_id: ``str``
:param rule_id: Rule ID
- :rtype: ``str``
+ :type rule_id: ``str``
:return: Instance of load balancer
:rtype: ``dict``
@@ -1380,14 +1379,14 @@ class OneAndOneNodeDriver(NodeDriver):
"""
Creates a public IP
- :param type: Type of IP IPV4 or IPV6]
- :rtype: ``str``
+ :param type: Type of IP (IPV4 or IPV6)
+ :type type: ``str``
:param reverse_dns: Reverse DNS
- :rtype: ``str``
+ :type reverse_dns: ``str``
:param datacenter_id: Datacenter ID where IP address will be crated
- :rtype: ``str``
+ :type datacenter_id: ``str``
:return: Instance of Public IP
:rtype: ``dict``
@@ -1414,7 +1413,7 @@ class OneAndOneNodeDriver(NodeDriver):
Gets a Public IP
:param ip_id: ID of the IP
- :rtype: ``str``
+ :type ip_id: ``str``
:return: Instance of Public IP
:rtype: ``dict``
@@ -1431,7 +1430,7 @@ class OneAndOneNodeDriver(NodeDriver):
Deletes a public IP
:param ip_id: ID of public IP
- :rtype: ``str``
+ :type ip_id: ``str``
:return: Instance of IP Address
:rtype: ``dict``
@@ -1448,10 +1447,10 @@ class OneAndOneNodeDriver(NodeDriver):
Updates a Public IP
:param ip_id: ID of public IP
- :rtype: ``str``
+ :type ip_id: ``str``
:param reverse_dns: Reverse DNS
- :rtype: ``str``
+ :type reverse_dns: ``str``
:return: Instance of Public IP
:rtype: ``dict``
@@ -1494,19 +1493,19 @@ class OneAndOneNodeDriver(NodeDriver):
Creates a private network
:param name: Name of the private network
- :rtype: ``str``
+ :type name: ``str``
:param description: Description of the private network
- :rtype: ``str``
+ :type description: ``str``
:param datacenter_id: ID of the data center for the private network
- :rtype: ``str``
+ :type datacenter_id: ``str``
:param network_address: Network address of the private network
- :rtype: ``str``
+ :type network_address: ``str``
:param subnet_mask: Subnet mask of the private network
- :rtype: ``str``
+ :type subnet_mask: ``str``
:return: Newly created private network
:rtype: ``dict``
@@ -1537,7 +1536,7 @@ class OneAndOneNodeDriver(NodeDriver):
Deletes a private network
:param network_id: Id of the private network
- :rtype: ``str``
+ :type network_id: ``str``
:return: Instance of the private network being deleted
:rtype: ``dict``
@@ -1555,26 +1554,26 @@ class OneAndOneNodeDriver(NodeDriver):
network_address=None,
subnet_mask=None):
"""
- Updates a private network
+ Updates a private network
- :param name: Name of the private network
- :rtype: ``str``
+ :param name: Name of the private network
+ :type name: ``str``
- :param description: Description of the private network
- :rtype: ``str``
+ :param description: Description of the private network
+ :type description: ``str``
- :param datacenter_id: ID of the data center for the private network
- :rtype: ``str``
+ :param datacenter_id: ID of the data center for the private network
+ :type datacenter_id: ``str``
- :param network_address: Network address of the private network
- :rtype: ``str``
+ :param network_address: Network address of the private network
+ :type network_address: ``str``
- :param subnet_mask: Subnet mask of the private network
- :rtype: ``str``
+ :param subnet_mask: Subnet mask of the private network
+ :type subnet_mask: ``str``
- :return: Instance of private network
- :rtype: ``dict``
- """
+ :return: Instance of private network
+ :rtype: ``dict``
+ """
body = {}
if name is not None:
@@ -1601,7 +1600,7 @@ class OneAndOneNodeDriver(NodeDriver):
Lists all private network servers
:param network_id: Private network ID
- :rtype: ``str``
+ :type network_id: ``str``
:return: List of private network servers
:rtype: ``dict``
@@ -1617,10 +1616,10 @@ class OneAndOneNodeDriver(NodeDriver):
Add servers to private network
:param network_id: Private Network ID
- :rtype: ``str``
+ :type network_id: ``str``
:param server_ids: List of server IDs
- :rtype: ``list`` of ``str``
+ :type server_ids: ``list`` of ``str``
:return: List of attached servers
:rtype: ``dict``
@@ -1644,10 +1643,10 @@ class OneAndOneNodeDriver(NodeDriver):
Removes a server from the private network
:param network_id: Private Network ID
- :rtype: ``str``
+ :type network_id: ``str``
:param server_id: Id of the server
- :rtype: ``str``
+ :type server_id: ``str``
:return: Instance of the private network
:rtype: ``dict``
@@ -1737,7 +1736,7 @@ class OneAndOneNodeDriver(NodeDriver):
Deletes a monitoring policy
:param policy_id: Id of the monitoring policy
- :rtype: ``str``
+ :type policy_id: ``str``
:return: Instance of the monitoring policy being deleted
:rtype: ``dict``
@@ -1757,17 +1756,19 @@ class OneAndOneNodeDriver(NodeDriver):
Updates monitoring policy
:param policy_id: Id of the monitoring policy
+ :type policy_id: ``str``
+
:param email: Email to send notifications to
- :rtype: ``str``
+ :type email: ``str``
:param thresholds: Thresholds for the monitoring policy
- :rtype: ``dict``
+ :type thresholds: ``dict``
:param name: Name of the monitoring policy
- :rtype: ``str``
+ :type name: ``str``
:param description: Description of the monitoring policy
- :rtype: ``str``
+ :type description: ``str``
:return: Instance of the monitoring policy being deleted
:rtype: ``dict``
@@ -1797,7 +1798,7 @@ class OneAndOneNodeDriver(NodeDriver):
Fetches a monitoring policy
:param policy_id: Id of the monitoring policy
- :rtype: ``str``
+ :type policy_id: ``str``
:return: Instance of a monitoring policy
:rtype: ``dict``
@@ -1814,6 +1815,7 @@ class OneAndOneNodeDriver(NodeDriver):
Fetches monitoring policy ports
:param policy_id: Id of the monitoring policy
+ :type policy_id:
:return: Instance of a monitoring policy
:rtype: ``dict``
@@ -1831,10 +1833,10 @@ class OneAndOneNodeDriver(NodeDriver):
Fetches monitoring policy port
:param policy_id: Id of the monitoring policy
- :rtype: ``str``
+ :type policy_id: ``str``
:param port_id: Id of the port
- :rtype: ``str``
+ :type port_id: ``str``
:return: Instance of a monitoring policy
:rtype: ``dict``
@@ -1852,10 +1854,10 @@ class OneAndOneNodeDriver(NodeDriver):
Removes monitoring policy port
:param policy_id: Id of the monitoring policy
- :rtype: ``str``
+ :type policy_id: ``str``
:param port_id: Id of the port
- :rtype: ``str``
+ :type port_id: ``str``
:return: Instance of a monitoring policy
:rtype: ``dict``
@@ -1873,10 +1875,10 @@ class OneAndOneNodeDriver(NodeDriver):
Add monitoring policy ports
:param policy_id: Id of the monitoring policy
- :rtype: ``str``
+ :type policy_id: ``str``
:param ports: List of ports
- :rtype: ``dict``
+ :type ports: ``dict``
[
{
'protocol':'TCP',
@@ -1885,6 +1887,7 @@ class OneAndOneNodeDriver(NodeDriver):
'email_notification':true
}
]
+
:return: Instance of a monitoring policy
:rtype: ``dict``
"""
@@ -1904,6 +1907,7 @@ class OneAndOneNodeDriver(NodeDriver):
Fetches monitoring policy processes
:param policy_id: Id of the monitoring policy
+ :type policy_id: ``str``
:return: Instance of a monitoring policy
:rtype: ``dict``
@@ -1921,10 +1925,10 @@ class OneAndOneNodeDriver(NodeDriver):
Fetches monitoring policy process
:param policy_id: Id of the monitoring policy
- :rtype: ``str``
+ :type policy_id: ``str``
:param process_id: Id of the process
- :rtype: ``str``
+ :type process_id: ``str``
:return: Instance of a monitoring policy
:rtype: ``dict``
@@ -1943,10 +1947,10 @@ class OneAndOneNodeDriver(NodeDriver):
Removes monitoring policy process
:param policy_id: Id of the monitoring policy
- :rtype: ``str``
+ :type policy_id: ``str``
:param process_id: Id of the process
- :rtype: ``str``
+ :type process_id: ``str``
:return: Instance of a monitoring policy
:rtype: ``dict``
@@ -1965,10 +1969,10 @@ class OneAndOneNodeDriver(NodeDriver):
Add monitoring policy processes
:param policy_id: Id of the monitoring policy
- :rtype: ``str``
+ :type policy_id: ``str``
:param processes: List of processes
- :rtype: ``list`` of ``dict``
+ :type processes: ``list`` of ``dict``
[
{
'process': 'taskmmgr',
@@ -1976,6 +1980,7 @@ class OneAndOneNodeDriver(NodeDriver):
'email_notification': true
}
]
+
:return: Instance of a monitoring policy
:rtype: ``dict``
"""
@@ -1995,7 +2000,7 @@ class OneAndOneNodeDriver(NodeDriver):
List all servers that are being monitoried by the policy
:param policy_id: Id of the monitoring policy
- :rtype: ``str``
+ :type policy_id: ``str``
:return: List of servers being monitored
:rtype: ``list`` of ``dict``
@@ -2013,10 +2018,10 @@ class OneAndOneNodeDriver(NodeDriver):
Adds servers to monitoring policy
:param policy_id: Id of the monitoring policy
- :rtype: ``str``
+ :type policy_id: ``str``
:param servers: List of server ID
- :rtype: ``list`` of ``str``
+ :type servers: ``list`` of ``str``
:return: Instance of a monitoring policy
:rtype: ``dict``
@@ -2037,10 +2042,10 @@ class OneAndOneNodeDriver(NodeDriver):
Removes a server from monitoring policy
:param policy_id: Id of the monitoring policy
- :rtype: ``str``
+ :type policy_id: ``str``
:param server_id: Id of the server
- :rtype: ``str``
+ :type server_id: ``str``
:return: Instance of a monitoring policy
:rtype: ``dict``