Skip to content

feat(service): add SurrealDB service templates (RocksDB + TiKV)#8329

Open
nenadilic84 wants to merge 1 commit intocoollabsio:nextfrom
nenadilic84:feat/add-surrealdb-templates
Open

feat(service): add SurrealDB service templates (RocksDB + TiKV)#8329
nenadilic84 wants to merge 1 commit intocoollabsio:nextfrom
nenadilic84:feat/add-surrealdb-templates

Conversation

@nenadilic84
Copy link
Copy Markdown

Changes

Add two one-click service templates for SurrealDB:

  • surrealdb — standalone instance using RocksDB as the storage backend, suitable for development and single-node deployments
  • surrealdb-with-tikv — distributed setup with PD + TiKV + SurrealDB, suitable for production workloads that need horizontal scalability

Both templates include:

  • Persistent named volumes for data durability
  • Health checks using surreal isready (built into the SurrealDB binary)
  • Auto-generated root credentials via SERVICE_PASSWORD_SURREALDB
  • SurrealDB v2.6.1, PD/TiKV v8.5.5

Issue

Category

  • Adding new one click service

Screenshots or Video (if applicable)

N/A — service template additions. Tested compose definitions locally with docker compose up.

AI Usage

  • AI is used in the process of creating this PR

Steps to Test

  1. Run php artisan generate:services to regenerate the service templates JSON
  2. Go to Projects > New > Service and search for "SurrealDB"
  3. Deploy the standalone (RocksDB) variant
  4. Open the service URL — you should see the SurrealDB HTTP endpoint responding on port 8000
  5. Connect with any SurrealDB client using the generated root credentials
  6. Repeat steps 3-5 for the TiKV variant (takes longer to start due to PD + TiKV initialization)

Contributor Agreement

Important

  • I have read and understood the contributor guidelines. If I have failed to follow any guideline, I understand that this PR may be closed without review.
  • I have tested the changes thoroughly and am confident that they will work as expected without issues when the maintainer tests them

Add two one-click service templates for SurrealDB:

- surrealdb.yaml: standalone instance with RocksDB storage backend
- surrealdb-with-tikv.yaml: distributed setup with TiKV (PD + TiKV + SurrealDB)

Both templates include persistent volumes, health checks using
surreal isready, and auto-generated root credentials via
SERVICE_PASSWORD_SURREALDB.

Resolves coollabsio#7642
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.

2 participants