feat: add charts for shlink and shlink-web

[jon4hz]

Description

This PR introduces new charts to deploy shlink and the corresponding web UI "shlink-web".
The chart is will be used in our internal initiative to replace our current URL shortener.

Thanks for the review!

Checklist

• This PR contains a description of the changes I'm making
• I updated the version in Chart.yaml
• I updated the changelog with an artifacthub.io/changes annotation in Chart.yaml, check the example in the documentation.
• I updated applicable README.md files using pre-commit run
• I documented any high-level concepts I'm introducing in docs/
• CI is currently green and this is ready for review
• I am ready to test changes after they are applied and released

[hairmare]

I'll have to find some time for an in depth review, some initial questions

• can you link any other efforts about shlink and k8s in description, why do we need to maintain a helm-chart, did we ask upstream if they wanted it, are there any
• why two charts? are there any deployment consideration that warrant exposing shlink in this way towards users?

[jon4hz]

can you link any other efforts about shlink and k8s in description, why do we need to maintain a helm-chart, did we ask upstream if they wanted it, are there any

A few years ago there were some efforts regarding a chart and the maintainer was interested, but unfortunately the existing helm chart is extremely outdated and unmaintained. See shlinkio/shlink#668

why two charts? are there any deployment consideration that warrant exposing shlink in this way towards users?

Technically, you don't need shlink-web in order to use the service since as you can connect any shlink service to the public webui on https://app.shlink.io/. However, we decided to host our own shlink-web so we can preconfigure an API key and use SSO (with oauth2-proxy) to offer the service in a more user-friendly manner.

[jon4hz]

btw, will take a look at the failing test tomorrow.

[eyenx]

Can you please add the maintainer of this charts to the CODEOWNERs file?

Thanks.

[eyenx]

can you link any other efforts about shlink and k8s in description, why do we need to maintain a helm-chart, did we ask upstream if they wanted it, are there any

A few years ago there were some efforts regarding a chart and the maintainer was interested, but unfortunately the existing helm chart is extremely outdated and unmaintained. See shlinkio/shlink#668

What About @christianhuth charts? They seem updated

https://github.com/christianhuth/helm-charts/tree/main/charts

I suggest just using those instead of maintaining our own if nothing is against it.

[hairmare]

nitpick: The URL could be canonicalized

Suggested change

	- https://github.com/shlinkio/shlink-web-client/tree/main
	- https://github.com/shlinkio/shlink-web-client/

[jon4hz]

What About @christianhuth charts? They seem updated

Oh... I did not know this chart existed :(
I quickly skimmed through the code and I noticed two things that currently prevent us from using those charts:

1. shlink-backend has no option to set an externalDatabase.
2. shlink-web only supports a configMap to add preconfigured shlink services and has no option to configure it with environment variables. This means we can't pass the predefined API token as a secret.

Both things should be easily fixable, so I guess I'll start working on some PRs.

[christianhuth]

Hi guys :)
I try to keep the Chart up-to-date. If there are any issues feel free to open up Issues and/or PRs.
Cheers ✌️

[christianhuth]

What About @christianhuth charts? They seem updated

Oh... I did not know this chart existed :(
I quickly skimmed through the code and I noticed two things that currently prevent us from using those charts:

1. shlink-backend has no option to set an externalDatabase.
2. shlink-web only supports a configMap to add preconfigured shlink services and has no option to configure it with environment variables. This means we can't pass the predefined API token as a secret.

Both things should be easily fixable, so I guess I'll start working on some PRs.

Thanks for pointing out that there is no option for using an external database. Will add this with the next release.

There is an option to define extra environment variables. As I started with the development of the Chart this seemed like a good approach. Today I would take another approach and make it possible to define common env variables through Value attributes. Is there a list of all env variables supported by shlink?

[jon4hz]

Hey @christianhuth, thanks for checking in and maintaining the chart!

I saw that you can define extra variables and if christianhuth/helm-charts#1249 gets merged, you could technically configure an external database without exposing any secrets, but I suppose having dedicated values for that might be more idiomatic.

All environment variables supported by shlink are documented here and shlink-web supports preconfiguring servers by env vars.

[christianhuth]

Will check this out in the next couple of days.