-##### Format code with ktlint checkstyle tool use the following command
-
+### Format code with ktlint checkstyle tool use the following command
`mvn process-sources -P format`
-
-## Reference
+#### Reference
https://github.com/pinterest/ktlint
-## Getting started
-
+## Basic Architecture

## Basic Requirements
Before you can build this project, you must install and configure the following dependencies on your machine:
- 1- Java 8 SDK
-
+ 1- Java 11 SDK
2- Node and npm installed
-
3- Angular CLI & Angular v8
-
4- MySQL Database
-
- 5- maven
+ 5- Maven 3.6.X
## Running in Development Mode
-* In the main project folder run `mvn clean install` command to install all libraries and dependencies for maven and npm.
+Running `mvn clean install` command to install all libraries and dependencies for the maven and npm.
+Running `mvn clean install -Pdocker` command to install all libraries and create below docker images
+ * ccsdk-blueprintsprocessor
+ * ccsdk-commandexecutor
+ * ccsdk-py-executor
+ * ccsdk-sdclistener
+ * ccsdk-cds-ui-server
+ * ccsdk-cds-ui
- 1- Back-end MS
-
- * create `sdnctl` table in MySQL
+**Note:** run `mvn clean install -Pdocker -Ddocker.skip.push=true` to skip pushing built docker image
+
+1) Back-end MS
+ * Create `sdnctl` table in MySQL
* (Optional) You could run the project in a specific profile(dev, local) by adding `-Dspring.profiles.active=profile-name`
-2- Loop-back server: that allow your request to reach the backend from cds-ui
+2) Loop-back server: that allow your request to reach the backend from cds-ui
* move to `./cds-ui/server/` folder and run the command `npm start`
- 3- cds-ui
+3) cds-ui
- * move to `./cds-ui/designer-client/` folder and run the command `npm start`, This command will make sure all the files follow the linting rules and then connect to the loopback server.
+ * Move to `./cds-ui/designer-client/` folder and run the command `npm start`.
+ * This command will make sure all the files follow the linting rules and then connect to the loopback server.
## Using an IDE
**Front-end** you could use `vscode` or `webstorm`.
-**Back-end** `Intellij` with kotlin plugin or any other editor
+**Back-end** `IntelliJ` with kotlin plugin or any other editor
---
-For more information check the `docs` folder.
\ No newline at end of file
+For more information check: https://docs.onap.org/projects/onap-ccsdk-cds/en/latest/index.html
\ No newline at end of file
</parent>
<artifactId>cds-ui-application</artifactId>
- <version>1.0.0-SNAPSHOT</version>
<packaging>pom</packaging>
<name>UI Application</name>
</parent>
<artifactId>cds-ui-client</artifactId>
- <version>1.0.0-SNAPSHOT</version>
<packaging>pom</packaging>
<name>UI Client</name>
</parent>
<artifactId>cds-ui-designer-client</artifactId>
- <version>1.0.0-SNAPSHOT</version>
<packaging>pom</packaging>
<name>UI designer Client</name>
<modelVersion>4.0.0</modelVersion>
<parent>
- <groupId>org.onap.ccsdk.parent</groupId>
- <artifactId>spring-boot-starter-parent</artifactId>
- <version>2.0.1</version>
- <relativePath/>
+ <groupId>org.onap.ccsdk.cds</groupId>
+ <artifactId>cds-aggregator</artifactId>
+ <version>1.0.0-SNAPSHOT</version>
+ <relativePath>..</relativePath>
</parent>
- <groupId>org.onap.ccsdk.cds</groupId>
<artifactId>cds-ui</artifactId>
- <version>1.0.0-SNAPSHOT</version>
<packaging>pom</packaging>
<name>UI Parent</name>
<properties>
<npm.executable>npm</npm.executable>
- <image.name>onap/ccsdk-cds-ui</image.name>
- <ccsdk.cds.version>${project.version}</ccsdk.cds.version>
- <ccsdk.build.timestamp>${maven.build.timestamp}</ccsdk.build.timestamp>
- <maven.build.timestamp.format>yyyyMMdd'T'HHmmss'Z'</maven.build.timestamp.format>
-
- <!-- docker related properties -->
- <docker.verbose>true</docker.verbose>
- <docker.skip.push>false</docker.skip.push>
- <docker.push.phase>deploy</docker.push.phase>
</properties>
</project>
</parent>
<artifactId>cds-ui-server</artifactId>
- <version>1.0.0-SNAPSHOT</version>
<packaging>pom</packaging>
<name>UI Server</name>
<groupId>org.onap.ccsdk.cds.components.cba</groupId>
<artifactId>blueprint-model</artifactId>
- <version>1.0.0-SNAPSHOT</version>
<packaging>pom</packaging>
<name>Components Model Catalog - Blueprints Model</name>
</parent>
<artifactId>test-blueprint-kotlin-parent</artifactId>
- <version>1.0.0-SNAPSHOT</version>
<packaging>pom</packaging>
<name>Components Model Catalog - Blueprints Model - Test Kotlin Parent</name>
</parent>
<artifactId>test-blueprint-model</artifactId>
- <version>1.0.0-SNAPSHOT</version>
<packaging>pom</packaging>
<name>Components Model Catalog - Blueprints Model - Test Blueprints</name>
</parent>
<artifactId>cds-components</artifactId>
- <version>1.0.0-SNAPSHOT</version>
<packaging>pom</packaging>
<name>Components (Root)</name>
<groupId>org.onap.ccsdk.cds.blueprintsprocessor.functions</groupId>
<artifactId>ansible-awx-executor</artifactId>
- <version>1.0.0-SNAPSHOT</version>
<name>MS Blueprints Processor Functions - Ansible AWX Executor</name>
<description>Blueprints Processor Function - Ansible Executor</description>
<groupId>org.onap.ccsdk.cds.blueprintsprocessor.functions</groupId>
<artifactId>cli-executor</artifactId>
- <version>1.0.0-SNAPSHOT</version>
<name>MS Blueprints Processor Functions - CLI Executor</name>
<description>Blueprints Processor Function - CLI Executor</description>
<groupId>org.onap.ccsdk.cds.blueprintsprocessor.functions</groupId>
<artifactId>config-snapshots</artifactId>
- <version>1.0.0-SNAPSHOT</version>
<name>MS Blueprints Processor Functions - Config Snapshots</name>
<description>Blueprints Processor Function - Config Snapshots</description>
<groupId>org.onap.ccsdk.cds.blueprintsprocessor.functions</groupId>
<artifactId>k8s-profile-upload</artifactId>
- <version>1.0.0-SNAPSHOT</version>
<name>MS Blueprints Processor Functions - K8s Profile Upload</name>
<description>Blueprints Processor Function - K8s Profile Upload</description>
<groupId>org.onap.ccsdk.cds.blueprintsprocessor.functions</groupId>
<artifactId>netconf-executor</artifactId>
- <version>1.0.0-SNAPSHOT</version>
<name>MS Blueprints Processor Functions - Netconf Executor</name>
<description>Blueprints Processor Function - Netconf Executor</description>
<groupId>org.onap.ccsdk.cds.blueprintsprocessor.functions</groupId>
<artifactId>resource-resolution</artifactId>
- <version>1.0.0-SNAPSHOT</version>
<packaging>jar</packaging>
<name>MS Blueprints Processor Functions - Resource Resolution</name>
<groupId>org.onap.ccsdk.cds.blueprintsprocessor.functions</groupId>
<artifactId>restconf-executor</artifactId>
- <version>1.0.0-SNAPSHOT</version>
<name>MS Blueprints Processor Functions - Restconf Executor</name>
<description>Blueprints Processor Function - Restconf Executor</description>
<groupId>org.onap.ccsdk.cds.blueprintsprocessor.modules</groupId>
<artifactId>blueprint-core</artifactId>
- <version>1.0.0-SNAPSHOT</version>
<name>MS Blueprints Processor Modules - Blueprints - Blueprints Core</name>
<groupId>org.onap.ccsdk.cds.blueprintsprocessor.modules</groupId>
<artifactId>configs-api</artifactId>
- <version>1.0.0-SNAPSHOT</version>
<packaging>jar</packaging>
<name>MS Blueprints Processor Modules - Inbound - Configurations API</name>
<groupId>org.onap.ccsdk.cds.blueprintsprocessor</groupId>
<artifactId>blueprintsprocessor-parent</artifactId>
- <version>1.0.0-SNAPSHOT</version>
<packaging>pom</packaging>
<name>MS Blueprints Processor Parent</name>
</parent>
<artifactId>cds-ms</artifactId>
- <version>1.0.0-SNAPSHOT</version>
<packaging>pom</packaging>
<name>MS (Root)</name>
</parent>
<artifactId>sdclistener-application</artifactId>
- <version>1.0.0-SNAPSHOT</version>
<packaging>jar</packaging>
<name>MS SDC Listener - Application</name>
<docker.verbose>true</docker.verbose>
<docker.skip.push>false</docker.skip.push>
<docker.push.phase>deploy</docker.push.phase>
+ <ccsdk.build.timestamp>${maven.build.timestamp}</ccsdk.build.timestamp>
+ <maven.build.timestamp.format>yyyyMMdd'T'HHmmss'Z'</maven.build.timestamp.format>
<ccsdk.cds.version>${project.version}</ccsdk.cds.version>
</properties>