initial info for contributions

[mavimo]

NB: should be merged AFTER #20

• Include MetalLB in order to be able to test ingress without any load balancer service (typically they are expensive 💸)
• Use port forward to expose ingress (in order to be able to test using Let's encrypt)
• Some minor fix on missing port in internal service
• Added DOCS

FYI my next steps will be to add pebble in order to make easy test on local env the TLS part, but at the moment my focus is on make the TLS part work :)

[mholt]

This is a great enhancement, thanks!

Just a couple of nits/typos.

I am not well-versed in the metal/k8s stuff here below so I'm going to leave it to @dannav if he wants to give it a once-over in his spare time, otherwise I'm OK with merging this (after my suggestions) if you feel good about it.

[dannav]

Thanks for this, this is awesome! Just a couple of things I think we should explicitly note as optional but maybe be helpful depending on your setup.

[dannav]

This is fine but should probably make it explicit that it is optional. Kubernetes comes with docker for Mac so I don’t want someone getting confused and setting up kind if they don’t need to 😛

[mavimo]

@dannav It's fine for you if I add a note like the one reported below?

OPTIONAL: this is needed only if you don't have a kubernetes cluster to use for development purpose (like Docker Desktop)

[mholt]

@mavimo That looks good to me, sure -- please go for it!

[dannav]

Same with this file. I would probably put it in an opt folder and link to this manifest

[mavimo]

This is required to be able to use a service as LoadBalancer, I'm not sure that using an external load balancer should be useful for development purpose (and AFAIK Docker desktop do not support LoadBalancer service out of the box).
Do not enable it by default will require extra steps to contributors and only few of them will need to hack the default config.. @dannav WDYT?

[dannav]

Yep, you're correct if you want to use a lb :-P. But you can do this with ingress if you want to test locally as well.

Here's an example w/ minikube and nginx: https://kubernetes.io/docs/tasks/access-application-cluster/ingress-minikube/

I guess the point I'm trying to get across is that unfortunately there are a million ways to do these things :-(. If we want to show one way to do it that's fine. But if we do, we should be explicit that it is optional unless there's a really good reason why it should be done a specific way.

[dannav]

I feel like I'm nitpicking now, ultimately I think this is fine to merge unless we want to be really explicit with the docs. Regardless when this is released a lot more docs are going to have to be created and we can always come back and clean this all up.