diff --git a/crates/extension-registry/API.md b/crates/extension-registry/API.md index dc41cd1..337dfa6 100644 --- a/crates/extension-registry/API.md +++ b/crates/extension-registry/API.md @@ -13,7 +13,7 @@ Base URL: `http://localhost:8082/api/v1` ## Authentication -The Extension Registry API does not require authentication for read operations. Backend authentication (Gitea/OCI) is handled server-side via +The Extension Registry API does not require authentication for read operations. Backend authentication (Gitea/OCI) is handled server-side via configuration. ## Extension Endpoints diff --git a/crates/orchestrator/README.md b/crates/orchestrator/README.md index 2a398ad..6befc3f 100644 --- a/crates/orchestrator/README.md +++ b/crates/orchestrator/README.md @@ -1,6 +1,6 @@ # Provisioning Orchestrator -A Rust-based orchestrator service that coordinates infrastructure provisioning workflows with pluggable storage backends and comprehensive migration +A Rust-based orchestrator service that coordinates infrastructure provisioning workflows with pluggable storage backends and comprehensive migration tools. ## Architecture @@ -49,16 +49,16 @@ cargo build --release --features surrealdb cargo run --features surrealdb -- --storage-type surrealdb-embedded --data-dir ./data # Run with SurrealDB server -cargo run --features surrealdb -- --storage-type surrealdb-server - --surrealdb-url ws://localhost:8000 +cargo run --features surrealdb -- --storage-type surrealdb-server + --surrealdb-url ws://localhost:8000 --surrealdb-username admin --surrealdb-password secret ``` ### Submit a Server Creation Workflow ```bash -curl -X POST http://localhost:8080/workflows/servers/create - -H "Content-Type: application/json" +curl -X POST http://localhost:8080/workflows/servers/create + -H "Content-Type: application/json" -d '{ "infra": "production", "settings": "./settings.yaml", @@ -129,8 +129,8 @@ The Test Environment Service enables: Test individual taskserv in isolated container: ```bash -curl -X POST http://localhost:8080/test/environments/create - -H "Content-Type: application/json" +curl -X POST http://localhost:8080/test/environments/create + -H "Content-Type: application/json" -d '{ "config": { "type": "single_taskserv", @@ -151,8 +151,8 @@ curl -X POST http://localhost:8080/test/environments/create Simulate complete server with multiple taskservs: ```bash -curl -X POST http://localhost:8080/test/environments/create - -H "Content-Type: application/json" +curl -X POST http://localhost:8080/test/environments/create + -H "Content-Type: application/json" -d '{ "config": { "type": "server_simulation", @@ -170,8 +170,8 @@ curl -X POST http://localhost:8080/test/environments/create Test multi-node cluster configurations: ```toml -curl -X POST http://localhost:8080/test/environments/create - -H "Content-Type: application/json" +curl -X POST http://localhost:8080/test/environments/create + -H "Content-Type: application/json" -d '{ "config": { "type": "cluster_topology", @@ -412,7 +412,7 @@ Seamless migration between storage backends: ./scripts/migrate-storage.nu --interactive # Direct migration -./scripts/migrate-storage.nu --from filesystem --to surrealdb-embedded +./scripts/migrate-storage.nu --from filesystem --to surrealdb-embedded --source-dir ./data --target-dir ./surrealdb-data # Validate migration setup @@ -511,5 +511,5 @@ This orchestrator solves the Nushell deep call stack limitations by: 3. Managing parallel execution externally 4. Preserving all existing business logic in Nushell -The existing `on_create_servers` function can be replaced with `on_create_servers_workflow` for orchestrated execution while maintaining full +The existing `on_create_servers` function can be replaced with `on_create_servers_workflow` for orchestrated execution while maintaining full compatibility. diff --git a/docs/deployment/guide.md b/docs/deployment/guide.md index 7ce6c55..f0b8f3a 100644 --- a/docs/deployment/guide.md +++ b/docs/deployment/guide.md @@ -7,7 +7,7 @@ ## ✅ Fixed: Docker Builds -Docker builds have been **fixed** to properly handle the Rust workspace structure. Both deployment methods (Native and Docker) are now fully +Docker builds have been **fixed** to properly handle the Rust workspace structure. Both deployment methods (Native and Docker) are now fully supported. **Note**: Docker builds use Rust nightly to support edition2024 (required by async-graphql 7.x from surrealdb).