Merge pull request #38 from NREL/dash-js

Move dashboard app to JavaScript

Author: daniel-thom

Cargo.toml

@@ -3,8 +3,7 @@ members = [
     ".",
     "torc-server",
     "torc-slurm-job-runner",
-    
-
+    "torc-dash",
 ]
 resolver = "2"
 
@@ -18,6 +17,11 @@ edition = "2024"
 # Shared dependencies
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
+
+# Configuration management
+config = { version = "0.14", features = ["toml"] }
+dirs = "5"
+toml = "0.8"
 serde_repr = "0.1"
 serde_with = { version = "3.8", default-features = false, features = ["base64", "std", "macros"] }
 chrono = { version = "0.4", features = ["serde"] }
@@ -50,7 +54,12 @@ petgraph = "0.6"
 plotly = { version = "0.10", default-features = false, features = ["kaleido"] }
 
 # Server-specific
+rust-embed = "8.5"
 async-trait = "0.1.24"
+axum = { version = "0.7", features = ["tokio", "http1", "http2"] }
+tower = "0.4"
+tower-http = { version = "0.5", features = ["cors", "fs"] }
+mime_guess = "2.0"
 swagger = { version = "6.1", features = ["serdejson", "server", "client", "tls", "tcp"] }
 hyper = { version = "0.14", features = ["full"] }
 serde_ignored = "0.1.1"
@@ -107,6 +116,11 @@ required-features = ["client", "tui", "plot_resources", "cli-docs"]
 
 [features]
 default = ["client", "tui", "plot_resources"]
+config = [
+    "dep:config",
+    "dep:dirs",
+    "dep:toml",
+]
 server = [
     "dep:async-trait",
     "dep:swagger",
@@ -123,6 +137,7 @@ server = [
     "dep:sha2",
     "dep:tracing",
     "dep:bcrypt",
+    "dep:rust-embed",
 ]
 client = [
     "dep:reqwest",
@@ -144,6 +159,7 @@ client = [
     "dep:signal-hook",
     "dep:libc",
     "dep:nvml-wrapper",
+    "config",
 ]
 tui = [
     "client",
@@ -194,6 +210,7 @@ jsonwebtoken = { workspace = true, optional = true }
 sha2 = { workspace = true, optional = true }
 tracing = { workspace = true, optional = true }
 bcrypt = { workspace = true, optional = true }
+rust-embed = { workspace = true, optional = true }
 
 # Client dependencies (optional)
 reqwest = { workspace = true, optional = true }
@@ -223,6 +240,11 @@ petgraph = { workspace = true, optional = true }
 # Plot-resources dependencies (optional)
 plotly = { workspace = true, optional = true }
 
+# Configuration management
+config = { workspace = true, optional = true }
+dirs = { workspace = true, optional = true }
+toml = { workspace = true, optional = true }
+
 # Conversion feature dependencies
 frunk = { version = "0.4.0", optional = true }
 frunk_derives = { version = "0.4.0", optional = true }
@@ -248,6 +270,7 @@ tempfile = "3.22.0"
 serial_test = "3.0"
 reqwest = { workspace = true }
 clap-markdown = "0.1"
+libc = "0.2"
 
 # CLI documentation generator depends on clap-markdown
 # It's also in dev-dependencies for tests

docs/src/SUMMARY.md

@@ -28,6 +28,7 @@
 # How-To Guides
 
 - [How-To](./how-to/README.md)
+  - [Configuration Files](./how-to/configuration-files.md)
   - [Creating Workflows](./how-to/creating-workflows.md)
   - [Working with Slurm](./how-to/slurm.md)
   - [Job Checkpointing](./how-to/checkpointing.md)
@@ -53,6 +54,9 @@
 # Tutorials
 
 - [Tutorials](./tutorials/README.md)
+  - [Configuration Files](./tutorials/configuration.md)
+  - [Dashboard Deployment](./tutorials/dashboard-deployment.md)
+  - [Workflow Wizard](./tutorials/workflow-wizard.md)
   - [Many Independent Jobs](./tutorials/many-jobs.md)
   - [Diamond Workflow](./tutorials/diamond.md)
   - [User Data Dependencies](./tutorials/user-data.md)

docs/src/how-to/README.md

@@ -4,6 +4,7 @@ This section provides task-oriented guides for accomplishing specific goals with
 
 **Topics covered:**
 
+- [Configuration Files](./configuration-files.md) - Setting up and using configuration files
 - [Creating Workflows](./creating-workflows.md) - Different methods for creating workflows
 - [Working with Slurm](./slurm.md) - Running workflows on Slurm clusters
 - [Job Checkpointing](./checkpointing.md) - Saving progress during wall-time timeouts

docs/src/how-to/configuration-files.md

@@ -0,0 +1,194 @@
+# Using Configuration Files
+
+This guide shows how to set up and use configuration files for Torc components.
+
+## Quick Start
+
+Create a user configuration file:
+
+```bash
+torc config init --user
+```
+
+Edit the file at `~/.config/torc/config.toml` to set your defaults.
+
+## Configuration File Locations
+
+| Location | Purpose | Priority |
+|----------|---------|----------|
+| `/etc/torc/config.toml` | System-wide defaults | 1 (lowest) |
+| `~/.config/torc/config.toml` | User preferences | 2 |
+| `./torc.toml` | Project-specific | 3 |
+| Environment variables | Runtime overrides | 4 |
+| CLI arguments | Explicit overrides | 5 (highest) |
+
+## Available Commands
+
+```bash
+# Show configuration file locations
+torc config paths
+
+# Show effective (merged) configuration
+torc config show
+
+# Show as JSON
+torc config show --format json
+
+# Create configuration file
+torc config init --user      # User config
+torc config init --local     # Project config
+torc config init --system    # System config (requires root)
+
+# Validate configuration
+torc config validate
+```
+
+## Client Configuration
+
+Common client settings:
+
+```toml
+[client]
+api_url = "http://localhost:8080/torc-service/v1"
+format = "table"  # or "json"
+log_level = "info"
+username = "myuser"
+
+[client.run]
+poll_interval = 5.0
+output_dir = "output"
+max_parallel_jobs = 4
+num_cpus = 8
+memory_gb = 32.0
+num_gpus = 1
+```
+
+## Server Configuration
+
+For `torc-server`:
+
+```toml
+[server]
+url = "0.0.0.0"
+port = 8080
+threads = 4
+database = "/path/to/torc.db"
+auth_file = "/path/to/htpasswd"
+require_auth = false
+completion_check_interval_secs = 60.0
+log_level = "info"
+https = false
+
+[server.logging]
+log_dir = "/var/log/torc"
+json_logs = false
+```
+
+## Dashboard Configuration
+
+For `torc-dash`:
+
+```toml
+[dash]
+host = "127.0.0.1"
+port = 8090
+api_url = "http://localhost:8080/torc-service/v1"
+torc_bin = "torc"
+torc_server_bin = "torc-server"
+standalone = false
+server_port = 0
+completion_check_interval_secs = 5
+```
+
+## Environment Variables
+
+Use environment variables for runtime configuration. Use double underscore (`__`) to separate nested keys:
+
+```bash
+# Client settings
+export TORC_CLIENT__API_URL="http://server:8080/torc-service/v1"
+export TORC_CLIENT__FORMAT="json"
+
+# Server settings
+export TORC_SERVER__PORT="9999"
+export TORC_SERVER__THREADS="8"
+
+# Dashboard settings
+export TORC_DASH__PORT="8090"
+```
+
+## Overriding with CLI Arguments
+
+CLI arguments always take precedence:
+
+```bash
+# Uses config file for api_url, but CLI for format
+torc --format json workflows list
+
+# CLI url overrides config file
+torc --url http://other:8080/torc-service/v1 workflows list
+```
+
+## Common Patterns
+
+### Development Environment
+
+```toml
+# ~/.config/torc/config.toml
+[client]
+api_url = "http://localhost:8080/torc-service/v1"
+log_level = "debug"
+
+[client.run]
+poll_interval = 2.0
+```
+
+### Team Shared Server
+
+```toml
+# ~/.config/torc/config.toml
+[client]
+api_url = "http://torc.internal.company.com:8080/torc-service/v1"
+username = "developer"
+```
+
+### CI/CD Pipeline
+
+```bash
+#!/bin/bash
+export TORC_CLIENT__API_URL="${CI_TORC_SERVER}"
+export TORC_CLIENT__FORMAT="json"
+
+torc run workflow.yaml
+result=$(torc workflows status $WORKFLOW_ID | jq -r '.status')
+```
+
+### HPC Cluster
+
+```toml
+# Project-local torc.toml
+[client]
+api_url = "http://login-node:8080/torc-service/v1"
+
+[client.run]
+num_cpus = 64
+memory_gb = 256.0
+num_gpus = 8
+output_dir = "/scratch/user/workflow_output"
+```
+
+## Troubleshooting
+
+**Configuration not applied?**
+
+1. Check which files are loaded: `torc config validate`
+2. View effective config: `torc config show`
+3. Verify file permissions and syntax
+
+**Environment variable not working?**
+
+Use double underscore for nesting: `TORC_CLIENT__API_URL` (not `TORC_CLIENT_API_URL`)
+
+**Invalid configuration?**
+
+Run validation: `torc config validate`