summaryrefslogtreecommitdiffstats
path: root/docs/Workspace_and_Development_Tools.rst
blob: 2012a20b09a57dae39d76b4a2a03393cfb3f0c1e (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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. Copyright 2017 Huawei Technologies Co., Ltd.

Workspace and Development Tools
===============================

We recognize that there are different ways to set up a workspace and different tools that may be chosen.  This is just one way to set things up.

Suggested Directory Structure
------------------------------
*NOTE*: You may have different versions of eclipse and java.

	onap
	
		.m2
		
		apache-maven-3.3.9
		
		camunda-modeler
		
		eclipse-jee-neon-3-linux-gtk-x86_64
		
		jdk1.8.0_131
		
		workspace
		
			SO
				chef-repo
				
				docker-config
				
				libs
				
				so
				
				so-config
				
Java
-----
Download the latest Java_8_SE_Development_Kit_ from Oracle.   Select a Linux x64 package.

Unpack it.

.. _Java_8_SE_Development_Kit: http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html

Maven
------

Download the Apache_Maven_3.3.9_ binary.  NOTE: 3.3.9 is the recommended version, even though much higher versions are available.

Unpack it.

.. _Apache_Maven_3.3.9: https://archive.apache.org/dist/maven/maven-3/3.3.9/binaries/

Create an .m2 directory for maven and put settings.xml_ in it.  Edit the local repository path in settings.xml to make it correct for your environment.  Everything else should be OK.

.. _settings.xml: https://wiki.onap.org/download/attachments/15997820/settings.xml?version=1&modificationDate=1506156303000&api=v2

Camunda Modeler
---------------

Download the Camunda_Modeler_.  Select the Linux x64 package.
Unpack it.

.. _Camunda_Modeler: https://camunda.org/download/modeler/

Eclipse
-------

Download Eclipse_for_Linux_.  Select the 64-bit Eclipse IDE for Java EE Developers.  Oxygen seems to be the latest version. These instructions were written for Neon.
Unpack it.

.. _Eclipse_for_Linux:  https://www.eclipse.org/downloads/eclipse-packages/?osType=linux

In the eclipse directory, edit eclipse.ini

	Add (or change) the -vm setting so that it points to your JDK.
	
	Adjust the maximum heap space (2GB is recommended).
	
	Example:
	
.. image:: images/Workspace_and_Development_Tools.png	
	
Eclipse Settings
----------------

**Configure eclipse to use your external maven 3.3.9 installation:**
	Go to Window→Preferences→Maven→Installations
	
	Click "Add" and browse to your apache-maven-3.3.9 directory.  Click "OK" to select it.
	
	Click "Finish"
	
.. image:: images/Workspace_and_Development_Tools_2.png

Make sure the external installation is selected:

.. image:: images/Workspace_and_Development_Tools_3.png

**Configure eclipse to use your settings.xml**
	Go to Window→Preferences→Maven→User Settings
	
	Type the full path to your settings.xml file into the "User Settings" box and click "OK".
	
.. image:: images/Workspace_and_Development_Tools_4.png
="p">.. _cli_cmd_sample: open-cli ======== schema-validate ---------------- input:: -l /tmp/hello-world.yaml output:: +--------+--------+ |sl-no |error | +--------+--------+ | | | +--------+--------+ schema-refresh ---------------- output:: +--------+--------------------------------+------------------+------------------------------------------------+----------+ |sl-no |command |product-version |schema |version | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |1 |vfmodule-create |onap-amsterdam |vfmodule-create-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |2 |schema-validate |open-cli |schema-validate.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |3 |schema-refresh |open-cli |schema-refresh.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |4 |cloud-list |onap-amsterdam |cloud-list-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |5 |sdnc-list |onap-amsterdam |sdnc-list-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |6 |sdnc-register |onap-amsterdam |sdnc-create-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |7 |sdnc-unregister |onap-amsterdam |sdnc-delete-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |8 |vnfm-show |onap-amsterdam |vnfm-show-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |9 |vnfm-unregister |onap-amsterdam |vnfm-delete-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |10 |vnfm-register |onap-amsterdam |vnfm-create-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |11 |vnfm-list |onap-amsterdam |vnfm-list-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |12 |vim-register |onap-amsterdam |vim-create-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |13 |vim-unregister |onap-amsterdam |vim-delete-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |14 |vim-list |onap-amsterdam |vim-list-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |15 |ems-list |onap-amsterdam |ems-list-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |16 |ems-register |onap-amsterdam |ems-create-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |17 |ems-show |onap-amsterdam |ems-show-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |18 |cloud-delete |onap-amsterdam |cloud-delete-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |19 |ems-unregister |onap-amsterdam |ems-delete-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |20 |subscription-list |openecomp |subscription-list-schema.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |21 |subscription-create |openecomp |subscription-create-schema.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |22 |subscription-list |onap-amsterdam |subscription-list-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |23 |subscription-create |onap-amsterdam |subscription-create-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |24 |subscription-delete |onap-amsterdam |subscription-delete-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |25 |customer-show |openecomp |customer-show-schema.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |26 |customer-show |onap-amsterdam |customer-show-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |27 |customer-list |openecomp |customer-list-schema.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |28 |customer-delete |openecomp |customer-delete-schema.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |29 |customer-create |openecomp |customer-create-schema.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |30 |customer-create |onap-amsterdam |customer-create-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |31 |customer-delete |onap-amsterdam |customer-delete-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |32 |customer-list |onap-amsterdam |customer-list-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |33 |vf-list |onap-amsterdam |vf-list-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |34 |service-list |onap-amsterdam |service-list-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |35 |vf-show |onap-amsterdam |vf-show-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |36 |tenant-create |onap-amsterdam |tenant-create-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |37 |tenant-list |onap-amsterdam |tenant-list-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |38 |tenant-delete |onap-amsterdam |tenant-delete-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |39 |service-type-create |openecomp |service-type-create-schema.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |40 |service-type-list |onap-amsterdam |service-type-list-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |41 |service-type-create |onap-amsterdam |service-type-create-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |42 |service-type-delete |openecomp |service-type-delete-schema.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |43 |service-type-list |openecomp |service-type-list-schema.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |44 |service-type-delete |onap-amsterdam |service-type-delete-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |45 |cloud-create |onap-amsterdam |cloud-create-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |46 |cloud-list |openecomp |cloud-list-schema.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |47 |microservice-delete |onap-amsterdam |microservice-delete-schema.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |48 |microservice-list |onap-amsterdam |microservice-list-schema.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |49 |microservice-show |onap-amsterdam |microservice-show-schema.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |50 |microservice-create |onap-amsterdam |microservice-create-schema.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |51 |hello-world |sample-1.0 |hello-world.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |52 |hello-world-http |sample-1.0 |hello-world-http.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |53 |vlm-checkin |onap-amsterdam |vlm-checkin-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |54 |license-group-create |openecomp |license-group-create-schema.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |55 |vlm-key-group-create |onap-amsterdam |vlm-key-group-create-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |56 |vlm-aggreement-list |onap-amsterdam |vlm-aggreement-list-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |57 |vlm-key-group-list |onap-amsterdam |vlm-key-group-list-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |58 |vlm-create |onap-amsterdam |vlm-create-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |59 |vlm-entitlement-pool-create |onap-amsterdam |vlm-entitlement-pool-create-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |60 |ep-show |openecomp |license-entitlement-pool-show-schema.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |61 |license-model-create |openecomp |license-model-create-schema.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |62 |license-group-show |openecomp |license-group-show-schema.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |63 |vsp-upload |openecomp |vsp-upload-schema.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |64 |vsp-package |onap-amsterdam |vsp-package-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |65 |vsp-submit |onap-amsterdam |vsp-submit-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |66 |vsp-checkout |onap-amsterdam |vsp-checkout-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |67 |vsp-create |openecomp |vsp-create-schema.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |68 |vsp-list |openecomp |vsp-list-schema.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |69 |vsp-show |onap-amsterdam |vsp-show-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |70 |vsp-show |openecomp |vsp-show-schema.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |71 |vsp-submit |openecomp |vsp-submit-schema.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |72 |vsp-create |onap-amsterdam |vsp-create-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |73 |vsp-add-artifact |onap-amsterdam |vsp-add-artifact-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |74 |vsp-revert |onap-amsterdam |vsp-revert-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |75 |vsp-checkin |openecomp |vsp-checkin-schema.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |76 |vsp-checkout |onap-amsterdam |vsp-checkout-schema.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |77 |vsp-validate |onap-amsterdam |vsp-validate-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |78 |vsp-list |onap-amsterdam |vsp-list-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |79 |vsp-checkin |onap-amsterdam |vsp-checkin-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |80 |service-model-checkin |onap-amsterdam |service-model-checkin-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |81 |service-model-distribute |onap-amsterdam |service-model-distribute-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |82 |service-model-list |onap-amsterdam |service-model-list-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |83 |service-model-certify-start |onap-amsterdam |service-model-certify-start-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |84 |service-model-add-vf |onap-amsterdam |service-model-add-vf-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |85 |service-model-certify-request |onap-amsterdam |service-model-certify-request-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |86 |service-model-revert |onap-amsterdam |service-model-checkout-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |87 |service-model-checkout |onap-amsterdam |service-model-revert-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |88 |service-model-certify-complete |onap-amsterdam |service-model-certify-complete-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |89 |service2vf-model-list |onap-amsterdam |service2vf-model-list-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |90 |service-model-create |onap-amsterdam |service-model-create-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |91 |service-model-approve |onap-amsterdam |service-model-approve-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |92 |vf-model-create |onap-amsterdam |vf-model-create-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |93 |vf-model-checkin |onap-amsterdam |vf-model-checkin-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |94 |vlm-revert |onap-amsterdam |vlm-revert-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |95 |vlm-feature-group-create |onap-amsterdam |vlm-feature-group-create-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |96 |vlm-submit |onap-amsterdam |vlm-submit-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |97 |license-model-show |openecomp |license-model-show-schema.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |98 |vf-model-certify-start |onap-amsterdam |vf-model-certify-start-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |99 |vf-model-list |onap-amsterdam |vf-model-list-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |100 |vlm-entitlement-pool-list |onap-amsterdam |vlm-entitlement-pool-list-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |101 |vlm-feature-group-list |onap-amsterdam |vlm-feature-group-list-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |102 |vlm-checkout |onap-amsterdam |vlm-checkout-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |103 |vlm-list |onap-amsterdam |vlm-list-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |104 |vlm-aggreement-create |onap-amsterdam |vlm-aggreement-create-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |105 |vf-model-certify-request |onap-amsterdam |vf-model-certify-request-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |106 |ep-create |openecomp |license-entitlement-pool-create-schema.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |107 |vf2vfmodule-model-list |onap-amsterdam |vf2vfmodule-model-list-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |108 |vf-model-certify-complete |onap-amsterdam |vf-model-certify-complete-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |109 |service-delete |onap-amsterdam |service-delete-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |110 |vfmodule-delete |onap-amsterdam |vf-module-delete-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |111 |vfmodule-create |onap-amsterdam |vfmodule-create-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |112 |service-create |onap-amsterdam |service-create-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |113 |vf-delete |onap-amsterdam |vf-delete-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+ |114 |vf-create |onap-amsterdam |vf-create-schema-1.1.yaml |1.0 | +--------+--------------------------------+------------------+------------------------------------------------+----------+