public inbox for pve-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: "Max Carrara" <m.carrara@proxmox.com>
To: "Roland Kammerer" <roland.kammerer@linbit.com>,
	"Proxmox VE development discussion" <pve-devel@lists.proxmox.com>
Subject: Re: [pve-devel] storage plugins: what is plugindata()->{content}[1]
Date: Tue, 25 Feb 2025 11:50:31 +0100	[thread overview]
Message-ID: <D81GW402I9IT.2I6IX7N77DSJQ@proxmox.com> (raw)
In-Reply-To: <Z6X9vOv2lCsvTy3o@arm64>

On Fri Feb 7, 2025 at 1:34 PM CET, Roland Kammerer wrote:
> On Fri, Feb 07, 2025 at 10:18:42AM +0100, Fabian Grünbichler wrote:
> > 
> > > Roland Kammerer via pve-devel <pve-devel@lists.proxmox.com> hat am 07.02.2025 10:02 CET geschrieben:
> > > Hi all,
> > > 
> > > rather simple question I guess, but I could not find the answer in
> > > https://pve.proxmox.com/wiki/Storage_Plugin_Development and linked
> > > documents and looks like my grep foo is lacking today, so here we go:
> > > I guess I know what the first hash in the 'content' array is, but what
> > > is the second? Actually, why is there a second one?
> > > 
> > > Storage/LVMPlugin.pm:
> > > content => [ {images => 1, rootdir => 1}, { images => 1 }]
> > > 
> > > vs.
> > > 
> > > Storage/LvmThinPlugin.pm:
> > > content => [ {images => 1, rootdir => 1}, { images => 1, rootdir => 1}]
> > > 
> > > Best, rck
> > 
> > the first one defines the allowed/valid content types, the second the default one(s):
>
> thanks Fabian and Fiona, that explains it.
>
> > we are working on improving the docs and cleaning all of this up!
>
> that is great news, even after maintaining a plugin for some time it
> usually takes a deep dive into some core code to actually understand
> some of the API. If there is then something to review or give feedback
> from an external plugin dev's point of view feel free to explicitly ping
> me.
>
> Best, rck

Thanks a lot for the offer! I do actually have a couple questions. It
would be nice if you could answer them, as it would aid in cleaning all
this up, but please don't feel like you have to, of course!

Note that I can't guarantee that everything will be incorporated into
the code of course, but I still wanted to reach out, as I'm in the
process of sorting all of this out.

1. Which parts of the plugin API (specifically PVE::Storage::Plugin)
   are hard to grasp / work with?

2. Since you've been working with the code for a while, do you have any
   improvement suggestions for the API? If so, which?
   (Note that by that I don't mean new features and such, but rather
   improvements to the API as a whole -- the subroutines it consists of
   etc.)

3. Are there any parts of the API that you would change? If so, which?

4. Do you think you would benefit from having (API) subroutines
   documented via docstrings?

5. Is there any kind of "tooling" that you'd like to have, which would
   aid you with plugin development? By that I mean things like being
   able to check if your plugin conforms to the current API version and
   such.

6. Is there any other things you'd like to mention? Feedback, critique
   and such are all welcome!

Also, should something pop up in the future that you'd like to mention,
please feel free to ping me here on the mailing list and let me know
what it is (: I'm always grateful for any feedback!

Thanks a lot in advance for your time!



_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel

  parent reply	other threads:[~2025-02-25 10:50 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-02-07  9:02 Roland Kammerer via pve-devel
2025-02-07  9:18 ` Fabian Grünbichler
2025-02-07 12:34   ` Roland Kammerer via pve-devel
2025-02-12 10:57     ` Fabian Grünbichler
     [not found]   ` <Z6X9vOv2lCsvTy3o@arm64>
2025-02-25 10:50     ` Max Carrara [this message]
2025-03-07  8:24       ` Roland Kammerer via pve-devel
     [not found]       ` <Z8qtOTycFZpN5bpL@arm64>
2025-03-07 12:01         ` Roland Kammerer via pve-devel
2025-03-12 11:09         ` Max Carrara
2025-02-07  9:19 ` Fiona Ebner

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=D81GW402I9IT.2I6IX7N77DSJQ@proxmox.com \
    --to=m.carrara@proxmox.com \
    --cc=pve-devel@lists.proxmox.com \
    --cc=roland.kammerer@linbit.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal