nova/README.rst
John Garbutt ddeb0e88c5 Refresh README and its docs links
The current README still mentions EC2 and over-duplicates information
that now lives in other files, like CONTRIBUTING.rst.

This patch re-focused the README on three key groups of folks:
* API users
* Operators
* Developers

Change-Id: I9df445ca0c800f0985900dcb00466c15e8d5570f
2016-08-08 10:26:08 +01:00

62 lines
1.7 KiB
ReStructuredText

OpenStack Nova
==============
OpenStack Nova provides a cloud computing fabric controller,
supporting a wide variety of compute technologies, including:
libvirt (KVM, Xen, LXC and more), Hyper-V, VMware, XenServer
and OpenStack Ironic.
OpenStack Nova is distributed under the terms of the Apache
License, Version 2.0. The full terms and conditions of this
license are detailed in the LICENSE file.
API
---
To learn how to use Nova's API, consult the documentation
available online at:
http://developer.openstack.org/api-guide/compute/
http://developer.openstack.org/api-ref/compute/
For more information on OpenStack APIs, SDKs and CLIs,
please see:
http://www.openstack.org/appdev/
http://developer.openstack.org/
Operators
---------
To learn how to deploy and configure OpenStack Nova, consult the
documentation available online at:
http://docs.openstack.org
For information about the different compute (hypervisor) drivers
supported by Nova, please read:
http://docs.openstack.org/developer/nova/feature_classification.html
In the unfortunate event that bugs are discovered, they should
be reported to the appropriate bug tracker. If you obtained
the software from a 3rd party operating system vendor, it is
often wise to use their own bug tracker for reporting problems.
In all other cases use the master OpenStack bug tracker,
available at:
http://bugs.launchpad.net/nova
Developers
----------
For information on how to contribute to Nova, please see the
contents of the CONTRIBUTING.rst.
Any new code must follow the development guidelines detailed
in the HACKING.rst file, and pass all unit tests.
Further developer focused documentation is available at:
http://docs.openstack.org/developer/nova/