parallelvirtualcluster
/
docs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Move explanation paragraphs above TOCs

This commit is contained in:
Joshua Boniface 2023-09-16 14:55:39 -04:00
parent e64f50924c
commit e2a0ff2c1c
3 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/about-pvc.md
View File

@ -2,6 +2,8 @@
title: "About PVC"
---
This document outlines the basic ideas and inspiration behind PVC as well as some frequently asked questions.
[TOC]
## Project Motivation

4
docs/deployment/cluster-architecture.md
View File

@ -2,10 +2,10 @@
title: Cluster Architecture
---
[TOC]
This document details the general architecture of a PVC cluster, including its main components, how the interoperate, how nodes are laid out, and the networks required by a cluster. This document must be read and understood to properly administrate a PVC cluster.
[TOC]
## Operating System
PVC is designed to run on top of Debian GNU/Linux, of any version since Debian 10.x "Buster". This is the operating system installed by the [PVC Node installer](https://github.com/parallelvirtualcluster/pvc-installer) and expected by the [PVC Ansible deployment playbooks](https://github.com/parallelvirtualcluster/pvc-ansible). No other operating systems, including derivatives of Debian, are supported by PVC.

4
docs/deployment/hardware-requirements.md
View File

@ -2,12 +2,12 @@
title: Hardware Requirements
---
[TOC]
PVC has relatively stringent restrictions on the hardware it can run on, in order to provide an optimal experience and production-grade performance, redundancy, and security. This document outlines the **minimum** and **recommended** hardware specifications, of each major device class, for running a production-grade PVC cluster.
Note, however, that your individual needs may be different, and thus your own recommended minimum requirements may be higher, even significantly higher, than those outlined here. One of PVC's benefits is the ability to seamlessly take nodes offline for maintenance, so upgrading hardware in the future is a fairly trivial task, but ensuring you get the right performance from the beginning can be critical to the success of a cluster deployment project.
[TOC]
## N-1 Redunancy
This document details the recommendations for *individual* node hardware choices, however it is important to consider the entire cluster when sizing nodes.