From e2a0ff2c1c540689151b0a8904c68d45dec81e92 Mon Sep 17 00:00:00 2001 From: "Joshua M. Boniface" Date: Sat, 16 Sep 2023 14:55:39 -0400 Subject: [PATCH] Move explanation paragraphs above TOCs --- docs/about-pvc.md | 2 ++ docs/deployment/cluster-architecture.md | 4 ++-- docs/deployment/hardware-requirements.md | 4 ++-- 3 files changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/about-pvc.md b/docs/about-pvc.md index 76e7437..810324c 100644 --- a/docs/about-pvc.md +++ b/docs/about-pvc.md @@ -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 diff --git a/docs/deployment/cluster-architecture.md b/docs/deployment/cluster-architecture.md index da83c91..ad0d668 100644 --- a/docs/deployment/cluster-architecture.md +++ b/docs/deployment/cluster-architecture.md @@ -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. diff --git a/docs/deployment/hardware-requirements.md b/docs/deployment/hardware-requirements.md index 35d2a8b..85ebdf1 100644 --- a/docs/deployment/hardware-requirements.md +++ b/docs/deployment/hardware-requirements.md @@ -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.