summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorShashank Kumar Shankar <shashank.kumar.shankar@intel.com>2018-08-20 15:50:50 -0700
committerVictor Morales <victor.morales@intel.com>2018-08-24 15:51:16 -0700
commita1373742a2c3f980360e4980f3b23b0ff3480ae6 (patch)
treece2fb583dea15b8a546d794d21786fdf0f666539 /README.md
parent6ff216219ccb4567baeb34c9dba73daabb60f629 (diff)
Seed code for k8s multicloud plugin
This patch provides the initial seed code for the multicloud Kubernetes plugin and also provides the plugin feature to add new Kubernetes kinds. Change-Id: Ie5ee414656665070cde2834c4855ac2ebc179a9a Issue-ID: MULTICLOUD-301 Signed-off-by: Shashank Kumar Shankar <shashank.kumar.shankar@intel.com> Signed-off-by: Victor Morales <victor.morales@intel.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md41
1 files changed, 41 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..0e62378f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@
+<!-- Copyright 2018 Intel Corporation.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License. -->
+
+# MultiCloud-k8-plugin
+
+MultiCloud Kubernetes plugin for ONAP multicloud.
+
+# Installation
+
+Requirements:
+* Go 1.10
+* Dep
+
+Steps:
+
+* Clone repo in GOPATH src:
+ * `cd $GOPATH/src && git clone https://git.onap.org/multicloud/k8s`
+
+* Run unit tests:
+ * `make build`
+
+* Compile to build Binary:
+ * `make deploy`
+
+# Archietecture
+
+Create Virtual Network Function
+
+![Create VNF](./doc/create_vnf.png)
+
+Create Virtual Link
+
+![Create VL](./doc/create_vl.png)