1 .. This work is a derivative of https://wiki.onap.org/display/DW/Running+Blueprints+Processor+Microservice+in+an+IDE
2 .. This work is licensed under a Creative Commons Attribution 4.0
3 .. International License. http://creativecommons.org/licenses/by/4.0
4 .. Copyright (C) 2020 Deutsche Telekom AG.
6 Running Blueprints Processor Microservice in an IDE
7 ====================================================
12 Have the blueprint processor running locally is to use the IDE to run the code, while having the database running in a container.
13 This way, code changes can be conveniently tested and debugged.
18 Check out the code from Gerrit: https://gerrit.onap.org/r/#/admin/projects/ccsdk/cds
23 In the checked out directory, type
27 mvn clean install -Pq -Dadditionalparam=-Xdoclint:none
29 Spin up a Docker container with the database
30 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
32 The Blueprints Processor project uses a database to store information about the blueprints
33 and therefore it needs to be online before attempting to run it.
35 One way to create the database is by using the :file:`docker-compose.yaml`
36 file present on the distribution module. This database will require a local directory to mount a volume, before running docker-compose remember to create following directory:
40 mkdir -p -m 755 /opt/app/cds/mysql/data
42 Navigate to the docker-compose file in the distribution module:
46 ms/blueprintsprocessor/distribution/src/main/dc
48 And run docker-composer:
52 docker-compose up -d db
54 This should spin up a container of the MariaDB image in the background.
55 To check if it has worked, this command can be used:
59 docker-compose logs -f
61 The phrase ``mysqld: ready for connections`` indicates that the database was started correctly.
63 From now on, the Docker container will be available on the computer; if it ever gets stopped,
64 it can be started again by the command:
68 docker start <id of mariadb container>
70 Set permissions on the local file system
71 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
73 Blueprints processor uses the local file system for some operations and, therefore,
74 need some existing and accessible paths to run properly.
76 Execute the following commands to create the needed directories, and grant access to the current user to modify them:
80 mkdir -p -m 755 /opt/app/onap/blueprints/archive
81 mkdir -p -m 755 /opt/app/onap/blueprints/deploy
82 mkdir -p -m 755 /opt/app/onap/scripts
83 sudo chown -R $(id -u):$(id -g) /opt/app/onap/
85 Import the project into the IDE
86 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
90 .. tab:: IntelliJ IDEA
92 Go to *File | Open* and choose the :file:`pom.xml` file of the cds directory:
96 Sometimes it may be necessary to reimport Maven project:
100 **Override some application properties:**
102 After the project is compiled, a Run Configuration profile overriding some application properties
103 with custom values needs to be created, to reflect the local environment characteristics.
107 .. group-tab:: Latest
109 Navigate to the main class of the Blueprints Processor, the BlueprintProcessorApplication class:
111 ``ms/blueprintsprocessor/application/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/BlueprintProcessorApplication.kt``.
113 Right-click inside it, at any point, to load the context menu and select create
114 BlueprintProcessorApplication configuration from context:
116 |imageCreateRunConfigkt|
118 **The following window will open:**
122 **Add the following in the field `VM Options`:**
125 :caption: **Custom values for properties**
127 -Dspring.profiles.active=dev
129 You can override any value from **application-dev.properties** file here. Use the following pattern:
133 -D<application-dev.properties key>=<application-dev.properties value>
135 .. group-tab:: Frankfurt
137 Navigate to the main class of the Blueprints Processor, the BlueprintProcessorApplication class:
139 ``ms/blueprintsprocessor/application/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/BlueprintProcessorApplication.kt``.
141 Right-click inside it, at any point, to load the context menu and select create
142 BlueprintProcessorApplication configuration from context:
144 |imageCreateRunConfigkt|
146 **The following window will open:**
150 **Add the following in the field `VM Options`:**
153 :caption: **Custom values for properties**
155 -Dspring.profiles.active=dev
157 You can override any value from **application-dev.properties** file here. Use the following pattern:
161 -D<application-dev.properties key>=<application-dev.properties value>
163 .. group-tab:: El Alto
165 Navigate to the main class of the Blueprints Processor, the BlueprintProcessorApplication class:
167 ``ms/blueprintsprocessor/application/src/main/java/org/onap/ccsdk/cds/blueprintsprocessor/BlueprintProcessorApplication.java.``
169 Right-click inside it, at any point, to load the context menu and select create
170 BlueprintProcessorApplication configuration from context:
172 |imageCreateRunConfigJava|
174 **The following window will open:**
178 **Add the following in the field `VM Options`:**
181 :caption: **Custom values for properties**
183 -Dspring.profiles.active=dev
185 You can override any value from **application-dev.properties** file here. Use the following pattern:
189 -D<application-dev.properties key>=<application-dev.properties value>
191 .. group-tab:: Dublin
193 Navigate to the main class of the Blueprints Processor, the BlueprintProcessorApplication class:
195 ``ms/blueprintsprocessor/application/src/main/java/org/onap/ccsdk/cds/blueprintsprocessor/BlueprintProcessorApplication.java``.
197 Right-click inside it, at any point, to load the context menu and select create
198 BlueprintProcessorApplication configuration from context:
200 |imageCreateRunConfigJava|
202 **The following window will open:**
206 **Add the following in that field:**
209 :caption: **Custom values for properties**
211 -DappName=ControllerBluePrints
212 -Dms_name=org.onap.ccsdk.apps.controllerblueprints
214 -Dspring.config.location=opt/app/onap/config/
215 -Dspring.datasource.url=jdbc:mysql://127.0.0.1:3306/sdnctl
216 -Dspring.datasource.username=sdnctl
217 -Dspring.datasource.password=sdnctl
218 -Dcontrollerblueprints.loadInitialData=true
219 -Dblueprintsprocessor.restclient.sdncodl.url=http://localhost:8282/
220 -Dblueprintsprocessor.db.primary.url=jdbc:mysql://localhost:3306/sdnctl
221 -Dblueprintsprocessor.db.primary.username=sdnctl
222 -Dblueprintsprocessor.db.primary.password=sdnctl
223 -Dblueprintsprocessor.db.primary.driverClassName=org.mariadb.jdbc.Driver
224 -Dblueprintsprocessor.db.primary.hibernateHbm2ddlAuto=update
225 -Dblueprintsprocessor.db.primary.hibernateDDLAuto=none
226 -Dblueprintsprocessor.db.primary.hibernateNamingStrategy=org.hibernate.cfg.ImprovedNamingStrategy
227 -Dblueprintsprocessor.db.primary.hibernateDialect=org.hibernate.dialect.MySQL5InnoDBDialect
228 -Dblueprints.processor.functions.python.executor.executionPath=./components/scripts/python/ccsdk_blueprints
229 -Dblueprints.processor.functions.python.executor.modulePaths=./components/scripts/python/ccsdk_blueprints,./components/scripts/python/ccsdk_netconf,./components/scripts/python/ccsdk_restconf
230 -Dblueprintsprocessor.restconfEnabled=true
231 -Dblueprintsprocessor.restclient.sdncodl.type=basic-auth
232 -Dblueprintsprocessor.restclient.sdncodl.url=http://localhost:8282/
233 -Dblueprintsprocessor.restclient.sdncodl.username=admin
234 -Dblueprintsprocessor.restclient.sdncodl.password=Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U
235 -Dblueprintsprocessor.grpcEnable=false
236 -Dblueprintsprocessor.grpcPort=9111
237 -Dblueprintsprocessor.blueprintDeployPath=/opt/app/onap/blueprints/deploy
238 -Dblueprintsprocessor.blueprintArchivePath=/opt/app/onap/blueprints/archive
239 -Dblueprintsprocessor.blueprintWorkingPath=/opt/app/onap/blueprints/work
240 -Dsecurity.user.password={bcrypt}$2a$10$duaUzVUVW0YPQCSIbGEkQOXwafZGwQ/b32/Ys4R1iwSSawFgz7QNu
241 -Dsecurity.user.name=ccsdkapps
242 -Dblueprintsprocessor.messageclient.self-service-api.kafkaEnable=false
243 -Dblueprintsprocessor.messageclient.self-service-api.topic=producer.t
244 -Dblueprintsprocessor.messageclient.self-service-api.type=kafka-basic-auth
245 -Dblueprintsprocessor.messageclient.self-service-api.bootstrapServers=127.0.0.1:9092
246 -Dblueprintsprocessor.messageclient.self-service-api.consumerTopic=receiver.t
247 -Dblueprintsprocessor.messageclient.self-service-api.groupId=receiver-id
248 -Dblueprintsprocessor.messageclient.self-service-api.clientId=default-client-id
249 -Dspring.profiles.active=dev
250 -Dblueprintsprocessor.httpPort=8080
254 **Browse Working Directory to your application path** ``.../cds/ms/blueprintsprocessor/application``
255 **if path is not already specified correctly.**
257 **Add/replace the following in Blueprint's application-dev.properties file:**
261 blueprintsprocessor.grpcclient.remote-python.type=token-auth
262 blueprintsprocessor.grpcclient.remote-python.host=localhost
263 blueprintsprocessor.grpcclient.remote-python.port=50051
264 blueprintsprocessor.grpcclient.remote-python.token=Basic Y2NzZGthcHBzOmNjc2RrYXBwcw==
266 blueprintprocessor.remoteScriptCommand.enabled=true
269 **Run the application:**
271 Select either run or debug for this Run Configuration to start the Blueprints Processor:
277 .. tab:: Visual Studio Code
281 .. group-tab:: Latest
283 * **Step #1** - Make sure your installation of Visual Studio Code is up to date. This guide was writen using version 1.48
284 * **Step #2** - Install `Kotlin extension from the Visual Studio Code Marketplace <https://marketplace.visualstudio.com/items?itemName=fwcd.kotlin>`_
285 * **Step #3** - On the top menu click *Run | Open Configurations*
287 .. warning:: This should open the file called `launch.json` but in some cases you'll need to wait for the Kotlin Language Server to be installed before you can do anything.
288 Please watch the bottom bar in Visual Studio Code for messages about things getting installed.
290 * **Step #4** - add configuration shown below to your configurations list.
297 "name": "Blueprint Processor",
298 "projectRoot": "${workspaceFolder}/ms/blueprintsprocessor/application",
299 "mainClass": "-Dspring.profiles.active=dev org.onap.ccsdk.cds.blueprintsprocessor.BlueprintProcessorApplicationKt"
302 .. warning:: The `projectRoot` path assumes that you created your Workspace in the main CDS repository folder. If not - please change the path accordingly
304 .. note:: The `mainClass` contains a spring profile param before the full class name. This is done because `args` is not supported by Kotlin launch.json configuration.
305 If you have a cleaner idea how to solve this - please let us know.
307 **Add/replace the following in Blueprint's application-dev.properties file:**
311 blueprintsprocessor.grpcclient.remote-python.type=token-auth
312 blueprintsprocessor.grpcclient.remote-python.host=localhost
313 blueprintsprocessor.grpcclient.remote-python.port=50051
314 blueprintsprocessor.grpcclient.remote-python.token=Basic Y2NzZGthcHBzOmNjc2RrYXBwcw==
316 blueprintprocessor.remoteScriptCommand.enabled=true
318 **Currently the following entries need to be added in VSC too:**
322 logging.level.web=DEBUG
323 logging.level.org.springframework.web: DEBUG
325 #Encrypted username and password for health check service
326 endpoints.user.name=eHbVUbJAj4AG2522cSbrOQ==
327 endpoints.user.password=eHbVUbJAj4AG2522cSbrOQ==
329 #BaseUrls for health check blueprint processor services
330 blueprintprocessor.healthcheck.baseUrl=http://localhost:8080/
331 blueprintprocessor.healthcheck.mapping-service-name-with-service-link=[Execution service,/api/v1/execution-service/health-check],[Resources service,/api/v1/resources/health-check],[Template service,/api/v1/template/health-check]
333 #BaseUrls for health check Cds Listener services
334 cdslistener.healthcheck.baseUrl=http://cds-sdc-listener:8080/
335 cdslistener.healthcheck.mapping-service-name-with-service-link=[SDC Listener service,/api/v1/sdclistener/healthcheck]
338 management.endpoints.web.exposure.include=*
339 management.endpoint.health.show-details=always
340 management.info.git.mode=full
342 In VSC the properties are read from target folder, thats why the following maven command needs to be rerun:
346 mvn clean install -DskipTests=true -Dmaven.test.skip=true -Dmaven.javadoc.skip=true -Dadditionalparam=-Xdoclint:none
348 Click Run in Menu bar.
353 Testing the application
354 ~~~~~~~~~~~~~~~~~~~~~~~
356 There are two main features of the Blueprints Processor that can be of interest of a developer:
357 blueprint publish and blueprint process.
359 To upload custom blueprints, the endpoint ``api/v1/execution-service/publish`` is used.
361 To process, the endpoint is ``api/v1/execution-service/process``.
363 Postman is a software that can be used to send these request, and an example of
364 them is present on https://www.getpostman.com/collections/b99863b0cde7565a32fc.
366 A detailed description of the usage of different APIs of CDS will follow.
372 Imported packages or annotiations are not found, Run Config not available?
373 *****************************************************************************
375 1. Rebuild with ``maven install ...`` (see above)
376 2. Potentially change Maven home directory in Settings
377 3. Maven reimport in IDE
382 * Change Java Version to 11
385 .. image alignment inside tabs doesn't work
387 .. |imageRunConfigJava| image:: media/run_config_java.png
391 .. |imageRunConfigKt| image:: media/run_config_kt.png
395 .. |imageCreateRunConfigJava| image:: media/create_run_config_java.png
399 .. |imageCreateRunConfigKt| image:: media/create_run_config_kt.png
403 .. |imageImportProject| image:: media/import_project.png
407 .. |imageReimportMaven| image:: media/reimport_maven.png
411 .. |imageRunDebug| image:: media/run_debug.png
415 .. |imageBuildLogs| image:: media/build_logs.png
419 .. |imageLogsVSC| image:: media/vsc_logs.png