pvc/docs/index.md

92 lines
5.1 KiB
Markdown
Raw Normal View History

2020-03-15 17:17:17 -04:00
# PVC - The Parallel Virtual Cluster system
2019-03-14 20:23:39 -04:00
<p align="center">
<img alt="Logo banner" src="https://git.bonifacelabs.ca/uploads/-/system/project/avatar/135/pvc_logo.png"/>
<br/><br/>
2019-08-08 20:42:49 -04:00
<a href="https://github.com/parallelvirtualcluster/pvc"><img alt="License" src="https://img.shields.io/github/license/parallelvirtualcluster/pvc"/></a>
<a href="https://github.com/parallelvirtualcluster/pvc/releases"><img alt="Release" src="https://img.shields.io/github/release-pre/parallelvirtualcluster/pvc"/></a>
<a href="https://parallelvirtualcluster.readthedocs.io/en/latest/?badge=latest"><img alt="Documentation Status" src="https://readthedocs.org/projects/parallelvirtualcluster/badge/?version=latest"/></a>
</p>
2019-03-14 20:23:39 -04:00
2020-03-15 17:36:12 -04:00
PVC is a KVM+Ceph+Zookeeper-based, Free Software, scalable, redundant, self-healing, and self-managing private cloud solution designed with administrator simplicity in mind. It is built from the ground-up to be redundant at the host layer, allowing the cluster to gracefully handle the loss of nodes or their components, both due to hardware failure or due to maintenance. It is able to scale from a minimum of 3 nodes up to 12 or more nodes, while retaining performance and flexibility, allowing the administrator to build a small cluster today and grow it as needed.
2019-03-14 20:23:39 -04:00
The major goal of PVC is to be administrator friendly, providing the power of Enterprise-grade private clouds like OpenStack, Nutanix, and VMWare to homelabbers, SMBs, and small ISPs, without the cost or complexity. It believes in picking the best tool for a job and abstracting it behind the cluster as a whole, freeing the administrator from the boring and time-consuming task of selecting the best component, and letting them get on with the things that really matter. Administration can be done from a simple CLI or via a RESTful API capable of building full-featured web frontends or additional applications, taking a self-documenting approach to keep the administrator learning curvet as low as possible. Setup is easy and straightforward with an [ISO-based node installer](https://github.com/parallelvirtualcluster/pvc-installer) and [Ansible role framework](https://github.com/parallelvirtualcluster/pvc-ansible) designed to get a cluster up and running as quickly as possible. Build your cloud in an hour, grow it as you need, and never worry about it: just add physical servers.
2019-03-14 20:23:39 -04:00
2020-03-15 17:17:17 -04:00
## Getting Started
2019-05-28 20:04:55 -04:00
To get started with PVC, please see the [About](https://parallelvirtualcluster.readthedocs.io/en/latest/about/) page for general information about the project, and the [Getting Started](https://parallelvirtualcluster.readthedocs.io/en/latest/getting-started/) page for details on configuring your cluster.
2019-07-06 16:58:35 -04:00
## Changelog
2020-11-24 12:26:57 -05:00
#### v0.9.8
* Adds support for cluster backup/restore
* Moves location of `init` command in CLI to make room for the above
* Cleans up some invalid help messages from the API
2020-11-19 10:48:28 -05:00
#### v0.9.7
* Fixes bug with provisioner system template modifications
2020-11-17 13:01:54 -05:00
#### v0.9.6
* Fixes bug with migrations
2020-11-17 12:34:04 -05:00
#### v0.9.5
* Fixes bug with line count in log follow
* Fixes bug with disk stat output being None
* Adds short pretty health output
* Documentation updates
2020-11-10 15:33:50 -05:00
#### v0.9.4
* Fixes major bug in OVA parser
2020-11-09 10:28:15 -05:00
#### v0.9.3
* Fixes bugs with image & OVA upload parsing
2020-11-08 02:03:29 -05:00
#### v0.9.2
* Major linting of the codebase with flake8; adds linting tools
* Implements CLI-based modification of VM vCPUs, memory, networks, and disks without directly editing XML
* Fixes bug where `pvc vm log -f` would show all 1000 lines before starting
* Fixes bug in default provisioner libvirt schema (`drive` -> `driver` typo)
2020-10-29 12:16:38 -04:00
#### v0.9.1
* Added per-VM migration method feature
* Fixed bug with provisioner system template listing
2020-10-26 02:20:18 -04:00
#### v0.9.0
Numerous small improvements and bugfixes. This release is suitable for general use and is pre-release-quality software.
This release introduces an updated version scheme; all future stable releases until 1.0.0 is ready will be made under this 0.9.z naming. This does not represent semantic versioning and all changes (feature, improvement, or bugfix) will be considered for inclusion in this release train.
2020-08-26 10:24:44 -04:00
#### v0.8
Numerous improvements and bugfixes. This release is suitable for general use and is pre-release-quality software.
2020-03-15 17:17:17 -04:00
#### v0.7
Numerous improvements and bugfixes, revamped documentation. This release is suitable for general use and is beta-quality software.
2020-02-08 18:27:39 -05:00
#### v0.6
Numerous improvements and bugfixes, full implementation of the provisioner, full implementation of the API CLI client (versus direct CLI client). This release is suitable for general use and is beta-quality software.
2019-07-06 16:58:35 -04:00
#### v0.5
First public release; fully implements the VM, network, and storage managers, the HTTP API, and the pvc-ansible framework for deploying and bootstrapping a cluster. This release is suitable for general use, though it is still alpha-quality software and should be expected to change significantly until 1.0 is released.
#### v0.4
Full implementation of virtual management and virtual networking functionality. Partial implementation of storage functionality.
#### v0.3
Basic implementation of virtual management functionality.