feat: add deployment info to website
This commit is contained in:
@@ -29,6 +29,7 @@
|
|||||||
<a href="#registry">Registry</a>
|
<a href="#registry">Registry</a>
|
||||||
<a href="#ui">UI</a>
|
<a href="#ui">UI</a>
|
||||||
<a href="#apps">Apps</a>
|
<a href="#apps">Apps</a>
|
||||||
|
<a href="#deployment">Deployment</a>
|
||||||
<a href="#docs">Docs</a>
|
<a href="#docs">Docs</a>
|
||||||
</div>
|
</div>
|
||||||
</nav>
|
</nav>
|
||||||
@@ -455,6 +456,79 @@ curl http://localhost:3002/health</code></pre>
|
|||||||
</div>
|
</div>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
|
<section id="deployment" class="content-section alt">
|
||||||
|
<div class="container">
|
||||||
|
<h2>Deployment</h2>
|
||||||
|
<p class="subtitle">Complete deployment configurations for running the SPORE stack</p>
|
||||||
|
<p class="repo-link"><a href="https://git.dcentral.systems/iot/spore-deployment" target="_blank" rel="noopener">Repository: spore-deployment</a></p>
|
||||||
|
|
||||||
|
<div class="feature-grid">
|
||||||
|
<div class="feature-card">
|
||||||
|
<h3>Docker Compose</h3>
|
||||||
|
<p>Simple deployment with docker-compose for development and production with one command: <code>docker compose up -d</code></p>
|
||||||
|
</div>
|
||||||
|
<div class="feature-card">
|
||||||
|
<h3>Nomad Orchestration</h3>
|
||||||
|
<p>Production-ready deployment with HashiCorp Nomad for multi-node clustering, rolling updates, and advanced resource management</p>
|
||||||
|
</div>
|
||||||
|
<div class="feature-card">
|
||||||
|
<h3>Complete Stack</h3>
|
||||||
|
<p>All SPORE services included: mosquitto MQTT broker, gateway, registry, UI, and LEDLab with proper networking and volumes</p>
|
||||||
|
</div>
|
||||||
|
<div class="feature-card">
|
||||||
|
<h3>MQTT Integration</h3>
|
||||||
|
<p>Built-in Mosquitto broker for message routing and event streaming with WebSocket support</p>
|
||||||
|
</div>
|
||||||
|
<div class="feature-card">
|
||||||
|
<h3>Data Persistence</h3>
|
||||||
|
<p>All data persisted in local directories for registry data, MQTT data, and firmware storage</p>
|
||||||
|
</div>
|
||||||
|
<div class="feature-card">
|
||||||
|
<h3>Health Monitoring</h3>
|
||||||
|
<p>Built-in service discovery, health checks, and real-time status monitoring for all services</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="content-block">
|
||||||
|
<h3>Quick Start</h3>
|
||||||
|
<pre><code class="language-bash"># Clone the deployment repository
|
||||||
|
git clone https://git.dcentral.systems/iot/spore-deployment.git
|
||||||
|
cd spore-deployment
|
||||||
|
|
||||||
|
# Start all services with Docker Compose
|
||||||
|
docker compose up -d
|
||||||
|
|
||||||
|
# Or start with Nomad (production)
|
||||||
|
make nomad-start
|
||||||
|
make nomad-job-run</code></pre>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="content-block">
|
||||||
|
<h3>Services</h3>
|
||||||
|
<ul>
|
||||||
|
<li><strong>mosquitto</strong> - MQTT broker (port 1883, WebSocket 9001)</li>
|
||||||
|
<li><strong>spore-gateway</strong> - Node discovery and WebSocket gateway (port 3001, UDP 4210)</li>
|
||||||
|
<li><strong>spore-registry</strong> - Firmware registry service (port 8090)</li>
|
||||||
|
<li><strong>spore-ledlab</strong> - LED animation studio (port 8080)</li>
|
||||||
|
<li><strong>spore-ui</strong> - Web UI for cluster management (port 3000)</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="content-block">
|
||||||
|
<h3>Access Points</h3>
|
||||||
|
<p>Once deployed, access the services at:</p>
|
||||||
|
<ul>
|
||||||
|
<li><strong>Web UI:</strong> http://localhost:3000</li>
|
||||||
|
<li><strong>LED Lab:</strong> http://localhost:8080</li>
|
||||||
|
<li><strong>Registry API:</strong> http://localhost:8090</li>
|
||||||
|
<li><strong>Gateway API:</strong> http://localhost:3001</li>
|
||||||
|
<li><strong>MQTT Broker:</strong> tcp://localhost:1883</li>
|
||||||
|
<li><strong>Nomad UI:</strong> http://localhost:4646 (Nomad deployments only)</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
|
||||||
<section id="docs" class="content-section">
|
<section id="docs" class="content-section">
|
||||||
<div class="container">
|
<div class="container">
|
||||||
<h2>Documentation</h2>
|
<h2>Documentation</h2>
|
||||||
@@ -511,6 +585,14 @@ curl http://localhost:3002/health</code></pre>
|
|||||||
<li><a href="https://git.dcentral.systems/iot/spore/src/branch/main/examples/pixelstream/README.md" target="_blank" rel="noopener">PixelStream Controller</a> - Required SPORE node firmware</li>
|
<li><a href="https://git.dcentral.systems/iot/spore/src/branch/main/examples/pixelstream/README.md" target="_blank" rel="noopener">PixelStream Controller</a> - Required SPORE node firmware</li>
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
|
<div class="doc-card">
|
||||||
|
<h3>SPORE Deployment</h3>
|
||||||
|
<ul>
|
||||||
|
<li><a href="https://git.dcentral.systems/iot/spore-deployment/src/branch/main/README.md" target="_blank" rel="noopener">Getting Started</a> - Complete deployment guide</li>
|
||||||
|
<li><a href="https://git.dcentral.systems/iot/spore-deployment/src/branch/main/nomad/README.md" target="_blank" rel="noopener">Nomad Deployment</a> - Production orchestration</li>
|
||||||
|
<li><a href="https://git.dcentral.systems/iot/spore-deployment/src/branch/main/docker-compose.yml" target="_blank" rel="noopener">Docker Compose</a> - Development configuration</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="container">
|
<div class="container">
|
||||||
@@ -561,6 +643,15 @@ npm start
|
|||||||
# Open browser
|
# Open browser
|
||||||
http://localhost:3000</code></pre>
|
http://localhost:3000</code></pre>
|
||||||
</div>
|
</div>
|
||||||
|
<div class="start-card">
|
||||||
|
<h4>SPORE Deployment</h4>
|
||||||
|
<pre><code># Docker Compose (dev)
|
||||||
|
docker compose up -d
|
||||||
|
|
||||||
|
# Nomad (production)
|
||||||
|
make nomad-start
|
||||||
|
make nomad-job-run</code></pre>
|
||||||
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
@@ -576,7 +667,8 @@ http://localhost:3000</code></pre>
|
|||||||
<a href="https://git.dcentral.systems/iot/spore-gateway" target="_blank" rel="noopener">spore-gateway</a> ·
|
<a href="https://git.dcentral.systems/iot/spore-gateway" target="_blank" rel="noopener">spore-gateway</a> ·
|
||||||
<a href="https://git.dcentral.systems/iot/spore-registry" target="_blank" rel="noopener">spore-registry</a> ·
|
<a href="https://git.dcentral.systems/iot/spore-registry" target="_blank" rel="noopener">spore-registry</a> ·
|
||||||
<a href="https://git.dcentral.systems/iot/spore-ui" target="_blank" rel="noopener">spore-ui</a> ·
|
<a href="https://git.dcentral.systems/iot/spore-ui" target="_blank" rel="noopener">spore-ui</a> ·
|
||||||
<a href="https://git.dcentral.systems/iot/spore-ledlab" target="_blank" rel="noopener">spore-ledlab</a>
|
<a href="https://git.dcentral.systems/iot/spore-ledlab" target="_blank" rel="noopener">spore-ledlab</a> ·
|
||||||
|
<a href="https://git.dcentral.systems/iot/spore-deployment" target="_blank" rel="noopener">spore-deployment</a>
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
</footer>
|
</footer>
|
||||||
|
|||||||
Reference in New Issue
Block a user