Developer Guide

In this section you will find information on Nova’s lower level programming APIs.

Programming HowTos and Tutorials

• Setting Up a Development Environment
  • Virtual environments
  • Linux Systems
  • Mac OS X Systems
  • Getting the code
  • Running unit tests
  • Manually installing and using the virtualenv
  • Using a remote debugger
  • Using fake computes for tests
  • Contributing Your Work
• Unit Tests
  • Preferred way to run the tests
  • Older way to run the tests
  • Flags
  • Running a subset of tests
  • Virtualenv
  • Gotchas
• Adding a Method to the OpenStack API
  • Routing
  • Controllers and actions
  • Serialization
  • Faults
• Guru Meditation Reports
  • Generating a GMR
  • Structure of a GMR
  • Adding Support for GMRs to New Executables
  • Extending the GMR

Background Concepts for Nova

• Nova System Architecture
  • Components
• Threading model
  • Yielding the thread in long-running tasks
  • MySQL access and eventlet
• Virtual Machine States and Transitions
  • Preconditions for commands
  • Create instance states
• Internationalization
• Filter Scheduler
  • Filtering
  • Weights
• AMQP and Nova
  • Nova RPC Mappings
  • RPC Calls
  • RPC Casts
  • AMQP Broker Load
  • RabbitMQ Gotchas
• Hooks
  • What are hooks good for?
  • What are hooks NOT good for?
  • Declaring hooks in the Nova codebase
  • Adding hook object code

Other Resources

• Project hosting with Launchpad
  • Launchpad credentials
  • Mailing list
  • Bug tracking
  • Feature requests (Blueprints)
  • Technical support (Answers)
• Code Reviews with Gerrit
• Continuous Integration with Jenkins

API Reference

Module Reference

• Services, Managers and Drivers
  • The nova.service Module
  • The nova.manager Module
  • Implementation-Specific Drivers
• The Database Layer
  • The nova.db.api Module
  • The Sqlalchemy Driver
    • The nova.db.sqlalchemy.api Module
    • The nova.db.sqlalchemy.models Module
    • The nova.db.sqlalchemy.session Module
  • Tests
• Virtualization
  • Compute
    • The nova.compute.manager Module
    • The nova.virt.connection Module
    • The nova.compute.disk Module
    • The nova.virt.images Module
    • The nova.compute.flavors Module
    • The nova.compute.power_state Module
  • Drivers
    • The nova.virt.libvirt_conn Driver
    • The nova.virt.xenapi Driver
    • The nova.virt.fake Driver
  • Tests
    • The compute_unittest Module
    • The virt_unittest Module
• Networking
  • The nova.network.manager Module
  • The nova.network.linux_net Driver
  • Tests
    • The network_unittest Module
• API Endpoint
  • Common Components
    • The nova.api Module
    • The nova.api.cloud Module
  • OpenStack API
    • The openstack Module
    • The auth Module
    • The backup_schedules Module
    • The faults Module
    • The flavors Module
    • The images Module
    • The servers Module
    • The sharedipgroups Module
  • EC2 API
    • The nova.api.ec2 Module
    • The apirequest Module
    • The cloud Module
    • The images Module
    • The metadatarequesthandler Module
  • Tests
    • The api_unittest Module
    • The api_integration Module
    • The cloud_unittest Module
    • The api.fakes Module
    • The api.test_wsgi Module
    • The test_api Module
    • The test_auth Module
    • The test_faults Module
    • The test_flavors Module
    • The test_images Module
    • The test_servers Module
    • The test_sharedipgroups Module
• Scheduler
  • The nova.scheduler.manager Module
  • The nova.scheduler.driver Module
  • The nova.scheduler.chance Driver
  • Tests
    • The scheduler_unittest Module
• Fake Drivers
  • The nova.virt.fake Module
  • The nova.auth.fakeldap Module
  • The nova.tests.service_unittest.FakeManager Class
  • The nova.tests.api.openstack.fakes Module
• Common and Misc Libraries
  • The nova.adminclient Module
  • The nova.context Module
  • The nova.exception Module
  • The nova.flags Module
  • The nova.process Module
  • The nova.rpc Module
  • The nova.server Module
  • The nova.test Module
  • The nova.utils Module
  • The nova.validate Module
  • The nova.wsgi Module
  • Tests
    • The declare_flags Module
    • The fake_flags Module
    • The flags_unittest Module
    • The process_unittest Module
    • The real_flags Module
    • The rpc_unittest Module
    • The runtime_flags Module
    • The validator_unittest Module
• Objectstore - File Storage Service
  • The nova.objectstore.handler Module
  • The nova.objectstore.bucket Module
  • The nova.objectstore.stored Module
  • The nova.objecstore.image Module
  • Tests
    • The objectstore_unittest Module
• Glance Integration - The Future of File Storage
  • The nova.image.service Module

Indices and tables

• Index
• Module Index
• Search Page