[{"_1":2,"_155":-5,"_156":-5},"loaderData",{"_3":4,"_13":14,"_21":22,"_134":135},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17,"_19":11,"_20":11},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_23":24,"_25":-5,"_26":11,"_27":11,"_28":29,"_30":31,"_32":-5,"_33":11,"_34":35,"_84":-5,"_85":86,"_125":-5,"_126":11,"_127":17,"_128":11,"_129":-5,"_130":11,"_131":-5,"_132":133},"canonicalUrl","https://hub.docker.com/r/thinkernel/rbd-docker-plugin/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","thinkernel","reponame","rbd-docker-plugin","cloudBuildSource","isAutobuildsAvailable","repo",{"_36":37,"_38":39,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":51,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":70,"_75":17,"_76":77,"_81":29,"_82":83},"categories",[],"content_types",[40],"image","date_registered","2017-02-28T12:10:41.672997Z","description","docker volume plugin for ceph rbd","is_private","last_updated","2017-03-17T06:46:26.083995Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[52],"application/vnd.docker.container.image.v1+json","name","pull_count",364,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","# Ceph Rados Block Device Docker VolumeDriver Plugin\n\n* Use Case: Persistent Storage for a Single Docker Container\n * an RBD Image can only be used by 1 Docker Container at a time\n\n* Plugin is a separate process running alongside Docker Daemon\n * plugin can only be configured for a single Ceph User (currently no \n good way to pass things from docker -> plugin, get only volume name)\n * run multiple plugin instances for varying configs (ceph user, default pool, default size)\n * can pass extra config via volume name to override default pool and creation size:\n * docker run --volume-driver rbd -v poolname/imagename@size:/mnt/disk1 ...\n\n* plugin supports all Docker VolumeDriver Plugin API commands:\n * Create - can provision Ceph RBD Image in a pool of a certain size\n * controlled by `--create` boolean flag (default false)\n * default size from `--size` flag (default 20480 = 20GB)\n * Mount - Locks, Maps and Mounts RBD Image to the Host system\n * Unmount - Unmounts, Unmaps and Unlocks the RBD Image on request\n * Remove - Removes (destroys) RBD Image on request\n * only called for `docker run --rm -v ...` or `docker rm -v ...`\n * action controlled by plugin's `--remove` flag, which can be one of three values:\n - ''ignore'' - the call to delete the ceph rbd volume is ignored (default)\n - ''rename'' - will cause image to be renamed with _zz_ prefix for later culling\n - ''delete'' - will actually delete ceph rbd image (destructive)\n * Get, List\n\n## Plugin Setup\n\nPlugin is a standalone process and places a Socket file in a known \nlocation. Generally need to start this before running Docker. It does \nnot daemonize as it is expected to be controlled by systemd, so if you \nneed it in the background, use normal shell process control (&).\n\nThe socket has a name (sans .sock) which is used to refer to the plugin\nvia the `--volume-driver=name` docker CLI option, allowing multiple\nuniquely named plugin instances with different default configurations.\n\nThe default name for the socket is \"rbd\", so you would refer to \n`--volume-driver rbd` from docker.\n\nGeneral build/run requirements:\n* librados2-devel and librbd1-devel for go-ceph\n* /usr/bin/rbd for mapping and unmapping to kernel\n* /usr/sbin/mkfs.xfs for fs creation\n* /usr/bin/mount and /usr/bin/umount\n\nTested with Ceph version 0.94.2 on Centos 7.1 host with Docker 1.8.\n\n### Commandline Options\n\n Usage of ./rbd-docker-plugin:\n --ceph-user=\"admin\": Ceph user to use for RBD\n --create=false: Can auto Create RBD Images (default: false)\n --fs=\"xfs\": FS type for the created RBD Image (must have mkfs.type)\n --logdir=\"/var/log\": Logfile directory for RBD Docker Plugin\n --mount=\"/var/lib/docker/volumes\": Mount directory for volumes on host\n --name=\"rbd\": Docker plugin name for use on --volume-driver option\n --plugin-dir=\"/run/docker/plugins\": Docker plugin directory for socket\n --pool=\"rbd\": Default Ceph Pool for RBD operations\n --remove=false: Can Remove (destroy) RBD Images (default: false, volume will be renamed zz_name)\n --size=20480: RBD Image size to Create (in MB) (default: 20480=20GB\n\n### Running Plugin\n\nStart with the default options:\n\n* socket name=rbd, pool=rbd, user=admin, logfile=/var/log/rbd-docker-plugin.log\n* no creation or removal of volumes\n\n sudo rbd-docker-plugin\n # docker run --volume-driver rbd -v ...\n\nFor Debugging: send log to STDERR:\n\n sudo RBD_DOCKER_PLUGIN_DEBUG=1 rbd-docker-plugin\n\nUse a different socket name and Ceph pool\n\n sudo rbd-docker-plugin --name rbd2 --pool liverpool\n # docker run --volume-driver rbd2 -v ...\n\nTo allow creation of new RBD Images:\n\n sudo rbd-docker-plugin --create\n\nTo allow creation and removal:\n\n sudo rbd-docker-plugin --create --remove\n\n### Testing\n\nUse with docker 1.8+ which has the `--volume-driver` support.\n\n* https://docker.com/\n\nAlternatively, you can POST json to the socket to test the functionality\nmanually. If your curl is new enough (v7.40+), you can use the\n`--unix-socket` option and syntax. You can also use [this golang\nversion](https://github.com/Soulou/curl-unix-socket) instead:\n\n go get github.com/Soulou/curl-unix-socket\n\n\nOnce you have that you can POST json to the plugin:\n\n % sudo curl-unix-socket -v -X POST unix:///run/docker/plugins/rbd.sock:/Plugin.Activate\n > POST /Plugin.Activate HTTP/1.1\n > Socket: /run/docker/plugins/rbd.sock\n > Content-Length: 0\n >\n < HTTP/1.1 200 OK\n < Content-Type: appplication/vnd.docker.plugins.v1+json\n < Date: Tue, 28 Jul 2015 18:52:11 GMT\n < Content-Length: 33\n {\"Implements\": [\"VolumeDriver\"]}\n\n\n # Plugin started without --create:\n % sudo curl-unix-socket -v -X POST -d '{\"Name\": \"testimage\"}' unix:///run/docker/plugins/rbd.sock:/VolumeDriver.Create\n > POST /VolumeDriver.Create HTTP/1.1\n > Socket: /run/docker/plugins/rbd.sock\n > Content-Length: 21\n >\n < HTTP/1.1 500 Internal Server Error\n < Content-Length: 62\n < Content-Type: appplication/vnd.docker.plugins.v1+json\n < Date: Tue, 28 Jul 2015 18:53:20 GMT\n {\"Mountpoint\":\"\",\"Err\":\"Ceph RBD Image not found: testimage\"}\n\n # Plugin started --create turned on will create unknown image:\n % sudo curl-unix-socket -v -X POST -d '{\"Name\": \"testimage\"}' unix:///run/docker/plugins/rbd.sock:/VolumeDriver.Create\n > POST /VolumeDriver.Create HTTP/1.1\n > Socket: /run/docker/plugins/rbd.sock\n > Content-Length: 21\n >\n < HTTP/1.1 200 OK\n < Content-Length: 27\n < Content-Type: appplication/vnd.docker.plugins.v1+json\n < Date: Fri, 14 Aug 2015 19:47:35 GMT\n {\"Mountpoint\":\"\",\"Err\":\"\"}\n\n## Examples\n\nIf you need persistent storage for your application container, you can use a Ceph Block Device as a persistent disk.\n\nYou can provision the Block Device and Filesystem first, or allow a\nsufficiently configured Plugin instance create it for you.\nThis plugin can create RBD images with XFS filesystem.\n\n1. (Optional) Provision RBD Storage yourself\n * `sudo rbd create --size 1024 foo`\n * `sudo rbd map foo` => /dev/rbd1\n * `sudo mkfs.xfs /dev/rbd1`\n * `sudo rbd unmap /dev/rbd1`\n2. Or Run the RBD Docker Plugin with `--create` option flag\n * `sudo rbd-docker-plugin --create`\n3. Requesting and Using Storage\n * `docker run --volume-driver=rbd --volume foo:/mnt/foo -it ubuntu /bin/bash`\n * Volume will be locked, mapped and mounted to Host and bind-mounted to container at `/mnt/foo`\n * When container exits, the volume will be unmounted, unmapped and unlocked\n * You can control the RBD Pool and initial Size using this syntax:\n * foo@1024 => pool=rbd (default), image=foo, size 1GB\n * deep/foo => pool=deep, image=foo and default `--size` (20GB)\n * deep/foo@1024 => pool=deep, image=foo, size 1GB\n - pool must already exist\n\n### Misc\n\n* RBD Snapshots: `sudo rbd snap create --image foo --snap foosnap`\n* Resize RBD image:\n * set max size: `sudo rbd resize --size 2048 --image foo`\n * map/mount and then fix XFS: `sudo xfs_growfs -d /mnt/foo`\n\n## TODO\n\n* add cluster config options to support non-default clusters\n* figure out how to test\n * do we need a working ceph cluster?\n * docker containers with ceph?\n\n## Links\n\n### Docker API Documentation\n\n- [Experimental: Extend Docker with a Plugin](https://github.com/docker/docker/blob/master/experimental/plugins.md)\n- [Experimental: Docker Plugin API](https://github.com/docker/docker/blob/master/experimental/plugin_api.md)\n- [Experimental: Docker Volume Plugins](https://github.com/docker/docker/blob/master/experimental/plugins_volume.md)\n\n### Code Examples and Libraries\n\n- https://plugins-demo-2015.github.io\n- [Flocker Docker Plugin](https://docs.clusterhq.com/en/1.0.3/labs/docker-plugin.html)\n- VolumeDriver golang framework: https://github.com/docker/go-plugins-helpers/tree/master/volume\n- GlusterFS Example: https://github.com/calavera/docker-volume-glusterfs\n- KeyWhiz example: https://github.com/calavera/docker-volume-keywhiz\n- Ceph Rados, RBD golang lib: https://github.com/ceph/go-ceph\n\nRelated Projects\n- https://github.com/AcalephStorage/docker-volume-ceph-rbd\n- https://github.com/contiv/volplugin\n\n# Packaging\n\nUsing [tpkg](http://tpkg.github.io) package to distribute and specify \nnative package dependencies. Tested with Centos 7.1 and yum/rpm \npackages.\n\n\n# License\n\nThis project is using the MIT License (MIT), see LICENSE file.\n\nCopyright (c) 2015 YP LLC\n","has_starred","hub_user","immutable_tags_settings",{"_71":11,"_72":73},"enabled","rules",[74],".*","is_automated","permissions",{"_78":17,"_79":11,"_80":11},"read","write","admin","user","storage_size",631652634,"orgData","recentTags",[87],{"_88":40,"_89":90,"_91":92,"_93":94,"_95":96,"_46":114,"_115":90,"_116":29,"_117":52,"_53":118,"_119":120,"_121":105,"_122":114,"_123":62,"_124":17},"content_type","creator",96014,"full_size",631641733,"id",8568083,"images",[97],{"_98":99,"_100":101,"_102":103,"_104":105,"_106":107,"_108":109,"_110":103,"_111":-5,"_112":92,"_59":62,"_113":-5},"architecture","amd64","digest","sha256:a0b7fb46c5eaf87a8375241b91a19179d17e774d2a03fdb32e68ea8dbc52e9a8","features","","last_pulled","2026-09-21T15:57:31.314167972Z","last_pushed","2017-03-01T03:39:19Z","os","linux","os_features","os_version","size","variant","2017-03-01T03:39:19.22291Z","last_updater","last_updater_username","media_type","latest","repository",1287334,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_34":136,"_143":144,"_132":153,"_154":11},{"_36":137,"_38":138,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":139,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":140,"_75":17,"_76":142,"_81":29,"_82":83},[],[40],[52],{"_71":11,"_72":141},[74],{"_78":17,"_79":11,"_80":11},"tags",{"_145":60,"_146":-5,"_147":-5,"_148":149},"count","next","previous","results",[150],{"_88":40,"_89":90,"_91":92,"_93":94,"_95":151,"_46":114,"_115":90,"_116":29,"_117":52,"_53":118,"_119":120,"_121":105,"_122":114,"_123":62,"_124":17},[152],{"_98":99,"_100":101,"_102":103,"_104":105,"_106":107,"_108":109,"_110":103,"_111":-5,"_112":92,"_59":62,"_113":-5},[],"canDeleteTags","actionData","errors"]

thinkernel/rbd-docker-plugin

Tags for thinkernel/rbd-docker-plugin