Skip to content
This repository has been archived by the owner on Aug 28, 2023. It is now read-only.

feature: Helm chart for Kubernetes deployment #1124

Closed
wants to merge 2 commits into from

Conversation

tolbrino
Copy link

@tolbrino tolbrino commented Jul 31, 2023

Make sure these boxes are checked! πŸ“¦βœ…

  • You have a nightly compatible version of rustfmt installed
rustup component add rustfmt --toolchain nightly
  • You ran cargo +nightly fmt on the code base before submitting

What was wrong? πŸ‘Ύ

The repository was lacking a Helm chart for Kubernetes deployment.

How was it fixed? 🎯

The Helm chart was added at charts/safe-client-gateway, a location adhering to Helm best-practises. The helper script at scripts/build-and-publish-helm-chart.sh can be used for releasing new versions of the Helm chart. Documentation of the chart is at charts/safe-client-gateway.

This chart is already used successfully to run the Safe infrastructure in Kubernetes.

Sibling PRs

@tolbrino tolbrino requested a review from a team as a code owner July 31, 2023 09:15
@github-actions
Copy link

github-actions bot commented Jul 31, 2023

CLA Assistant Lite bot:
Thank you for your submission, we really appreciate it. Like many open-source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution. You can sign the CLA by just posting a Pull Request Comment same as the below format.


I have read the CLA Document and I hereby sign the CLA


1 out of 2 committers have signed the CLA.
βœ… @tolbrino
❌ @ausias-armesto
You can retrigger this bot by commenting recheck in this Pull Request

@tolbrino tolbrino changed the title Feature/helm feature: Helm chart for Kubernetes deployment Jul 31, 2023
@tolbrino
Copy link
Author

I have read the CLA Document and I hereby sign the CLA

@tolbrino
Copy link
Author

recheck

@fmrsabino
Copy link
Contributor

@tolbrino and @ausias-armesto thank you for your contribution.

The repository was lacking a Helm chart for Kubernetes deployment.

This is not something that we need for the project. My recommendation is to fork the repository and change it according to your needs.

At the moment we won't specify on how the service should be deployed and the respective resources (that is up to each team using it). This applies to the suggested kubernetes configuration.

@tolbrino
Copy link
Author

@tolbrino and @ausias-armesto thank you for your contribution.

The repository was lacking a Helm chart for Kubernetes deployment.

This is not something that we need for the project. My recommendation is to fork the repository and change it according to your needs.

At the moment we won't specify on how the service should be deployed and the respective resources (that is up to each team using it). This applies to the suggested kubernetes configuration.

Thanks for the feedback. We are already working with our own forks, but that does not help out the Safe community as a whole since discovery of such additional changes is hard.

I understand you might not want to add these files into each repository. How about creating a new repository called safe-charts which holds all available charts for the various Safe infrastructure components? You may then also state that the repository is a community effort and not an official distribution, but at least its a single place for the community to find it.

@fmrsabino
Copy link
Contributor

Thanks for the feedback. We are already working with our own forks, but that does not help out the Safe community as a whole since discovery of such additional changes is hard.

We try to address the community needs including feature-discovery. However a discussion about those needs is also required. The introduction of this tool and respective deployment files assumes that this how the project should be deployed and these tools should be used. We do not make any assumptions on how the deployment should work in this repo and we give that choice to the developers who want to run our services themselves. We do provide a Docker image to make it easier to deploy but even then we do not assume that the image itself should be used (e.g. a developer/team might want to use a competing solution to Docker).

I understand you might not want to add these files into each repository. How about creating a new repository called safe-charts which holds all available charts for the various Safe infrastructure components? You may then also state that the repository is a community effort and not an official distribution, but at least its a single place for the community to find it.

If the suggestion is for it to live under the safe-global then this needs to be aligned internally. However, due to the open-source nature of the project, something like safe-charts can be created by any org. I cannot promise that this is something that will be done under safe-global (for the reasons that I mentioned).

Also, there was no discussion on why this change is necessary for the project and an evaluation on the community support behind it. Adding Helm to the repository assumes that Helm is the desired solution that we want for the community and so far that discussion did not take place. Since this repository mostly deals with the business logic for client-side rendering, the respective deployment of such service should in this case be considered on a separate repo (as you suggested).

@tolbrino
Copy link
Author

tolbrino commented Aug 1, 2023

Closing. Moved helm chart into https://github.com/hoprnet/safe-charts

@tolbrino tolbrino closed this Aug 1, 2023
@github-actions github-actions bot locked and limited conversation to collaborators Aug 1, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants