Setting up VidiCore Management Agent (VMA)

In order to license and maintain your BYOC stack we suggest that you install the VidiCore Management Agent (VMA) on your Vidispine Server (or on a server next to it). The VidiCore Management Agent will act as a proxy between your Vidispine server and our VidiCore Management Server which is an integrated part of VidiNet.

The VMA-VMS components are needed in order to license BYOC systems.

• The VMA connects outbound towards VidiNet using port 443.

• Web proxying is supported.

The VMA needs two authentication configurations – one towards your local VidiCore API Server (username-password) and one towards VidiNet (Access Key – Secret Key). The procedure is as follows:

1. Install VMA

   1. Download the suitable VMA package and install it on your Vidispine API Server (or on a separate machine). 

      RedHat/CentOS Debian/Ubuntu

2. Configure VidiCore API Server connection in settings file

   1. Configure the VMA connection to your VidiCore API Server by editing the following values in the file /etc/vidispine/management-agent.yaml (see example at the bottom of this email for syntax)

      1. vidispine.apiUrl

      2. vidispine.username

      3. vidispine.password

3. Configure VidiNet connection

   1. In the VidiNet Dashboard, go to “Settings” and create a VMA access key pair. Remember to copy the Access Key and Secret Key when they are displayed, you will only see the secret key once.

   2. Configure the VidiNet connection by editing the following values in the file /etc/vidispine/management-agent.yaml

      1. vidinet.systemId: f70890fb-4064-41f1-9986-36e36cc86a3d (A UUID)

      2. vidinet.systemName (You decide this, it is used to identify your system and will appear under “My Services” in Vidinet Dashboard and also be inserted into license key)

      3. vidinet.accessKey (obtained in Step 3a)

      4. vidinet.secretKey (obtained in Step 3a)

   3. Save the configuration file

4. Start the VMA with command systemctl status vidispine-management-agent.service. (VMA must be restarted if configuration file is changed)

5. Verify the setup (can be done in multiple ways)

   1. In the VMA: The VMA comes with a monitoring interface at http://localhost:9010/overview, see image below:

   2. In Vidinet: In the VidiNet Dashboard, your local VidiCore system will now appear under “My Services” as a BYOC licensed system.

   3. In VidiCore: Verify that your VidiCore Server is properly licensed by checking license info under /API/version (NOTE: it may take up to 10 minutes for the system to become licensed).

EXAMPLE OF vidispine.management-agent.yaml FILE:

server:
  applicationConnectors:
  - type: http
    port: 9010
  adminConnectors:
  - type: http
    port: 9011
 
vidispine:
  apiUrl: https://localhost:9000/
  adminUrl: http://localhost:9001/
  username: admin
  password: admin
 
vidinet:
  enabled: true
  systemId: xxxxx
  systemName: test-local
  accessKey: xxx
  secretKey: xxx
 
logging:
  level: INFO
  appenders:
  - type: file
    logFormat: "%-5p [%d{ISO8601,UTC}] %c: %m%n%rEx"
    currentLogFilename: /var/log/vidispine/management-agent.log
    archivedLogFilenamePattern: /var/log/vidispine/management-agent-%d.log.gz
    archivedFileCount: 7
    timeZone: UTC
  loggers:
    com.vidispine.management.agent: INFO

• *****************

Logs are written to /var/log/vidispine/management-agent.log.