docs/installconfigure/Workspace_and_Development_Tools.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. Copyright 2017 Huawei Technologies Co., Ltd.
   4
   5 Workspace and Development Tools
   6 ===============================
   7
   8 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.
   9
  10 Suggested Directory Structure
  11 ------------------------------
  12 *NOTE*: You may have different versions of eclipse and java.
  13
  14         onap
  15
  16                 .m2
  17
  18                 apache-maven-3.3.9
  19
  20                 camunda-modeler
  21
  22                 eclipse-jee-neon-3-linux-gtk-x86_64
  23
  24                 jdk1.8.0_131
  25
  26                 workspace
  27
  28                         SO
  29                                 chef-repo
  30
  31                                 docker-config
  32
  33                                 libs
  34
  35                                 so
  36
  37                                 so-config
  38
  39 Java
  40 -----
  41 Download the latest Java_8_SE_Development_Kit_ from Oracle.   Select a Linux x64 package.
  42
  43 Unpack it.
  44
  45 .. _Java_8_SE_Development_Kit: http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html
  46
  47 Maven
  48 ------
  49
  50 Download the Apache_Maven_3.3.9_ binary.  NOTE: 3.3.9 is the recommended version, even though much higher versions are available.
  51
  52 Unpack it.
  53
  54 .. _Apache_Maven_3.3.9: https://archive.apache.org/dist/maven/maven-3/3.3.9/binaries/
  55
  56 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.
  57
  58 .. _settings.xml: https://wiki.onap.org/download/attachments/15997820/settings.xml?version=1&modificationDate=1506156303000&api=v2
  59
  60 Camunda Modeler
  61 ---------------
  62
  63 Download the Camunda_Modeler_.  Select the Linux x64 package.
  64 Unpack it.
  65
  66 .. _Camunda_Modeler: https://camunda.org/download/modeler/
  67
  68 Eclipse
  69 -------
  70
  71 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.
  72 Unpack it.
  73
  74 .. _Eclipse_for_Linux:  https://www.eclipse.org/downloads/eclipse-packages/?osType=linux
  75
  76 In the eclipse directory, edit eclipse.ini
  77
  78         Add (or change) the -vm setting so that it points to your JDK.
  79
  80         Adjust the maximum heap space (2GB is recommended).
  81
  82         Example:
  83
  84 .. image:: images/Workspace_and_Development_Tools.png
  85
  86 Eclipse Settings
  87 ----------------
  88
  89 **Configure eclipse to use your external maven 3.3.9 installation:**
  90         Go to Window→Preferences→Maven→Installations
  91
  92         Click "Add" and browse to your apache-maven-3.3.9 directory.  Click "OK" to select it.
  93
  94         Click "Finish"
  95
  96 .. image:: images/Workspace_and_Development_Tools_2.png
  97
  98 Make sure the external installation is selected:
  99
 100 .. image:: images/Workspace_and_Development_Tools_3.png
 101
 102 **Configure eclipse to use your settings.xml**
 103         Go to Window→Preferences→Maven→User Settings
 104
 105         Type the full path to your settings.xml file into the "User Settings" box and click "OK".
 106
 107 .. image:: images/Workspace_and_Development_Tools_4.png