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

Add Helm Chart for LibreTranslate Deployment #481

Merged
merged 1 commit into from
Aug 11, 2023
Merged

Add Helm Chart for LibreTranslate Deployment #481

merged 1 commit into from
Aug 11, 2023

Conversation

drivard
Copy link
Contributor

@drivard drivard commented Aug 11, 2023

This PR introduces a comprehensive Helm chart for the deployment and management of LibreTranslate within a Kubernetes cluster. The chart provides a scalable and flexible solution to handle various deployment scenarios and requirements.

I use the k8s.yaml has the starting boiler plate.

Key Features

  • Configurable Parameters: Customize the deployment according to specific needs through values.yaml.
  • Persistent Storage Support: Support for both ReadWriteOnce and ReadWriteMany access modes, allowing persistent storage for models and databases.
  • Authentication and Security: Integration with basic authentication, security context, and image pull secrets.
  • Scalability: Facilitates horizontal scaling with StatefulSets.
  • Health Checks: Includes readiness and liveness probes for monitoring the health of the application.
  • Documentation: Detailed README with instructions for installation, configuration, and upgrade.

Usage Scenarios

  • Deployment on Kubernetes cluster.
  • Integration with existing storage solutions like NFS through storage class.
  • Support for custom images and private registries.

Testing

The chart has been tested on Kubernetes version 1.26.

  • Tested the helm chart using RKE2 Kubernetes cluster on Harvester.
  • Tested against the harvester/longhorn default storage class for ReadWriteOnce persistent volume.
  • Tested against democratic-csi/nfs on TrueNAS Scale for ReadwriteMany persistent volume.
  • Tested scaling of the Statefulset to 1 and 2 replicas with both ReadWriteMany and ReadWriteOnce storage class.

Instructions

The README file includes detailed instructions for installation, customization, and upgrade.

Introduce a Helm chart to streamline the deployment and management of LibreTranslate within a Kubernetes cluster. The chart includes configurable parameters, persistent storage support, authentication, scalability features, health checks, and detailed documentation. See the PR for complete details.
Copy link
Member

@pierotofy pierotofy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @drivard for this valuable contribution!

@pierotofy pierotofy merged commit 0b40d00 into LibreTranslate:main Aug 11, 2023
1 of 4 checks passed
@PJ-Finlay
Copy link
Contributor

Awesome thanks @drivard ! Should we add a doc to the main project Readme?

@drivard
Copy link
Contributor Author

drivard commented Aug 13, 2023

I thought about it let me propose a new pr about it i will look at it at beginning of next week

@drivard
Copy link
Contributor Author

drivard commented Aug 15, 2023

@PJ-Finlay @pierotofy giving it more thoughts. I am thinking you might want to consider creating a second repository for the chart in order to setup something like describe here in the helm documentation.

I am not having the time now but I will in 2 weeks. I could give it a try if you are interested.

what do you 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

Successfully merging this pull request may close these issues.

None yet

3 participants