openstack/cinder
Code Issues Proposed changes
0554ee1d47
cinder/doc/source/index.rst
Sean McGinnis b9c59caaab Update docs landing page to follow guideline 
During the rocky cycle, there was a docs-spec approved [0] with the goal
of having a recommended consistent documentation landing page for all
projects.

This updates our docs landing page to follow the structure described in
that recommendation.

[0] http://specs.openstack.org/openstack/docs-specs/specs/rocky/front-page-template.html

Change-Id: I0f31c59e6b39ab8d9c0009f72967c793dadbed64
2018-11-02 09:46:34 -05:00

4.6 KiB
Raw Blame History

OpenStack Block Storage (Cinder) documentation

What is Cinder?

Cinder is the OpenStack Block Storage service for providing volumes to Nova virtual machines, Ironic bare metal hosts, containers and more. Some of the goals of Cinder are to be/have:

  • Component based architecture: Quickly add new behaviors
  • Highly available: Scale to very serious workloads
  • Fault-Tolerant: Isolated processes avoid cascading failures
  • Recoverable: Failures should be easy to diagnose, debug, and rectify
  • Open Standards: Be a reference implementation for a community-driven api

For end users

As an end user of Cinder, you'll use Cinder to create and manage volumes using the Horizon user interface, command line tools such as the python-cinderclient, or by directly using the REST API.

Tools for using Cinder

  • Horizon: The official web UI for the OpenStack Project.
  • OpenStack Client: The official CLI for OpenStack Projects. You should use this as your CLI for most things, it includes not just nova commands but also commands for most of the projects in OpenStack.
  • Cinder Client: The openstack CLI is recommended, but there are some advanced features and administrative commands that are not yet available there. For CLI access to these commands, the cinder CLI can be used instead.

Using the Cinder API

All features of Cinder are exposed via a REST API that can be used to build more complicated logic or automation with Cinder. This can be consumed directly or via various SDKs. The following resources can help you get started consuming the API directly.

  • Cinder API
  • Cinder microversion history </contributor/api_microversion_history>

For operators

This section has details for deploying and maintaining Cinder services.

Installing Cinder

Cinder can be configured standalone using the configuration setting auth_strategy = noauth, but in most cases you will want to at least have the Keystone Identity service and other OpenStack services installed.

Installation Guide <install/index> Upgrade Process <upgrade>

Administrating Cinder

Contents:

admin/index

Reference

Contents:

configuration/index reference/support-matrix drivers cli/index

Additional resources

For contributors

Contributions to Cinder are welcome. There can be a lot of background information needed to get started. This section should help get you started. Please feel free to also ask any questions in the #openstack-cinder IRC channel.

Getting started

Contributing to Cinder

Contents:

contributor/index API Microversions </contributor/api_microversion_dev/>

Additional reference

Contents:

common/glossary.rst

Indices and tables

Contents:

  • genindex
  • search