Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

(draft)

How to run the Blueprints Processor Platform in an IDE

Objective

Have the processor running locally is to use the IDE to run the code, while having the database running in a container. This way, code changes can be conveniently tested and debugged.

Check out the code

Check out the latest code from Gerrit: https://gerrit.onap.org/r/#/admin/projects/ccsdk/cds

Build it locally

In the checked out directory, type

    mvn clean install -DskipTests=true -Dmaven.test.skip=true -Dmaven.javadoc.skip=true -Dadditionalparam=-Xdoclint:none

Spin up a Docker container with the database

The Blueprints Processor project uses a database to store information about the blueprints and therefore it needs to be online before attempting to run it.

One way to create the database is to adapt the docker-compose.yaml file present on the distribution module.

Navigate to the docker-compose file in the distribution module:

    cd ms/blueprintsprocessor/distribution/src/main/dc

Edit it to exclude the blueprints-processor image:

Distribution module's docker-compose.yaml file
version: '3.3'

services:
  db:
    image: mariadb:latest
    container_name: ccsdk-mariadb
    ports:
    - "3306:3306"
    volumes:
    - ~/vm_mysql:/var/lib/mysql
    restart: always
    environment:
      MYSQL_ROOT_PASSWORD: sdnctl
      MYSQL_DATABASE: sdnctl
      MYSQL_USER: sdnctl
      MYSQL_PASSWORD: sdnctl
#  blueprints-processor:
#    depends_on:
#    - db
#    image: onap/ccsdk-blueprintsprocessor:latest
#    container_name: bp-rest
#    ports:
#    - "8000:8080"
#    restart: always
#    environment:
#      APPLICATIONNAME: BlueprintsProcessor
#      BUNDLEVERSION: 1.0.0
#      APP_CONFIG_HOME: /opt/app/onap/config
#      STICKYSELECTORKEY:
#      ENVCONTEXT: dev


After this, run docker-composer:

    docker-compose up -d

This should spin up a container of the mariadb image in the background. To check if it as worked, this command can be used:

    docker-compose logs -f

The phrase mysqld: ready for connections indicates that the database was started correctly.

After this, revert the docker-compose.yaml file to its original state:

    git checkout -- ms/blueprintsprocessor/distribution/src/main/dc/docker-compose.yaml

From now on, the Docker container will be available on the computer; if it ever gets stopped, it can be started again by the command:

    docker start <id of mariadb container>

Set permissions on the local file system

Blueprints processor uses the local file system for some operations and, therefore, need some existing and accessible paths to run properly.

Execute the following commands to create the needed directories and to give permissions for them:

    mkdir -p /opt/app/onap/blueprints/archive
    mkdir -p /opt/app/onap/blueprints/deploy
    mkdir -p /opt/app/onap/scripts
    sudo chmod -R 777 app/

Import the project on the IDE

For this page, the chosen IDE is IntelliJ, but the instructions present here can be adapted to be used in other IDEs as well.

Go to File | Open and choose the pom.xml file of the cds directory:

Override some application properties

After the project is compiled, a Run Configuration profile overriding some application properties with custom values needs to be created, to reflect the local environment characteristics.

Navigate to the main class of the Blueprints Processor, the BlueprintProcessorApplication class: cds/ms/blueprintsprocessor/application/src/main/java/org/onap/ccsdk/cds/blueprintsprocessor/BlueprintProcessorApplication.java.

Right-click inside it, in any point, to load the context menu and select create BlueprintProcessorApplication configuration from context:

The following window will open:

Unfold the environment section and click in the VM options expansion icon, to add the custom values to be applied to some application properties:

Add the following in that field:

Custom values for properties
-DappName=ControllerBluePrints
-Dms_name=org.onap.ccsdk.apps.controllerblueprints
-DappVersion=1.0.0
-Dspring.config.location=opt/app/onap/config/
-Dspring.datasource.url=jdbc:mysql://127.0.0.1:3306/sdnctl
-Dspring.datasource.username=sdnctl
-Dspring.datasource.password=sdnctl
-Dcontrollerblueprints.loadInitialData=true
-Dblueprintsprocessor.restclient.sdncodl.url=http://localhost:8282/
-Dblueprintsprocessor.db.primary.url=jdbc:mysql://localhost:3306/sdnctl
-Dblueprintsprocessor.db.primary.username=sdnctl
-Dblueprintsprocessor.db.primary.password=sdnctl
-Dblueprintsprocessor.db.primary.driverClassName=org.mariadb.jdbc.Driver
-Dblueprintsprocessor.db.primary.hibernateHbm2ddlAuto=update
-Dblueprintsprocessor.db.primary.hibernateDDLAuto=none
-Dblueprintsprocessor.db.primary.hibernateNamingStrategy=org.hibernate.cfg.ImprovedNamingStrategy
-Dblueprintsprocessor.db.primary.hibernateDialect=org.hibernate.dialect.MySQL5InnoDBDialect
-Dblueprints.processor.functions.python.executor.executionPath=./components/scripts/python/ccsdk_blueprints
-Dblueprints.processor.functions.python.executor.modulePaths=./components/scripts/python/ccsdk_blueprints,./components/scripts/python/ccsdk_netconf,./components/scripts/python/ccsdk_restconf 
-Dblueprintsprocessor.restconfEnabled=true
-Dblueprintsprocessor.restclient.sdncodl.type=basic-auth
-Dblueprintsprocessor.restclient.sdncodl.url=http://localhost:8282/
-Dblueprintsprocessor.restclient.sdncodl.username=admin
-Dblueprintsprocessor.restclient.sdncodl.password=Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U
-Dblueprintsprocessor.grpcEnable=false
-Dblueprintsprocessor.grpcPort=9111
-Dblueprintsprocessor.blueprintDeployPath=/opt/app/onap/blueprints/deploy
-Dblueprintsprocessor.blueprintArchivePath=/opt/app/onap/blueprints/archive
-Dsecurity.user.password={bcrypt}$2a$10$duaUzVUVW0YPQCSIbGEkQOXwafZGwQ/b32/Ys4R1iwSSawFgz7QNu
-Dsecurity.user.name=ccsdkapps
-Dspring.profiles.active=dev
-Dblueprintsprocessor.httpPort=55555
-Dserver.port=8080

Run the application

Select either run or debug for this Run Configuration to start the Blueprints Processor:

      .   ____          _            __ _ _
     /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
    ( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
     \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
      '  |____| .__|_| |_|_| |_\__, | / / / /
     =========|_|==============|___/=/_/_/_/
     :: Spring Boot ::        (v2.1.3.RELEASE)

    INFO  org.onap.ccsdk.cds.blueprintsprocessor.BlueprintProcessorApplication - Starting BlueprintProcessorApplication 
    INFO  org.onap.ccsdk.cds.blueprintsprocessor.BlueprintProcessorApplication - The following profiles are active: dev
    INFO  org.springframework.boot.devtools.env.DevToolsPropertyDefaultsPostProcessor - Devtools property defaults active! Set 'spring.devtools.add-properties' to 'false' to disable
    INFO  org.springframework.boot.devtools.env.DevToolsPropertyDefaultsPostProcessor - For additional web related logging consider setting the 'logging.level.web' property to 'DEBUG'
    INFO  org.springframework.data.repository.config.RepositoryConfigurationDelegate - Bootstrapping Spring Data repositories in DEFAULT mode.
    INFO  org.springframework.data.repository.config.RepositoryConfigurationDelegate - Finished Spring Data repository scanning in 91ms. Found 3 repository interfaces.
    INFO  org.springframework.context.support.PostProcessorRegistrationDelegate$BeanPostProcessorChecker - Bean 'org.springframework.transaction.annotation.ProxyTransactionManagementConfiguration' (...)
    INFO  org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean - Initialized JPA EntityManagerFactory for persistence unit 'default'
    INFO  org.springframework.boot.devtools.autoconfigure.OptionalLiveReloadServer - LiveReload server is running on port 35729
    INFO  org.onap.ccsdk.cds.blueprintsprocessor.services.workflow.DefaultBlueprintSvcLogicService - Registering executors(execute) with type(class org.onap.ccsdk.cds.blueprintsprocessor.services. (...)
    INFO  org.onap.ccsdk.cds.blueprintsprocessor.services.workflow.DefaultBlueprintSvcLogicService - Registering executors(block) with type(class org.onap.ccsdk.sli.core.sli.provider.base.BlockNodeExecutor
    INFO  org.onap.ccsdk.cds.blueprintsprocessor.services.workflow.DefaultBlueprintSvcLogicService - Registering executors(return) with type(class org.onap.ccsdk.sli.core.sli.provider.base.ReturnNodeExecutor
    INFO  org.onap.ccsdk.cds.blueprintsprocessor.services.workflow.DefaultBlueprintSvcLogicService - Registering executors(break) with type(class org.onap.ccsdk.sli.core.sli.provider.base.BreakNodeExecutor
    INFO  org.onap.ccsdk.cds.blueprintsprocessor.services.workflow.DefaultBlueprintSvcLogicService - Registering executors(exit) with type(class org.onap.ccsdk.sli.core.sli.provider.base.ExitNodeExecutor
    INFO  class org.onap.ccsdk.cds.blueprintsprocessor.db.BlueprintProcessorCatalogServiceImpl - BlueprintProcessorCatalogServiceImpl initialized
    INFO  org.springframework.boot.actuate.endpoint.web.EndpointLinksResolver - Exposing 2 endpoint(s) beneath base path '/actuator'
    INFO  org.onap.ccsdk.cds.blueprintsprocessor.db.primary.PrimaryDatabaseConfiguration - Initialised Primary Transaction Manager for url jdbc:mysql://localhost:3306/sdnctl
    INFO  org.springframework.boot.web.embedded.netty.NettyWebServer - Netty started on port(s): 55555
    INFO  org.onap.ccsdk.cds.blueprintsprocessor.BlueprintProcessorApplication - Started BlueprintProcessorApplication in 4.595 seconds (JVM running for 5.124)







  • No labels