Initial openvim v0.4.6 upload
[osm/openvim.git] / charm / openvim / layer-openvim / README.md
1 # Overview
2
3 Launches an OpenVIM controller.
4
5 # Preparation
6
7 When running with an LXD cloud, the openvim-compute nodes needs to have some
8 devices added and be run with extra privileges. A quick-and-dirty way of
9 accomplishing this is to edit the juju-default LXD profile:
10
11     lxc profile edit juju-default
12     
13 change it to:
14
15     name: juju-default
16     config:
17       boot.autostart: "true"
18       security.nesting: "true"
19       security.privileged: "true"
20     description: ""
21     devices:
22       kvm:
23         path: /dev/kvm
24         type: unix-char
25       tun:
26         path: /dev/net/tun
27         type: unix-char
28
29 # Usage
30
31     juju deploy mysql
32     juju deploy openvim
33     juju deploy openvim-compute
34     juju relate mysql openvim
35     juju relate openvim-compute openvim
36     
37 # Creating and starting a VM
38
39 The openvim charm will create a default tenant, image, flavor,
40 and networks, but you'll want to add your own VM when you're ready to deploy.
41 This charm generates a basic VM yaml definition for you if you'd like to launch
42 one quickly. First, ssh into your openvim box:
43
44     juju ssh openvim-contrller/0 # may not be zero, find instance id with `juju status`.
45
46 Then create your VM and get its uuid:
47
48     /home/ubuntu/openmano/openvim/openvim vm-create /tmp/server.yaml
49     
50 And finally start it:
51
52     /home/ubuntu/openmano/openvim/openvim vm-start <vm-uuid>
53     
54
55 # Contact Information
56
57 Rye Terrell rye.terrell@canonical.com
58 George Kraft george.kraft@canonical.com