docs/Workspace_and_Development_Tools.rst

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