Developer Guide

In this section you will find information on manila’s lower level programming APIs.

Programming HowTos and Tutorials

• Setting Up a Development Environment
  • Virtual environments
  • Linux Systems
  • Mac OS X Systems
  • Getting the code
  • Running unit tests
  • Manually installing and using the virtualenv
  • Contributing Your Work
• Unit Tests
  • Running the tests
  • Flags
  • Running a subset of tests
  • Suppressing logging output when tests fail
  • Virtualenv
  • Database
  • Gotchas
• Tempest Tests
  • Installation of plugin to tempest
  • Configuration of manila-related tests in tempest.conf
  • Running tests
  • Running a subset of tests based on test location
  • Running a subset of tests based on service involvement
  • Running a subset of positive or negative tests
• Adding a Method to the OpenStack API
  • Routing
  • Controllers and actions
  • Serialization
  • Faults

Background Concepts for manila

• Manila System Architecture
  • Components
  • Further Challenges
• Threading model
  • Yielding the thread in long-running tasks
  • MySQL access and eventlet
• Internationalization
• AMQP and manila
  • Manila RPC Mappings
  • RPC Calls
  • RPC Casts
  • AMQP Broker Load
  • RabbitMQ Gotchas
• Manila minimum requirements and features since Mitaka
  • At least one driver mode (DHSS true/false)
  • At least one file system sharing protocol
  • Access rules
  • Shares
  • Share extending
  • Capabilities
  • Continuous Integration systems
  • Unit tests
  • Documentation
• Manila optional requirements and features since Mitaka
  • Snapshots
  • Managing/Unmanaging shares
  • Share shrinking
  • Share ensuring
• Manila experimental features since Mitaka
  • Share Migration
  • Consistency Groups
• Pool-Aware Scheduler Support
  • Problem Description
  • Proposed change
  • Terminology
  • Design
  • Data model impact
  • REST API impact
  • Security impact
  • Notifications impact
  • Admin impact
  • Other end user impact
  • Performance Impact
  • Developer impact
  • Documentation Impact

Other Resources

• Project hosting with Launchpad
  • Launchpad credentials
  • Mailing list
  • Bug tracking
  • Feature requests (Blueprints)
  • Technical support (Answers)
• Code Reviews with Gerrit
• Continuous Integration with Jenkins

API Reference

• API Endpoint
  • Common Components
    • The manila.api Module
    • The manila.api.v1 Module
    • The manila.api.contrib Module
  • OpenStack API
    • The openstack Module
  • Tests
    • The api Module
• API Microversions
  • Background
  • When do I need a new Microversion?
  • In Code
    • Adding a new API method
    • Removing an API method
    • Changing a method’s behaviour
    • A method with only small changes between versions
    • A change in schema only
    • When not using decorators
  • Other necessary changes
  • Allocating a microversion
  • Testing Microversioned API Methods
• REST API Version History
  • 1.0
  • 2.0
  • 2.1
  • 2.2
  • 2.3
  • 2.4
  • 2.5
  • 2.6
  • 2.7
  • 2.8
  • 2.9
  • 2.10
  • 2.11
  • 2.12
  • 2.13
    • 2.14
  • 2.15
• Experimental APIs
  • Background
  • When do I need to set an API experimental?
  • When do I need to remove the experimental annotation from an API?
  • In Code

Module Reference

• Introduction to the Shared File Systems service
• Services, Managers and Drivers
  • The manila.service Module
  • The manila.manager Module
  • Implementation-Specific Drivers
• The Database Layer
  • The manila.db.api Module
  • The Sqlalchemy Driver
    • The manila.db.sqlalchemy.api Module
    • The manila.db.sqlalchemy.models Module
  • Tests
• Shared Filesystems
  • The manila.share.manager Module
  • The manila.share.driver Module
• Manila share driver hooks
  • Possibilities
  • Features
  • Limitations
  • Implementation in share drivers
  • What is required for writing new ‘hook’ implementation?
  • How to use ‘hook’ implementations?
  • Driver methods that are wrapped with hooks
    • The manila.share.hook.py Module
• Authentication and Authorization
  • The manila.quota Module
  • The manila.policy Module
  • Tests
    • The test_quota Module
    • The test_policy Module
  • System limits
• API Endpoint
  • Common Components
    • The manila.api Module
    • The manila.api.v1 Module
    • The manila.api.contrib Module
  • OpenStack API
    • The openstack Module
  • Tests
    • The api Module
• Scheduler
  • The manila.scheduler.manager Module
  • The manila.scheduler.driver Module
  • The manila.scheduler.simple Driver
  • Tests
    • The scheduler Module
• Fake Drivers
  • The fake_compute Module
  • The fake_driver Module
  • The fake_network Module
  • The fake_utils Module
  • The fake_volume Module
• Common and Misc Libraries
  • The manila.context Module
  • The manila.exception Module
  • The manila.test Module
  • The manila.utils Module
  • The manila.wsgi Module
  • Tests
    • The test_exception Module
• Ganesha Library
  • Supported operations
  • Requirements
  • NFS-Ganesha configuration
  • Further Ganesha related manila configuration
  • Using Ganesha Library in drivers
  • Customizing Ganesha exports
  • Known Restrictions
  • Known Issues
    • The manila.share.drivers.ganesha Module

Capabilities and Extra-Specs

• Capabilities and Extra-Specs
  • Share Types
  • Extra-Specs
  • Common Capabilities
  • Reporting Capabilities
  • Developer impact
  • Work Flow
• Export Location Metadata
• Metadata Keys

Share backends feature support mapping

• Manila share features support mapping
  • Mapping of share drivers and share features support
  • Mapping of share drivers and share access rules support
  • Mapping of share drivers and security services support

Share backends

• ZFS (on Linux) Driver
  • Requirements
  • Supported Operations
  • Possibilities
  • Restrictions
  • Known problems
  • Backend Configuration
    • The manila.share.drivers.zfsonlinux.driver Module
    • The manila.share.drivers.zfsonlinux.utils Module
• NetApp Clustered Data ONTAP
  • Supported Operations
  • Supported Operating Modes
  • Network approach
  • Supported shared filesystems
  • Required licenses
  • Known restrictions
    • The manila.share.drivers.netapp.common.py Module
• Isilon Driver
  • Requirements
  • Supported Operations
  • Backend Configuration
  • Restrictions
    • The manila.share.drivers.emc.driver Module
    • The manila.share.drivers.emc.plugins.isilon.isilon Module
• VNX Driver
  • Requirements
  • Supported Operations
  • Pre-Configurations on VNX
  • Backend Configuration
  • Restrictions
    • The manila.share.drivers.emc.driver Module
    • The manila.share.drivers.emc.plugins.vnx.connection Module
• Generic approach for share provisioning
  • Network configurations
  • Requirements for service image
  • Supported shared filesystems
  • Known restrictions
    • The manila.share.drivers.generic Module
    • The manila.share.drivers.service_instance Module
• GlusterFS driver
  • Supported shared filesystems
  • Supported Operations
  • Requirements
  • Manila driver configuration setting
  • Layouts
    • Gluster NFS with volume mapped layout
  • Known Restrictions
    • The manila.share.drivers.glusterfs Module
• GlusterFS Native driver
  • Network Approach
  • Supported shared filesystems
  • Multi-tenancy model
  • Supported Operations
  • Requirements
  • Manila driver configuration setting
  • Host and backend configuration
  • Known Restrictions
    • The manila.share.drivers.glusterfs.glusterfs_native.GlusterfsNativeShareDriver Module
• CephFS Native driver
  • Prerequisities
  • Authorize the driver to communicate with Ceph
  • Configure CephFS backend in manila.conf
  • Creating shares
  • Mounting a client with FUSE
• GPFS Driver
  • Supported shared filesystems
  • Supported Operations
  • Requirements
  • Manila driver configuration setting
  • Known Restrictions
    • The manila.share.drivers.ibm.gpfs Module
• Huawei Driver
  • Requirements
  • Supported Operations
  • Pre-Configurations on Huawei
  • Backend Configuration
  • Share Types
  • Restrictions
    • The manila.share.drivers.huawei.huawei_nas Module
• HDFS native driver
  • Network configuration
  • Supported shared filesystems
  • Supported Operations
  • Requirements
  • Manila driver configuration
  • Known Restrictions
    • The manila.share.drivers.hdfs.hdfs_native Module
• Hitachi HNAS manila driver
  • Driver Version 1.0
    • HNAS Storage Requirements
    • Supported Operations
    • Driver Configuration
    • Manage and Unmanage Shares
• HPE 3PAR Driver
  • Supported Operations
  • Requirements
  • Pre-Configuration on the HPE 3PAR
  • Backend Configuration
  • Network Approach
  • Share Types
    • The manila.share.drivers.hpe.hpe_3par_driver Module
• Tegile Driver
  • Requirements
  • Supported Operations
  • Backend Configuration
  • Restrictions
    • The manila.share.drivers.tegile.tegile Module

Indices and tables

• Index
• Module Index
• Search Page