Difference between revisions of "Documentation/ContentSpecs"
Annegentle (talk | contribs) |
Annegentle (talk | contribs) |
||
| Line 39: | Line 39: | ||
== API documentation == | == API documentation == | ||
| − | * [http://developer.openstack.org/api-ref.html]: Complete reference listing of OpenStack REST APIs with | + | * [http://developer.openstack.org/api-ref.html Complete API Reference]: Complete reference listing of OpenStack REST APIs with example requests and responses. |
| + | * [http://specs.openstack.org API specifications]: Within project's specification repos, some have opted to document API specifications, such as Identity. | ||
| + | * [http://docs.openstack.org/developer/swift/#object-storage-v1-rest-api-documentation Object Storage API v1] | ||
| + | |||
---- | ---- | ||
[[Category:Documentation]] | [[Category:Documentation]] | ||
Revision as of 22:08, 15 December 2014
Contents
Release specific documentation
The Installation Guides and Configuration Reference are released at release time, with draft material published to docs.openstack.org/trunk/. The rest of the guides are continuously released.
Installation Guides
The OpenStack Installation Guides describe a manual install process, as in, by hand, no automation, for multiple distributions based on packaging system:
- Installation Guide for Debian 7.0
- Installation Guide for openSUSE and SUSE Linux Enterprise Server
- Installation Guide for Red Hat Enterprise Linux, CentOS, and Fedora
- Installation Guide for Ubuntu 12.04 and 14.04 (LTS) Server
Guides for deployers and administrators
OpenStack Configuration Reference: Contains a reference listing of all configuration options for core and integrated OpenStack services by release version.
Continously released documentation
These guides cover multiple versions and we follow the general release information. The guides cover thus the latest two versions, for example Icehouse and Havana. The following exceptions apply:
- Operations Guide: Icehouse target, revised specifically to target that release
- Security Guide: written prior to Havana release
- HA Guide: updated last at Havana timeframe, still needs updates
Guides for deployers and administrators
- OpenStack Architecture Design Guide: Contains information on how to plan, design and architect an OpenStack cloud.
- OpenStack Cloud Administrator Guide: Contains how-to information for managing an OpenStack cloud as needed for your use cases, such as storage, computing, or software-defined-networking.
- OpenStack High Availability Guide: Describes potential strategies for making your OpenStack services and related controllers and data stores highly available.
- OpenStack Security Guide: Provide best practices and conceptual information about securing an OpenStack cloud.
- Virtual Machine Image Guide: Shows you how to obtain, create, and modify virtual machine images that are compatible with OpenStack.
Guides for end users
- OpenStack End User Guide: Shows OpenStack end users how to create and manage resources in an OpenStack cloud with the OpenStack dashboard and OpenStack client commands.
- OpenStack Admin User Guide: Shows OpenStack administrators how to create and manage resources in an OpenStack cloud with the OpenStack dashboard and OpenStack client commands.
- OpenStack API Quick Start: A brief overview of how to send REST API requests to endpoints for OpenStack services.
- Command-Line Interface Reference: Automatically generates help text for CLI commands and subcommands.
API documentation
- Complete API Reference: Complete reference listing of OpenStack REST APIs with example requests and responses.
- API specifications: Within project's specification repos, some have opted to document API specifications, such as Identity.
- Object Storage API v1
