Contributioning to SDC
Prerequisites
TODO Link to Onap contribution page
JIRA
SDC issues are tracked on ONAP JIRA: https://jira.onap.org/secure/RapidBoard.jspa?rapidView=71&projectKey=SDC
Jenkins
JIRA project CI: https://jenkins.onap.org/view/sdc/
Gerrit
Chenage proposals for SDC projects are available here: https://gerrit.onap.org/r/#/admin/projects/?filter=sdc
Coding Policy
Role of SDC in ONAP - component use cases
TODO describe/link to sdc onbaording demo, describe design time
High level architecture
Architecture is described on another subpage: SDC Architecture
Subprojects
| Component | Description | |
|---|---|---|
| asdctool | Collection of standalone utilities used in different projects: import, export, migration etc. | |
build-tools | ||
| Catalog | catalog-be | Business logic of the app. Compiles to WAR. |
catalog-dao | Manages persistance layer:
// Contains dead Neo4j code. It may replace titan | |
catalog-fe | Proxy between ui and backend. Contains business logic as well. | |
catalog-model | Connection layer, serves models to other projects | |
catalog-ui | ||
| common | ||
common-app-api | Utils and logic shared between frontend and backend. | |
common-be | ||
dcae-d | ||
docs | ||
dox-sequence-diagram-ui | ||
jtosca | Generic TOSCA parser based on 1.1 spec | |
onap-ui | ||
openecomp-bdd | ||
openecomp-be | ||
openecomp-ui | ||
sdc-distribution-client | ||
sdc-docker-base | Docker creation project | |
sdc-os-chef | ||
sdc-titan-cassandra | ||
| sdc-tosca | TOSCA parser based on jtosca. Complies with ONAP SDC TOSCA model(?) | |
sdc-workflow-designer | Graphic tool for service lifecycle management | |
security-utils | ||
services | ||
| ui-ci |
Dependencies
SDC is a standalone application that, as such, does not require any other components. Deployed SDC enables to import or create an asset (design time). In order to take advantage of it (deploy a service) other components are required. For a start, please see:
- DCAE
- SO
- VID
- DMaaP
Interfaces - API and clients
Distribution Client
APIs
APIs are available on the page generated from SDC repo: http://onap.readthedocs.io/en/latest/submodules/sdc.git/docs/offeredapis.html
Documentation available in another pages: SDC API
Documentation
Documentation generated from code repository: http://onap.readthedocs.io/en/latest/submodules/sdc.git/docs/index.html
User interface
Onap home page for design related issues: Design
Tutorials
- Building and running SDC using Docker for OSX
- Categories to use in SDC project
- Consumer creation
- Csar Structure
- Deploying SDC on a Linux VM for Development
- SDC Artifact Versions
- SDC - Blessing Flow
- SDC Distribution model
- SDC docker_run Script Usage
- SDC Importing New Normatives - UNDER Construction!!!!
- SDC Jenkins Triggers
- SDC on OOM
- SDC Sanity
- SDC Simulator
- SDC supported artifact types
- SDC SWAGGER
- SDC Troubleshooting
- SDC Vagrant Common Commands
- Using Lab POD-ONAP-01 Environment
- Using Vagrant-Onap for local deployment of SDC project
- VOLTE test case input collection for tracking