Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Kubernetes] Add Kubernetes Helm Chart for Docspell #2502

Open
TheAnachronism opened this issue Feb 17, 2024 · 11 comments
Open

[Kubernetes] Add Kubernetes Helm Chart for Docspell #2502

TheAnachronism opened this issue Feb 17, 2024 · 11 comments

Comments

@TheAnachronism
Copy link
Contributor

An often used strategy to deploy something to Kubernetes is per Helm chart. This way, people only have to specify their settings inside a values.yaml file and the chart will take care of generating the correct Kubernetes manifests and configs for the entire application and its dependencies.

Docspell already has somewhat of a Kubernetes deployment with Kustomize, where I've tried to fix some issues in #2498.

TheAnachronism added a commit to TheAnachronism/docspell that referenced this issue Feb 17, 2024
TheAnachronism added a commit to TheAnachronism/docspell that referenced this issue Feb 17, 2024
TheAnachronism added a commit to TheAnachronism/docspell that referenced this issue Feb 18, 2024
TheAnachronism added a commit to TheAnachronism/docspell that referenced this issue Feb 18, 2024
TheAnachronism added a commit to TheAnachronism/docspell that referenced this issue Feb 18, 2024
TheAnachronism added a commit to TheAnachronism/docspell that referenced this issue Feb 18, 2024
TheAnachronism added a commit to TheAnachronism/docspell that referenced this issue Feb 18, 2024
TheAnachronism added a commit to TheAnachronism/docspell that referenced this issue Feb 18, 2024
TheAnachronism added a commit to TheAnachronism/docspell that referenced this issue Feb 18, 2024
TheAnachronism added a commit to TheAnachronism/docspell that referenced this issue Feb 18, 2024
@TheAnachronism
Copy link
Contributor Author

I've published a first version of the helm chart here:
https://git.anachronis.dev/TheAnachronism/-/packages/helm/docspell/

Anyone's free to test around with this and suggest any improvements ^^

@waldher
Copy link
Contributor

waldher commented Feb 19, 2024

Thanks so much for submitting this.
One concern I had about adding a helm chart: How would it be hosted? Usually helm charts need a separate HTTP server, which is why you added this to your own git host, I assume.

@TheAnachronism
Copy link
Contributor Author

AFAIK, GitHub has a package registry for public repos, right? I thought Helm was included there.
Otherwise, https://artifacthub.io/ would be an option too. Or using the OCI registry version, docker hub could be used as well.

I hosted it on my own git instance, for testing purposes. When I started this, I wasn't really concerned about what registry it would end up on, I just wanted to start the discussion and development of one.

@eikek
Copy link
Owner

eikek commented Feb 20, 2024

Let me know if I can help with anything hosting related. There should be (i hope) some options.

@TheAnachronism
Copy link
Contributor Author

Mhh I think it would be worth looking into artifact hub. If we want to make a helm chart available @eikek, we'll need some registry to host it.

@pschichtel
Copy link

btw I've been using my own chart for a couple of months now: https://github.com/pschichtel/helm-charts/tree/main/charts/docspell

@TheAnachronism
Copy link
Contributor Author

Nice work! I see you went the route of just supplying the entire config as the docspell.conf file.
I was thinking about that as well, but eventually, I thought I'd go for configuring everything purely by the values.yaml file and converting that into env variables.

@eikek
Copy link
Owner

eikek commented Feb 25, 2024

Hi there, I had some thought about the k8s setup: I will sooner or later move the docker setup into a separate repo, because it becomes too tedious to maintain for me. I was thinking to also create a separate repo in the docspell org for the helm setup. Both of you could be committers there and do whatever, whenever you like. (it could also build the docker images) WDYT? For me, the repo becomes a bit too heavy. @waldher @TheAnachronism (and whoever else likes)

@TheAnachronism
Copy link
Contributor Author

Mhhh, yeah why not.
Do you want to separate docker and kubernetes stuff as well?
Or just make the kubernetes stuff a subdirectory of the docker repo?

@eikek
Copy link
Owner

eikek commented Feb 25, 2024

I don't care how to organize, tbh. Would leave that all to you 😄 We can as well have docker + kubernetes in one repo, perhaps not so bad an idea? I had the idea with the separate repo for the docker images for a while now. Now with the kubernetes setup, I thought that it could live next to each other, or be a separate repo as well.

@TheAnachronism
Copy link
Contributor Author

For starters, I think it would be OK if we have one repo for all the containerization stuff. So docker and different Kubernetes deployment options (Helm and Kustomize, I'd say)

If we later need to pull out the helm chart, that shouldn't be much of a problem, I think.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants