| commit | 38b3b95830568296bde457cd33f79277765f5704 | [log] [tgz] |
|---|---|---|
| author | Wojciech Sliwka <wojciech.sliwka@nokia.com> | Wed Jul 03 08:38:28 2019 +0200 |
| committer | Tomasz Golabek <tomasz.golabek@nokia.com> | Tue Jul 23 11:33:02 2019 +0000 |
| tree | 0dea07cbf7469f3c1f4b93d04510312ec86226e6 | |
| parent | a73cbca41fbba96855173f39c89c04d50d4d8672 [diff] |
Migrate swagger to openapi v3 Issue-ID: SDC-2261 Change-Id: I614c15878b9d165a4468570e8318867632c88434 Signed-off-by: Wojciech Sliwka <wojciech.sliwka@nokia.com>
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.
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. 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.
SDC manages four levels of assets:
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.
There are four major components of SDC:
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.
In order to do so just add this section to your global git.config file under the [core] key:
longpaths = true
SDC is built from several projects while the parent "sdc" contains the main pom.xml for all of them:
In order to build all the projects, go to sdc project and run the command: mvn clean install
Currently SDC build process also supports docker building. 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.
For the dockers to be built during the build process use the "docker" profile by adding -P docker to the mvn clean install command
More flags to use in the build process are:
using those flags will speed up the building process of the project
In order to access the sdc from your local vagrant environment you'll need to run the webseal_simulator docker. This can be achieved by using the command: /data/scripts/simulator_docker_run.sh
To access the simulator just go to this url: http://<ip_address>:8285/login
For more information regarding using the webseal_simulator please refer to the following guide: SDC Simulator
In order to access the SDC UI from your dev environment you need to do the following:
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.npm start -- --env.role <wanted_role> with the wanted role to login to SDC as.The following table shows the SDC containers found on the vagrant after a successful build:
| Name | Description |
|---|---|
| sdc-cs | The Docker contains our Cassandra server. On docker startup the Cassandra server is started. |
| sdc-cs-init | The docker contains the logic for creating the needed schemas for SDC catalog server, On docker startup, the schemes are created. |
| 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. |
| sdc-es | The Docker contains Elastic Search server. On docker startup, Elastic Search server is started. |
| 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. |
| sdc-onboard-BE | The Docker contains the onboarding Backend Jetty server. On docker startup, the Jetty server is started with the application. |
| sdc-BE | The Docker contains the catalog Backend Jetty server. On docker startup, the Jetty server is started with the application. |
| 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. |
| On startup, the docker executes the rest calls to the catalog server. | |
| sdc-FE | The Docker contains the SDC Fronted Jetty server. On docker startup, the Jetty server is started with our application. |
For further information and an image explaining the containers dependency map please refer to the following page: SDC Docker Diagram
The dockers that are responsible for running automation tests in the local environment are built as part of SDC docker profile build.
In order to run the automation tests when starting the dockers on the machine, there are 2 flags to use:
This link lists all the commands in the vagrant-onap: Vagrant Common Commands
SDC docker_run script is documented here: SDC docker_run Script Usage
For more information regarding testing the project please refer to the following guide: SDC Sanity
For more information regarding SDC on OOM please refer to the following page: SDC on OOM
Install nodejs & gulp
| Problem | Why is this happening | Solution |
|---|---|---|
| npm cannot reach destination | onboarding proxy | When within onboarding network, you should set onboarding proxy to NPM as the following: |
| npm config set proxy http://genproxy:8080 | ||
| npm config set https-proxy http://genproxy:8080 | ||
| git protocol is blocked | onboarding network | When within onboarding network, you should set globally that when git |
| and cannot connect | rules for protocols | protocol is used, it will be replaced with "https" |
| git config --global url."https://".insteadOf git:// |
In order to check the life state of SDC you can run the command health from inside the vagrant. Alternatively you can run the following commands to check the FE and BE status:
FE - curl http://<ip_address>:8181/sdc1/rest/healthCheck
BE - curl http://<ip_address>:8080/sdc2/rest/healthCheck
Another method to check about problems in SDC is to look at the log files. The log files of the SDC can be found in the /data/logs folder
The docker logs are found under the directory /docker_logs.
The jetty(Applicative) are found in the respective folder according to the wanted section For example, the BE logs will found under the directory /BE.
For more information regarding SDC Troubleshooting please refer to the following guide: SDC Troubleshooting