Skip to content

Latest commit

 

History

History
24 lines (23 loc) · 1.71 KB

index.md

File metadata and controls

24 lines (23 loc) · 1.71 KB
Raw

Documentation index

  • README - Project overview and high-level architecture descriptions.
  • Index - This index
  • Running the ImageAPI service - Options and considerations for running the ImageAPI service.
  • Security Considerations - Some security considerations when running the ImageAPI service.
  • API Documentation - Auto-generated, human-readable API documentation.
  • Attachments
    • iSCSI - Attaching iSCSI LUNs.
    • Local - Using a local block device as an attachment.
    • Loopback - Attaching files as Loopback devices.
    • RBD - Attaching Ceph/RBD objects.
  • Mounts
    • Attach - Mounting filesystems on Attachments.
    • Bind - Mounting sub-directories as Mounts.
    • NFS - Mounting and using NFS shares.
    • Overlay - Overlay mounting read-only mounts to make them read-write.
  • Containers - Defining and using Containers.
  • Examples
    • Full Interaction - A walkthrough of a full set of interactions (via curl) with the ImageAPI.
    • Scheme: NFS - Example defintions for using read-only NFS mounts + Overlay for images.
    • Scheme: NFS + Loopback - Example definitions for using read-only NFS mounts with SquashFS files for images.
    • Scheme: RBD - Example definitions for using read-only RBD attach + Overlay for images.
    • Scheme: iSCSI - Example definitions for using read-only iSCSI attach + Overlay for images.