2023-04-13 17:27:14 +00:00
# Serge AI Helm Chart
2023-04-14 22:34:43 +00:00
[![License: WTFPL ](https://img.shields.io/badge/License-WTFPL-brightgreen.svg )](http://www.wtfpl.net/about/)
[![Artifact Hub ](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/serge )](https://artifacthub.io/packages/search?repo=serge)
2023-04-13 17:27:14 +00:00
This Helm chart deploys a LLaMA based chat interface named Serge.
https://github.com/nsarrazin/serge
## Prerequisites
- Kubernetes 1.12+ or OpenShift 3.11+
- Helm 3+
## Installing the Chart
To install the chart with the release name `serge-ai` :
2023-04-14 21:43:25 +00:00
#### Enable helm OCI support
2023-04-13 17:27:14 +00:00
```sh
export HELM_EXPERIMENTAL_OCI=1
```
2023-04-14 21:43:25 +00:00
#### Install the chart
2023-04-13 17:27:14 +00:00
```sh
2023-04-14 21:43:25 +00:00
helm install serge-ai oci://registry-1.docker.io/mrtuxedo/serge --version 0.0.3
2023-04-13 17:27:14 +00:00
```
See the [configuration ](#configuration ) section for information on how to customize the installation.
## Uninstalling the Chart
To uninstall the chart with the release name serge-ai, run:
```sh
helm uninstall serge-ai
```
## Configuration
The following table lists the configurable parameters of the chart and their default values. For more information, see the values.yaml file.
|Parameter |Description |Default|
--- | --- | --- |
2023-04-14 21:43:25 +00:00
|image.tag|Target branch for Serge |latest|
2023-04-13 17:27:14 +00:00
|environment.timezone |Timezone Identifier for deployment| Europe/Amsterdam|
|persistence.datadb.size|Volume size for chat history storage|16Gi|
|persistence.weights.size|Volume size for model weights storage|64Gi|
To override any of the default values, create a YAML file with your desired overrides and pass it to the helm install command using the --values flag. For example:
2023-04-14 21:43:25 +00:00
> Remember to [enable helm OCI support](#enable-helm-oci-support)
```sh
helm install serge-ai oci://registry-1.docker.io/mrtuxedo/serge --version 0.0.3 --values my-values.yaml
```
To set default values from the `install` command:
2023-04-13 17:27:14 +00:00
```sh
2023-04-14 21:43:25 +00:00
helm install serge-ai oci://registry-1.docker.io/mrtuxedo/serge --version 0.0.3 \
--namespace serge-ai \
--create-namespace \
--set environment.timezone=Antarctica/DumontDUrville
2023-04-13 17:27:14 +00:00
```
For more information on configuring the chart, see the values.yaml file and the official Helm documentation.
## Contributing
2023-04-14 21:43:25 +00:00
Thank you for considering contributing to this Helm chart! Pull requests and bug reports are always welcome. Chart source repository can be found [here ](https://git.ssh.surf/MrTuxedo/serge-helm-chart ).
2023-04-13 17:27:14 +00:00
Before submitting a pull request, please ensure that:
- Your changes are well-tested and conform to the Helm chart best practices and conventions.
- Your changes are clearly documented in the pull request description and/or the chart's README.md file.
- You have run the `helm lint` and `helm template` commands to validate your chart and ensure that it can be rendered correctly.
For major changes, please open an issue first to discuss your proposed changes.
2023-04-14 21:43:25 +00:00
For more information on contributing to Helm charts, see the [official Helm documentation ](https://helm.sh/docs/ ).
2023-04-13 17:27:14 +00:00
2023-04-14 22:34:43 +00:00
2023-04-13 17:27:14 +00:00
### License
2023-04-14 22:34:43 +00:00
[WTFPL ](./LICENSE )