c41dbfc0e2
Shared File Systems service (manila) should be added to the Config Ref similar to Block Storage (cinder). The content would be similar to cinder in that it would have sections to describe Intro, Drivers, Log Files and Options. Change-Id: I89fc64f8cd4fe880b36017139e7989f3a4100cc6 Implements: blueprint manila-config-ref
105 lines
6.1 KiB
XML
105 lines
6.1 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<section xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:xi="http://www.w3.org/2001/XInclude"
|
|
xmlns:xlink="http://www.w3.org/1999/xlink"
|
|
version="5.0"
|
|
xml:id="section_shared-file-systems-overview">
|
|
<title>Introduction to the Shared File Systems service</title>
|
|
<para>The Shared File Systems service provides shared file systems that
|
|
Compute instances can consume.</para>
|
|
<para>The Shared File Systems service provides:</para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para><systemitem class="service">manila-api</systemitem>. A WSGI app that authenticates
|
|
and routes requests throughout the Shared File Systems service. It supports the
|
|
OpenStack APIs.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><systemitem class="service">manila-scheduler</systemitem>. Schedules and routes
|
|
requests to the appropriate share service. The scheduler uses configurable filters
|
|
and weighers to route requests. The Filter Scheduler is the default and enables
|
|
filters on things like Capacity, Availability Zone, Share Types, and Capabilities
|
|
as well as custom filters.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><systemitem class="service">manila-share</systemitem>.
|
|
Manages back-end devices that provide shared file systems.
|
|
A manila-share service can run in one of two modes, with or without handling of
|
|
share servers. Share servers export file shares via share networks.
|
|
When share servers are not used, the networking requirements are handled
|
|
outside of Manila.</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
<para>The Shared File Systems service contains the following components:</para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para><emphasis role="bold">Back-end storage devices</emphasis>. The Shared File
|
|
Services service requires some form of back-end shared file system provider
|
|
that the service is built on. The reference implementation uses the Block Storage
|
|
service (Cinder) and a service VM to provide shares. Additional drivers are
|
|
used to access shared file systems from a variety of vendor solutions.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><emphasis role="bold">Users and tenants (projects)</emphasis>. The Shared File
|
|
Systems service can be used by many different cloud computing consumers or customers
|
|
(tenants on a shared system), using role-based access assignments. Roles control the
|
|
actions that a user is allowed to perform. In the default configuration, most
|
|
actions do not require a particular role unless they are restricted to
|
|
administrators, but this can be configured by the system administrator in the
|
|
appropriate <filename>policy.json</filename> file that maintains the rules.
|
|
A user's access to manage particular shares is limited by tenant. Guest access
|
|
to mount and use shares is secured by IP and/or user access rules.
|
|
Quotas used to control resource consumption across available hardware resources
|
|
are per tenant.</para>
|
|
<para>For tenants, quota controls are available to limit:</para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para>The number of shares that can be created.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>The number of gigabytes that can be provisioned for shares.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>The number of share snapshots that can be created.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>The number of gigabytes that can be provisioned for share snapshots.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>The number of share networks that can be created.</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
<para>You can revise the default quota values with the Shared File Systems CLI,
|
|
so the limits placed by quotas are editable by admin users.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><emphasis role="bold">Shares, snapshots, and share networks</emphasis>. The basic
|
|
resources offered by the Shared File Systems service are shares, snapshots
|
|
and share networks:</para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para><emphasis role="bold">Shares</emphasis>. A share is a unit of storage
|
|
with a protocol, a size, and an access list. Shares are the basic
|
|
primitive provided by Manila. All shares exist on a
|
|
backend. Some shares are associated with share networks and share servers.
|
|
The main protocols supported are NFS and CIFS, but other protocols are
|
|
supported as well.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><emphasis role="bold">Snapshots</emphasis>. A snapshot is a point in
|
|
time copy of a share. Snapshots can only be used to create new shares
|
|
(containing the snapshotted data). Shares cannot be deleted until all
|
|
associated snapshots are deleted.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><emphasis role="bold">Share networks</emphasis>. A share network is a
|
|
tenant-defined object that informs Manila about the security and
|
|
network configuration for a group of shares. Share networks are only
|
|
relevant for backends that manage share servers. A share network contains
|
|
a security service and network/subnet.</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</section>
|