Welcome to Apache Libcloud’s documentation!

Apache Libcloud is a Python library which hides differences between different cloud provider APIs and allows you to manage different cloud resources through a unified and easy to use API.

Resource you can manage with Libcloud are divided in the following categories:

• Cloud Servers and Block Storage - services such as Amazon EC2 and Rackspace CloudServers
• Cloud Object Storage and CDN - services such as Amazon S3 and Rackspace CloudFiles
• Load Balancers as a Service - services such as Amazon Elastic Load Balancer and GoGrid LoadBalancers
• DNS as a Service - services such as Amazon Route 53 and Zerigo
• Container Services - container virtualization like Docker and Rkt as well as container based services
• Backup as a Service - services such as Amazon EBS and OpenStack Freezer

A subset of supported providers in Libcloud.

Documentation

Main

• Getting Started
  • Installation (stable version)
  • Installation (development version)
  • Upgrading
  • Using it
  • Where to go from here?
• Supported Providers
  • Compute
    • Provider Matrix
    • Supported Methods (Base compute)
    • Supported Methods (Block Storage)
    • Supported Methods (Key pair management)
  • Load Balancer
    • Provider Matrix
    • Supported Methods
  • Object Storage
    • Provider Matrix
    • Supported Methods (Main)
    • Supported Methods (CDN)
  • Container
    • Provider Matrix
    • Supported Methods
  • Backup
    • Provider Matrix
    • Supported Methods
  • DNS
    • Provider Matrix
    • Supported Methods
• Third Party Drivers
  • Compute
  • DNS
• Compute
  • Terminology
    • Compute
    • Key Pair Management
    • Block Storage
  • Supported Providers
  • Pricing
  • Deployment
  • SSH key pair management
  • Examples
  • API Reference
• Object Storage
  • Terminology
  • Supported Providers
  • Examples
  • API Reference
• Load Balancer
  • Terminology
  • Supported Providers
  • Examples
  • API Reference
• DNS
  • Terminology
  • Supported Providers
  • Examples
  • API Reference
• Container
  • Drivers
  • Simple Container Support
  • Cluster Suppport
  • Bootstrapping Docker with Compute Drivers
  • Supported Providers
  • Examples
  • API Reference
  • Utility Classes
• Backup
  • Terminology
  • Supported Providers
  • Examples
  • API Reference
• Troubleshooting
  • Debugging
    • Example 1 - Logging output to standard error
    • Example 2 - Making JSON / XML response human friendly
• API Documentation
• Frequently Asked Questions (FAQ)
  • Why are the block storage related management methods located in the compute API?
  • What are the extension methods and arguments?
  • How do I test if provider credentials are valid?
  • I want do add a new provider driver what should I do?
  • I want to add / propose a new API, what should I do?
  • How do I obtain Libcloud version?
• Changes in Apache Libcloud v2.0
  • Replacement of httplib with requests
    • Allow redirects is enabled by default
    • HTTP/HTTPS Proxies
  • Adding support for Python 3.6 and deprecation of Python 3.2
  • SSL CA certificates are now bundled with the package
    • Providing a list of CA trusts is no longer supported
  • Performance improvements and introduction of sessions
  • Changes to the storage API
    • Support for Buffered IO Streams
  • Other minor changes
• Registering a third party driver
• SSL Certificate Validation in <v2.0
  • Windows Users
  • Acquiring CA Certificates
  • Using a custom CA certificate
  • Adding additional CA certificate to the path
  • Disabling SSL certificate validation
  • Changing used SSL / TLS version
• Using an HTTP / HTTPS proxy
  • Known limitations
  • Examples
    • 1. Using http_proxy / htps_proxy environment variable
    • 2. Passing proxy_url argument to the connection class constructor
    • 3. Calling set_http_proxy method
    • 4. Using an HTTPS proxy
• Using Libcloud in multi-threaded and async environments
  • Libcloud and thread-safety
  • Using Libcloud with gevent
  • Using Libcloud with Twisted
• Working with the object oriented APIs
  • Example 1 - listing records for a zone with a known id
  • Example 2 - creating an EC2 instance with a known NodeSize and NodeImage id
  • Example 1 - listing records for a zone with a known id
  • Example 2 - creating an EC2 instance with a known NodeSize and NodeImage id
  • Example 3 - creating an EC2 instance with an IAM profile

Developer Information

• Developer Information
  • Type Annotations
  • Mailing Lists
  • IRC
  • Issue Tracker
  • Testing
  • Continuous Integration
  • Test Coverage
• Development
  • Contributing
  • Getting started with contributing to Libcloud
  • General contribution guidelines
  • Code style guide
  • Git pre-commit hook
  • Code conventions
    • 1. Import ordering
    • 2. Function and method ordering
    • 3. Prefer keyword over regular arguments
    • 4. Don’t abuse **kwargs
    • 5. When returning a dictionary, document its structure
    • 6. Prefer to use “is not None” when checking if a variable is provided or defined
  • Docstring conventions
  • Contribution workflow
    • 1. Start a discussion on our Github repository or on the mailing list
    • 2. Open a new issue on our issue tracker
    • 3. Fork our Github repository
    • 4. Create a new branch for your changes
    • 5. Make your changes
    • 6. Write tests for your changes and make sure all the tests pass
    • 7. Commit your changes
    • 8. Open a pull request with your changes
    • 9. Wait for the review
    • Contributing Bigger Changes
  • Supporting Multiple Python Versions
    • Context Managers
    • Utility functions for cross-version compatibility

Committer Guide

• Committer Guide
  • New committer guidelines
    • 1. Subscribe to the public mailing lists
    • 2. Subscribe to the private mailing list
    • 3. Create PyPi account
    • 4. Link your ASF and Github account
  • Merging user contributions
  • Making a release (for release managers)
    • 0. Update committed files
    • 1. Pre-release check list
    • 2. Update Github
    • 3. Creating release artifacts
    • 4. Tagging a release
    • 5. Upload the release artifacts and start a [VOTE] thread
    • 6. Uploading release artifacts to Apache servers
    • 7. Publishing package to PyPi
    • 8. Verifying the release artifact check sums
    • 9. Updating doaplibcloud.rdf, \_init__.py
    • 10. Updating website
    • 11. Sending announcements
  • Mailing list email templates
    • Release voting thread template
    • Release announcement

Other

• Changelog
  • Changes in Apache Libcloud v2.7.0
  • General
  • Common
  • Compute
    • Storage
  • Changes in Apache Libcloud 2.6.1
    • Compute
    • Storage
    • Load Balancer
  • Changes in Apache Libcloud 2.6.0
    • General
    • Compute
    • Storage
    • DNS
  • Changes in Apache Libcloud 2.5.0
    • General
    • Common
    • Compute
    • Storage
    • Container
    • DNS
    • Storage
  • Changes in Apache Libcloud 2.4.0
    • Common
    • Compute
    • DNS
    • Storage
    • Other
  • Changes in Apache Libcloud 2.3.0
    • Common
    • Compute
    • Storage
  • Changes in Apache Libcloud 2.2.1
    • Common
    • Compute
    • Tests
  • Changes in Apache Libcloud 2.2.0
    • Compute
  • Changes in Apache Libcloud 2.2.0
    • Common
    • Compute
    • Container
    • DNS
    • Load Balancer
    • Storage
  • Changes in Apache Libcloud 2.1.0
    • Common
    • Compute
    • Container
    • Storage
  • Changes in Apache Libcloud 2.0.0
    • Common
    • Compute
    • DNS
  • Changes in Apache Libcloud 2.0.0rc2
    • Common
    • Compute
    • Storage
  • Changes Apache Libcloud 2.0.0rc1
    • Common
    • Compute
  • Changes in Apache Libcloud 1.5.0
    • Common
    • Compute
    • Container
  • Changes in Apache Libcloud 1.4.0
    • Compute
    • Container
    • Load Balancing
    • Storage
  • Changes in Apache Libcloud 1.3.0
    • General
    • Compute
    • Container
    • Load Balancer
    • Storage
  • Changes in Apache Libcloud 1.2.1
    • Backup
  • Changes in Apache Libcloud 1.2.0
    • General
    • Compute
    • Load balancer
    • DNS
    • Container
    • Storage
  • Changes with Apache Libcloud 1.1.0
    • General
    • Compute
    • Container
    • Load Balancer
  • Changes with Apache Libcloud 1.0.0
    • General
    • Compute
    • Storage
    • Loadbalancer
    • DNS
  • Changes with Apache Libcloud 1.0.0-rc2
    • General
    • Compute
    • Storage
    • Loadbalancer
    • DNS
    • Backup
  • Changes with Apache Libcloud 1.0.0-pre1
    • General
    • Compute
    • DNS
  • Changes with Apache Libcloud 0.20.1
    • Compute
  • Changes with Apache Libcloud 0.20.0
    • General
    • Compute
    • Storage
    • Loadbalancer
    • DNS
  • Changes with Apache Libcloud 0.19.0
    • General
    • Compute
    • Storage
    • Loadbalancer
    • DNS
  • Changes with Apache Libcloud 0.18.0
    • General
    • Compute
    • Storage
    • Loadbalancer
    • DNS
  • Changes with Apache Libcloud 0.17.0
    • General
    • Compute
    • Storage
    • Loadbalancer
    • DNS
  • Changes with Apache Libcloud 0.16.0
    • General
    • Compute
    • Storage
    • Loadbalancer
    • DNS
  • Changes with Apache Libcloud 0.15.1
    • Compute
    • DNS
  • Changes with Apache Libcloud 0.15.0
    • General
    • Compute
    • Storage
    • Load Balancer
    • DNS
  • Changes with Apache Libcloud 0.14.1
    • Compute
    • Load Balancer
    • Storage
    • DNS
  • Changes with Apache Libcloud 0.14.0
    • General
    • Compute
    • Storage
    • DNS
  • Changes with Apache Libcloud 0.14.0-beta3
    • General
    • Compute
    • Storage
    • Load Balancer
    • DNS
  • Changes with Apache Libcloud 0.13.3
    • Compute
  • Changes with Apache Libcloud 0.13.2
    • General
    • Compute
    • Storage
    • Load Balancer
    • DNS
  • Changes with Apache Libcloud 0.13.1
    • General
    • Compute
    • Storage
  • Changes with Apache Libcloud 0.13.0
    • General
  • Misc
    • Compute
    • Storage
    • Load Balancer
  • Changes with Apache Libcloud 0.12.4
    • Compute
    • Storage
  • Changes with Apache Libcloud 0.12.3
    • General
    • Compute
    • DNS
  • Changes with Apache Libcloud 0.12.1
    • General
    • Compute
    • Storage
    • DNS
    • Load-Balancer
  • Changes with Apache Libcloud 0.11.4
    • General
    • Compute
    • Storage
    • DNS
  • Changes with Apache Libcloud 0.11.3
    • Storage
  • Changes with Apache Libcloud 0.11.2
    • General
    • Compute
    • Storage
    • Load-balancer
  • Changes with Apache Libcloud 0.11.1
    • General
  • Changes with Apache Libcloud 0.11.0
    • Compute
    • DNS
    • Storage
    • Other
  • Changes with Apache Libcloud 0.10.1
    • General
    • Compute
    • Storage
    • Load-balancer
  • Changes with Apache Libcloud 0.9.1
    • General
    • Compute
    • Storage
    • Load-balancer
    • DNS
  • Changes with Apache Libcloud 0.8.0
    • General
    • Compute
    • Storage
    • Load-balancer
  • Changes with Apache Libcloud 0.7.1
    • General
  • Changes with Apache Libcloud 0.7.0
    • General
    • Compute
    • Load-balancer
  • Changes with Apache Libcloud 0.6.2
    • General
    • Compute
    • Storage
    • DNS
  • Changes with Apache Libcloud 0.6.1
    • General
    • Compute
    • Load-baancer
    • DNS
  • Changes with Apache Libcloud 0.6.0-beta1
    • General
    • Compute
    • Storage
    • Load-balancer
    • DNS
  • Changes with Apache Libcloud 0.5.2
    • Compute
    • Storage
  • Changes with Apache Libcloud 0.5.0
  • Changes with Apache Libcloud 0.4.2 (Released January 18, 2011)
  • Changes with Apache Libcloud 0.4.0 [Released October 6, 2010]
  • Changes with Apache Libcloud 0.3.1 [Released May 11, 2010]
  • Changes with Apache Libcloud 0.3.0 [Tagged May 6, 2010, not released]
  • Changes with Apache Libcloud 0.2.0 [Tagged February 2, 2010]
• Upgrade Notes
  • Libcloud 2.7.0
  • Libcloud 1.0.0
  • Libcloud 0.20.0
  • Libcloud 0.19.0
  • Libcloud 0.16.0
    • Changes in the OpenStack authentication and service catalog classes
  • Libcloud 0.14.1
    • Fix record name inconsistencies in the Rackspace DNS driver
  • Libcloud 0.14.0
    • Default Content-Type is now provided if none is supplied and none can be guessed
    • SSH Key pair management functionality has been promoted to the base API
    • New default kernel versions used when creating Linode servers
    • Addition of new “STOPPED” node state
    • Amazon EC2 compute driver changes
    • Rackspace compute driver changes
    • CloudStack compute driver changes
    • Joyent compute driver changes
    • ElasticHosts compute driver changes
    • Unification of extension arguments for security group handling in the EC2 driver
    • CloudFiles Storage driver changes
    • Rackspace DNS driver changes
    • Rackspace load balancer driver changes
    • ScriptDeployment and ScriptFileDeployment constructor now takes args argument
    • Pricing data changes
    • RecordType ENUM value is now a string
    • Cache busting functionality is now only enabled in Rackspace first-gen driver
    • libcloud.security.VERIFY_SSL_CERT_STRICT variable has been removed
    • get_container method changes in the S3 driver
  • Libcloud 0.8
  • Libcloud 0.7
  • Libcloud 0.6
• Security
  • Reporting a vulnerability
  • How are vulnerabilities handled?

Note

Unless noted otherwise, all of the examples and code snippets in the documentation are licensed under the Apache 2.0 license.