SurrealDB
Helm chart for deploying surrealdb
Install
Add the zop.dev chart repository, then install surrealdb into your cluster.
helm repo add zopdev https://helm.zop.dev
helm repo update
helm install my-surrealdb zopdev/surrealdb --version v0.0.4The SurrealDB Helm chart provides an easy way to deploy SurrealDB, a next-generation database for modern applications, in your Kubernetes cluster. SurrealDB supports SQL-like queries and is highly flexible, scalable, and efficient.
Prerequisites
- Kubernetes 1.19+
- Helm 3+
Add Helm Repository
Add the Helm repository by running:
helm repo add zopdev https://helm.zop.devhelm repo updateFor more details, see the Helm Repository Documentation.
Install Helm Chart
To deploy the SurrealDB Helm chart, use the following command:
helm install [RELEASE_NAME] zopdev/surrealdbReplace [RELEASE_NAME] with your desired release name. Example:
helm install my-surrealdb zopdev/surrealdbYou can override default values during installation by providing a values.yaml file.
Refer to the Helm Install Documentation for further details.
Uninstall Helm Chart
To remove the SurrealDB Helm chart and associated resources, run:
helm uninstall [RELEASE_NAME]Example:
helm uninstall my-surrealdbCheck the Helm Uninstall Documentation for more information.
Configuration
The following table lists the configurable parameters of the SurrealDB Helm chart:
| Input | Type | Description | Default |
|---|---|---|---|
replicaCount | integer | Number of SurrealDB replicas to deploy. | 1 |
image | string | Docker image and tag for the SurrealDB container. | "surrealdb/surrealdb:latest" |
resources.requests.cpu | string | Minimum CPU resources required by the SurrealDB container. | "100m" |
resources.requests.memory | string | Minimum memory resources required by the SurrealDB container. | "256M" |
resources.limits.cpu | string | Maximum CPU resources the SurrealDB container can use. | "1000m" |
resources.limits.memory | string | Maximum memory resources the SurrealDB container can use. | "1Gi" |
diskSize | string | Size of the persistent volume for SurrealDB data storage. | "10Gi" |
updateStrategy.type | string | Update strategy for rolling updates. | "RollingUpdate" |
port | integer | Port on which SurrealDB listens for incoming connections. | 8000 |
Override these values in a values.yaml file or via command-line arguments during installation.
Example values.yaml File
Below is an example configuration for custom installation:
version: v2
# Resource configurationresources: requests: cpu: "100m" memory: "256M" limits: cpu: "1000m" memory: "1Gi"
# disk size for surrealdbdiskSize: "10Gi"Use the custom configuration with the following command:
helm install my-surrealdb zopdev/surrealdb -f values.yamlFeatures
- Scalability: Supports horizontal scaling with replica configuration.
- Resource Control: Fine-grained control over resource limits and requests for optimized performance.
- Persistent Storage: Configurable disk size to ensure data durability.
- Rolling Updates: Seamless updates with no downtime using the rolling update strategy.
- Flexible Port Configuration: Easily specify the port for database connections.
Pod Scheduling
nodeSelector, tolerations and affinity are passed straight through to the pod spec. All three are empty by default and render nothing, so leaving them unset changes nothing for an existing release.
Together they place the workload on a dedicated node pool — the nodeSelector picks the pool, the toleration gets past its taint:
nodeSelector: workload: stateful
tolerations: - key: workload operator: Equal value: stateful effect: NoScheduleaffinity takes a full Affinity object and is rendered verbatim.
Contributing
We welcome contributions to improve this Helm chart. Please refer to the CONTRIBUTING.md file for contribution guidelines.
Code of Conduct
To maintain a healthy and collaborative community, please adhere to our Code of Conduct.
License
This project is licensed under the LICENSE. Please review it for terms of use.
Connection Config
- SURREAL_PORT : Port on which SurrealDB listens for incoming requests.Defaults at 8000.
- SURREAL_HOST : Hostname or service name for the SurrealDB instance in the cluster.