6.5 KiB
Welcome to Nova's developer documentation!
Nova is an OpenStack project designed to provide power massively scalable, on demand, self service access to compute resources.
The developer documentation provided here is continually kept up-to-date based on the latest code, and may not represent the state of the project at any specific prior release.
Note
This is documentation for developers, if you are looking for more general documentation including API, install, operator and user guides see docs.openstack.org
This documentation is intended to help explain what the Nova developers think is the current scope of the Nova project, as well as the architectural decisions we have made in order to support that scope. We also document our plans for evolving our architecture over time. Finally, we documented our current development process and policies.
Compute API References
The Nova compute API is quite large, we provide a concept guide which gives some of the high level details, as well as a more detailed API reference.
The API reference covers all versions of the API. Version 2.0 and Version 2.1 are actually the same API, and Version 2.1 evolves forward with microversions. The API ref starts with the base API version, and specifies all changes that exist to it as microversions roll forward. You can also see a history of our microversions here:
reference/api-microversion-history
Note
Only Version 2.1 APIs should be used from this point forward, Version 2.0 APIs are only provided for backward compatibility purposes.
There was a session on the v2.1 API at the Liberty summit which you can watch here.
Feature Status
Nova aims to have a single compute API that works the same across all deployments of Nova. While many features are well-tested, well-documented, support live upgrade, and are ready for production, some are not. Also the choice of underlying technology affects the list of features that are ready for production.
Our first attempt to communicate this is the feature support matrix (previously called the hypervisor support matrix). Over time we hope to evolve that to include a classification of each feature's maturity and exactly what technology combinations are covered by current integration testing efforts.
user/feature-classification user/support-matrix
Developer Guide
If you are new to Nova, this should help you start to understand what Nova actually does, and why.
contributor/index
Architecture Concepts
This follows on for the discussion in the introduction, and digs into details on specific parts of the Nova architecture.
We find it important to document the reasons behind our architectural decisions, so its easier for people to engage in the debates about the future of Nova's architecture. This is all part of Open Design and Open Development.
reference/rpc user/architecture user/block-device-mapping user/conductor user/filter-scheduler user/aggregates reference/i18n reference/notifications user/placement user/quotas reference/threading reference/vm-states user/wsgi
Architecture Evolution Plans
The following section includes documents that describe the overall plan behind groups of nova-specs. Most of these cover items relating to the evolution of various parts of Nova's architecture. Once the work is complete, these documents will move into the "Concepts" section. If you want to get involved in shaping the future of Nova's architecture, these are a great place to start reading up on the current plans.
user/cells user/cellsv2_layout user/upgrade reference/policy-enforcement reference/stable-api reference/scheduler-evolution
Configuration
configuration/config configuration/sample-config
Policy
configuration/policy configuration/sample-policy
Man Pages
cli/index
Module Reference
reference/services
contributor/development-environment reference/gmr contributor/api contributor/api-2 contributor/blueprints contributor/code-review contributor/microversions contributor/placement.rst contributor/policies.rst contributor/releasenotes contributor/testing contributor/testing/libvirt-numa contributor/testing/serial-console contributor/testing/zero-downtime-upgrade contributor/how-to-get-involved contributor/process contributor/project-scope
Installation Guide
install/index
Metadata
user/vendordata
Administrators Guide
admin/index
Indices and tables
search