Fix document typo in readme.md
[multicloud/k8s.git] / README.md
1 <!-- Copyright 2018 Intel Corporation.
2 Licensed under the Apache License, Version 2.0 (the "License");
3 you may not use this file except in compliance with the License.
4 You may obtain a copy of the License at
5     http://www.apache.org/licenses/LICENSE-2.0
6 Unless required by applicable law or agreed to in writing, software
7 distributed under the License is distributed on an "AS IS" BASIS,
8 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
9 See the License for the specific language governing permissions and
10 limitations under the License. -->
11
12 # MultiCloud-k8s-plugin
13
14 MultiCloud Kubernetes plugin for ONAP multicloud.
15
16 # Installation
17
18 Requirements:
19 * Go 1.11
20
21 Steps:
22
23 * Clone repo in GOPATH src:
24     * `cd $GOPATH/src && git clone https://git.onap.org/multicloud/k8s`
25
26 * Run unit tests:
27     *  `make build`
28
29 * Compile to build Binary:
30     * `make deploy`
31
32 # Architecture
33
34 Create Virtual Network Function
35
36 ![Create VNF](./docs/create_vnf.png)
37
38 Create Virtual Link
39
40 ![Create VL](./docs/create_vl.png)