Skip to content

Commit

Permalink
Architecture: add high level view section
Browse files Browse the repository at this point in the history
- Add very high view
- Add the main building block details and interaction

Signed-off-by: David Morel <david.morel@vates.fr>
  • Loading branch information
David Morel committed Jun 28, 2023
1 parent d37d6cc commit d130c06
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 0 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 21 additions & 0 deletions docs/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,27 @@

This page contains advanced info regarding XCP-ng architecture.

## High level view

Here you can find a high level view of how XCP-ng is interacted with by users and other applications, as well as the various blocks that it is made of. This part follows the [c4 model](http://c4model.com) principle for its diagrams.

### Interactions

The Hypervisor runs on a host, and is managed by its user directly via CLI, or through other administration applications such as [Xen Orechestra](https://xen-orchestra.com/#!/xo-home)j or [XCP-ng Center](https://github.com/xcp-ng/xenadmin)
![c4 system context diagram of XCP-ng](../assets/img/architecture/C1-context-driagram.drawio.png)

### Main Building Blocks

Inside the hypervisor, there are various parts allowing its main features:
- Controlling and configuring XCP-ng
- Controlling and configuring the VMs
- Making network and Storage work for the host and guests
- Fetching information about the host and the guests

Here is how they organize and interface with each others:

![c4 container diagram of XCP-ng](../assets/img/architecture/C2-xcp-ng-container-diagram.drawio.png)

## Storage

### Virtual disks on HVMs and PV guests
Expand Down

0 comments on commit d130c06

Please sign in to comment.