Merge "Update k8splugin snapshot image"
[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.14.4
20
21 Steps:
22
23 * Clone repo:
24     * `git clone https://git.onap.org/multicloud/k8s`
25
26 * Build everything:
27     *  `cd k8s/src/k8splugin && make all`
28
29 * Run Tests:
30     *  `cd k8s/src/k8splugin && make test`
31
32 * Generate Coverage Report:
33     * `cd k8s/src/k8splugin && make cover`
34
35 * Run the plugin:
36     * `cd k8s/deployments && ./start.sh`
37
38 # Troubleshooting
39
40 * Logs can be set as "warn" or "info" in the config.json file of the orchestrator directory. By default the log level is set as "warn".