Skip to content

Commit

Permalink
docs: README update
Browse files Browse the repository at this point in the history
Signed-off-by: Fabian Deutsch <[email protected]>
  • Loading branch information
fabiand committed Dec 22, 2016
1 parent 5b8c470 commit a490524
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 18 deletions.
24 changes: 21 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,34 @@
[![Build Status](https://travis-ci.org/kubevirt/kubevirt.svg?branch=master)](https://travis-ci.org/kubevirt/kubevirt)
[![Go Report Card](https://goreportcard.com/badge/github.com/kubevirt/kubevirt)](https://goreportcard.com/report/github.com/kubevirt/kubevirt)

KubeVirt is a virtual machine management architecture built around Kubernetes.
**KubeVirt** is a virtual machine management architecture built around
Kubernetes.
The virtualization capabilities are layered on top of Kubernetes,
existing functionality like scheduling and storage are however directly
consumed from Kubernetes.

KubeVirt aims at beeing able to provide management for fully featured
Virtual Machines, thus VMs where you can tune every single parameter.
These are usually the kind of VMs you find 'classic' datacenter
virtualization environments.

## Getting Started

This document contains some more background below.
If you want to get started right away, make sure to continue with our
To get started right away please read out
[Getting Started Guide](docs/getting-started.md).


## Documentation

You can learn more about how KubeVirt is designed (and why it is that way),
and learn more about the major components by taking a look at
[our documentation](docs/):

* [Glossary](docs/glossary.md) - Explaining the most important terms
* [Architecture](docs/architecture.md) - High-level view on the architetcure
* [Components](docs/components.md) - Detailed look at all components


## Technical Overview

Kubernetes allows for extensions to its architecture in the form of 3rd party
Expand Down
30 changes: 15 additions & 15 deletions docs/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,21 @@ pattern.
## Stack


+---------------------+
| KubeVirt |
+---------------------+
| Orchestration (K8s) |
+---------------------+
| Scheduling (K8s) |
+---------------------+
| Container Runtime |
+---------------------+
| Operating System |
+---------------------+
| Virtual |
+---------------------+
| Physical |
+---------------------+
+---------------------+
| KubeVirt |
~~+---------------------+~~
| Orchestration (K8s) |
+---------------------+
| Scheduling (K8s) |
+---------------------+
| Container Runtime |
~~+---------------------+~~
| Operating System |
+---------------------+
| (Virtual) |
~~+---------------------+~~
| Physical |
+---------------------+

Users requiring virtualization services are speaking to the Virtualization API
(see below) which in turn is speaking to the Kubernetes cluster to schedule
Expand Down

0 comments on commit a490524

Please sign in to comment.