Welcome to CloudBridge’s documentation!

CloudBridge aims to provide a simple layer of abstraction over different cloud providers, reducing or eliminating the need to write conditional code for each cloud.

Usage example

The simplest possible example for doing something useful with CloudBridge would look like the following.

from cloudbridge.factory import CloudProviderFactory, ProviderList

provider = CloudProviderFactory().create_provider(ProviderList.AWS, {})
print(provider.compute.instances.list())

In the example above, the AWS_ACCESS_KEY and AWS_SECRET_KEY environment variables must be set to your cloud credentials.

Quick Reference

The following object graph shows how to access various provider services, and the resource that they return. Click on any object to drill down into its details.

Installation

The latest release can always be installed form PyPI. For other installation options, see the installation page:

pip install cloudbridge

Documentation

• Concepts and Organisation
  • Object types
  • Object identification and naming
  • Detailed class relationships
• Getting Started
  • Installation
  • Create a provider
  • List some resources
  • Create a key pair
  • Create a network
  • Create a VM firewall
  • Launch an instance
  • Assign a public IP address
  • Get a resource
  • Cleanup
• Using CloudBridge
  • How to install CloudBridge
  • Procuring access credentials
  • Connection and authentication setup
  • Launching instances
  • Networking
  • Object states and lifecycles
  • Paging and iteration
  • Using block storage
  • Using object storage
  • Resource types and mapping
  • Troubleshooting
• Contributor Guide
  • Design Goals
  • Design Decisions
  • Testing
  • Provider Development Walkthrough
  • Release Process
• API reference
  • Providers
  • Services
  • Resources
  • Exceptions

Page index

• Index