{"id":44539244,"url":"https://github.com/simplyblock/simplyblock-proxmox","last_synced_at":"2026-02-13T18:55:09.681Z","repository":{"id":282248008,"uuid":"944419602","full_name":"simplyblock/simplyblock-proxmox","owner":"simplyblock","description":null,"archived":false,"fork":false,"pushed_at":"2025-08-29T11:41:35.000Z","size":40,"stargazers_count":6,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-08-29T14:48:35.994Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Perl","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/simplyblock.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-03-07T10:08:47.000Z","updated_at":"2025-08-29T11:41:32.000Z","dependencies_parsed_at":"2025-04-23T16:42:46.525Z","dependency_job_id":"1a02cdd9-bfed-4bb3-a8f6-f2ff750dd2f0","html_url":"https://github.com/simplyblock/simplyblock-proxmox","commit_stats":null,"previous_names":["mxsrc/simplyblock-proxmox","simplyblock-io/simplyblock-proxmox","simplyblock/simplyblock-proxmox"],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/simplyblock/simplyblock-proxmox","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simplyblock%2Fsimplyblock-proxmox","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simplyblock%2Fsimplyblock-proxmox/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simplyblock%2Fsimplyblock-proxmox/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simplyblock%2Fsimplyblock-proxmox/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/simplyblock","download_url":"https://codeload.github.com/simplyblock/simplyblock-proxmox/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simplyblock%2Fsimplyblock-proxmox/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29414285,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-13T06:24:03.484Z","status":"ssl_error","status_checked_at":"2026-02-13T06:23:12.830Z","response_time":78,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-02-13T18:55:09.537Z","updated_at":"2026-02-13T18:55:09.658Z","avatar_url":"https://github.com/simplyblock.png","language":"Perl","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Simplyblock Proxmox integration\n\n**High-performance NVMe-first software-defined block storage for Proxmox VE**\n\n[![Docs](https://img.shields.io/badge/Docs-simplyblock-green)](https://docs.simplyblock.io/latest/deployments/proxmox/) [![Issues](https://img.shields.io/github/issues/simplyblock/simplyblock-proxmox)](https://github.com/simplyblock/simplyblock-proxmox/issues)\n\n![](assets/simplyblock-logo.svg)\n\n---\n\n## 🚀 Overview\n\n`simplyblock-proxmox` is the official **simplyblock storage plugin for Proxmox VE**. \n\nIt enables **enterprise-grade, NVMe/TCP-powered block storage** directly inside Proxmox, offering high performance, scalability, and resilience without the need for specialized hardware or vendor lock-in.\n\nWith simplyblock, you can seamlessly integrate **software-defined storage (SDS)** into your Proxmox environment, enabling support for advanced features like:\n\n- ⚡ **Ultra-low latency**: Unlock performance with NVMe-over-TCP\n- 🧩 **Native Proxmox integration**: Manage volumes directly in Proxmox\n- 🛡️ **Enterprise data services**: Snapshots, clones, erasure coding, multi-tenancy\n- 🔒 **Secure \u0026 robust**: Cluster authentication and Quality of Service (QoS)\n- ☁️ **Cloud \u0026 on-prem flexibility**: Deploy anywhere Proxmox runs\n\n👉 For full documentation, see the [Simplyblock Proxmox Deployment Guide](https://docs.simplyblock.io/latest/deployments/proxmox/).\n\n---\n\n## ✨ Features\n\n| Feature                           | Benefit                                                                 |\n|----------------------------------|-------------------------------------------------------------------------|\n| **Proxmox Plugin**               | Storage lifecycle fully managed with the Proxmox UI                     |\n| **NVMe/TCP Support**              | High throughput, low latency storage over standard Ethernet              |\n| **Snapshots \u0026 Clones**           | Efficient data protection and instant provisioning                      |\n| **Erasure Coding**                | Fault-tolerant, space-efficient redundancy                             |\n| **Multi-tenancy \u0026 QoS**          | Isolated tenants with guaranteed IOPS, bandwidth, and latency           |\n| **Resilient Networking**         | Supports redundant or isolated storage/control networks                  |\n| **Auto-Reconnect**               | Automatic reconnection of NVMe devices after network or host failures   |\n\n---\n\n## 📦 Quick Start Guide\n\nThe following section acts as a quick start guide. For the full documentation see the [Simplyblock Proxmox Deployment Guide](https://docs.simplyblock.io/latest/deployments/proxmox/).\n\n### 1. Add the Simplyblock Repository\n\nRun as **root** or via `sudo`:\n\n```bash\ncurl https://install.simplyblock.io/install-debian-repository | bash\n````\n\nOr set it up manually:\n\n```bash\ncurl -o /etc/apt/keyrings/simplyblock.gpg https://install.simplyblock.io/simplyblock.key\necho 'deb [signed-by=/etc/apt/keyrings/simplyblock.gpg] https://install.simplyblock.io/debian stable main' | \\\n  tee /etc/apt/sources.list.d/simplyblock.list\n```\n\n### 2. Install the Plugin\n\n```bash\napt update\napt install simplyblock-proxmox\n```\n\nThis installs the storage plugin and makes it available inside Proxmox VE.\n\n---\n\n## ⚙️ Configuration\n\nRegister a simplyblock storage backend in Proxmox:\n\n```bash\npvesm add simplyblock \u003cSTORAGE_NAME\u003e \\\n  --entrypoint=\u003cCONTROL_PLANE_ADDR\u003e \\\n  --cluster=\u003cCLUSTER_ID\u003e \\\n  --secret=\u003cCLUSTER_SECRET\u003e \\\n  --pool=\u003cSTORAGE_POOL_NAME\u003e\n```\n\n### Parameters\n\n* `STORAGE_NAME`: Display name of the storage in Proxmox\n* `CONTROL_PLANE_ADDR`: IP/hostname of the simplyblock control plane\n* `CLUSTER_ID`: Id of the simplyblock cluster (retrieved from `sbctl cluster list`)\n* `CLUSTER_SECRET`: Authentication secret (retrieved from `sbctl cluster get-secret`)\n* `STORAGE_POOL_NAME`: Storage pool name inside the simplyblock storage plane\n\n👉 Run `sbctl cluster list` and `sbctl cluster get-secret` to retrieve cluster details.\n\nOnce added, you can manage simplyblock storage like any other backend, directly from the **Proxmox GUI or CLI**.\n\n---\n\n## 🖥️ Usage\n\n* Create VMs and containers using simplyblock volumes.\n* Manage volumes directly via the **Proxmox Storage panel**.\n* Use CLI for advanced workflows:\n\n  ```bash\n  pvesm list \u003cSTORAGE-NAME\u003e\n  pvesm alloc \u003cSTORAGE-NAME\u003e \u003cVM-ID\u003e \u003cSIZE\u003e\n  pvesm free \u003cSTORAGE-NAME\u003e \u003cVOLUME-ID\u003e\n  ```\n\n---\n\n## 📚 Documentation\n\n* [Deployment Guide](https://docs.simplyblock.io/latest/deployments/proxmox/)\n* [Architecture Overview](https://docs.simplyblock.io/latest/architecture/)\n* [Release Notes](https://docs.simplyblock.io/latest/release-notes/)\n* [Maintenance \u0026 Operations](https://docs.simplyblock.io/latest/maintenance-operations/)\n\n---\n\n## 🛠️ Troubleshooting\n\n| Problem                      | Solution                                                                   |                                        |\n| ---------------------------- | -------------------------------------------------------------------------- | -------------------------------------- |\n| Storage not showing in UI    | Verify installation with \\`dpkg -l                                         | grep simplyblock\\` and restart Proxmox |\n| NVMe volume not reconnecting | In Proxmox, auto-reconnect is built in. On plain Linux, run `nvme connect` |                                        |\n| Network contention           | Use dedicated NICs or VLANs; avoid software-only VLANs                     |                                        |\n| Cluster secret not accepted  | Refresh with `sbctl cluster get-secret` and re-register storage            |                                        |\n\nIf issues persist, please [open an issue](https://github.com/simplyblock/simplyblock-proxmox/issues).\n\n---\n\n## 🤝 Contributing\n\nWe welcome community contributions!\n\n1. Fork the repo\n2. Create your feature branch (`git checkout -b feature/my-feature`)\n3. Commit your changes (`git commit -m \"Add my feature\"`)\n4. Push to the branch (`git push origin feature/my-feature`)\n5. Open a Pull Request\n\nBefore contributing, please review:\n\n* `CONTRIBUTING.md` (if available)\n* Open [issues](https://github.com/simplyblock/simplyblock-proxmox/issues) to avoid duplicates\n\n---\n\n## 📬 Support\n\n* 📖 [Documentation](https://docs.simplyblock.io/latest/deployments/proxmox/)\n* 🐞 [GitHub Issues](https://github.com/simplyblock/simplyblock-proxmox/issues)\n* 🌐 [Simplyblock Website](https://www.simplyblock.io)\n\nMaintained by the **simplyblock team**.\n\n## Packaging for Releases\n\n```bash\nEMAIL=\u003cmail\u003e gbp dch --git-author --release --new-version \u003cversion\u003e-1\ngit add debian/changelog\ngit commit -m \"Release v\u003cversion\u003e\"\ngit tag \u003cversion\u003e -m \"Version \u003cversion\u003e\"\ndpkg-buildpackage -b --no-sign  # or push to GitHub\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimplyblock%2Fsimplyblock-proxmox","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsimplyblock%2Fsimplyblock-proxmox","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimplyblock%2Fsimplyblock-proxmox/lists"}