{"type":"doc","content":[{"type":"paragraph","content":[{"text":"This tutorial shows how you can test your custom feature by creating and starting a minimal distribution. As example we will do it for the o-ran-sc for a o-ran radio unit front haul(ru-fh) devicemanager for ONAP Frankfurt.","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Odl feature","type":"text"}]},{"type":"paragraph","content":[{"text":"To create an odl/ONAP feature you have to create at least three parts:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"provider with your code","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"feature which defines the odl bundles to startup","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"installer which brings the artifacts into the container","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"A good example is the ","type":"text"},{"text":"SDN-R helpserver","type":"text","marks":[{"type":"link","attrs":{"href":"https://gerrit.onap.org/r/gitweb?p=ccsdk/features.git;a=tree;f=sdnr/wt/helpserver;h=d2c05041e8653ff3c39a919e30d264947ada692b;hb=refs/heads/frankfurt"}}]},{"text":" which has only these parts or the o-ran ru-fh devicemanager.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Distribution","type":"text"}]},{"type":"paragraph","content":[{"text":"To create a distribution within our custom feature based on sdnc-image we need three files.","type":"text"}]},{"type":"codeBlock","content":[{"text":"├── pom.xml\n├── src\n│ └── main\n│ ├── docker\n│ │ └── Dockerfile\n│ └── scripts\n│ └── TagVersion.groovy","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"TagVersion.groovy","type":"text"}]}]}]},{"type":"codeBlock","content":[{"text":"package org.oransc.oam.distribution\n\n\ndef versionArray;\nif ( project.properties['o-ran-sc.project.version'] != null ) {\n\tversionArray = project.properties['o-ran-sc.project.version'].split('\\\\.');\n}\n\nif ( project.properties['o-ran-sc.project.version'].endsWith(\"-SNAPSHOT\") ) {\n\tpatchArray = versionArray[2].split('-');\n\tproject.properties['project.docker.latestminortag.version']=versionArray[0] + '.' + versionArray[1] + \"-SNAPSHOT-latest\";\n\tproject.properties['project.docker.latestfulltag.version']=versionArray[0] + '.' + versionArray[1] + '.' + patchArray[0] + \"-SNAPSHOT-latest\";\n\tproject.properties['project.docker.latesttagtimestamp.version']=versionArray[0] + '.' + versionArray[1] + '.' + patchArray[0] + \"-SNAPSHOT-\"+project.properties['ccsdk.build.timestamp'];\n} else {\n\tproject.properties['project.docker.latestminortag.version']=versionArray[0] + '.' + versionArray[1] + \"-STAGING-latest\";\n\tproject.properties['project.docker.latestfulltag.version']=versionArray[0] + '.' + versionArray[1] + '.' + versionArray[2] + \"-STAGING-latest\";\n\tproject.properties['project.docker.latesttagtimestamp.version']=versionArray[0] + '.' + versionArray[1] + '.' + versionArray[2] + \"-STAGING-\"+project.properties['ccsdk.build.timestamp'];\n}","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Dockerfile","type":"text"}]}]}]},{"type":"codeBlock","content":[{"text":"# Base odl alpine with added packages needed for\nFROM ${base.image.repo}\nENV SDNR_ORAN_REPO ${features.repo}\nRUN sed -i -e \"\\|featuresRepositories|s|$|,${SDNR_ORAN_REPO}|\" $ODL_HOME/etc/org.apache.karaf.features.cfg\nENV SDNRWT_BOOTFEATURES ${features.boot}\n\nUSER root\n# copy CCSDK mvn artifacts to ODL repository\nCOPY system /tmp/system\nRUN rsync -a /tmp/system $ODL_HOME && rm -rf /tmp/system\nRUN chown -R odl:odl $ODL_HOME\nUSER odl","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"pom file","type":"text"}]}]}]},{"type":"codeBlock","content":[{"text":"\n\n 4.0.0\n\n \n org.onap.ccsdk.parent\n odlparent-lite\n 1.5.2-SNAPSHOT\n \n \n\n org.o-ran-sc.distribution\n distribution-ru-fh-controller\n 0.7.1-SNAPSHOT\n pom\n\n sdnc-distribution :: o-ran-sc :: ru-fh-controller\n SDNC Docker container with rh-fh-devicemanager controller\n \n openECOMP\n \n\n \n nexus3.onap.org:10001/onap/sdnc-image:1.8.0-STAGING-20200225T124813Z\n o-ran-sc/sdnc-ru-fh-image\n ${maven.build.timestamp}\n ${project.version}\n ${project.version}\n mvn:org.o-ran-sc.oam.features/devicemanager-oran-ru-fh-feature/${o-ran-sc.features.version}/xml/features\n sdnr-wt-feature-aggregator,devicemanager-oran-ru-fh-feature\n ${project.version}\n ${https_proxy}\n yyyyMMdd'T'HHmmss'Z'\n opt/opendaylight\n deploy\n true\n\n \n\n \n \n org.o-ran-sc.oam.features\n devicemanager-oran-ru-fh-installer\n \t ${o-ran-sc.features.version}\n repo\n zip\n \n \n \n \n \n \n org.apache.maven.wagon\n wagon-http-lightweight\n 2.2\n \n \n \n \n org.codehaus.groovy.maven\n gmaven-plugin\n 1.0\n \n \n validate\n \n execute\n \n \n ${basedir}/src/main/scripts/TagVersion.groovy\n \n \n \n \n \n maven-resources-plugin\n 2.6\n \n \n copy-dockerfile\n \n copy-resources\n \n validate\n \n ${basedir}/target/docker-stage\n \n \n src/main/docker\n \n Dockerfile\n \n true\n \n \n \n \n \n \n \n org.apache.maven.plugins\n maven-dependency-plugin\n \n \n unpack features\n generate-sources\n \n unpack-dependencies\n \n \n ${basedir}/target/docker-stage\n true\n false\n true\n true\n \n \n \n \n \n io.fabric8\n docker-maven-plugin\n 0.28.0\n false\n \n \n \n ${image.name}\n \n try\n ${basedir}/target/docker-stage\n \n ${project.docker.latestminortag.version}\n ${project.docker.latestfulltag.version}\n ${project.docker.latesttagtimestamp.version}\n \n \n \n \n \n \n \n generate-images\n package\n \n build\n \n \n \n push-images\n ${docker.push.phase}\n \n build\n push\n \n \n \n \n \n \n\n\n","type":"text"}]},{"type":"paragraph","content":[{"text":"The only thing you have to do is to manipulate the properties and the dependencies in the pom.xml.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"base-image: on which you want to run your custom feature","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"o-ran-sc.features: which is the feature repo you have to add (should look like this mvn:org.something.more/myartifact-feature/version/xml/features","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"features.boot: which will add the features to the odl boot features on startup","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"and you have to add the dependency (in this case devicemanager-oran-ru-fh-installer) to inject the artifacts into the container during build process.","type":"text"}]}]}]}],"version":1}