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.
19 Check out the code from Gerrit: https://gerrit.onap.org/r/#/admin/projects/ccsdk/cds
24 In the checked out directory, type
28 mvn clean install -DskipTests=true -Dmaven.test.skip=true -Dmaven.javadoc.skip=true -Dadditionalparam=-Xdoclint:none
30 Spin up a Docker container with the database
31 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
33 The Blueprints Processor project uses a database to store information about the blueprints
34 and therefore it needs to be online before attempting to run it.
36 One way to create the database is by using the :file:`docker-compose.yaml`
37 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:
41 mkdir -p -m 755 /opt/app/cds/mysql/data
43 Navigate to the docker-compose file in the distribution module:
51 cd ms/blueprintsprocessor/application/src/main/dc
53 .. group-tab:: Frankfurt
57 cd ms/blueprintsprocessor/application/src/main/dc
59 .. group-tab:: El Alto
63 ms/blueprintsprocessor/distribution/src/main/dc
69 ms/blueprintsprocessor/distribution/src/main/dc
71 And run docker-composer:
75 docker-compose up -d db
77 This should spin up a container of the MariaDB image in the background.
78 To check if it has worked, this command can be used:
82 docker-compose logs -f
84 The phrase ``mysqld: ready for connections`` indicates that the database was started correctly.
86 From now on, the Docker container will be available on the computer; if it ever gets stopped,
87 it can be started again by the command:
91 docker start <id of mariadb container>
94 Set permissions on the local file system
95 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
97 Blueprints processor uses the local file system for some operations and, therefore,
98 need some existing and accessible paths to run properly.
100 Execute the following commands to create the needed directories, and grant access to the current user to modify them:
104 mkdir -p -m 755 /opt/app/onap/blueprints/archive
105 mkdir -p -m 755 /opt/app/onap/blueprints/deploy
106 mkdir -p -m 755 /opt/app/onap/scripts
107 sudo chown -R $(id -u):$(id -g) /opt/app/onap/
109 Import the project into the IDE
110 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
114 .. group-tab:: IntelliJ IDEA
116 Go to *File | Open* and choose the :file:`pom.xml` file of the cds directory:
120 Sometimes it may be necessary to reimport Maven project:
125 Override some application properties
126 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
128 After the project is compiled, a Run Configuration profile overriding some application properties
129 with custom values needs to be created, to reflect the local environment characteristics.
133 .. group-tab:: Latest
135 Navigate to the main class of the Blueprints Processor, the BlueprintProcessorApplication class:
137 ``ms/blueprintsprocessor/application/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/BlueprintProcessorApplication.kt``.
139 Right-click inside it, at any point, to load the context menu and select create
140 BlueprintProcessorApplication configuration from context:
142 |imageCreateRunConfigkt|
144 **The following window will open:**
148 **Add the following in the field `VM Options`:**
151 :caption: **Custom values for properties**
153 -Dspring.profiles.active=dev
155 You can override any value from **application-dev.properties** file here. Use the following pattern:
159 -D<application-dev.properties key>=<application-dev.properties value>
161 .. group-tab:: Frankfurt
163 Navigate to the main class of the Blueprints Processor, the BlueprintProcessorApplication class:
165 ``ms/blueprintsprocessor/application/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/BlueprintProcessorApplication.kt``.
167 Right-click inside it, at any point, to load the context menu and select create
168 BlueprintProcessorApplication configuration from context:
170 |imageCreateRunConfigkt|
172 **The following window will open:**
176 **Add the following in the field `VM Options`:**
179 :caption: **Custom values for properties**
181 -Dspring.profiles.active=dev
183 You can override any value from **application-dev.properties** file here. Use the following pattern:
187 -D<application-dev.properties key>=<application-dev.properties value>
189 .. group-tab:: El Alto
191 Navigate to the main class of the Blueprints Processor, the BlueprintProcessorApplication class:
193 ``ms/blueprintsprocessor/application/src/main/java/org/onap/ccsdk/cds/blueprintsprocessor/BlueprintProcessorApplication.java.``
195 Right-click inside it, at any point, to load the context menu and select create
196 BlueprintProcessorApplication configuration from context:
198 |imageCreateRunConfigJava|
200 **The following window will open:**
204 **Add the following in the field `VM Options`:**
207 :caption: **Custom values for properties**
209 -Dspring.profiles.active=dev
211 You can override any value from **application-dev.properties** file here. Use the following pattern:
215 -D<application-dev.properties key>=<application-dev.properties value>
217 .. group-tab:: Dublin
219 Navigate to the main class of the Blueprints Processor, the BlueprintProcessorApplication class:
221 ``ms/blueprintsprocessor/application/src/main/java/org/onap/ccsdk/cds/blueprintsprocessor/BlueprintProcessorApplication.java``.
223 Right-click inside it, at any point, to load the context menu and select create
224 BlueprintProcessorApplication configuration from context:
226 |imageCreateRunConfigJava|
228 **The following window will open:**
232 **Add the following in that field:**
235 :caption: **Custom values for properties**
237 -DappName=ControllerBluePrints
238 -Dms_name=org.onap.ccsdk.apps.controllerblueprints
240 -Dspring.config.location=opt/app/onap/config/
241 -Dspring.datasource.url=jdbc:mysql://127.0.0.1:3306/sdnctl
242 -Dspring.datasource.username=sdnctl
243 -Dspring.datasource.password=sdnctl
244 -Dcontrollerblueprints.loadInitialData=true
245 -Dblueprintsprocessor.restclient.sdncodl.url=http://localhost:8282/
246 -Dblueprintsprocessor.db.primary.url=jdbc:mysql://localhost:3306/sdnctl
247 -Dblueprintsprocessor.db.primary.username=sdnctl
248 -Dblueprintsprocessor.db.primary.password=sdnctl
249 -Dblueprintsprocessor.db.primary.driverClassName=org.mariadb.jdbc.Driver
250 -Dblueprintsprocessor.db.primary.hibernateHbm2ddlAuto=update
251 -Dblueprintsprocessor.db.primary.hibernateDDLAuto=none
252 -Dblueprintsprocessor.db.primary.hibernateNamingStrategy=org.hibernate.cfg.ImprovedNamingStrategy
253 -Dblueprintsprocessor.db.primary.hibernateDialect=org.hibernate.dialect.MySQL5InnoDBDialect
254 -Dblueprints.processor.functions.python.executor.executionPath=./components/scripts/python/ccsdk_blueprints
255 -Dblueprints.processor.functions.python.executor.modulePaths=./components/scripts/python/ccsdk_blueprints,./components/scripts/python/ccsdk_netconf,./components/scripts/python/ccsdk_restconf
256 -Dblueprintsprocessor.restconfEnabled=true
257 -Dblueprintsprocessor.restclient.sdncodl.type=basic-auth
258 -Dblueprintsprocessor.restclient.sdncodl.url=http://localhost:8282/
259 -Dblueprintsprocessor.restclient.sdncodl.username=admin
260 -Dblueprintsprocessor.restclient.sdncodl.password=Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U
261 -Dblueprintsprocessor.grpcEnable=false
262 -Dblueprintsprocessor.grpcPort=9111
263 -Dblueprintsprocessor.blueprintDeployPath=/opt/app/onap/blueprints/deploy
264 -Dblueprintsprocessor.blueprintArchivePath=/opt/app/onap/blueprints/archive
265 -Dblueprintsprocessor.blueprintWorkingPath=/opt/app/onap/blueprints/work
266 -Dsecurity.user.password={bcrypt}$2a$10$duaUzVUVW0YPQCSIbGEkQOXwafZGwQ/b32/Ys4R1iwSSawFgz7QNu
267 -Dsecurity.user.name=ccsdkapps
268 -Dblueprintsprocessor.messageclient.self-service-api.kafkaEnable=false
269 -Dblueprintsprocessor.messageclient.self-service-api.topic=producer.t
270 -Dblueprintsprocessor.messageclient.self-service-api.type=kafka-basic-auth
271 -Dblueprintsprocessor.messageclient.self-service-api.bootstrapServers=127.0.0.1:9092
272 -Dblueprintsprocessor.messageclient.self-service-api.consumerTopic=receiver.t
273 -Dblueprintsprocessor.messageclient.self-service-api.groupId=receiver-id
274 -Dblueprintsprocessor.messageclient.self-service-api.clientId=default-client-id
275 -Dspring.profiles.active=dev
276 -Dblueprintsprocessor.httpPort=8080
280 Add/replace the following in Blueprint's application-dev.properties file:
281 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
285 blueprintsprocessor.grpcclient.remote-python.type=token-auth
286 blueprintsprocessor.grpcclient.remote-python.host=localhost
287 blueprintsprocessor.grpcclient.remote-python.port=50051
288 blueprintsprocessor.grpcclient.remote-python.token=Basic Y2NzZGthcHBzOmNjc2RrYXBwcw==
290 blueprintprocessor.remoteScriptCommand.enabled=true
296 Select either run or debug for this Run Configuration to start the Blueprints Processor:
302 .. group-tab:: Visual Studio Code
304 * **Step #1** - Make sure your installation of Visual Studio Code is up to date. This guide was writen using version 1.48
305 * **Step #2** - Install `Kotlin extension from the Visual Studio Code Marketplace <https://marketplace.visualstudio.com/items?itemName=fwcd.kotlin>`_
306 * **Step #3** - On the top menu click *Run | Open Configurations*
308 .. 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.
309 Please watch the bottom bar in Visual Studio Code for messages about things getting installed.
311 * **Step #4** - add configuration shown below to your configurations list.
318 "name": "Blueprint Processor",
319 "projectRoot": "${workspaceFolder}/ms/blueprintsprocessor/application",
320 "mainClass": "-Dspring.profiles.active=dev org.onap.ccsdk.cds.blueprintsprocessor.BlueprintProcessorApplicationKt"
323 .. warning:: The `projectRoot` path assumes that you created your Workspace in the main CDS repository folder. If not - please change the path accordingly
325 .. 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.
326 If you have a cleaner idea how to solve this - please let us know.
329 Testing the application
330 ~~~~~~~~~~~~~~~~~~~~~~~~~
332 There are two main features of the Blueprints Processor that can be of interest of a developer:
333 blueprint upload and blueprint process.
335 To upload custom blueprints, the endpoint ``api/v1/execution-service/upload`` is used.
337 To process, the endpoint is ``api/v1/execution-service/process``.
339 Postman is a software that can be used to send these request, and an example of
340 them is present on https://www.getpostman.com/collections/b99863b0cde7565a32fc.
346 Imported packages or annotiations are not found, Run Config not available?
347 *****************************************************************************
349 1. Rebuild with ``maven install ...`` (see above)
350 2. Potentially change Maven home directory in Settings
351 3. Maven reimport in IDE
356 * Change Java Version to 11 or 8
358 .. |imageRunConfigJava| image:: media/run_config_java.png
362 .. |imageRunConfigKt| image:: media/run_config_kt.png
366 .. |imageCreateRunConfigJava| image:: media/create_run_config_java.png
370 .. |imageCreateRunConfigKt| image:: media/create_run_config_kt.png
374 .. |imageImportProject| image:: media/import_project.png
378 .. |imageReimportMaven| image:: media/reimport_maven.png
382 .. |imageRunDebug| image:: media/run_debug.png
386 .. |imageRunDebug| image:: media/run_debug.png
390 .. |imageBuildLogs| image:: media/build_logs.png