a2165cf651
Per the spec [1]: contributor/ – anything related to contributing to the project or how the team is managed. Applies to some of the current content under /developer, we are changing the name to emphasize that not all contributors are developers and sometimes developers are users but not contributors. We currently have a handful of docs that focus on the "how to develop or contribute" aspects of nova, and these are moved. Docs that focus on architecture or design decisions for nova are not moved, as these will go into 'reference'. A TODO is added to the former 'api_plugins' document as it's mega out-of-date and needs some serious work. [1] specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration Change-Id: Iad770688b4eafeb9caa710b4398b02d80a017a70
7.1 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:
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.
contributor/testing feature_classification support-matrix
Developer Guide
If you are new to Nova, this should help you start to understand what Nova actually does, and why.
contributor/how-to-get-involved contributor/process architecture contributor/project-scope contributor/development-environment
Development Policies
The Nova community is a large community. We have lots of users, and they all have a lot of expectations around upgrade and backwards compatibility. For example, having a good stable API, with discoverable versions and capabilities is important for maintaining the strong ecosystem around Nova.
Our process is always evolving, just as Nova and the community around Nova evolves over time. If there are things that seem strange, or you have ideas on how to improve things, please engage in that debate, so we continue to improve how the Nova community operates.
This section looks at the processes and why. The main aim behind all the process is to aid good communication between all members of the Nova community, while keeping users happy and keeping developers productive.
contributor/process contributor/blueprints contributor/policies contributor/code-review contributor/releasenotes
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.
contributor/api-2 rpc block_device_mapping conductor filter_scheduler aggregates i18n notifications placement contributor/placement quotas threading vmstates 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.
cells upgrade contributor/api contributor/microversions policy_enforcement stable_api scheduler_evolution
Advanced testing and guides
gmr contributor/testing/libvirt-numa contributor/testing/serial-console contributor/testing/zero-downtime-upgrade
Sample Configuration File
configuration/sample-config
Sample Policy file
configuration/sample-policy
Man Pages
cli/index
Module Reference
services
Metadata
vendordata
Indices and tables
search