Documentation: lack of important documentation in multiple areas

[zamazan4ik]

Description

After reading the documentation I've noticed the lack of multiple important areas. Since in the roadmap there is no explicit information regarding documentation improvement, I think I need to leave the areas, which are important at least to me, and should be described in the documentation.

• Does it support replication and sharding? How exactly it could be configured?
• Does it support any kind of multi-cluster support? E.g. Cross-Cluster Replication, Stand-By Clusters.
• How could I secure my cluster? Users support, roles, permissions, authentication methods, and how it could be configured.
• Is there any quotas support? E.g. specify request quotas per user and deny requests if the quota is exceeded.
• Supported Hardware Architectures/OS combinations. From the Install page, it's not clear, which hardware architectures (like x86-64, ARM, etc.) are supported on which Operating systems. If you have special requirements for the instruction sets (like AVX) - write about this in the documentation too.
• How to install on Kubernetes? Is it supported? If yes, please describe, how SurrealDB should be installed on k8s. Would be awesome to have something like an official Helm chart (or any other way to deploy on k8s)
• Are there any recommendations regarding setup on cloud environments (like AWS/Azure/GCP)? E.g. reference architectures, recommended hardware (e.g. recommended AWS EC2 machine type)? What about reference deploy architectures for on-premise installations?
• How could I install Highly-Available (HA) cluster? Are there any restrictions/recommendations regarding network latency between nodes?
• How to upgrade/downgrade SurrealDB? Does it support zero-downtime upgrade and downgrade? What about compatibility between releases - what is the current policy?
• How to backup and restore SurrealDB? Are there any built-in integrity checks for the backup?
• How to monitor SurrealDB? Does it support any kind of integrated monitoring (like Prometheus endpoint, stated integration, etc)? If yes, how to configure it, and which metrics are supported? Is there a ready-to-use Grafana dashboard for SurrealDB?

I think this list could be somehow transformed into the documentation task epic, and could be resolved step by step.

Is there an existing issue for this?

• I have searched the existing issues

Code of Conduct

• I agree to follow this project's Code of Conduct

[rblaine95]

I wrote a super, super, basic helm chart that I'd be happy to contribute to the project, just something to get the ball rolling

[dyaa]

@rblaine95 I would like to try. Could you share it?

[rblaine95]

Hi @dyaa, I just pushed it to rblaine95/helm-surrealdb

It's very basic, I was just tinkering, take a look and let me know your thoughts.

Edit: I haven't actually had an opportunity to test that it actually works.
I got a pod up with persistence but haven't actually had a chance to run any queries or tests.

[mms-gianni]

@dyaa I've found another one here: sailrs-io/surrealdb-helm but yours looks a lot better.