Initial openvim v0.4.6 upload

[osm/openvim.git] / charm / openvim / layer-openvim-compute / README.md

diff --git a/charm/openvim/layer-openvim-compute/README.md b/charm/openvim/layer-openvim-compute/README.md
new file mode 100644 (file)
index 0000000..a6a203c
--- /dev/null
+++ b/charm/openvim/layer-openvim-compute/README.md
@@ -0,0 +1,58 @@
+# Overview
+
+Launches an OpenVIM compute node.
+
+# Preparation
+
+When running with an LXD cloud, the openvim-compute nodes needs to have some
+devices added and be run with extra privileges. A quick-and-dirty way of
+accomplishing this is to edit the juju-default LXD profile:
+
+    lxc profile edit juju-default
+    
+change it to:
+
+    name: juju-default
+    config:
+      boot.autostart: "true"
+      security.nesting: "true"
+      security.privileged: "true"
+    description: ""
+    devices:
+      kvm:
+        path: /dev/kvm
+        type: unix-char
+      tun:
+        path: /dev/net/tun
+        type: unix-char
+
+# Usage
+
+    juju deploy mysql
+    juju deploy openvim-controller
+    juju deploy openvim-compute
+    juju relate mysql openvim-controller
+    juju relate openvim-compute openvim-controller
+    
+# Creating and starting a VM
+
+The openvim-controller charm will create a default tenant, image, flavor,
+and networks, but you'll want to add your own VM when you're ready to deploy.
+This charm generates a basic VM yaml definition for you if you'd like to launch
+one quickly. First, ssh into your openvim-controller box:
+
+    juju ssh openvim-controller/0 # may not be zero, find instance id with `juju status`.
+
+Then create your VM and get its uuid:
+
+    /home/ubuntu/openmano/openvim/openvim vm-create /tmp/server.yaml
+    
+And finally start it:
+
+    /home/ubuntu/openmano/openvim/openvim vm-start <vm-uuid>
+    
+
+# Contact Information
+
+Rye Terrell rye.terrell@canonical.com
+George Kraft george.kraft@canonical.com