README.md

   1 # ONAP SDC
   2
   3 ## Introduction
   4
   5 SDC is the ONAP visual modeling and design tool. It creates internal metadata that describes assets used by all ONAP components, both at design time and run time.
   6
   7 The SDC manages the content of a catalog and logical assemblies of selected catalog items to completely define how and when VNFs are realized in a target environment.
   8 A complete virtual assembly of specific catalog items, together with selected workflows and instance configuration data, completely defines how the deployment, activation, and life-cycle management of VNFs are accomplished.
   9
  10 SDC manages four levels of assets:
  11
  12 * Resource - A fundamental capability, implemented either entirely in software, or as software that interacts with a hardware device.
  13 Each Resource is a combination of one or more Virtual Function Components (VFCs), along with all the information necessary to instantiate, update, delete and manage the Resource.
  14 * Service - A well-formed object comprising one or more Resources. Service Designers create Services from Resources, and include all of the information about the Service needed to instantiate, update, delete and manage the Service.
  15
  16 The key output of SDC is a set of models containing descriptions of asset capabilities and instructions to manage them. These models are stored in the SDC Master Reference Catalog for the entire enterprise to use.
  17
  18 There are four major components of SDC:
  19
  20 * Catalog - The repository for assets at the Resource, Service and Product levels. Assets are added to the Catalog using the Design Studio.
  21 * Design Studio - Used to create, modify and add Resource, Service and Product definitions in the Catalog.
  22 * Certification Studio - Available in a future release, is used to test new assets at all levels. It will be used for sandbox experimentation, and will include support for automated testing.
  23 * Distribution Studio - Used to deploy certified assets. From the Distribution studio, new Product assets, including their underlying Resources and Services, are deployed into lab environments for testing purposes, and into production after certification is complete. In a future release, there will be a way to export Product information to external Business Support Systems for customer ordering and billing.
  24
  25 ## Git Configuration
  26
  27 Note that if you're working on Windows, it's important to enable long paths for your machine; otherwise git won't be able to handle some files.
  28
  29 In order to do so just add this section to your global git.config file under the `[core]` key:
  30
  31     longpaths = true
  32
  33 ## Compiling the Project
  34
  35 SDC is built from several projects while the parent "sdc" contains the main pom.xml for all of them:
  36 - asdctool              - set of utilities used for scheme creation and data migration in SDC
  37 - catalog-be            - backend code
  38 - catalog-fe            - frontend java code (servlet, proxy)
  39 - catalog-dao           - database layer
  40 - catalog-model         - data model of the application
  41 - catalog-ui            - front end code (javascript, html, css)
  42 - common                - set of utilities used by the onboarding project
  43 - common-app-api        - common code for frontend and backend
  44 - common-be             - utilities, datatypes and enums
  45 - security-utils        - handle encryption/decryption of passwords
  46 - onboarding-be         - onboarding backend code
  47 - onboarding-ui         - onboarding frontend code
  48 - test-apis-ci          - the automation framework used by SDC for API based testing
  49 - ui-ci                 - the automation framework used by SDC for UI based testing, based on Selenium
  50 - sdc-os-chef           - chefs scripts used for docker creation and startup
  51 - utils                 - set of dev utils used for working with the project locally
  52
  53 In order to build all the projects, go to sdc project and run the command: `mvn clean install`
  54
  55 Currently SDC build process also supports docker building.
  56 Note that if you're working on Windows, you'll need to define an environment variable on your machine with key `DOCKER_HOST` and value: `tcp://<ip_address>:2375` in order to build and upload local dockers to a local environment.
  57
  58 For the dockers to be built during the build process use the "docker" profile by adding `-P docker` to the `mvn clean install` command
  59
  60 More flags to use in the build process are:
  61 * -DskipTests - Skips unit tests execution
  62 * -DskipUICleanup=true - Skips deleting the UI folders
  63 * -Djacoco.skip=true - Skips running jacoco tests
  64 * -DskipPMD - Skips creating a PMD report
  65
  66 **using those flags will speed up the building process of the project**
  67
  68 ## Accessing SDC
  69
  70 In order to access the sdc from your local vagrant environment you'll need to run the webseal_simulator docker.
  71 This can be achieved by using the command: `/data/scripts/simulator_docker_run.sh`
  72
  73 To access the simulator just go to this url: `http://<ip_address>:8285/login`
  74
  75 For more information regarding using the webseal_simulator please refer to the following guide: [SDC Simulator](https://wiki.onap.org/display/DW/SDC+Simulator)
  76
  77 ## Accessing SDC UI in Dev Mode
  78
  79 In order to access the SDC UI from your dev environment you need to do the following:
  80
  81 1. Go to file `webpack.server.js` found under the catalog-ui folder in the main sdc project and update the "localhost" variable to be the ip of your local vagrant machine.
  82 2. Navigate to the catalog-ui folder and run the command: `npm start -- --env.role <wanted_role>` with the wanted role to login to SDC as.
  83
  84 ## SDC Containers
  85
  86 The following table shows the SDC containers found on the vagrant after a successful build:
  87
  88 | Name                | Description                                                                                                                                   |
  89 |---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
  90 | sdc-cs              | The Docker contains our Cassandra server. On docker startup the Cassandra server is started.                                                  |
  91 | sdc-cs-init         | The docker contains the logic for creating the needed schemas for SDC catalog server,  On docker startup, the schemes are created.            |
  92 | sdc-cs-onboard-init | The docker contains the logic for creating the needed schemas for SDC onboarding server, On docker startup, the schemes are created.          |
  93 | sdc-es              | The Docker contains Elastic Search server. On docker startup, Elastic Search server is started.                                               |
  94 | sdc-init-es         | The Docker contains the logic for creating the needed mapping for SDC and the views for kibana. On docker startup, the mapping is created.    |
  95 | sdc-onboard-BE      | The Docker contains the onboarding Backend Jetty server. On docker startup, the Jetty server is started with the application.                 |
  96 | sdc-BE              | The Docker contains the catalog Backend Jetty server. On docker startup, the Jetty server is started with the application.                    |
  97 | sdc-BE-init         | The docker contains the logic for importing the SDC Tosca normative types and the logic for configuring external users for SDC external APIs. |
  98 |                     | On startup, the docker executes the rest calls to the catalog server.                                                                         |
  99 | sdc-FE              | The Docker contains the SDC Fronted Jetty server. On docker startup, the Jetty server is started with our application.                        |
 100
 101 For further information and an image explaining the containers dependency map please refer to the following page: [SDC Docker Diagram](https://wiki.onap.org/display/DW/SDC+Troubleshooting)
 102
 103 ## Testing the Project
 104
 105 The dockers that are responsible for running automation tests in the local environment are built as part of SDC docker profile build.
 106
 107 In order to run the automation tests when starting the dockers on the machine, there are 2 flags to use:
 108
 109 * -tad - Use this flag to run the default suite of API tests
 110 * -tud - Use this flag to run the default suite of UI tests
 111
 112 This link lists all the commands in the vagrant-onap: [Vagrant Common Commands](https://wiki.onap.org/display/DW/SDC+Vagrant+Common+Commands)
 113
 114 SDC docker_run script is documented here: [SDC docker_run Script Usage](https://wiki.onap.org/display/DW/SDC+docker_run+Script+Usage)
 115
 116 For more information regarding testing the project please refer to the following guide: [SDC Sanity](https://wiki.onap.org/display/DW/SDC+Sanity)
 117
 118 ## SDC on OOM
 119
 120 For more information regarding SDC on OOM please refer to the following page: [SDC on OOM](https://wiki.onap.org/display/DW/SDC+on+OOM)
 121
 122 ## Frontend Local Env - onboarding
 123
 124 ### Steps:
 125
 126 Install nodejs & gulp
 127 1. download nodejs from here: https://nodejs.org/en/ (take the "current" version with latest features) & install it.
 128 2. install gulp by running the following command: npm install --global gulp-cli
 129
 130 ### Install DOX-UI a:
 131
 132 1. pull for latest changes
 133 2. go to folder dox-sequence-diagram-ui
 134 3. run npm install
 135 4. wait for it...
 136 5. go to folder dox-ui
 137 6. run npm install
 138 7. create a copy of devConfig.defaults.json file and name it devConfig.json (we already configured git to ignore it so it will not be pushed)
 139 8. in that file, populate the fields of the IP addresses of your BE machine you'd like to connect (pay attention, it is a JSON file): For example http://<host>:<port>
 140 9. after everything is successful, run gulp
 141 10. after server is up, your favorite UI will wait for you at: http://localhost:9000/sdc1/proxy-designer1#/onboardVendor
 142
 143 ### Troubleshooting:
 144
 145 | Problem                       |   Why is this happening | Solution                                                                                   |
 146 |-------------------------------|-------------------------|--------------------------------------------------------------------------------------------|
 147 | npm cannot reach destination  | onboarding proxy        | When within onboarding network, you should set onboarding proxy to NPM as the following:   |
 148 |                               |                         | npm config set proxy http://genproxy:8080                                                  |
 149 |                               |                         | npm config set https-proxy http://genproxy:8080                                            |
 150 |                               |                         |                                                                                            |
 151 | git protocol is blocked       | onboarding network      | When within onboarding network, you should set globally that when git                      |
 152 | and cannot connect            | rules for protocols     | protocol is used, it will be replaced with "https"                                         |
 153 |                               |                         | git config --global url."https://".insteadOf git://                                        |
 154 --------------------------------------------------------------------------------------------------------------------------------------------------------
 155
 156 ## SDC Troubleshooting
 157
 158 In order to check the life state of SDC you can run the command `health` from inside the vagrant.
 159 Alternatively you can run the following commands to check the FE and BE status:
 160
 161 FE - `curl http://<ip_address>:8181/sdc1/rest/healthCheck`
 162
 163 BE - `curl http://<ip_address>:8080/sdc2/rest/healthCheck`
 164
 165 Another method to check about problems in SDC is to look at the log files.
 166 The log files of the SDC can be found in the `/data/logs` folder
 167
 168 The docker logs are found under the directory `/docker_logs`.
 169
 170 The jetty(Applicative) are found in the respective folder according to the wanted section
 171 For example, the BE logs will found under the directory `/BE`.
 172
 173 For more information regarding SDC Troubleshooting please refer to the following guide: [SDC Troubleshooting](https://wiki.onap.org/display/DW/SDC+Troubleshooting)
 174
 175 ## Getting Help
 176
 177 #####  [Mailing list](mailto:onap-sdc@lists.onap.org)
 178
 179 ##### [JIRA](http://jira.onap.org)
 180
 181 ##### [WIKI](https://wiki.onap.org/display/DW/Service+Design+and+Creation+%28SDC%29+Portal)