Cloudux-starter-kit-service NPM

MediaCentral CloudUX Service Starter kit

Starter kit for creating a service for CloudUX

Getting started

To use this application you will need following tools: 1. running MediaCentral | Cloud UX 2018.6 machine 2. node.js and npm 3. proxy ball for more information check FAQ

Installation:

Using npm type in your CLI:

npm install -g cloudux-starter-kit-service

Run from CLI:

In your CLI type:

cloudux-starter-kit-service to create service with creator.
cloudux-starter-kit-service --help Do display help page.

Installation can be executed by providing flags to your toolkit.

Usage :

-N New Service
- -n Project name (required)
- -d Project description (required)
- -i MediaCentral server host IP (required)
- -r Realm (required)
- -v Service version (required)
- -m File with methods of you service (optional)
- -p project path (optional)
-B Build Service
- -p path to a project root (required)
- -n project name (Should match project/src/project.json under identity.appName) (required)
- -z app version should match project/src/project.config.json version field (required)
- -o organization should match project/src/project.config.json organization field (required)
- -i appID should match project/src/project.config.json appID field (required)
- -j appSecret should match project/src/project.config.json appID field (required)
- -d developerID should match project/src/project.config.json developerID field (optional)
- -x httpsproxy For docker build (optional)_
-I Build DockerImage
- -p project path (required)
- -n project name (Should match project/src/project.json under identity.appName) (required)
- -z app version should match project/src/project.config.json version field (required)
- -o organization should match project/src/project.config.json organization field (required)
- -i appID should match project/src/project.config.json appID field (required)
- -j appSecret should match project/src/project.config.json appID field (required)
- -x httpsproxy For docker build (optional)_
- -d developerID should match project/src/project.config.json developerID field (optional)
-P Publish project
- -p path to a project root (required)
- -n project name (Should match project/src/project.json under identity.appName) (required)
- -z app version should match project/src/project.config.json version field (required)
- -o organization should match project/src/project.config.json organization field (required)
- -k privateKeyPath should match project/src/project.config.json privateKeyPath field (required)
- -i appID should match project/src/project.config.json appID field (required)
- -j appSecret should match project/src/project.config.json appID field (required)
- -x httpsproxy For docker build (optional)_
- -d developerID should match project/src/project.config.json developerID field (optional)
- -s password to ssh private key (optional)

API

const kit = require('cloudux-starter-kit-service')
kit(options)

`kit({options})`

For new service:
- name -- project name (required)
- project_description -- project description (required)
- project_hostIp -- MediaCentral server Ip (required)
- relm -- realm (required)
- version -- Version of your service (required)
- project -- path to save project (optional)
- project_service_methods_file -- File with methods of you service (optional)
Building Service:
- build -- set build to true to build your project (required)
- project -- path to save project (required)
- name -- project name (required)
- https_proxy -- For docker build (optional)
- config -- Object with fields :
  - version -- Version of your service (required)
  - organization -- Name of organization (required)
  - developerId -- Your developer ID (optional)
Publish Service:
- publish -- set publish to true to publish your project (required)
- build -- set build to false (required)
- project -- path to save project (required)
- name -- project name (required)
- password -- password to your ssh key (optional)
- https_proxy -- For docker build (optional)
- config -- path to a project config file (optional if the config is project/src/project.config.json)
  - version -- version of your app (required)
  - organization -- name of you organization (required)
  - privateKeyPath -- Path to your private key (required)
  - appID - your Application ID (required)
  - developerID -- your developer ID (optional)
buildImage -- set buildImage to true to build image of your project
- project -- path to your project (required)
- name -- path to your project (required)
- https_proxy -- For docker build (optional)
- config -- path to your project (required)
  - version -- App version (required)
  - appID - your Application ID (required)
  - appSecret - your Application Secret (required)
  - organization -- Organization name (required)
  - developerId -- Organization name (optional)

FAQ

Why am I getting '404 Not Found: proxy-bal'?

You'll need to include proxy-bal module.

How to include proxy-bal

Proxy-bal is package accesible only for developers with a Avid developer account
Steps include proxy-bal:
1. Download proxy-bal package from https://my.avid.com/cpp/sdk/apc (Avid Platform Connector Node) 2. Extract downloaded files 3. Enter the extracted directory and then node_modules directory 3. Extract proxy-bal.tgz file 4. Rename package directory to proxy-bal 5. Copy the proxy-bal directory to node_modules in service directory 6. Open command line inside proxy-bal directory and type npm update

Why my service won't connect because of 'unauthorized token'?

Because you need to receive appID and appSecret and paste it to your project.config.json. Check Development Guide to find out how optain AppID and AppSecret.

Check our CloudUX examples on Avid-Technology Github

Check our Quick Start for CloudUX