openstack/manila
Code Issues Proposed changes
e8adec1b96
manila/doc/source/index.rst
liuyamin bc1fc3a307 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: Ie2d2a2c06ef0ffe32a80eac85313ab57020af5ba
2019-03-01 01:10:15 +00:00

3.7 KiB
Raw Blame History

OpenStack Shared Filesystems (manila) documentation

What is Manila?

Manila is the OpenStack Shared Filesystems service for providing Shared Filesystems as a service. Some of the goals of Manila 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 Manila, you'll use Manila to create a remote file system with either tools or the API directly: python-manilaclient, or by directly using the REST API.

Tools for using Manila

Contents:

user/index

Using the Manila API

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

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

For operators

This section has details for deploying and maintaining Manila services.

Installing Manila

Manila 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.

install/index

Administrating Manila

Contents:

admin/index

Reference

Contents：

configuration/index cli/index

Additional resources

For contributors

Contributions to Manila are welcome. There is a lot of background information that can help you get started. Please feel free to also ask any questions in the #openstack-manila IRC channel.

Getting started

Contributing to Manila

Contents:

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

Additional reference

Contents:

reference/index

Additional reference

Contents:

  • genindex