Fixed some typos
[osm/openvim.git] / charm / README.md
1 # Juju Charms for deploying OpenVIM
2
3 ## Overview
4 These are the charm layers used to build Juju charms for deploying OpenVIM components. These charms are also published to the [Juju Charm Store](https://jujucharms.com/) and can be deployed directly from there using the [etsi-osm](https://jujucharms.com/u/nfv/etsi-osm), or they can be build from these layers and deployed locally.
5
6 ## Building the OpenVIM Charms
7
8 To build these charms, you will need [charm-tools][]. You should also read
9 over the developer [Getting Started][] page for an overview of charms and
10 building them. Then, in any of the charm layer directories, use `charm build`.
11 For example:
12
13     export JUJU_REPOSITORY=$HOME/charms
14     mkdir $HOME/charms
15
16     cd openvim/charms/hadoop/layer-openvim
17     charm build
18
19 This will build the OpenVIM controller charm, pulling in the appropriate base and
20 interface layers from [interfaces.juju.solutions][]. You can get local copies
21 of those layers as well using `charm pull-source`:
22
23     export LAYER_PATH=$HOME/layers
24     export INTERFACE_PATH=$HOME/interfaces
25     mkdir $HOME/{layers,interfaces}
26
27     charm pull-source layer:openvim-compute
28     charm pull-source interface:openvim-compute
29
30 You can then deploy the locally built charms individually:
31
32     juju deploy local:exenial/openvim
33
34 You can also use the local version of a bundle:
35
36     juju deploy openvim/charms/bundles/openmano.yaml
37
38 > Note: With Juju versions < 2.0, you will need to use [juju-deployer][] to
39 deploy the local bundle.
40
41
42 [charm-tools]: https://jujucharms.com/docs/stable/tools-charm-tools
43 [Getting Started]: https://jujucharms.com/docs/devel/developer-getting-started
44 [interfaces.juju.solutions]: http://interfaces.juju.solutions/
45 [juju-deployer]: https://pypi.python.org/pypi/juju-deployer/