docs/Workspace_and_Development_Tools.rst


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
.highlight .hll { background-color: #ffffcc }
.highlight .c { color: #888888 } /* Comment */
.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
.highlight .k { color: #008800; font-weight: bold } /* Keyword */
.highlight .ch { color: #888888 } /* Comment.Hashbang */
.highlight .cm { color: #888888 } /* Comment.Multiline */
.highlight .cp { color: #cc0000; font-weight: bold } /* Comment.Preproc */
.highlight .cpf { color: #888888 } /* Comment.PreprocFile */
.highlight .c1 { color: #888888 } /* Comment.Single */
.highlight .cs { color: #cc0000; font-weight: bold; background-color: #fff0f0 } /* Comment.Special */
.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .gr { color: #aa0000 } /* Generic.Error */
.highlight .gh { color: #333333 } /* Generic.Heading */
.highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
.highlight .go { color: #888888 } /* Generic.Output */
.highlight .gp { color: #555555 } /* Generic.Prompt */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #666666 } /* Generic.Subheading */
.highlight .gt { color: #aa0000 } /* Generic.Traceback */
.highlight .kc { color: #008800; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #008800; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #008800; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #008800 } /* Keyword.Pseudo */
.highlight .kr { color: #008800; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #888888; font-weight: bold } /* Keyword.Type */
.highlight .m { color: #0000DD; font-weight: bold } /* Literal.Number */
.highlight .s { color: #dd2200; background-color: #fff0f0 } /* Literal.String */
.highlight .na { color: #336699 } /* Name.Attribute */
.highlight .nb { color: #003388 } /* Name.Builtin */
.highlight .nc { color: #bb0066; font-weight: bold } /* Name.Class */
.highlight .no { color: #003366; font-weight: bold } /* Name.Constant */
.highlight .nd { color.. 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