diff --git a/README.md b/README.md index d2298007..177c2e6a 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,10 @@

-Logo banner +Logo banner

+Website License Code style: Black -Release +Latest Release Documentation Status

@@ -23,62 +24,64 @@ Installation of PVC is accomplished by two main components: a [Node installer IS Just give it physical servers, and it will run your VMs without you having to think about it, all in just an hour or two of setup time. +More information about PVC, its motivations, the hardware requirements, and setting up and managing a cluster [can be found over at our docs page](https://docs.parallelvirtualcluster.org). + ## Getting Started To get started with PVC, please see the [About](https://docs.parallelvirtualcluster.org/en/latest/about-pvc/) page for general information about the project, and the [Getting Started](https://docs.parallelvirtualcluster.org/en/latest/deployment/getting-started/) page for details on configuring your first cluster. ## Changelog -View the changelog in [CHANGELOG.md](CHANGELOG.md). **Please note that any breaking changes are announced here; ensure you read the changelog before upgrading!** +View the changelog in [CHANGELOG.md](https://github.com/parallelvirtualcluster/pvc/blob/master/CHANGELOG.md). **Please note that any breaking changes are announced here; ensure you read the changelog before upgrading!** ## Screenshots These screenshots show some of the available functionality of the PVC system and CLI as of PVC v0.9.85. -

0. Integrated help
+

0. Integrated help
The CLI features an integrated, fully-featured help system to show details about every possible command.

-

1. Connection management
+

1. Connection management
A single CLI instance can manage multiple clusters, including a quick detail view, and will default to a "local" connection if an "/etc/pvc/pvc.conf" file is found; sensitive API keys are hidden by default.

-

2. Cluster details and output formats
+

2. Cluster details and output formats
PVC can show the key details of your cluster at a glance, including health, persistent fault events, and key resources; the CLI can output both in pretty human format and JSON for easier machine parsing in scripts.

-

3. Node information
+

3. Node information
PVC can show details about the nodes in the cluster, including their live health and resource utilization.

-

4. VM information
+

4. VM information
PVC can show details about the VMs in the cluster, including their state, resource allocations, current hosting node, and metadata.

-

5. VM details
+

5. VM details
In addition to the above basic details, PVC can also show extensive information about a running VM's devices and other resource utilization.

-

6. Network information
+

6. Network information
PVC has two major client network types, and ensures a consistent configuration of client networks across the entire cluster; managed networks can feature DHCP, DNS, firewall, and other functionality including DHCP reservations.

-

7. Storage information
+

7. Storage information
PVC provides a convenient abstracted view of the underlying Ceph system and can manage all core aspects of it.

-

8. VM and node logs
+

8. VM and node logs
PVC can display logs from VM serial consoles (if properly configured) and nodes in-client to facilitate quick troubleshooting.

-

9. VM and worker tasks
+

9. VM and worker tasks
PVC provides full VM lifecycle management, as well as long-running worker-based commands (in this example, clearing a VM's storage locks).

-

10. Provisioner
+

10. Provisioner
PVC features an extensively customizable and configurable VM provisioner system, including EC2-compatible CloudInit support, allowing you to define flexible VM profiles and provision new VMs with a single command.

-

11. Prometheus and Grafana dashboard
+

11. Prometheus and Grafana dashboard
PVC features several monitoring integration examples under "node-daemon/monitoring", including CheckMK, Munin, and, most recently, Prometheus, including an example Grafana dashboard for cluster monitoring and alerting.