metallb-operator icon indicating copy to clipboard operation
metallb-operator copied to clipboard

Published 20 hours ago • verified publisher icon metallb

Document MetalLB CRD parameters

Open liornoy opened this issue 2 years ago • 10 comments

As for this pr: https://github.com/metallb/metallb-operator/pull/239 we have many different parameters for MetalLB CRD, making the operator to deploy it in different ways. However, the doc only displays this lean CRD version:

apiVersion: metallb.io/v1beta1
kind: MetalLB
metadata:
  name: metallb
  namespace: metallb-system

We should document the different available parameters.

liornoy avatar Nov 10 '22 13:11 liornoy

Yep, makes sense

fedepaol avatar Nov 10 '22 13:11 fedepaol

Do you want to document the CRD parameters on the installation page? @liornoy @fedepaol

roopeshsn avatar Jan 14 '24 06:01 roopeshsn

I think the "Using the MetalLB Operator" section in the installation page could be a good place for it.

liornoy avatar Jan 14 '24 09:01 liornoy

I think the "Using the MetalLB Operator" section in the installation page could be a good place for it.

Thanks, I'll work on it! Also the documentation also lags the operator installation steps right? First the CRD need to applied and then deploying the operator as a pod right?

Edit: Alright there is one option to install this operator that's via operatorhub.

roopeshsn avatar Jan 14 '24 11:01 roopeshsn

I drafted the documentation for the additional operator parameters to create a custom resource of kind MetalLB. I referenced the types and tests written in the PR #239. Let me know if any changes are required @liornoy

roopeshsn avatar Jan 15 '24 08:01 roopeshsn

Thanks! I'll review this soon :)

liornoy avatar Jan 15 '24 08:01 liornoy

@roopeshsn Thanks again! I think it's great that you put an example of metallb.yaml that includes all of the optional fields (I think it's only missing the "RuntimeClassName" field in this manifest). And on the bottom section you added a description for each field. I think this is a great and necessary addition. We need to figure out where does it fit in metallb's website and later produce a PR that can we discuss on. The relevant pages in the website imo would be https://metallb.universe.tf/apis/ and https://github.com/metallb/metallb/blob/main/website/content/installation/_index.md#using-the-metallb-operator

liornoy avatar Jan 15 '24 12:01 liornoy

Thanks for the review! I think we'll put the example manifest on the installation page (https://github.com/metallb/metallb/blob/main/website/content/installation/_index.md#using-the-metallb-operator) and redirect readers to the APIs page ( https://metallb.universe.tf/apis/) for the detailed reference on parameter types by mentioning a link.

roopeshsn avatar Jan 16 '24 04:01 roopeshsn

@roopeshsn hey, sorry to ping after so much time. Just checking if you are still interested in moving this forward.

fedepaol avatar Apr 15 '24 09:04 fedepaol

@roopeshsn hey, sorry to ping after so much time. Just checking if you are still interested in moving this forward.

Sure, @fedepaol! What do you have in mind? What exactly should I need to work on?

roopeshsn avatar Apr 15 '24 16:04 roopeshsn