Просмотр исходного кода

Make library name consistent throughout the documentation

Enis Afgan 10 лет назад
Родитель
Сommit
a7042bf70e

+ 4 - 4
README.rst

@@ -1,7 +1,7 @@
-cloudbridge
+CloudBridge
 ===========
 ===========
 
 
-cloudbridge aims to provide a simple layer of abstraction over
+CloudBridge aims to provide a simple layer of abstraction over
 different cloud providers, reducing or eliminating the need to write
 different cloud providers, reducing or eliminating the need to write
 conditional code for each cloud. It is currently under development and is in
 conditional code for each cloud. It is currently under development and is in
 the Alpha state.
 the Alpha state.
@@ -45,7 +45,7 @@ the documentation.
 Usage example
 Usage example
 ~~~~~~~~~~~~~
 ~~~~~~~~~~~~~
 
 
-To `get started`_ with cloudbridge, export your cloud access credentials
+To `get started`_ with CloudBridge, export your cloud access credentials
 (e.g., AWS_ACCESS_KEY and AWS_SECRET_KEY for your AWS credentials) and start
 (e.g., AWS_ACCESS_KEY and AWS_SECRET_KEY for your AWS credentials) and start
 exploring the API:
 exploring the API:
 
 
@@ -82,7 +82,7 @@ Design Goals
    The cloud infrastructure will very likely support block storage, although
    The cloud infrastructure will very likely support block storage, although
    this is currently optional. It may optionally support object storage.
    this is currently optional. It may optionally support object storage.
 
 
-4. Make the cloudbridge layer as thin as possible without compromising goal 1.
+4. Make the CloudBridge layer as thin as possible without compromising goal 1.
    By wrapping the cloud provider's native SDK and doing the minimal work
    By wrapping the cloud provider's native SDK and doing the minimal work
    necessary to adapt the interface, we can achieve greater development speed
    necessary to adapt the interface, we can achieve greater development speed
    and reliability since the native provider SDK is most likely to have both
    and reliability since the native provider SDK is most likely to have both

+ 1 - 1
cloudbridge/cloud/interfaces/resources.py

@@ -1734,7 +1734,7 @@ class SecurityGroupRule(CloudResource):
         """
         """
         ID for this rule.
         ID for this rule.
 
 
-        Note that this may be a Cloudbridge-specific ID if the underlying
+        Note that this may be a CloudBridge-specific ID if the underlying
         provider does not support rule IDs.
         provider does not support rule IDs.
 
 
         :rtype: str
         :rtype: str

+ 3 - 3
docs/getting_started.rst

@@ -7,7 +7,7 @@ features. For more details on individual features, see the
 
 
 Installation
 Installation
 ------------
 ------------
-Cloudbridge is available on PyPI so to install the latest available version,
+CloudBridge is available on PyPI so to install the latest available version,
 run::
 run::
 
 
     pip install cloudbridge
     pip install cloudbridge
@@ -62,7 +62,7 @@ Next, we need to create a security group and add a rule to allow ssh access.
 .. code-block:: python
 .. code-block:: python
 
 
     sg = provider.security.security_groups.create(
     sg = provider.security.security_groups.create(
-        'cloudbridge_intro', 'A security group used by Cloudbridge')
+        'cloudbridge_intro', 'A security group used by CloudBridge')
     sg.add_rule('tcp', 22, 22, '0.0.0.0/0')
     sg.add_rule('tcp', 22, 22, '0.0.0.0/0')
 
 
 Launch an instance
 Launch an instance
@@ -75,7 +75,7 @@ get a base Ubuntu image ``ami-d85e75b0`` and launch an instance.
     img = provider.compute.images.get('ami-d85e75b0')
     img = provider.compute.images.get('ami-d85e75b0')
     inst_type = provider.compute.instance_types.find(name='m1.small')
     inst_type = provider.compute.instance_types.find(name='m1.small')
     inst = provider.compute.instances.create(
     inst = provider.compute.instances.create(
-        name='Cloudbridge-intro', image=img, instance_type=inst_type,
+        name='CloudBridge-intro', image=img, instance_type=inst_type,
         key_pair=kp, security_groups=[sg])
         key_pair=kp, security_groups=[sg])
     # Refresh the state
     # Refresh the state
     inst.refresh()
     inst.refresh()

+ 3 - 3
docs/topics/block_storage.rst

@@ -14,7 +14,7 @@ performed via the :class:`.VolumeService`. To start, let's create a 1GB volume.
 
 
 .. code-block:: python
 .. code-block:: python
 
 
-    vol = provider.block_store.volumes.create('Cloudbridge-vol', 1, 'us-east-1e')
+    vol = provider.block_store.volumes.create('CloudBridge-vol', 1, 'us-east-1e')
     vol.wait_till_ready()
     vol.wait_till_ready()
     provider.block_store.volumes.list()
     provider.block_store.volumes.list()
 
 
@@ -47,7 +47,7 @@ long time for a snapshot to become ready, particularly on AWS.
 .. code-block:: python
 .. code-block:: python
 
 
     snap = vol.create_snapshot('cloudbridge-snap',
     snap = vol.create_snapshot('cloudbridge-snap',
-                               'A demo snapshot created via Cloudbridge.')
+                               'A demo snapshot created via CloudBridge.')
     snap.wait_till_ready()
     snap.wait_till_ready()
     snap.state
     snap.state
     # 'available'
     # 'available'
@@ -55,7 +55,7 @@ long time for a snapshot to become ready, particularly on AWS.
 In order to make use of a snapshot, it is necessary to create a volume from it::
 In order to make use of a snapshot, it is necessary to create a volume from it::
 
 
     vol = provider.block_store.volumes.create(
     vol = provider.block_store.volumes.create(
-        'Cloudbridge-snap-vol', 1, 'us-east-1e', snapshot=snap)
+        'CloudBridge-snap-vol', 1, 'us-east-1e', snapshot=snap)
 
 
 The newly created volume behaves just like any other volume and can be attached
 The newly created volume behaves just like any other volume and can be attached
 to an instance for use.
 to an instance for use.

+ 5 - 5
docs/topics/launch.rst

@@ -37,7 +37,7 @@ only needing to specify the basic parameters:
 .. code-block:: python
 .. code-block:: python
 
 
     inst = provider.compute.instances.create(
     inst = provider.compute.instances.create(
-        name='Cloudbridge-basic', image=img, instance_type=inst_type,
+        name='CloudBridge-basic', image=img, instance_type=inst_type,
         key_pair=kp, security_groups=[sg])
         key_pair=kp, security_groups=[sg])
 
 
 Launch with private networking
 Launch with private networking
@@ -53,9 +53,9 @@ into the subnet (``/27``):
 
 
 .. code-block:: python
 .. code-block:: python
 
 
-    net = provider.network.create(name="Cloudbridge-net")
+    net = provider.network.create(name="CloudBridge-net")
     net.cidr_block  # '10.0.0.0/16'
     net.cidr_block  # '10.0.0.0/16'
-    sn = net.create_subnet('10.0.0.1/27', "Cloudbridge-subnet")
+    sn = net.create_subnet('10.0.0.1/27', "CloudBridge-subnet")
 
 
 Once we hace created a private network, we'll define a launch configuration
 Once we hace created a private network, we'll define a launch configuration
 object to aggregate all the launch configuration options. The launch config
 object to aggregate all the launch configuration options. The launch config
@@ -67,7 +67,7 @@ below). Finally, we can launch the instance:
     lc = provider.compute.instances.create_launch_config()
     lc = provider.compute.instances.create_launch_config()
     lc.add_network_interface(sn.id)
     lc.add_network_interface(sn.id)
     inst = provider.compute.instances.create(
     inst = provider.compute.instances.create(
-        name='Cloudbridge-VPC', image=img,  instance_type=inst_type,
+        name='CloudBridge-VPC', image=img,  instance_type=inst_type,
         launch_config=lc, key_pair=kp, security_groups=[sg])
         launch_config=lc, key_pair=kp, security_groups=[sg])
 
 
 
 
@@ -87,7 +87,7 @@ refer to :class:`.LaunchConfig`.
     lc = provider.compute.instances.create_launch_config()
     lc = provider.compute.instances.create_launch_config()
     lc.add_volume_device(source=img, size=11, is_root=True)
     lc.add_volume_device(source=img, size=11, is_root=True)
     inst = provider.compute.instances.create(
     inst = provider.compute.instances.create(
-        name='Cloudbridge-BDM', image=img,  instance_type=inst_type,
+        name='CloudBridge-BDM', image=img,  instance_type=inst_type,
         launch_config=lc, key_pair=kp, security_groups=[sg])
         launch_config=lc, key_pair=kp, security_groups=[sg])
 
 
 where img is the :class:`.Image` object to use for the root volume.
 where img is the :class:`.Image` object to use for the root volume.

+ 35 - 15
docs/topics/object_lifecycles.rst

@@ -67,14 +67,21 @@ The following states are defined for a CloudBridge Instance.
 ===================   =============   ==================
 ===================   =============   ==================
 State                 Category        Description
 State                 Category        Description
 ===================   =============   ==================
 ===================   =============   ==================
-UNKNOWN               actionable      Instance state is unknown. This means that the instance does not exist or CloudBridge does not know how to map this state.
+UNKNOWN               actionable      Instance state is unknown. This means
+                                      that the instance does not exist or
+                                      CloudBridge does not know how to map this
+                                      state.
 PENDING               informational   Instance is pending
 PENDING               informational   Instance is pending
-CONFIGURING           informational   Instance is being reconfigured in some way and may not be usable.
+CONFIGURING           informational   Instance is being reconfigured in some
+                                      way and may not be usable.
 RUNNING               actionable      Instance is running.
 RUNNING               actionable      Instance is running.
 REBOOTING             informational   Instance is rebooting.
 REBOOTING             informational   Instance is rebooting.
-TERMINATED            actionable      Instance is terminated. No further operations possible.
-STOPPED               actionable      Instance is stopped. Instance can be resumed.
-ERROR                 actionable      Instance is in an error state. No further operations possible.
+TERMINATED            actionable      Instance is terminated. No further
+                                      operations possible.
+STOPPED               actionable      Instance is stopped. Instance can be
+                                      resumed.
+ERROR                 actionable      Instance is in an error state. No further
+                                      operations possible.
 ===================   =============   ==================
 ===================   =============   ==================
 
 
 
 
@@ -98,13 +105,18 @@ The following states are defined for a CloudBridge Volume.
 ===================   =============   ==================
 ===================   =============   ==================
 State                 Category        Description
 State                 Category        Description
 ===================   =============   ==================
 ===================   =============   ==================
-UNKNOWN               actionable      Volume state is unknown. This means that the volume does not exist or CloudBridge does not know how to map this state.
+UNKNOWN               actionable      Volume state is unknown. This means that
+                                      the volume does not exist or CloudBridge
+                                      does not know how to map this state.
 CREATING              informational   Volume is pending
 CREATING              informational   Volume is pending
-CONFIGURING           informational   Volume is being reconfigured in some way and may not be usable.
+CONFIGURING           informational   Volume is being reconfigured in some way
+                                      and may not be usable.
 AVAILABLE             actionable      Volume is unattached and available for use.
 AVAILABLE             actionable      Volume is unattached and available for use.
 IN_USE                informational   Volume is attached to an instance and in-use.
 IN_USE                informational   Volume is attached to an instance and in-use.
-DELETED               actionable      Volume has been deleted. No further operations possible.
-ERROR                 actionable      Volume is in an error state. No further operations possible.
+DELETED               actionable      Volume has been deleted. No further
+                                      operations possible.
+ERROR                 actionable      Volume is in an error state. No further
+                                      operations possible.
 ===================   =============   ==================
 ===================   =============   ==================
 
 
 The lifecycle diagram is as follows:
 The lifecycle diagram is as follows:
@@ -128,11 +140,16 @@ The following states are defined for a CloudBridge Snapshot.
 ===================   =============   ==================
 ===================   =============   ==================
 State                 Category        Description
 State                 Category        Description
 ===================   =============   ==================
 ===================   =============   ==================
-UNKNOWN               actionable      Snapshot state is unknown. This means that the snapshot does not exist or CloudBridge does not know how to map this state.
+UNKNOWN               actionable      Snapshot state is unknown. This means
+                                      that the snapshot does not exist or
+                                      CloudBridge does not know how to map this
+                                      state.
 PENDING               informational   Snapshot is pending
 PENDING               informational   Snapshot is pending
-CONFIGURING           informational   Snapshot is being reconfigured in some way and may not be usable.
+CONFIGURING           informational   Snapshot is being reconfigured in some
+                                      way and may not be usable.
 AVAILABLE             actionable      Snapshot is ready.
 AVAILABLE             actionable      Snapshot is ready.
-ERROR                 actionable      Snapshot is in an error state. No further operations possible.
+ERROR                 actionable      Snapshot is in an error state. No further
+                                      operations possible.
 ===================   =============   ==================
 ===================   =============   ==================
 
 
 The lifecycle diagram is as follows:
 The lifecycle diagram is as follows:
@@ -154,10 +171,13 @@ The following states are defined for a CloudBridge Image.
 ===================   =============   ==================
 ===================   =============   ==================
 State                 Category        Description
 State                 Category        Description
 ===================   =============   ==================
 ===================   =============   ==================
-UNKNOWN               actionable      Image state is unknown. This means that the Image does not exist or CloudBridge does not know how to map this state.
+UNKNOWN               actionable      Image state is unknown. This means that
+                                      the Image does not exist or CloudBridge
+                                      does not know how to map this state.
 PENDING               informational   Image is pending
 PENDING               informational   Image is pending
 AVAILABLE             actionable      Image is ready.
 AVAILABLE             actionable      Image is ready.
-ERROR                 actionable      Image is in an error state. No further operations possible.
+ERROR                 actionable      Image is in an error state. No further
+                                      operations possible.
 ===================   =============   ==================
 ===================   =============   ==================
 
 
 The lifecycle diagram is as follows:
 The lifecycle diagram is as follows:
@@ -170,4 +190,4 @@ An Image may initially be in an UNKNOWN state and transition into
 a PENDING state when created anew. Similarly, it may transition into an UNKNOWN
 a PENDING state when created anew. Similarly, it may transition into an UNKNOWN
 state after deleted and the image no longer exists. More rarely, an
 state after deleted and the image no longer exists. More rarely, an
 Image may transition into an UNKNOWN state if CloudBridge does not know
 Image may transition into an UNKNOWN state if CloudBridge does not know
-how to map the state reported by the cloud provider.
+how to map the state reported by the cloud provider.

+ 3 - 3
docs/topics/overview.rst

@@ -1,11 +1,11 @@
-Using Cloudbridge
+Using CloudBridge
 =================
 =================
-Introductions to all the key parts of Cloudbridge you'll need to know:
+Introductions to all the key parts of CloudBridge you'll need to know:
 
 
 .. toctree::
 .. toctree::
    :maxdepth: 1
    :maxdepth: 1
 
 
-    How to install Cloudbridge <install.rst>
+    How to install CloudBridge <install.rst>
     Connection and authentication setup <setup.rst>
     Connection and authentication setup <setup.rst>
     Launching instances <launch.rst>
     Launching instances <launch.rst>
     Object states and lifecycles <object_lifecycles.rst>
     Object states and lifecycles <object_lifecycles.rst>

+ 4 - 4
docs/topics/paging_and_iteration.rst

@@ -5,7 +5,7 @@ Overview
 --------
 --------
 Most provider services have list() methods, and all list methods accept a limit
 Most provider services have list() methods, and all list methods accept a limit
 parameter which specifies the maximum number of results to return. If a limit
 parameter which specifies the maximum number of results to return. If a limit
-is not specified, cloudbridge will default to the global configuration variable
+is not specified, CloudBridge will default to the global configuration variable
 `default_result_limit`, which can be modified through the provider config.
 `default_result_limit`, which can be modified through the provider config.
 
 
 Since the returned result list may have more records available, CloudBridge
 Since the returned result list may have more records available, CloudBridge
@@ -33,9 +33,9 @@ Example:
                                              marker=rl.marker)
                                              marker=rl.marker)
 
 
 
 
-To ease development, CloudBridge also provides standard Python iterators that will page
-the results in for you automatically. Therefore, when you need to iterate through all
-available objects, the following shorthand is recommended:
+To ease development, CloudBridge also provides standard Python iterators that
+will page the results in for you automatically. Therefore, when you need to
+iterate through all available objects, the following shorthand is recommended:
 
 
 Example:
 Example:
 
 

+ 2 - 2
docs/topics/provider_development.rst

@@ -10,7 +10,7 @@ the native cloud provider Python library, here
 ``pip install google-api-python-client``.
 ``pip install google-api-python-client``.
 
 
 2. Add a ``provider.py`` file. This file will contain the main implementation
 2. Add a ``provider.py`` file. This file will contain the main implementation
-of the cloud provider and will be the entry point that cloudbridge uses for all
+of the cloud provider and will be the entry point that CloudBridge uses for all
 provider related services. You will need to subclass ``BaseCloudProvider`` and
 provider related services. You will need to subclass ``BaseCloudProvider`` and
 add a class variable named ``PROVIDER_ID``.
 add a class variable named ``PROVIDER_ID``.
 
 
@@ -199,7 +199,7 @@ tests pass.
     is up to the implementor, a general design we have followed is to have the
     is up to the implementor, a general design we have followed is to have the
     cloud connection globally available within the provider.
     cloud connection globally available within the provider.
 
 
-To add the sdk, we edit cloudbridge's main ``setup.py`` and list the
+To add the sdk, we edit CloudBridge's main ``setup.py`` and list the
 dependencies.
 dependencies.
 
 
 .. code-block:: python
 .. code-block:: python

+ 20 - 11
docs/topics/setup.rst

@@ -75,15 +75,16 @@ will override environment values.
               'aws_secret_key' : '<your_secret_key>'}
               'aws_secret_key' : '<your_secret_key>'}
     provider = CloudProviderFactory().create_provider(ProviderList.AWS, config)
     provider = CloudProviderFactory().create_provider(ProviderList.AWS, config)
 
 
-Some optional configuration values can only be provided through the config dictionary. These
-are listed below for each provider.
+Some optional configuration values can only be provided through the config
+dictionary. These are listed below for each provider.
 
 
 **CloudBridge**
 **CloudBridge**
 
 
 ====================  ==================
 ====================  ==================
 Variable		      Description
 Variable		      Description
 ====================  ==================
 ====================  ==================
-default_result_limit  Number of results that a ``.list()`` method should return. Defaults to 50.
+default_result_limit  Number of results that a ``.list()`` method should return.
+                      Defaults to 50.
 ====================  ==================
 ====================  ==================
 
 
 
 
@@ -95,27 +96,35 @@ Variable		      Description
 ec2_is_secure         True to use an SSL connection. Default is ``True``.
 ec2_is_secure         True to use an SSL connection. Default is ``True``.
 ec2_region_name       Default region name. Defaults to ``us-east-1``.
 ec2_region_name       Default region name. Defaults to ``us-east-1``.
 ec2_region_endpoint   Endpoint to use. Default is ``ec2.us-east-1.amazonaws.com``.
 ec2_region_endpoint   Endpoint to use. Default is ``ec2.us-east-1.amazonaws.com``.
-ec2_port              EC2 connection port. Does not need to be specified unless EC2 service is running on an alternative port.
+ec2_port              EC2 connection port. Does not need to be specified unless
+                      EC2 service is running on an alternative port.
 ec2_conn_path	      Connection path. Defaults to ``/``.
 ec2_conn_path	      Connection path. Defaults to ``/``.
-ec2_validate_certs     Whether to use SSL certificate verification. Default is ``False``.
+ec2_validate_certs    Whether to use SSL certificate verification. Default is
+                      ``False``.
 s3_is_secure          True to use an SSL connection. Default is ``True``.
 s3_is_secure          True to use an SSL connection. Default is ``True``.
 s3_host               Host connection endpoint. Default is ``s3.amazonaws.com``.
 s3_host               Host connection endpoint. Default is ``s3.amazonaws.com``.
-s3_port               Host connection port. Does not need to be specified unless S3 service is running on an alternative port.
+s3_port               Host connection port. Does not need to be specified unless
+                      S3 service is running on an alternative port.
 s3_conn_path          Connection path. Defaults to ``/``.
 s3_conn_path          Connection path. Defaults to ``/``.
-s3_validate_certs     Whether to use SSL certificate verification. Default is ``False``.
+s3_validate_certs     Whether to use SSL certificate verification. Default is
+                      ``False``.
 ====================  ==================
 ====================  ==================
 
 
 
 
 Other configuration variables
 Other configuration variables
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 In addition to the provider specific configuration variables above, there are
 In addition to the provider specific configuration variables above, there are
-some general configuration environment variables that apply to cloudbridge as
+some general configuration environment variables that apply to CloudBridge as
 a whole
 a whole
 
 
 =====================  ==================
 =====================  ==================
 Variable		       Description
 Variable		       Description
 =====================  ==================
 =====================  ==================
-CB_DEBUG               Setting ``CB_DEBUG=True`` will cause detailed debug output to be printed for each provider (including HTTP traces).
-CB_USE_MOCK_PROVIDERS  Setting this to ``True`` will cause the CloudBridge test suite to use mock drivers when available.
-CB_TEST_PROVIDER       Set this value to a valid :class:`.ProviderList` value such as ``aws``, to limit tests to that provider only.
+CB_DEBUG               Setting ``CB_DEBUG=True`` will cause detailed debug
+                       output to be printed for each provider (including HTTP
+                       traces).
+CB_USE_MOCK_PROVIDERS  Setting this to ``True`` will cause the CloudBridge test
+                       suite to use mock drivers when available.
+CB_TEST_PROVIDER       Set this value to a valid :class:`.ProviderList` value
+                       such as ``aws``, to limit tests to that provider only.
 =====================  ==================
 =====================  ==================

+ 4 - 3
docs/topics/test.rst

@@ -11,12 +11,13 @@ Our testing goals are to:
  1. Write one set of tests that all provider implementations must pass.
  1. Write one set of tests that all provider implementations must pass.
 
 
  2. Make that set of tests a 'conformance' test suite, which validates that each
  2. Make that set of tests a 'conformance' test suite, which validates that each
-    implementation correctly implements the cloudbridge specification.
+    implementation correctly implements the CloudBridge specification.
 
 
  3. Make the test suite comprehensive enough that a provider which passes all
  3. Make the test suite comprehensive enough that a provider which passes all
     the tests can be used safely by an application with no additional testing.
     the tests can be used safely by an application with no additional testing.
-    In other words, the cloudbridge specification and accompanying test suite
-    must be comprehensive enough that no provider specific workarounds, code or testing is required.
+    In other words, the CloudBridge specification and accompanying test suite
+    must be comprehensive enough that no provider specific workarounds, code or
+    testing is required.
 
 
  4. For development, mock providers may be used to speed up the feedback cycle,
  4. For development, mock providers may be used to speed up the feedback cycle,
     but providers must also pass the full suite of tests when run against actual
     but providers must also pass the full suite of tests when run against actual