Difference between revisions of "Documentation/ContentSpecs"
Annegentle (talk | contribs) |
Annegentle (talk | contribs) |
||
Line 31: | Line 31: | ||
[http://docs.openstack.org/api/quick-start/content/ OpenStack API Quick Start]: A brief overview of how to send REST API requests to endpoints for OpenStack services. | [http://docs.openstack.org/api/quick-start/content/ OpenStack API Quick Start]: A brief overview of how to send REST API requests to endpoints for OpenStack services. | ||
+ | |||
+ | [http://docs.openstack.org/cli-reference/content/ Command-Line Interface Reference]: Automatically generates help text for CLI commands and subcommands. |
Revision as of 19:04, 9 April 2014
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.
OpenStack Installation Guides: Describe a manual install process, as in, by hand, no automation, for multiple distributions based on packaging system:
OpenStack Configuration Reference: Contains a reference listing of all configuration options for core and integrated OpenStack services by release version.
Guides for deployers and administrators:
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.