4.0.0/sentinel-sdk/installing-the-sdk

user@machine:~$ $JAVA_HOME/bin/java -version
openjdk version "11.0.6" 2020-01-14 LTS
OpenJDK Runtime Environment 18.9 (build 11.0.6+10-LTS)
OpenJDK 64-Bit Server VM 18.9 (build 11.0.6+10-LTS, mixed mode, sharing)
1	Ensure that Ant version 1.10.5 or later is in your `PATH` environment variable. To verify type ant -version
2	Within the SDK, run `sdkadm` in interactive mode. This can be done through using `ant sdkadm` from the command line, or running the `sdkadm` command from within the `build/bin` directory.
3	Type `help` within `sdkadm` to view available commands.
4	Use the `list-modules` command to view modules available in the repository for you to use. For details on `list-modules`, type `help list-modules`.
5	Next create a deployment module, which will let you install Sentinel Express components into Rhino. To view the available service deployment modules, use the `list-modules +service-deploy` command, which gets you something like this: > list-modules +service-deploy Listing modules based on module tags. Modules matching all of the following tags will be listed: service-deploy opencloud#sentinel-diameter-full-deploy#sentinel-diameter/4.0.0;4.0.0.0 opencloud#sentinel-diameter-test-full-deploy#sentinel-diameter/4.0.0;4.0.0.0 opencloud#sentinel-sip-full-deploy#sentinel-sip/4.0.0;4.0.0.0 opencloud#sentinel-sip-modules-deploy#sentinel-sip/4.0.0;4.0.0.0 opencloud#sentinel-sip-test-full-deploy#sentinel-sip/4.0.0;4.0.0.0 opencloud#sentinel-ss7-common-deploy#sentinel-ss7/4.0.0;4.0.0.0 opencloud#sentinel-ss7-full-deploy#sentinel-ss7/4.0.0;4.0.0.0 opencloud#sentinel-ss7-sis-full-deploy#sentinel-ss7/4.0.0;4.0.0.0 8 modules matched search criteria out of a total possible 583. Pagination was set to display unlimited results per page. Specify a pagination entry count as an argument (e.g. '10') to pause output during display. Specify '-tag' arguments to narrow results by excluding modules matching one or more -tags. Specify '-v' or '--verbose' to enable display all module details including descriptions. Specify '--show-all-versions' to list modules for all versions instead of only the latest version. Sentinel has various services (SIP, SS7, Diameter, Registrar, and so on) available as modules that you can use the deployment module to deploy. As can be seen, there are eight Sentinel service-deployment modules that are suitable for installation.
6	Now create a deployment module for the service, using the `create-deployment-module` command with the following arguments (the output from this command is quite long and has been edited for brevity here): > create-deployment-module deploy-sip-service deploy-sip-service opencloud#sentinel-sip-full-deploy#sentinel-sip/4.0.0;4.0.0.0 The following dependencies will be included in the new module: opencloud#sentinel-sip-full-deploy#sentinel-sip/4.0.0;4.0.0.0 Creating deployment module 'deploy-sip-service' in directory 'deploy-sip-service'. downloading https://repo.rhino.metaswitch.com/artifactory/opencloud-internal-snapshots/opencloud/sentinel-core/4.0.0/deployment-template/4.0.0.0/deployment-template-module-pack-4.0.0.0.zip ... .. (2kB) .. (0kB) [SUCCESSFUL ] opencloud#deployment-template#sentinel-core/4.0.0;4.0.0.0!deployment-template-module-pack.zip(module-pack) (65ms) Populating '/home/testuser/sentinel-express-sdk/deploy-sip-service/config' with configuration artifacts. downloading https://repo.rhino.metaswitch.com/artifactory/opencloud-internal-snapshots/opencloud/sentinel-core/4.0.0/sentinel-cassandra-ra-deploy/4.0.0.0/sentinel-cassandra-ra-deploy-config-4.0.0.0.zip ... .. (0kB) .. (0kB) [SUCCESSFUL ] opencloud#sentinel-cassandra-ra-deploy#sentinel-core/4.0.0;4.0.0.0!sentinel-cassandra-ra-deploy-config.zip(config) (76ms) downloading https://repo.rhino.metaswitch.com/artifactory/opencloud-internal-snapshots/opencloud/sentinel-legacy-deploy/4.0.0/sentinel-cdr-ra-deploy/4.0.0.0/sentinel-cdr-ra-deploy-config-4.0.0.0.properties ... .. (0kB) .. (0kB) ... edited for brevity ... downloading https://repo.rhino.metaswitch.com/artifactory/opencloud-internal-snapshots/opencloud/sentinel-sip/4.0.0/sentinel-sip-full-deploy/4.0.0.0/config-4.0.0.0.properties ... .. (0kB) .. (0kB) [SUCCESSFUL ] opencloud#sentinel-sip-full-deploy#sentinel-sip/4.0.0;4.0.0.0!config.properties (57ms) Finished writing deployment module to: /home/testuser/sentinel-express-sdk/deploy-sip-service The purpose of deployment modules is to be able to install a complete product in one go, and creating one is therefore typically one of the first things to do in an SDK. For more information about deployment modules see Modules. Custom features can also be added to deployment modules, see Creating a Feature.
7	Now that the deployment module has been created successfully, you can use the `list-sdk-modules` command to view the modules inside your SDK: > list-sdk-modules Searching for modules in: /home/testuser/sentinel-express-sdk Found 1 module: deploy-sip-service The new module `deploy-sip-service` should show up in the output.
8	Exit the sdkadm program: type `quit`, and press Enter. The file system will have a new directory called `deploy-sip-service`. This contains the deployment module. Here’s what it includes: $ cd deploy-sip-service/ /deploy-sip-service$ ls build.xml config doc ivy.xml module.properties
9	Look at the contents of each of the files and directories, to 'get a feel' for what is included in a deployment module.
10	Make sure that you are in the `deploy-sip-service` module. Type `ant clean publish-local` to build the module. The output should look like this: $ ant clean publish-local Buildfile: /home/testuser/sentinel-express-sdk/deploy-sip-service/build.xml clean-module: [echo] Cleaning module build artifacts. clean: init-build-extensions: pre-init-ivy-common: init-ivy-common: [echo] Ivy Resolvers: /home/testuser/sentinel-express-sdk/build/ivy/resolvers-remote.xml [echo] Configuring Ivy with settings: /home/testuser/sentinel-express-sdk/build/ivy/ivysettings.xml [ivy:var] :: Apache Ivy 2.3.0 - 20130110142753 :: http://ant.apache.org/ivy/ :: [ivy:var] :: loading settings :: file = /home/testuser/sentinel-express-sdk/build/ivy/ivysettings.xml ivy-authentication-check: [ivy:resolve] :: loading settings :: file = /home/testuser/sentinel-express-sdk/build/ivy/ivysettings.xml [echo] Build infrastructure lib/ directory is up to date. update-index-properties: [oc:index-properties] Properties file "/home/testuser/sentinel-express-sdk/release.properties" already exists. [oc:index-properties] Index configuration has not changed since previous build. [oc:index-properties] Index configuration uses dynamic revisions. Current version of indexes will be queried. [oc:index-properties] Querying current version of: opencloud#sentinel-express-index#sentinel-pack/4.0.0;latest.integration [oc:index-properties] Current version is: opencloud#sentinel-express-index#sentinel-pack/4.0.0;4.0.0.0 [oc:index-properties] Currently available index versions are the same as previous build. Properties file "/home/testuser/sentinel-express-sdk/release.properties" will not be regenerated. init: init-module: [mkdir] Created dir: /home/testuser/sentinel-express-sdk/deploy-sip-service/target/logs [echo] Resolving ivy configurations "" for deploy-sip-service set-local-build-revision: [oc:ivybuildnumber] [oc:ivybuildnumber] Revision search for deploy-sip-service [oc:ivybuildnumber] --------------------------------------- [oc:ivybuildnumber] Revision basis: 1.0.0 [oc:ivybuildnumber] Latest revision: none [oc:ivybuildnumber] [oc:ivybuildnumber] [oc:ivybuildnumber] New revisions for deploy-sip-service [oc:ivybuildnumber] --------------------------------------- [oc:ivybuildnumber] release: 1.0.0.0 [oc:ivybuildnumber] milestone: 1.0.0.0-M1 [oc:ivybuildnumber] snapshot: 1.0.0.0-SNAPSHOT.r20160401141827 [oc:ivybuildnumber] local: 1.0.0.0-DEV0-testuser [oc:ivybuildnumber] [echo] Building for local publication of revision 1.0.0.0-DEV0-testuser set-default-build-revision: do-build: [echo] Initialising build extensions. [echo] Retrieving ivy configuration "antlib" into /home/testuser/sentinel-express-sdk/deploy-sip-service/target/libs/antlib [copy] Copying 1 file to /home/testuser/sentinel-express-sdk/deploy-sip-service/target/generated [echo] Skipping default module src build - no source available. [echo] Skipping default module test build - no test source available. [mkdir] Created dir: /home/testuser/sentinel-express-sdk/deploy-sip-service/target/artifacts [echo] [echo] [touch] Creating /home/testuser/sentinel-express-sdk/deploy-sip-service/target/artifacts/deploy-sip-service-deploy.xml [echo] [copy] Copying 100 files to /home/testuser/sentinel-express-sdk/deploy-sip-service/target/generated/config [zip] Building zip: /home/testuser/sentinel-express-sdk/deploy-sip-service/target/artifacts/deploy-sip-service-config.zip [copy] Copying 1 file to /home/testuser/sentinel-express-sdk/deploy-sip-service/target/artifacts [echo] [echo] Building module as a module pack. [echo] Building module pack using the following properties: [echo] module.pack.include.path=/ [echo] module.pack.exclude.path= [echo] module.pack.basedir=/home/testuser/sentinel-express-sdk/deploy-sip-service [echo] module.pack.prepend.file= [echo] module.pack.prepend.include.path=*/.java [echo] module.pack.prepend.exclude.path= [mkdir] Created dir: /home/testuser/sentinel-express-sdk/deploy-sip-service/target/module-pack [copy] Copying 106 files to /home/testuser/sentinel-express-sdk/deploy-sip-service/target/module-pack [oc:update-module-pack-dependencies] Updating module-pack ivy dependencies for: /home/testuser/sentinel-express-sdk/deploy-sip-service/target/module-pack [oc:update-module-pack-dependencies] [oc:update-module-pack-dependencies] [oc:verify-module-pack] Verifying module-pack content: /home/testuser/sentinel-express-sdk/deploy-sip-service/target/module-pack [oc:verify-module-pack] [zip] Building zip: /home/testuser/sentinel-express-sdk/deploy-sip-service/target/artifacts/deploy-sip-service-module-pack.zip build: test: [echo] Skipping default module test - no tests available. publish-local-module: [echo] Publishing module to local repository. [ivy:publish] :: delivering :: UNSET#deploy-sip-service#trunk;working@testmachine :: 1.0.0.0-DEV0-testuser :: integration :: Fri Apr 01 14:18:28 NZDT 2016 [ivy:publish] delivering ivy file to /home/testuser/sentinel-express-sdk/deploy-sip-service/target/artifacts/ivy.xml [ivy:publish] :: publishing :: UNSET#deploy-sip-service [ivy:publish] published deploy-sip-service-config to /home/testuser/.ivy2/opencloud-local/UNSET/trunk/deploy-sip-service/1.0.0.0-DEV0-testuser.part/deploy-sip-service-config-1.0.0.0-DEV0-testuser.zip [ivy:publish] published deploy-sip-service-config to /home/testuser/.ivy2/opencloud-local/UNSET/trunk/deploy-sip-service/1.0.0.0-DEV0-testuser.part/deploy-sip-service-config-1.0.0.0-DEV0-testuser.properties [ivy:publish] published deploy-sip-service-module-pack to /home/testuser/.ivy2/opencloud-local/UNSET/trunk/deploy-sip-service/1.0.0.0-DEV0-testuser.part/deploy-sip-service-module-pack-1.0.0.0-DEV0-testuser.zip [ivy:publish] published ivy to /home/testuser/.ivy2/opencloud-local/UNSET/trunk/deploy-sip-service/1.0.0.0-DEV0-testuser.part/ivy.xml [ivy:publish] publish commited: moved /home/testuser/.ivy2/opencloud-local/UNSET/trunk/deploy-sip-service/1.0.0.0-DEV0-testuser.part [ivy:publish] to /home/testuser/.ivy2/opencloud-local/UNSET/trunk/deploy-sip-service/1.0.0.0-DEV0-testuser publish-local: BUILD SUCCESSFUL Total time: 1 minute 10 seconds