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 2013/12/18 19:47:17 UTC
[1/2] git commit: docs: Add a missing section,
fix some formatting issues.
Updated Branches:
refs/heads/trunk a50862046 -> 6af002454
docs: Add a missing section, fix some formatting issues.
Project: http://git-wip-us.apache.org/repos/asf/libcloud/repo
Commit: http://git-wip-us.apache.org/repos/asf/libcloud/commit/71fba543
Tree: http://git-wip-us.apache.org/repos/asf/libcloud/tree/71fba543
Diff: http://git-wip-us.apache.org/repos/asf/libcloud/diff/71fba543
Branch: refs/heads/trunk
Commit: 71fba543c8b5459f7e5040e8378332702ec9a6e0
Parents: a508620
Author: Tomaz Muraus <to...@apache.org>
Authored: Wed Dec 18 19:22:03 2013 +0100
Committer: Tomaz Muraus <to...@apache.org>
Committed: Wed Dec 18 19:22:03 2013 +0100
----------------------------------------------------------------------
docs/compute/index.rst | 4 ++++
docs/compute/supported_providers.rst | 2 +-
docs/supported_providers.rst | 9 +++++++--
3 files changed, 12 insertions(+), 3 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/libcloud/blob/71fba543/docs/compute/index.rst
----------------------------------------------------------------------
diff --git a/docs/compute/index.rst b/docs/compute/index.rst
index 99159e3..dbefcb4 100644
--- a/docs/compute/index.rst
+++ b/docs/compute/index.rst
@@ -34,6 +34,10 @@ Compute
* :class:`~libcloud.compute.types.NodeState` - represents a node state.
Standard states are: ``running``, ``stopped``, ``rebooting``, ``terminated``,
``pending``, and ``unknown``.
+
+Key Pair Management
+~~~~~~~~~~~~~~~~~~~
+
* :class:`~libcloud.compute.base.KeyPair` - represents an SSH key pair object.
Block Storage
http://git-wip-us.apache.org/repos/asf/libcloud/blob/71fba543/docs/compute/supported_providers.rst
----------------------------------------------------------------------
diff --git a/docs/compute/supported_providers.rst b/docs/compute/supported_providers.rst
index 6c8381c..204f49a 100644
--- a/docs/compute/supported_providers.rst
+++ b/docs/compute/supported_providers.rst
@@ -17,6 +17,6 @@ Supported Methods (block storage)
.. include:: _supported_methods_block_storage.rst
Supported Methods (key pair management)
----------------------------------
+---------------------------------------
.. include:: _supported_methods_key_pair_management.rst
http://git-wip-us.apache.org/repos/asf/libcloud/blob/71fba543/docs/supported_providers.rst
----------------------------------------------------------------------
diff --git a/docs/supported_providers.rst b/docs/supported_providers.rst
index 68716af..c7f58ef 100644
--- a/docs/supported_providers.rst
+++ b/docs/supported_providers.rst
@@ -11,8 +11,8 @@ Provider Matrix
.. include:: compute/_supported_providers.rst
-Supported Methods (Main)
-~~~~~~~~~~~~~~~~~~~~~~~~
+Supported Methods (Base compute)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. include:: compute/_supported_methods_main.rst
@@ -21,6 +21,11 @@ Supported Methods (Block Storage)
.. include:: compute/_supported_methods_block_storage.rst
+Supported Methods (Key pair management)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. include:: compute/_supported_methods_key_pair_management.rst
+
Load Balancer
-------------
[2/2] git commit: docs: Fix a bunch of build warnings.
Posted by to...@apache.org.
docs: Fix a bunch of build warnings.
Project: http://git-wip-us.apache.org/repos/asf/libcloud/repo
Commit: http://git-wip-us.apache.org/repos/asf/libcloud/commit/6af00245
Tree: http://git-wip-us.apache.org/repos/asf/libcloud/tree/6af00245
Diff: http://git-wip-us.apache.org/repos/asf/libcloud/diff/6af00245
Branch: refs/heads/trunk
Commit: 6af002454c606f16a44970fd21efc9982c1987f4
Parents: 71fba54
Author: Tomaz Muraus <to...@apache.org>
Authored: Wed Dec 18 19:35:36 2013 +0100
Committer: Tomaz Muraus <to...@apache.org>
Committed: Wed Dec 18 19:44:16 2013 +0100
----------------------------------------------------------------------
docs/committer_guide.rst | 2 +-
docs/compute/api.rst | 2 ++
docs/compute/deployment.rst | 2 ++
docs/compute/drivers/cloudframes.rst | 2 +-
docs/compute/drivers/openstack.rst | 21 +++++++++++----------
docs/compute/examples.rst | 4 +++-
docs/compute/key_pair_management.rst | 2 ++
docs/compute/pricing.rst | 2 ++
docs/compute/supported_providers.rst | 2 ++
docs/development.rst | 2 +-
docs/dns/api.rst | 2 ++
docs/dns/examples.rst | 2 ++
docs/dns/supported_providers.rst | 2 ++
docs/faq.rst | 2 +-
docs/index.rst | 2 +-
docs/loadbalancer/api.rst | 2 ++
docs/loadbalancer/examples.rst | 2 ++
docs/loadbalancer/supported_providers.rst | 2 ++
docs/storage/api.rst | 2 ++
docs/storage/examples.rst | 2 ++
docs/storage/supported_providers.rst | 2 ++
docs/testing.rst | 2 ++
docs/upgrade_notes.rst | 11 +++++++----
libcloud/compute/drivers/vcloud.py | 6 +++---
24 files changed, 59 insertions(+), 23 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/libcloud/blob/6af00245/docs/committer_guide.rst
----------------------------------------------------------------------
diff --git a/docs/committer_guide.rst b/docs/committer_guide.rst
index 6b73f3f..63390a8 100644
--- a/docs/committer_guide.rst
+++ b/docs/committer_guide.rst
@@ -14,7 +14,7 @@ New committer guidelines
First congratulations and welcome to the team!
1. Subscribe to the public mailing lists
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If you haven't yet, subscribe to {dev,users,commits}@apache.libcloud.org
mailing lists. Committs mailing list is especially important because all of
http://git-wip-us.apache.org/repos/asf/libcloud/blob/6af00245/docs/compute/api.rst
----------------------------------------------------------------------
diff --git a/docs/compute/api.rst b/docs/compute/api.rst
index 9b8d9c5..cfd5ebc 100644
--- a/docs/compute/api.rst
+++ b/docs/compute/api.rst
@@ -1,3 +1,5 @@
+:orphan:
+
Compute Base API
================
http://git-wip-us.apache.org/repos/asf/libcloud/blob/6af00245/docs/compute/deployment.rst
----------------------------------------------------------------------
diff --git a/docs/compute/deployment.rst b/docs/compute/deployment.rst
index f1daa4f..bba91fc 100644
--- a/docs/compute/deployment.rst
+++ b/docs/compute/deployment.rst
@@ -1,3 +1,5 @@
+:orphan:
+
Deployment
==========
http://git-wip-us.apache.org/repos/asf/libcloud/blob/6af00245/docs/compute/drivers/cloudframes.rst
----------------------------------------------------------------------
diff --git a/docs/compute/drivers/cloudframes.rst b/docs/compute/drivers/cloudframes.rst
index a85bd19..40262d5 100644
--- a/docs/compute/drivers/cloudframes.rst
+++ b/docs/compute/drivers/cloudframes.rst
@@ -2,7 +2,7 @@ CloudFrames Compute Driver Documentation
========================================
Connecting to the CloudFrames installation
-----------------------------------------
+------------------------------------------
This will tell you how to interpret the available arguments:
http://git-wip-us.apache.org/repos/asf/libcloud/blob/6af00245/docs/compute/drivers/openstack.rst
----------------------------------------------------------------------
diff --git a/docs/compute/drivers/openstack.rst b/docs/compute/drivers/openstack.rst
index 66be263..57c15f6 100644
--- a/docs/compute/drivers/openstack.rst
+++ b/docs/compute/drivers/openstack.rst
@@ -22,16 +22,17 @@ Available arguments:
* ``ex_force_auth_version`` - API version of the authentication service. This
argument determines how authentication is performed. Valid and supported
versions are:
- * ``1.0`` - authenticate against the keystone using the provided username
- and API key (old and deprecated version which was used by Rackspace in
- the past)
- * ``1.1`` - authenticate against the keystone using the provided username
- and API key (old and deprecated version which was used by Rackspace in
- the past)
- * ``2.0`` or ``2.0_apikey`` - authenticate against keystone with a username
- and API key
- * ``2.0_password`` - authenticate against keystone with a username and
- password
+
+ * ``1.0`` - authenticate against the keystone using the provided username
+ and API key (old and deprecated version which was used by Rackspace in
+ the past)
+ * ``1.1`` - authenticate against the keystone using the provided username
+ and API key (old and deprecated version which was used by Rackspace in
+ the past)
+ * ``2.0`` or ``2.0_apikey`` - authenticate against keystone with a username
+ and API key
+ * ``2.0_password`` - authenticate against keystone with a username and
+ password
Unless you are working with a very old version of OpenStack you will either
want to use ``2.0_apikey`` or ``2.0_password``.
http://git-wip-us.apache.org/repos/asf/libcloud/blob/6af00245/docs/compute/examples.rst
----------------------------------------------------------------------
diff --git a/docs/compute/examples.rst b/docs/compute/examples.rst
index 4be14e4..68a96cd 100644
--- a/docs/compute/examples.rst
+++ b/docs/compute/examples.rst
@@ -1,3 +1,5 @@
+:orphan:
+
Compute Examples
================
@@ -117,7 +119,7 @@ Create a node on a CloudStack provider using a provided key pair and security gr
This example demonstrates how to create a node using an existing key pair.
Created node also gets added to the provided security groups.
-.. literalinclude:: /examples/compute/create_cloudstack_node_keypair_secgroup.py
+.. literalinclude:: /examples/compute/cloudstack/create_cloudstack_node_keypair_secgroup.py
:language: python
Create flaoting IP and attach it to a node using a local OpenStack provider
http://git-wip-us.apache.org/repos/asf/libcloud/blob/6af00245/docs/compute/key_pair_management.rst
----------------------------------------------------------------------
diff --git a/docs/compute/key_pair_management.rst b/docs/compute/key_pair_management.rst
index 107f8b5..0723b6c 100644
--- a/docs/compute/key_pair_management.rst
+++ b/docs/compute/key_pair_management.rst
@@ -1,3 +1,5 @@
+:orphan:
+
SSH key pair management
=======================
http://git-wip-us.apache.org/repos/asf/libcloud/blob/6af00245/docs/compute/pricing.rst
----------------------------------------------------------------------
diff --git a/docs/compute/pricing.rst b/docs/compute/pricing.rst
index 8bed66f..f44ba3e 100644
--- a/docs/compute/pricing.rst
+++ b/docs/compute/pricing.rst
@@ -1,3 +1,5 @@
+:orphan:
+
Pricing
=======
http://git-wip-us.apache.org/repos/asf/libcloud/blob/6af00245/docs/compute/supported_providers.rst
----------------------------------------------------------------------
diff --git a/docs/compute/supported_providers.rst b/docs/compute/supported_providers.rst
index 204f49a..3dc5c08 100644
--- a/docs/compute/supported_providers.rst
+++ b/docs/compute/supported_providers.rst
@@ -1,3 +1,5 @@
+:orphan:
+
Supported Providers
===================
http://git-wip-us.apache.org/repos/asf/libcloud/blob/6af00245/docs/development.rst
----------------------------------------------------------------------
diff --git a/docs/development.rst b/docs/development.rst
index 29d12c0..7f7ff04 100644
--- a/docs/development.rst
+++ b/docs/development.rst
@@ -134,7 +134,7 @@ make sure the commit message contains the ticket number.
For example:
-.. sourcode:: bash
+.. sourcecode:: bash
git commit -a -m "[LIBCLOUD-123] Add a new compute driver for CloudStack based providers."
http://git-wip-us.apache.org/repos/asf/libcloud/blob/6af00245/docs/dns/api.rst
----------------------------------------------------------------------
diff --git a/docs/dns/api.rst b/docs/dns/api.rst
index 9d0eb38..75c2c9e 100644
--- a/docs/dns/api.rst
+++ b/docs/dns/api.rst
@@ -1,3 +1,5 @@
+:orphan:
+
DNS Base API
============
http://git-wip-us.apache.org/repos/asf/libcloud/blob/6af00245/docs/dns/examples.rst
----------------------------------------------------------------------
diff --git a/docs/dns/examples.rst b/docs/dns/examples.rst
index f3047cc..b02e51a 100644
--- a/docs/dns/examples.rst
+++ b/docs/dns/examples.rst
@@ -1,3 +1,5 @@
+:orphan:
+
DNS Examples
============
http://git-wip-us.apache.org/repos/asf/libcloud/blob/6af00245/docs/dns/supported_providers.rst
----------------------------------------------------------------------
diff --git a/docs/dns/supported_providers.rst b/docs/dns/supported_providers.rst
index b04c521..e34e5eb 100644
--- a/docs/dns/supported_providers.rst
+++ b/docs/dns/supported_providers.rst
@@ -1,3 +1,5 @@
+:orphan:
+
Supported Providers
===================
http://git-wip-us.apache.org/repos/asf/libcloud/blob/6af00245/docs/faq.rst
----------------------------------------------------------------------
diff --git a/docs/faq.rst b/docs/faq.rst
index 734fd8d..da7f81e 100644
--- a/docs/faq.rst
+++ b/docs/faq.rst
@@ -80,7 +80,7 @@ there aren't enough common points which would allow us to build a
cross-provider API which would still provide enough value to the end user.
If the API matches the criteria defined above, you should send a proposal to
-our :ref:`mailing list <mailing-list>` where we can discuss it further.
+our :ref:`mailing list <mailing-lists>` where we can discuss it further.
Ideally, the proposal should also contain a prototype of a driver for at least
two different providers. This helps us make sure that the API you have designed
is not biased towards a single provider.
http://git-wip-us.apache.org/repos/asf/libcloud/blob/6af00245/docs/index.rst
----------------------------------------------------------------------
diff --git a/docs/index.rst b/docs/index.rst
index 71a5358..0abe519 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -67,7 +67,7 @@ Other
:glob:
:maxdepth: 3
- security
+ security
.. note::
http://git-wip-us.apache.org/repos/asf/libcloud/blob/6af00245/docs/loadbalancer/api.rst
----------------------------------------------------------------------
diff --git a/docs/loadbalancer/api.rst b/docs/loadbalancer/api.rst
index 90e2305..d062695 100644
--- a/docs/loadbalancer/api.rst
+++ b/docs/loadbalancer/api.rst
@@ -1,3 +1,5 @@
+:orphan:
+
LoadBalancer Base API
=====================
http://git-wip-us.apache.org/repos/asf/libcloud/blob/6af00245/docs/loadbalancer/examples.rst
----------------------------------------------------------------------
diff --git a/docs/loadbalancer/examples.rst b/docs/loadbalancer/examples.rst
index bfc2dda..9c99be6 100644
--- a/docs/loadbalancer/examples.rst
+++ b/docs/loadbalancer/examples.rst
@@ -1,3 +1,5 @@
+:orphan:
+
LoadBalancer Examples
=====================
http://git-wip-us.apache.org/repos/asf/libcloud/blob/6af00245/docs/loadbalancer/supported_providers.rst
----------------------------------------------------------------------
diff --git a/docs/loadbalancer/supported_providers.rst b/docs/loadbalancer/supported_providers.rst
index b04c521..e34e5eb 100644
--- a/docs/loadbalancer/supported_providers.rst
+++ b/docs/loadbalancer/supported_providers.rst
@@ -1,3 +1,5 @@
+:orphan:
+
Supported Providers
===================
http://git-wip-us.apache.org/repos/asf/libcloud/blob/6af00245/docs/storage/api.rst
----------------------------------------------------------------------
diff --git a/docs/storage/api.rst b/docs/storage/api.rst
index 2f546e0..a400431 100644
--- a/docs/storage/api.rst
+++ b/docs/storage/api.rst
@@ -1,3 +1,5 @@
+:orphan:
+
Storage Base API
================
http://git-wip-us.apache.org/repos/asf/libcloud/blob/6af00245/docs/storage/examples.rst
----------------------------------------------------------------------
diff --git a/docs/storage/examples.rst b/docs/storage/examples.rst
index c73c0a0..8b0a6ef 100644
--- a/docs/storage/examples.rst
+++ b/docs/storage/examples.rst
@@ -1,3 +1,5 @@
+:orphan:
+
Storage Examples
================
http://git-wip-us.apache.org/repos/asf/libcloud/blob/6af00245/docs/storage/supported_providers.rst
----------------------------------------------------------------------
diff --git a/docs/storage/supported_providers.rst b/docs/storage/supported_providers.rst
index b755e62..c4d5da5 100644
--- a/docs/storage/supported_providers.rst
+++ b/docs/storage/supported_providers.rst
@@ -1,3 +1,5 @@
+:orphan:
+
Supported Providers
===================
http://git-wip-us.apache.org/repos/asf/libcloud/blob/6af00245/docs/testing.rst
----------------------------------------------------------------------
diff --git a/docs/testing.rst b/docs/testing.rst
index 335c1c7..808d32e 100644
--- a/docs/testing.rst
+++ b/docs/testing.rst
@@ -1,3 +1,5 @@
+:orphan:
+
Testing
=======
http://git-wip-us.apache.org/repos/asf/libcloud/blob/6af00245/docs/upgrade_notes.rst
----------------------------------------------------------------------
diff --git a/docs/upgrade_notes.rst b/docs/upgrade_notes.rst
index 899bac9..a527eb4 100644
--- a/docs/upgrade_notes.rst
+++ b/docs/upgrade_notes.rst
@@ -642,7 +642,8 @@ Libcloud 0.8
* ``ex_save_image`` method in the OpenStack driver now returns a ``NodeImage``
instance.
-For a full list of changes, please see the `CHANGES file <https://git-wip-us.apache.org/repos/asf?p=libcloud.git;a=blob;f=CHANGES;h=fd1f9cd8917bf9d9c5f4d5344872dbccba894444;hb=b26812db71e6c36be3cc5f7fcb87f82b267bfddd>`_.
+For a full list of changes, please see the `CHANGES file
+<https://git-wip-us.apache.org/repos/asf?p=libcloud.git;a=blob;f=CHANGES;h=fd1f9cd8917bf9d9c5f4d5344872dbccba894444;hb=b26812db71e6c36be3cc5f7fcb87f82b267bfddd>`__.
Libcloud 0.7
------------
@@ -673,7 +674,8 @@ Updated code:
driver=driver)
* Old deprecated paths have been removed. If you still haven't updated your
-code you need to do it now, otherwise it won't work with 0.7 and future releases.
+ code you need to do it now, otherwise it won't work with 0.7 and future
+ releases.
Bellow is a list of old paths and their new locations:
@@ -687,7 +689,8 @@ Bellow is a list of old paths and their new locations:
In the ``contrib/`` directory you can also find a simple bash script which can
perform a search and replace for you - `migrate_paths.py <https://svn.apache.org/repos/asf/libcloud/trunk/contrib/migrate_paths.sh>`_.
-For a full list of changes, please see the `CHANGES file <https://git-wip-us.apache.org/repos/asf?p=libcloud.git;a=blob;f=CHANGES;h=276948338c2581de1178e51f7f7cdbd4e7ba9286;hb=2ad8f3fa1f258d6c53d7b058cdc6cd9ab1fd579b>`_.
+For a full list of changes, please see the `CHANGES file
+<https://git-wip-us.apache.org/repos/asf?p=libcloud.git;a=blob;f=CHANGES;h=276948338c2581de1178e51f7f7cdbd4e7ba9286;hb=2ad8f3fa1f258d6c53d7b058cdc6cd9ab1fd579b>`__.
Libcloud 0.6
------------
@@ -734,4 +737,4 @@ For example:
Cls = get_provider(Provider.OPENNEBULA)
driver = Cls('key', 'secret', api_version='1.4')
-For a full list of changes, please see the `CHANGES file <https://svn.apache.org/viewvc/libcloud/trunk/CHANGES?revision=1198753&view=markup>`_.
+For a full list of changes, please see the `CHANGES file <https://svn.apache.org/viewvc/libcloud/trunk/CHANGES?revision=1198753&view=markup>`__.
http://git-wip-us.apache.org/repos/asf/libcloud/blob/6af00245/libcloud/compute/drivers/vcloud.py
----------------------------------------------------------------------
diff --git a/libcloud/compute/drivers/vcloud.py b/libcloud/compute/drivers/vcloud.py
index a457d88..177820e 100644
--- a/libcloud/compute/drivers/vcloud.py
+++ b/libcloud/compute/drivers/vcloud.py
@@ -690,8 +690,8 @@ class VCloudNodeDriver(NodeDriver):
return result
def create_node(self, **kwargs):
- """Creates and returns node.
-
+ """
+ Creates and returns node.
@inherits: :class:`NodeDriver.create_node`
@@ -706,7 +706,7 @@ class VCloudNodeDriver(NodeDriver):
:keyword ex_cpus: number of virtual cpus (limit depends on provider)
:type ex_cpus: ``int``
- :keyword ex_row: ????
+ :keyword ex_row: ???
:type ex_row: ``str``
:keyword ex_group: ????