Defining widget fields via kubernetes automatic service discovery annotations?

[katanacrimson]

Description

I'm not seeing any documented way to define which widget fields are desired when using the kubernetes ingress annotations, documented here. Digging through the code, it almost looked like it was supposed to be parsed out from JSON, like so:

apiVersion: 'networking.k8s.io/v1'
kind: 'Ingress'
metadata:
  name: 'app-ingress'
  namespace: 'calibreweb'
  annotations:
    gethomepage.dev/enabled: 'true'
    gethomepage.dev/name: 'calibre-web'
    gethomepage.dev/description: 'e-book collection'
    gethomepage.dev/href: 'https://...'
    gethomepage.dev/group: 'services'
    gethomepage.dev/icon: 'mdi-book-arrow-down-outline-#bb2d2d'
    gethomepage.dev/widget.type: 'calibreweb'
    gethomepage.dev/widget.url: 'https://...'
    gethomepage.dev/widget.fields: "['books', 'authors']"
    gethomepage.dev/pod-selector: ''

This, however, does not appear to be working as desired - all fields show for the calibreweb widget, instead of just books and authors. Further, specifying this as an actual list in yaml is rejected by kubernetes, as annotation values must be a string.

Is this not supported? Is this intended to work differently, or should this be a feature request?

homepage version

0.8.4

Installation method

Other (please describe above)

Configuration

No response

Container Logs

No response

Browser Logs

No response

Troubleshooting

[glime-ai[bot]]

Based on the context provided, it seems that the issue you're experiencing is related to the way the gethomepage.dev/widget.fields annotation is being parsed. The documentation and sources provided do not explicitly mention how to define widget fields using Kubernetes ingress annotations. However, from the example you've given, it appears that you're trying to pass a JSON array as a string, which might not be the correct approach.

In Kubernetes annotations, all values must indeed be strings, which means that complex structures such as arrays or objects need to be serialized into a string format. However, the correct serialization format for the gethomepage.dev/widget.fields annotation is not clear from the provided documentation.

Given that the documentation does not specify the format for the widget.fields annotation, and considering that your current approach is not yielding the desired results, I would recommend reaching out to the maintainers of the Homepage project for clarification. You can do this by opening an issue on the project's GitHub repository or checking if there are any existing issues or discussions that address this topic.

In the meantime, as a workaround, you could try different serialization formats for the array, such as a comma-separated string, to see if that is accepted by the Homepage application. For example:

gethomepage.dev/widget.fields: 'books,authors'

If you have already tried other troubleshooting steps or if there is additional context that might help resolve this issue, please provide that information so I can assist you further.

---

Thanks for posting a discussion about homepage here on GitHub. Homepage now uses a fancy new AI tool thanks to our friends at Glime, so the answer below is the AI bot's attempt to answer your question. If you feel it's sufficient you can mark the answer and close this post, otherwise feel free to leave it open of course!

Thanks for using Homepage! ❤️

This comment was generated by Glime.

[shamoon]

I'm always surprised which things have come up before and which haven't. I'd have to double-check our source / test it but indeed this may just not be implemented at all. We don't have a lot of folks working on k8s side of things. I don't think it'd be very challenging to do tho

[shamoon]

Yea since my only real way to test kubernetes stuff right now is using the very-basic k3d setup we have in this project (which has 0 service widgets) I dont have a way to check this easily.

The code

homepage/src/utils/config/service-helpers.js

Lines 286 to 294 in b9b9fb0

	Object.keys(ingress.metadata.annotations).forEach((annotation) => {
	if (annotation.startsWith(ANNOTATION_WIDGET_BASE)) {
	shvl.set(
	constructedService,
	annotation.replace(`${ANNOTATION_BASE}/`, ""),
	ingress.metadata.annotations[annotation],
	);
	}
	});

would theoretically generate something like

constructedService = {
          app: ...,
          namespace: ...
          widget: ..
        }

and then later

homepage/src/utils/config/service-helpers.js

Line 351 in b9b9fb0

if (cleanedService.widget) {

and

homepage/src/utils/config/service-helpers.js

Lines 449 to 457 in b9b9fb0

	if (typeof fields === "string") {
	try {
	JSON.parse(fields);
	} catch (e) {
	logger.error("Invalid fields list detected in config for service '%s'", service.name);
	fieldsList = null;
	}
	}

I would think would parse e.g. a JSON string version.

But again, cant test easily atm

[katanacrimson]

Huh. It's...working, now that I attempt to specify JSON.

Looking back at what I had, I was using single-quotes to encapsulate the strings within the stringified JSON, which is most definitely not valid JSON. That one's on me.

So, this works:

    gethomepage.dev/widget.fields: '["books", "authors"]'

Might be worth documenting, perhaps?

[github-actions[bot]]

This discussion has been automatically closed due to inactivity. See our contributing guidelines for more details.