aboutsummaryrefslogtreecommitdiffstats
path: root/kubernetes/README.md
blob: 9d8d4cc9abfc9f9254beb4f61a3d11f91c3808d9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
## **Quick Start Guide**


This is a quick start guide describing how to deploy ONAP on Kubernetes using Helm.

Pre-requisites:

-  Your Kubernetes environment must be available. For more information see, [ONAP on Kubernetes](https://wiki.onap.org/display/DW/ONAP+on+Kubernetes).
-  Deployment artifacts are customized for your location.


### **Deploy ONAP Instance**

Step 1. Clone the OOM repository from ONAP gerrit:

```
> git clone http://gerrit.onap.org/r/oom
> cd oom/kubernetes
```

Step 2. Customize the oom/kubernetes/onap parent chart, like the values.yaml file, to suit your deployment. You may want to selectively enable or disable ONAP components by changing the subchart **enabled** flags to *true* or *false*.  The .yaml file for OpenStackEncryptedPassword should be the MSO ecnrypted value of the openstack tenant password
```
Example:
...
robot: # Robot Health Check
  enabled: true
sdc:
  enabled: false
sdnc:
  enabled: false
so: # Service Orchestrator
  enabled: true
...
```
Step 3. To setup a local Helm repository to serve up the local ONAP charts:
        [Note: ensure helm init has been executed on the node, or run helm init --client-only]
```
> helm serve &
```
Note the port number that is listed and use it in the Helm repo add as follows:
```
> helm repo add local http://127.0.0.1:8879
```

Step 4. Build a local Helm repository (from the kubernetes directory):
```
> make all
```

Step 5. Display the charts that are available to be deployed:
```
> helm search -l
NAME                    VERSION    DESCRIPTION
local/appc              2.0.0      Application Controller
local/clamp             2.0.0      ONAP Clamp
local/onap              2.0.0      Open Network Automation Platform (ONAP)
local/robot             2.0.0      A helm Chart for kubernetes-ONAP Robot
local/so                2.0.0      ONAP Service Orchestrator
...
```

**Note:**
Setup of this Helm repository is a one time activity. If you make changes to your deployment charts or values be sure to use **make** to update your local Helm repository.

Step 6. Once the repo is setup, installation of ONAP can be done with a single command:
```
> helm install local/onap --name dev --namespace onap
```
**Note:** the **--namespace onap** is currently required while all onap helm charts are migrated to version 2.0. After this activity is complete, namespaces will be optional.

Use the following to monitor your deployment and determine when ONAP is ready for use:
```
> kubectl get pods --all-namespaces -o=wide
```


#### **Cleanup deployed ONAP instance**

To delete a deployed instance, use the following command:
```
> helm del dev --purge
```



For more information on OOM project documentation, refer to:

 -  [Quick Start Guide on Wiki](https://wiki.onap.org/display/DW/ONAP+Operations+Manager+Project#ONAPOperationsManagerProject-QuickStartGuide)
 -  [Quick Start Guide on readthedocs](http://onap.readthedocs.io/en/latest/submodules/oom.git/docs/OOM%20Project%20Description/oom_project_description.html#quick-start-guide)
icensed * under the Creative Commons License, Attribution 4.0 Intl. (the “License”); * you may not use this documentation except in compliance with the License. * You may obtain a copy of the License at * * https://creativecommons.org/licenses/by/4.0/ * * Unless required by applicable law or agreed to in writing, documentation * 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. * * ============LICENSE_END============================================ * * ECOMP is a trademark and service mark of AT&T Intellectual Property. */ package org.onap.portalsdk.analytics.model.definition; import java.util.ArrayList; import java.util.HashMap; import java.util.List; import org.onap.portalsdk.analytics.RaptorObject; import org.onap.portalsdk.analytics.view.DataRow; import org.onap.portalsdk.analytics.view.DataValue; import org.onap.portalsdk.analytics.view.ReportData; public class ReportMap extends RaptorObject { String markerColor = ""; String addressColumn = ""; String dataColumn = ""; String isMapAllowedYN = ""; String addAddressInDataYN = ""; List markers = new ArrayList(); public String getIsMapAllowedYN() { return isMapAllowedYN; } public void setIsMapAllowedYN(String isMapAllowedYN) { this.isMapAllowedYN = isMapAllowedYN; } public ReportMap(String markerColor, String addressColumn, String dataColumn, String isMapAllowed, String addAddressInDataYN){ this.setMarkerColor(markerColor); this.setAddressColumn(addressColumn); this.setDataColumn(dataColumn); this.setIsMapAllowedYN(isMapAllowed); this.setAddAddressInDataYN(addAddressInDataYN); } public String getAddressColumn() { return addressColumn; } public void setAddressColumn(String addressColumn) { this.addressColumn = addressColumn; } public String getDataColumn() { return dataColumn; } public void setDataColumn(String dataColumn) { this.dataColumn = dataColumn; } public String getMarkerColor() { return markerColor; } public void setMarkerColor(String markerColor) { this.markerColor = markerColor; } public List getMarkers() { return markers; } public void setMarkers(List markers) { this.markers = markers; } public String getAddAddressInDataYN() { return addAddressInDataYN; } public void setAddAddressInDataYN(String addAddressInDataYN) { this.addAddressInDataYN = addAddressInDataYN; } }