Developer Guide

In this section you will find information on Cinder’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
• 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
    • When not using decorators
  • Other necessary changes
  • Allocating a microversion
  • Testing Microversioned API Methods
• API Races - Conditional Updates
  • Background
  • Conditional Update
  • Basic Usage
  • Returning Errors
  • Building filters on the API
  • Using DB fields for assignment
  • Conditional value setting
  • reflect_changes considerations
  • Limitations
  • Considerations for new ORM & Versioned Objects
• REST API Version History
  • 3.0
  • 3.1
  • 3.2
  • 3.3
  • 3.4
  • 3.5
  • 3.6
  • 3.7
  • 3.8
  • 3.9
  • 3.10
  • 3.11
  • 3.12
  • 3.13
  • 3.14
  • 3.15 (Maximum in Newton)
  • 3.16
  • 3.17
  • 3.18
  • 3.19
  • 3.20
  • 3.21
  • 3.22
  • 3.23
  • 3.24
  • 3.25
  • 3.26
  • 3.27
• Testing
  • Test Types
    • Unit Tests
    • Functional Tests
    • Tempest Tests
  • Running the tests
    • Unit Tests
    • Functional Tests
    • Tempest Tests
    • Database Setup
  • Running a subset of tests using tox
  • Gotchas
• Adding a Method to the OpenStack API
  • Routing
  • Controllers and actions
  • Serialization
  • Faults
• Drivers
  • Basic attributes
  • Minimum Features
  • Core Functionality
  • Volume Stats
  • Feature Enforcement
  • Driver Development Documentations
    • Base Driver Interface
    • Snapshot Interface
    • Manage/Unmanage Support
    • Manage/Unmanage Snapshot Support
    • Volume Consistency Groups
    • Generic Volume Groups
• Guru Meditation Reports
  • Generating a GMR
  • Structure of a GMR
  • Adding Support for GMRs to New Executables
  • Extending the GMR
• Replication
  • Config file examples
  • Volume Types / Extra Specs
  • Capabilities reporting
  • Required methods
• User Messages
  • The Message API Module
  • The Resource Types Module
  • The Permitted Messages Module
• Migration
  • Introduction to volume migration
  • How to do volume migration via CLI
  • Configurations
  • What can be tracked during volume migration
  • How to implement volume migration for a back-end driver
  • Required methods
• Running Cinder API under Apache
  • Files
  • Access Control
• Upgrades
  • Database schema and data migrations
    • Adding a column
    • Dropping a column not referenced in SQLAlchemy code
    • Removal of unnecessary column
    • ALTER on a column
  • RPC API changes
  • RPC payload changes (oslo.versionedobjects)
• Generic Volume Groups
  • Introduction to generic volume groups
  • Action items for drivers supporting consistency groups
  • Group Type and Group Specs / Volume Types and Extra Specs
  • Capabilities reporting
  • Driver methods
  • Migrate CGs to Generic Volume Groups
  • References

Background Concepts for Cinder

• Cinder System Architecture
  • Components
• Volume Attach/Detach workflow
  • Attach/Detach Operations are multi-part commands
  • Attach workflow
    • reserve_volume(self, context, volume)
    • initialize_connection(self, context, volume, connector)
    • attach(self, context, volume, instance_uuid, host_name, mount_point, mode)
  • Detach workflow
    • begin_detaching(self, context, volume)
    • terminate_connection(self, context, volume, connector, force=False)
    • detach(self, context, volume, attachment_id)
• Threading model
  • Yielding the thread in long-running tasks
  • MySQL access and eventlet
• Internationalization
• AMQP and Cinder
  • Cinder RPC Mappings
  • RPC Calls
  • RPC Casts
  • AMQP Broker Load
  • RabbitMQ Gotchas

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
• Release notes

API Reference

• The cinder.api.common Module
• The cinder.api.contrib.admin_actions Module
• The cinder.api.contrib.availability_zones Module
• The cinder.api.contrib.backups Module
• The cinder.api.contrib.capabilities Module
• The cinder.api.contrib.cgsnapshots Module
• The cinder.api.contrib.consistencygroups Module
• The cinder.api.contrib.extended_services Module
• The cinder.api.contrib.extended_snapshot_attributes Module
• The cinder.api.contrib.hosts Module
• The cinder.api.contrib.image_create Module
• The cinder.api.contrib.qos_specs_manage Module
• The cinder.api.contrib.quota_classes Module
• The cinder.api.contrib.quotas Module
• The cinder.api.contrib.resource_common_manage Module
• The cinder.api.contrib.scheduler_hints Module
• The cinder.api.contrib.scheduler_stats Module
• The cinder.api.contrib.services Module
• The cinder.api.contrib.snapshot_actions Module
• The cinder.api.contrib.snapshot_manage Module
• The cinder.api.contrib.snapshot_unmanage Module
• The cinder.api.contrib.types_extra_specs Module
• The cinder.api.contrib.types_manage Module
• The cinder.api.contrib.used_limits Module
• The cinder.api.contrib.volume_actions Module
• The cinder.api.contrib.volume_encryption_metadata Module
• The cinder.api.contrib.volume_host_attribute Module
• The cinder.api.contrib.volume_image_metadata Module
• The cinder.api.contrib.volume_manage Module
• The cinder.api.contrib.volume_mig_status_attribute Module
• The cinder.api.contrib.volume_tenant_attribute Module
• The cinder.api.contrib.volume_transfer Module
• The cinder.api.contrib.volume_type_access Module
• The cinder.api.contrib.volume_type_encryption Module
• The cinder.api.contrib.volume_unmanage Module
• The cinder.api.extensions Module
• The cinder.api.middleware.auth Module
• The cinder.api.middleware.fault Module
• The cinder.api.openstack.api_version_request Module
• The cinder.api.openstack.versioned_method Module
• The cinder.api.openstack.wsgi Module
• The cinder.api.urlmap Module
• The cinder.api.v1.limits Module
• The cinder.api.v1.router Module
• The cinder.api.v1.snapshot_metadata Module
• The cinder.api.v1.snapshots Module
• The cinder.api.v1.types Module
• The cinder.api.v1.volume_metadata Module
• The cinder.api.v1.volumes Module
• The cinder.api.v2.limits Module
• The cinder.api.v2.router Module
• The cinder.api.v2.snapshot_metadata Module
• The cinder.api.v2.snapshots Module
• The cinder.api.v2.types Module
• The cinder.api.v2.views.types Module
• The cinder.api.v2.views.volumes Module
• The cinder.api.v2.volume_metadata Module
• The cinder.api.v2.volumes Module
• The cinder.api.v3.attachments Module
• The cinder.api.v3.backups Module
• The cinder.api.v3.clusters Module
• The cinder.api.v3.consistencygroups Module
• The cinder.api.v3.group_snapshots Module
• The cinder.api.v3.group_specs Module
• The cinder.api.v3.group_types Module
• The cinder.api.v3.groups Module
• The cinder.api.v3.messages Module
• The cinder.api.v3.resource_common_manage Module
• The cinder.api.v3.router Module
• The cinder.api.v3.snapshot_manage Module
• The cinder.api.v3.snapshots Module
• The cinder.api.v3.views.attachments Module
• The cinder.api.v3.views.clusters Module
• The cinder.api.v3.views.group_snapshots Module
• The cinder.api.v3.views.group_types Module
• The cinder.api.v3.views.groups Module
• The cinder.api.v3.views.messages Module
• The cinder.api.v3.views.snapshots Module
• The cinder.api.v3.views.volumes Module
• The cinder.api.v3.views.workers Module
• The cinder.api.v3.volume_manage Module
• The cinder.api.v3.volume_metadata Module
• The cinder.api.v3.volumes Module
• The cinder.api.v3.workers Module
• The cinder.api.versions Module
• The cinder.api.views.availability_zones Module
• The cinder.api.views.backups Module
• The cinder.api.views.capabilities Module
• The cinder.api.views.cgsnapshots Module
• The cinder.api.views.consistencygroups Module
• The cinder.api.views.limits Module
• The cinder.api.views.manageable_snapshots Module
• The cinder.api.views.manageable_volumes Module
• The cinder.api.views.qos_specs Module
• The cinder.api.views.scheduler_stats Module
• The cinder.api.views.snapshots Module
• The cinder.api.views.transfers Module
• The cinder.api.views.types Module
• The cinder.api.views.versions Module
• The cinder.backup.api Module
• The cinder.backup.chunkeddriver Module
• The cinder.backup.driver Module
• The cinder.backup.drivers.ceph Module
• The cinder.backup.drivers.glusterfs Module
• The cinder.backup.drivers.google Module
• The cinder.backup.drivers.nfs Module
• The cinder.backup.drivers.posix Module
• The cinder.backup.drivers.swift Module
• The cinder.backup.drivers.tsm Module
• The cinder.backup.manager Module
• The cinder.backup.rpcapi Module
• The cinder.brick.local_dev.lvm Module
• The cinder.cmd.api Module
• The cinder.cmd.backup Module
• The cinder.cmd.manage Module
• The cinder.cmd.rtstool Module
• The cinder.cmd.scheduler Module
• The cinder.cmd.volume Module
• The cinder.cmd.volume_usage_audit Module
• The cinder.common.config Module
• The cinder.common.constants Module
• The cinder.common.sqlalchemyutils Module
• The cinder.compute.nova Module
• The cinder.config.generate_cinder_opts Module
• The cinder.consistencygroup.api Module
• The cinder.context Module
• The cinder.coordination Module
• The cinder.db.api Module
• The cinder.db.base Module
• The cinder.db.migration Module
• The cinder.db.sqlalchemy.api Module
• The cinder.db.sqlalchemy.migrate_repo.manage Module
• The cinder.db.sqlalchemy.migrate_repo.versions.061_cinder_init Module
• The cinder.db.sqlalchemy.migrate_repo.versions.062_deleted_type_to_Integer Module
• The cinder.db.sqlalchemy.migrate_repo.versions.063_placeholder Module
• The cinder.db.sqlalchemy.migrate_repo.versions.064_add_restore_volume_id_to_backups Module
• The cinder.db.sqlalchemy.migrate_repo.versions.065_add_replication_info_to_service Module
• The cinder.db.sqlalchemy.migrate_repo.versions.066_add_allocated_id_column_to_reservations Module
• The cinder.db.sqlalchemy.migrate_repo.versions.067_readd_iscsi_targets_table Module
• The cinder.db.sqlalchemy.migrate_repo.versions.068_placeholder Module
• The cinder.db.sqlalchemy.migrate_repo.versions.069_placeholder Module
• The cinder.db.sqlalchemy.migrate_repo.versions.070_placeholder Module
• The cinder.db.sqlalchemy.migrate_repo.versions.071_placeholder Module
• The cinder.db.sqlalchemy.migrate_repo.versions.072_placeholder Module
• The cinder.db.sqlalchemy.migrate_repo.versions.073_drop_available_versions_and_iscsi_targets Module
• The cinder.db.sqlalchemy.migrate_repo.versions.074_add_message_table Module
• The cinder.db.sqlalchemy.migrate_repo.versions.075_add_cluster_and_fields Module
• The cinder.db.sqlalchemy.migrate_repo.versions.076_add_workers_table Module
• The cinder.db.sqlalchemy.migrate_repo.versions.077_add_group_types_and_group_specs_table Module
• The cinder.db.sqlalchemy.migrate_repo.versions.078_add_groups_and_group_volume_type_mapping_table Module
• The cinder.db.sqlalchemy.migrate_repo.versions.079_add_group_snapshots Module
• The cinder.db.sqlalchemy.migrate_repo.versions.080_placeholder Module
• The cinder.db.sqlalchemy.migrate_repo.versions.081_placeholder Module
• The cinder.db.sqlalchemy.migrate_repo.versions.082_placeholder Module
• The cinder.db.sqlalchemy.migrate_repo.versions.083_placeholder Module
• The cinder.db.sqlalchemy.migrate_repo.versions.084_placeholder Module
• The cinder.db.sqlalchemy.migrate_repo.versions.085_modify_workers_updated_at Module
• The cinder.db.sqlalchemy.migrate_repo.versions.086_create_default_cgsnapshot_type Module
• The cinder.db.sqlalchemy.migrate_repo.versions.087_allow_null_request_id_in_message Module
• The cinder.db.sqlalchemy.migrate_repo.versions.088_add_replication_info_to_cluster Module
• The cinder.db.sqlalchemy.migrate_repo.versions.089_add_cluster_name_image_cache Module
• The cinder.db.sqlalchemy.migrate_repo.versions.090_add_race_preventer_to_workers Module
• The cinder.db.sqlalchemy.migrate_repo.versions.091_add_attachment_specs Module
• The cinder.db.sqlalchemy.migrate_repo.versions.092_placeholder Module
• The cinder.db.sqlalchemy.migrate_repo.versions.093_placeholder Module
• The cinder.db.sqlalchemy.migrate_repo.versions.094_placeholder Module
• The cinder.db.sqlalchemy.migrate_repo.versions.095_placeholder Module
• The cinder.db.sqlalchemy.migrate_repo.versions.096_placeholder Module
• The cinder.db.sqlalchemy.models Module
• The cinder.exception Module
• The cinder.flow_utils Module
• The cinder.group.api Module
• The cinder.hacking.checks Module
• The cinder.i18n Module
• The cinder.image.cache Module
• The cinder.image.glance Module
• The cinder.image.image_utils Module
• The cinder.interface.backup_chunked_driver Module
• The cinder.interface.backup_driver Module
• The cinder.interface.backup_verify_driver Module
• The cinder.interface.base Module
• The cinder.interface.fczm_driver Module
• The cinder.interface.util Module
• The cinder.interface.volume_consistencygroup_driver Module
• The cinder.interface.volume_driver Module
• The cinder.interface.volume_group_driver Module
• The cinder.interface.volume_management_driver Module
• The cinder.interface.volume_snapshot_driver Module
• The cinder.interface.volume_snapshotmanagement_driver Module
• The cinder.keymgr.conf_key_mgr Module
• The cinder.manager Module
• The cinder.message.api Module
• The cinder.message.defined_messages Module
• The cinder.message.resource_types Module
• The cinder.objects.backup Module
• The cinder.objects.base Module
• The cinder.objects.cgsnapshot Module
• The cinder.objects.cleanable Module
• The cinder.objects.cleanup_request Module
• The cinder.objects.cluster Module
• The cinder.objects.consistencygroup Module
• The cinder.objects.fields Module
• The cinder.objects.group Module
• The cinder.objects.group_snapshot Module
• The cinder.objects.group_type Module
• The cinder.objects.manageableresources Module
• The cinder.objects.qos_specs Module
• The cinder.objects.request_spec Module
• The cinder.objects.service Module
• The cinder.objects.snapshot Module
• The cinder.objects.volume Module
• The cinder.objects.volume_attachment Module
• The cinder.objects.volume_type Module
• The cinder.opts Module
• The cinder.policy Module
• The cinder.quota Module
• The cinder.quota_utils Module
• The cinder.rpc Module
• The cinder.scheduler.base_filter Module
• The cinder.scheduler.base_handler Module
• The cinder.scheduler.base_weight Module
• The cinder.scheduler.driver Module
• The cinder.scheduler.evaluator.evaluator Module
• The cinder.scheduler.filter_scheduler Module
• The cinder.scheduler.filters.affinity_filter Module
• The cinder.scheduler.filters.availability_zone_filter Module
• The cinder.scheduler.filters.capabilities_filter Module
• The cinder.scheduler.filters.capacity_filter Module
• The cinder.scheduler.filters.driver_filter Module
• The cinder.scheduler.filters.extra_specs_ops Module
• The cinder.scheduler.filters.ignore_attempted_hosts_filter Module
• The cinder.scheduler.filters.instance_locality_filter Module
• The cinder.scheduler.filters.json_filter Module
• The cinder.scheduler.flows.create_volume Module
• The cinder.scheduler.host_manager Module
• The cinder.scheduler.manager Module
• The cinder.scheduler.rpcapi Module
• The cinder.scheduler.scheduler_options Module
• The cinder.scheduler.weights.capacity Module
• The cinder.scheduler.weights.chance Module
• The cinder.scheduler.weights.goodness Module
• The cinder.scheduler.weights.stochastic Module
• The cinder.scheduler.weights.volume_number Module
• The cinder.service Module
• The cinder.ssh_utils Module
• The cinder.test Module
• The cinder.transfer.api Module
• The cinder.utils Module
• The cinder.version Module
• The cinder.volume.api Module
• The cinder.volume.configuration Module
• The cinder.volume.driver Module
• The cinder.volume.driver_utils Module
• The cinder.volume.drivers.block_device Module
• The cinder.volume.drivers.blockbridge Module
• The cinder.volume.drivers.cloudbyte.cloudbyte Module
• The cinder.volume.drivers.cloudbyte.options Module
• The cinder.volume.drivers.coho Module
• The cinder.volume.drivers.coprhd.common Module
• The cinder.volume.drivers.coprhd.fc Module
• The cinder.volume.drivers.coprhd.helpers.authentication Module
• The cinder.volume.drivers.coprhd.helpers.commoncoprhdapi Module
• The cinder.volume.drivers.coprhd.helpers.consistencygroup Module
• The cinder.volume.drivers.coprhd.helpers.exportgroup Module
• The cinder.volume.drivers.coprhd.helpers.host Module
• The cinder.volume.drivers.coprhd.helpers.project Module
• The cinder.volume.drivers.coprhd.helpers.snapshot Module
• The cinder.volume.drivers.coprhd.helpers.tag Module
• The cinder.volume.drivers.coprhd.helpers.tenant Module
• The cinder.volume.drivers.coprhd.helpers.urihelper Module
• The cinder.volume.drivers.coprhd.helpers.virtualarray Module
• The cinder.volume.drivers.coprhd.helpers.virtualpool Module
• The cinder.volume.drivers.coprhd.helpers.volume Module
• The cinder.volume.drivers.coprhd.iscsi Module
• The cinder.volume.drivers.coprhd.scaleio Module
• The cinder.volume.drivers.datera.datera_api2 Module
• The cinder.volume.drivers.datera.datera_api21 Module
• The cinder.volume.drivers.datera.datera_common Module
• The cinder.volume.drivers.datera.datera_iscsi Module
• The cinder.volume.drivers.dell.dell_storagecenter_api Module
• The cinder.volume.drivers.dell.dell_storagecenter_common Module
• The cinder.volume.drivers.dell.dell_storagecenter_fc Module
• The cinder.volume.drivers.dell.dell_storagecenter_iscsi Module
• The cinder.volume.drivers.dell_emc.ps Module
• The cinder.volume.drivers.dell_emc.scaleio.driver Module
• The cinder.volume.drivers.dell_emc.unity.adapter Module
• The cinder.volume.drivers.dell_emc.unity.client Module
• The cinder.volume.drivers.dell_emc.unity.driver Module
• The cinder.volume.drivers.dell_emc.unity.utils Module
• The cinder.volume.drivers.dell_emc.vmax.common Module
• The cinder.volume.drivers.dell_emc.vmax.fast Module
• The cinder.volume.drivers.dell_emc.vmax.fc Module
• The cinder.volume.drivers.dell_emc.vmax.https Module
• The cinder.volume.drivers.dell_emc.vmax.iscsi Module
• The cinder.volume.drivers.dell_emc.vmax.masking Module
• The cinder.volume.drivers.dell_emc.vmax.provision Module
• The cinder.volume.drivers.dell_emc.vmax.provision_v3 Module
• The cinder.volume.drivers.dell_emc.vmax.utils Module
• The cinder.volume.drivers.dell_emc.vnx.adapter Module
• The cinder.volume.drivers.dell_emc.vnx.client Module
• The cinder.volume.drivers.dell_emc.vnx.common Module
• The cinder.volume.drivers.dell_emc.vnx.const Module
• The cinder.volume.drivers.dell_emc.vnx.driver Module
• The cinder.volume.drivers.dell_emc.vnx.taskflows Module
• The cinder.volume.drivers.dell_emc.vnx.utils Module
• The cinder.volume.drivers.dell_emc.xtremio Module
• The cinder.volume.drivers.disco.disco Module
• The cinder.volume.drivers.disco.disco_api Module
• The cinder.volume.drivers.disco.disco_attach_detach Module
• The cinder.volume.drivers.dothill.dothill_client Module
• The cinder.volume.drivers.dothill.dothill_common Module
• The cinder.volume.drivers.dothill.dothill_fc Module
• The cinder.volume.drivers.dothill.dothill_iscsi Module
• The cinder.volume.drivers.drbdmanagedrv Module
• The cinder.volume.drivers.falconstor.fc Module
• The cinder.volume.drivers.falconstor.fss_common Module
• The cinder.volume.drivers.falconstor.iscsi Module
• The cinder.volume.drivers.falconstor.rest_proxy Module
• The cinder.volume.drivers.fujitsu.eternus_dx_common Module
• The cinder.volume.drivers.fujitsu.eternus_dx_fc Module
• The cinder.volume.drivers.fujitsu.eternus_dx_iscsi Module
• The cinder.volume.drivers.fusionstorage.dsware Module
• The cinder.volume.drivers.fusionstorage.fspythonapi Module
• The cinder.volume.drivers.hgst Module
• The cinder.volume.drivers.hitachi.hbsd_basiclib Module
• The cinder.volume.drivers.hitachi.hbsd_common Module
• The cinder.volume.drivers.hitachi.hbsd_fc Module
• The cinder.volume.drivers.hitachi.hbsd_horcm Module
• The cinder.volume.drivers.hitachi.hbsd_iscsi Module
• The cinder.volume.drivers.hitachi.hbsd_snm2 Module
• The cinder.volume.drivers.hitachi.hnas_backend Module
• The cinder.volume.drivers.hitachi.hnas_iscsi Module
• The cinder.volume.drivers.hitachi.hnas_nfs Module
• The cinder.volume.drivers.hitachi.hnas_utils Module
• The cinder.volume.drivers.hitachi.vsp_common Module
• The cinder.volume.drivers.hitachi.vsp_fc Module
• The cinder.volume.drivers.hitachi.vsp_horcm Module
• The cinder.volume.drivers.hitachi.vsp_horcm_fc Module
• The cinder.volume.drivers.hitachi.vsp_horcm_iscsi Module
• The cinder.volume.drivers.hitachi.vsp_iscsi Module
• The cinder.volume.drivers.hitachi.vsp_utils Module
• The cinder.volume.drivers.hpe.hpe_3par_common Module
• The cinder.volume.drivers.hpe.hpe_3par_fc Module
• The cinder.volume.drivers.hpe.hpe_3par_iscsi Module
• The cinder.volume.drivers.hpe.hpe_lefthand_iscsi Module
• The cinder.volume.drivers.hpe.hpe_xp_fc Module
• The cinder.volume.drivers.hpe.hpe_xp_opts Module
• The cinder.volume.drivers.huawei.constants Module
• The cinder.volume.drivers.huawei.fc_zone_helper Module
• The cinder.volume.drivers.huawei.huawei_conf Module
• The cinder.volume.drivers.huawei.huawei_driver Module
• The cinder.volume.drivers.huawei.huawei_utils Module
• The cinder.volume.drivers.huawei.hypermetro Module
• The cinder.volume.drivers.huawei.replication Module
• The cinder.volume.drivers.huawei.rest_client Module
• The cinder.volume.drivers.huawei.smartx Module
• The cinder.volume.drivers.ibm.flashsystem_common Module
• The cinder.volume.drivers.ibm.flashsystem_fc Module
• The cinder.volume.drivers.ibm.flashsystem_iscsi Module
• The cinder.volume.drivers.ibm.gpfs Module
• The cinder.volume.drivers.ibm.ibm_storage.certificate Module
• The cinder.volume.drivers.ibm.ibm_storage.cryptish Module
• The cinder.volume.drivers.ibm.ibm_storage.ds8k_connection Module
• The cinder.volume.drivers.ibm.ibm_storage.ds8k_helper Module
• The cinder.volume.drivers.ibm.ibm_storage.ds8k_proxy Module
• The cinder.volume.drivers.ibm.ibm_storage.ds8k_replication Module
• The cinder.volume.drivers.ibm.ibm_storage.ds8k_restclient Module
• The cinder.volume.drivers.ibm.ibm_storage.ibm_storage Module
• The cinder.volume.drivers.ibm.ibm_storage.proxy Module
• The cinder.volume.drivers.ibm.ibm_storage.strings Module
• The cinder.volume.drivers.ibm.ibm_storage.xiv_proxy Module
• The cinder.volume.drivers.ibm.storwize_svc.replication Module
• The cinder.volume.drivers.ibm.storwize_svc.storwize_const Module
• The cinder.volume.drivers.ibm.storwize_svc.storwize_svc_common Module
• The cinder.volume.drivers.ibm.storwize_svc.storwize_svc_fc Module
• The cinder.volume.drivers.ibm.storwize_svc.storwize_svc_iscsi Module
• The cinder.volume.drivers.infinidat Module
• The cinder.volume.drivers.infortrend.infortrend_fc_cli Module
• The cinder.volume.drivers.infortrend.infortrend_iscsi_cli Module
• The cinder.volume.drivers.infortrend.raidcmd_cli.cli_factory Module
• The cinder.volume.drivers.infortrend.raidcmd_cli.common_cli Module
• The cinder.volume.drivers.kaminario.kaminario_common Module
• The cinder.volume.drivers.kaminario.kaminario_fc Module
• The cinder.volume.drivers.kaminario.kaminario_iscsi Module
• The cinder.volume.drivers.lenovo.lenovo_client Module
• The cinder.volume.drivers.lenovo.lenovo_common Module
• The cinder.volume.drivers.lenovo.lenovo_fc Module
• The cinder.volume.drivers.lenovo.lenovo_iscsi Module
• The cinder.volume.drivers.lvm Module
• The cinder.volume.drivers.nec.cli Module
• The cinder.volume.drivers.nec.volume Module
• The cinder.volume.drivers.nec.volume_common Module
• The cinder.volume.drivers.nec.volume_helper Module
• The cinder.volume.drivers.netapp.common Module
• The cinder.volume.drivers.netapp.dataontap.block_7mode Module
• The cinder.volume.drivers.netapp.dataontap.block_base Module
• The cinder.volume.drivers.netapp.dataontap.block_cmode Module
• The cinder.volume.drivers.netapp.dataontap.client.api Module
• The cinder.volume.drivers.netapp.dataontap.client.client_7mode Module
• The cinder.volume.drivers.netapp.dataontap.client.client_base Module
• The cinder.volume.drivers.netapp.dataontap.client.client_cmode Module
• The cinder.volume.drivers.netapp.dataontap.fc_7mode Module
• The cinder.volume.drivers.netapp.dataontap.fc_cmode Module
• The cinder.volume.drivers.netapp.dataontap.iscsi_7mode Module
• The cinder.volume.drivers.netapp.dataontap.iscsi_cmode Module
• The cinder.volume.drivers.netapp.dataontap.nfs_7mode Module
• The cinder.volume.drivers.netapp.dataontap.nfs_base Module
• The cinder.volume.drivers.netapp.dataontap.nfs_cmode Module
• The cinder.volume.drivers.netapp.dataontap.performance.perf_7mode Module
• The cinder.volume.drivers.netapp.dataontap.performance.perf_base Module
• The cinder.volume.drivers.netapp.dataontap.performance.perf_cmode Module
• The cinder.volume.drivers.netapp.dataontap.utils.capabilities Module
• The cinder.volume.drivers.netapp.dataontap.utils.data_motion Module
• The cinder.volume.drivers.netapp.dataontap.utils.loopingcalls Module
• The cinder.volume.drivers.netapp.dataontap.utils.utils Module
• The cinder.volume.drivers.netapp.eseries.client Module
• The cinder.volume.drivers.netapp.eseries.exception Module
• The cinder.volume.drivers.netapp.eseries.fc_driver Module
• The cinder.volume.drivers.netapp.eseries.host_mapper Module
• The cinder.volume.drivers.netapp.eseries.iscsi_driver Module
• The cinder.volume.drivers.netapp.eseries.library Module
• The cinder.volume.drivers.netapp.eseries.utils Module
• The cinder.volume.drivers.netapp.options Module
• The cinder.volume.drivers.netapp.utils Module
• The cinder.volume.drivers.nexenta.iscsi Module
• The cinder.volume.drivers.nexenta.jsonrpc Module
• The cinder.volume.drivers.nexenta.nexentaedge.iscsi Module
• The cinder.volume.drivers.nexenta.nexentaedge.jsonrpc Module
• The cinder.volume.drivers.nexenta.nexentaedge.nbd Module
• The cinder.volume.drivers.nexenta.nfs Module
• The cinder.volume.drivers.nexenta.ns5.iscsi Module
• The cinder.volume.drivers.nexenta.ns5.jsonrpc Module
• The cinder.volume.drivers.nexenta.ns5.nfs Module
• The cinder.volume.drivers.nexenta.options Module
• The cinder.volume.drivers.nexenta.utils Module
• The cinder.volume.drivers.nfs Module
• The cinder.volume.drivers.nimble Module
• The cinder.volume.drivers.prophetstor.dpl_fc Module
• The cinder.volume.drivers.prophetstor.dpl_iscsi Module
• The cinder.volume.drivers.prophetstor.dplcommon Module
• The cinder.volume.drivers.prophetstor.options Module
• The cinder.volume.drivers.pure Module
• The cinder.volume.drivers.qnap Module
• The cinder.volume.drivers.quobyte Module
• The cinder.volume.drivers.rbd Module
• The cinder.volume.drivers.reduxio.rdx_cli_api Module
• The cinder.volume.drivers.reduxio.rdx_iscsi_driver Module
• The cinder.volume.drivers.remotefs Module
• The cinder.volume.drivers.san.hp.hpmsa_client Module
• The cinder.volume.drivers.san.hp.hpmsa_common Module
• The cinder.volume.drivers.san.hp.hpmsa_fc Module
• The cinder.volume.drivers.san.hp.hpmsa_iscsi Module
• The cinder.volume.drivers.san.san Module
• The cinder.volume.drivers.sheepdog Module
• The cinder.volume.drivers.smbfs Module
• The cinder.volume.drivers.solidfire Module
• The cinder.volume.drivers.synology.synology_common Module
• The cinder.volume.drivers.synology.synology_iscsi Module
• The cinder.volume.drivers.tegile Module
• The cinder.volume.drivers.tintri Module
• The cinder.volume.drivers.violin.v7000_common Module
• The cinder.volume.drivers.violin.v7000_fcp Module
• The cinder.volume.drivers.violin.v7000_iscsi Module
• The cinder.volume.drivers.vmware.datastore Module
• The cinder.volume.drivers.vmware.exceptions Module
• The cinder.volume.drivers.vmware.vmdk Module
• The cinder.volume.drivers.vmware.volumeops Module
• The cinder.volume.drivers.vzstorage Module
• The cinder.volume.drivers.windows.constants Module
• The cinder.volume.drivers.windows.smbfs Module
• The cinder.volume.drivers.windows.windows Module
• The cinder.volume.drivers.xio Module
• The cinder.volume.drivers.zadara Module
• The cinder.volume.drivers.zfssa.restclient Module
• The cinder.volume.drivers.zfssa.webdavclient Module
• The cinder.volume.drivers.zfssa.zfssaiscsi Module
• The cinder.volume.drivers.zfssa.zfssanfs Module
• The cinder.volume.drivers.zfssa.zfssarest Module
• The cinder.volume.drivers.zte.zte_ks Module
• The cinder.volume.drivers.zte.zte_pub Module
• The cinder.volume.flows.api.create_volume Module
• The cinder.volume.flows.api.manage_existing Module
• The cinder.volume.flows.common Module
• The cinder.volume.flows.manager.create_volume Module
• The cinder.volume.flows.manager.manage_existing Module
• The cinder.volume.flows.manager.manage_existing_snapshot Module
• The cinder.volume.group_types Module
• The cinder.volume.manager Module
• The cinder.volume.qos_specs Module
• The cinder.volume.rpcapi Module
• The cinder.volume.targets.cxt Module
• The cinder.volume.targets.driver Module
• The cinder.volume.targets.fake Module
• The cinder.volume.targets.iet Module
• The cinder.volume.targets.iscsi Module
• The cinder.volume.targets.lio Module
• The cinder.volume.targets.scst Module
• The cinder.volume.targets.tgt Module
• The cinder.volume.throttling Module
• The cinder.volume.utils Module
• The cinder.volume.volume_types Module
• The cinder.wsgi.common Module
• The cinder.wsgi.eventlet_server Module
• The cinder.wsgi.wsgi Module
• The cinder.zonemanager.drivers.brocade.brcd_fabric_opts Module
• The cinder.zonemanager.drivers.brocade.brcd_fc_san_lookup_service Module
• The cinder.zonemanager.drivers.brocade.brcd_fc_zone_client_cli Module
• The cinder.zonemanager.drivers.brocade.brcd_fc_zone_connector_factory Module
• The cinder.zonemanager.drivers.brocade.brcd_fc_zone_driver Module
• The cinder.zonemanager.drivers.brocade.brcd_http_fc_zone_client Module
• The cinder.zonemanager.drivers.brocade.fc_zone_constants Module
• The cinder.zonemanager.drivers.cisco.cisco_fabric_opts Module
• The cinder.zonemanager.drivers.cisco.cisco_fc_san_lookup_service Module
• The cinder.zonemanager.drivers.cisco.cisco_fc_zone_client_cli Module
• The cinder.zonemanager.drivers.cisco.cisco_fc_zone_driver Module
• The cinder.zonemanager.drivers.cisco.fc_zone_constants Module
• The cinder.zonemanager.drivers.driver_utils Module
• The cinder.zonemanager.drivers.fc_zone_driver Module
• The cinder.zonemanager.fc_common Module
• The cinder.zonemanager.fc_san_lookup_service Module
• The cinder.zonemanager.fc_zone_manager Module
• The cinder.zonemanager.fczm_constants Module
• The cinder.zonemanager.utils Module

Module Reference

• Services, Managers and Drivers
  • The cinder.service Module
  • The cinder.manager Module
  • Implementation-Specific Drivers
• The Database Layer
  • The cinder.db.api Module
  • The Sqlalchemy Driver
    • The cinder.db.sqlalchemy.api Module
    • The cinder.db.sqlalchemy.models Module
  • Tests
• Storage Volumes, Disks
  • The cinder.volume.manager Module
  • The cinder.volume.driver Module
  • Tests
    • The cinder.tests.unit.volume Module
  • Old Docs
• Authentication and Authorization
  • The cinder.api.middleware.auth Module
  • The cinder.quota Module
    • Tests
  • The middleware.test_auth Module
  • The test_quota Module
  • The test_quota_utils Module
    • Legacy Docs
    • Introduction
    • Relationship of US eAuth to RBAC
    • Roles
    • Enhancements
    • CloudAudit APIs
    • Type declarations
    • Request Brokering
    • Dirty Cloud - Hybrid Data Centers
    • The Details
    • System limits
    • Further Challenges
• API Endpoint
  • Common Components
    • The cinder.api Module
  • Tests
    • The api Module
    • The api.fakes Module
    • The api.openstack Module
    • The api.openstack.test_wsgi Module
    • The test_auth Module
    • The test_faults Module
• Scheduler
  • The cinder.scheduler.manager Module
  • The cinder.scheduler.driver Module
  • The cinder.scheduler.filter_scheduler Driver
  • Tests
    • The cinder.tests.unit.scheduler Module
• Fake Drivers
  • The cinder.tests.unit.test_service.FakeManager Class
  • The cinder.tests.unit.api.fakes Module
• Common and Misc Libraries
  • The cinder.context Module
  • The cinder.exception Module
  • The cinder.common.config Module
  • The cinder.rpc Module
  • The cinder.test Module
  • The cinder.utils Module
  • The cinder.wsgi Module
  • Tests
    • The conf_fixture Module
    • The test_rpc Module

Indices and tables

• Index
• Module Index
• Search Page