Add initial README

Signed-off-by: Yohei Ueda <[email protected]>

Author: yoheiueda

DCO1.1.txt

@@ -0,0 +1,37 @@
+Developer Certificate of Origin
+Version 1.1
+
+Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
+1 Letterman Drive
+Suite D4700
+San Francisco, CA, 94129
+
+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
+
+
+Developer's Certificate of Origin 1.1
+
+       By making a contribution to this project, I certify that:
+
+       (a) The contribution was created in whole or in part by me and I
+           have the right to submit it under the open source license
+           indicated in the file; or
+
+       (b) The contribution is based upon previous work that, to the best
+           of my knowledge, is covered under an appropriate open source
+           license and I have the right under that license to submit that
+           work with modifications, whether created in whole or in part
+           by me, under the same open source license (unless I am
+           permitted to submit under a different license), as indicated
+           in the file; or
+
+       (c) The contribution was provided directly to me by some other
+           person who certified (a), (b) or (c) and I have not modified
+           it.
+
+       (d) I understand and agree that this project and the contribution
+           are public and that a record of the contribution (including all
+           personal information I submit with it, including my sign-off) is
+           maintained indefinitely and may be redistributed consistent with
+           this project or the open source license(s) involved.

README.md

@@ -0,0 +1,27 @@
+# Cloud API adaptor for Peer Pod VMs
+
+This repository contains the core components for Peer Pod VMs.
+A goal of this project is to secure workload pods from Kubernetes administrators by running them in a separate VM from a worker node VM.
+
+## Goals
+
+* Accept requests from Kata shim to create/delete cloud VM instances
+* Manage VM instances to run pods using cloud API endpoint
+* Forward communication between kata shim on a worker node VM and kata agent on a pod VM
+* Provide a mechanism to establish a network tunnel between a worker and pod VMs to Kubernetes pod network
+
+## Architecture
+
+Architecture document is coming soon...
+
+![Architecture](./docs/architecture.png)
+
+## Components
+
+* Cloud API adaptor ([cmd/cloud-api-adaptor](./cmd/cloud-api-adaptor))
+* Agent protocol forwarder ([cmd/agent-protocol-forwarder](./cmd/agent-protocol-forwarder))
+* A modified version of the shim of Kata containers CCv0 (not included in this repository)
+
+## Contribution
+
+This project uses [the Apache 2.0 license](./LICENSE). Contribution to this project requires the [DCO 1.1](./DCO1.1.txt) process to be followed.