Skip to content

Commit c0f5baa

Browse files
Documenting
1 parent f330881 commit c0f5baa

File tree

5 files changed

+51
-12
lines changed

5 files changed

+51
-12
lines changed

docs/.vitepress/config.ts

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import { defineConfig } from "vitepress";
2+
import lightbox from "vitepress-plugin-lightbox";
23

34
export default defineConfig({
45
lang: "en-US",
@@ -7,8 +8,7 @@ export default defineConfig({
78
"Open-source IaaS for Hyper-V — multi-tenant, API-first, agent-based automation.",
89

910
base: "/docs/",
10-
outDir: "../dist/docs",
11-
11+
outDir: "../dist/docs",
1212
themeConfig: {
1313
logo: "/assets/logo.svg",
1414
siteTitle: "OpenHVX",
@@ -75,4 +75,15 @@ export default defineConfig({
7575
],
7676
["meta", { property: "og:image", content: "/assets/og-cover.png" }],
7777
],
78+
79+
markdown: {
80+
config: (md) => {
81+
// Activer le plugin lightbox
82+
md.use(lightbox, {
83+
// Optionnel : config
84+
selector: "img[data-zoomable]",
85+
delay: 300,
86+
scrollOffset: 50,
87+
});
88+
}
7889
});

docs/.vitepress/theme/index.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import DefaultTheme from "vitepress/theme";
22
import "./custom.css";
3+
import mediumZoom from "vitepress-plugin-medium-zoom";
34

45
export default {
56
...DefaultTheme,

docs/index.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,38 +10,35 @@ OpenHVX is an open-source orchestration platform for **multi-tenant Hyper-V infr
1010

1111
OpenHVX separates orchestration and execution into clear layers.
1212

13-
The architecture is divided into four functional layers:
13+
The architecture is divided into two functional layers:
1414

1515
### Architecture Diagram
1616

1717
<br>
1818

19-
<img src="/assets/schema.openhvx.light.png" alt="OpenHVX Architecture Diagram" class="only-light" />
20-
<img src="/assets/schema.openhvx.dark.png" alt="OpenHVX Architecture Diagram" class="only-dark" />
19+
<img src="/assets/schema.openhvx.light.png" alt="OpenHVX Architecture Diagram" class="only-light" data-zoomable />
20+
<img src="/assets/schema.openhvx.dark.png" alt="OpenHVX Architecture Diagram" class="only-dark" data-zoomable />
2121

2222
- **Control Plane:** Includes the API Gateway, Authentication Service, Controller, WS-Broker (console tunneling), MongoDB, and RabbitMQ. It handles orchestration logic, workflows, multi-tenancy and quota enforcement.
2323
- **Data Plane:** Consists of lightweight PowerShell Agents running on Hyper-V hosts. Agents execute tasks, collect inventory, and stream console sessions.
24-
- **Integration Plane:** Manages tenant networking and routing through the Network Orchestrator (VyOS API, IPAM).
25-
- **Storage Layer:** SMB/NFS repositories store public and tenant-specific VM images.
2624

2725
The design emphasizes **asynchronous communication**, **tenant isolation**, and **extensibility** through modular services.
2826

2927
---
3028

3129
## Features
3230

33-
- **VM Lifecycle:** Create, edit, clone, and manage VMs with cloud-init and console access via WS-Broker.
31+
- **VM Lifecycle:** Create, edit, clone, and manage VMs with cloud-init and serial console access.
3432
- **Quotas:** Per-tenant CPU, RAM, storage, and VM limits with atomic reservation (hold → execute → release).
3533
- **Multi-Tenancy:** Logical separation of compute, storage, and network resources per tenant.
3634
- **Networking:** Automated provisioning via VyOS API and IPAM integration for NAT, routing, and isolation. (Still under development)
3735
- **Authentication:** Admin and tenant login flows with JWT tokens and different audiences.
3836
- **Agents:** Lightweight, host-based agents for secure orchestration and telemetry.
3937
- **Extensible:** Modular microservice architecture, event-driven.
38+
- **Modern UI:** Specific UI for tenant & admin scope.
4039

4140
---
4241

4342
### 🤝 Contributing
4443

4544
We welcome contributions from the community! Whether it’s documentation improvements, feature suggestions, or bug reports — every input helps make OpenHVX better. Visit the [GitHub organization](https://github.com/openhvx) to get started.
46-
47-
> **Built for Hyper-V. Driven by automation. Empowered by simplicity.**

package-lock.json

Lines changed: 29 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,9 @@
1313
"serve": "vitepress serve docs"
1414
},
1515
"devDependencies": {
16-
"vue": "3.2.44",
17-
"vitepress": "1.0.0-alpha.28"
16+
"vitepress": "1.0.0-alpha.28",
17+
"vitepress-plugin-lightbox": "^1.0.3",
18+
"vue": "3.2.44"
1819
},
1920
"pnpm": {
2021
"peerDependencyRules": {

0 commit comments

Comments
 (0)