...

...

Logging in to Yarnman administration,  https://<ip address or DNS name>/administration

...

Enter Username and Password to log in

...

There are now several options to change details for, and to view the current settings of the node, such as Unique ID, Name, Associated Customer, IP Address, Media/Control Port Start Port Range, Media/Control Port End Port Range, Hostname and Administrative Node.

Jade Berlin - JTAPI

Since every node / arm has the Jade Berlin JTAPI service installed (which is required for the Yarnlab Testmate App), these may be restarted and (re-) downloaded from here. To (re-) download it, you will be asked to enter the corresponding IP of the CUCM to download the jar file from.

...

You also have the possibility to see details for the corresponding Arm Bindings and Testing Endpoints for this very Interface. To see these details, just click on select the corresponding tab (as seen above).
To go back to the Interfaces Overview, click on 'Interfaces‘Interfaces' on the left side menu again.
To add a new Interface, click on "+ Add Interface* in the upper right corner. The following screen will open:

...

You can now enter the details for your new Interface, such as Type, Name, Description, Associated Customer and Associated Cluster.
Pressing "Cancel" will bring you back to the corresponding Interface Overview.
Pressing "Submit" will bring you to the following screen, where you can now see and enter more details for this new Interface:

...

Next, select the "Arm Bindings" tab to Bind interface to relevant node, enter IP address and credentials

...

Select Node from drop down, followed by Bind to Arm to bind the interface to relevant Core or remote arm. Next, select "Update / Set Credentials" and Submit

...

To verify that the interface is working correctly, select the "Test Connection" button

...

Branding

The branding option allows for the

Adding an interface

Select Add Interface

...

Select the CUCM or Unity Connection interface type as required from Interface Type drop down. Populate Interface Name and Description fields, then Submit. 

...

Select Arm Bindings Tab, then from drop down select Standalone, followed by Bind To Arm

...

Select Update / Set Credentials button, then enter IP Address and credentials for source cluster followed by Submit

...

If for CUCM the following screen will display to enter credentials

...

or if for UCXN as follows

...

On the next screen, select Test Connection button

...

Then on the results page, select the blue banner to refresh page for CUCM

...

or for UCXN

...

Branding

The branding option allows for the application of company branding to the applications. Click on 'Branding' on the left side menu. The following screen will open:

...

Here, you may populate/ change name, select authentication method from drop down menu, and the linked authentication database

Yarnman Management/ Utilities/ Specifications

Yarnman Server Specifications

Minimum recommended specifications for Yarnman running standard datasets. For larger datasets, this would need to be increased
4 x vCPU
8 GB vRAM
1000 GB vStorage

Yarnman Manual Log Collection

If log collection option as described in previous chapters is not available/ can not be accessed, log collection may be performed manually by ssh access to Yarnman
Please send screenshot of error encountered and detailed steps to reproduce and time stamp from ssh via date command
run command via ssh to collect logs
tar -czvf yarnman-logs.tar.gz --exclude='*.tar.gz' /var/log/yarnman
Then sftp file and send to support as required

Upgrade Yarnman - Apply a patch

Process to apply patch in Yarnman

1. Copy the patch file:  yarnman-app-<version>.tar.gz   to  /opt/yarnlab/install via SFTP

2. ssh into the server

3. Run command: cd /opt/yarnlab/yarnman

4. Run the upgrade script:  ./scripts/install-yarnman-app.sh yarnman-app-<version>.tar.gz

Upgrade Yarnman – Linux Deps upgrade

Process to upgrade the Linux Deps. It is recommended to take a snapshot prior to update

1. Copy the update file:  yarnman-linux-bundle-master-<version>.tar.gz.sig to  /opt/yarnlab/install via SFTP

2. ssh into the server

3. Run command: cd /opt/yarnlab/yarnman

4. Run the upgrade script:  ./scripts/ install-linux-deps.sh yarnman-linux-bundle-master-<version>.tar.gz.sig

Note that all download links all have a corresponding .md5 and linux-deps upgrade also have optional md5 verification

Upgrade Yarnman – Linux Version 18 upgrade

Process to upgrade Linux to version 18. It is strongly recommended to take a snapshot prior to upgrade

1. Download Linux Upgrade Script + Application Patch from Yarnlab web site 

https://yldev.blob.core.windows.net/packages/yarnman-linux-upgrade18-bundle-<Ver>-master-<Build>.tar.gz.sig 

https://yldev.blob.core.windows.net/packages/yarnman-app-<Ver>-master-<Build>.tar.gz.sig

1. SFTP file on to yarnman server - place in install directory /opt/yarnlab/install

2. Take a Snapshot

3. ssh to yarnman server

CD /opt/yarnlab/yarnman

1. Run The application patch

./scripts/install-yarnman-app.sh yarnman-app-<Ver>-master-<Build>.tar.gz.sig   

Note: this command may require -i at the end depending on source version. It would then be ./scripts/....tar.gz -i        

1. Verify that app installed correctly in Yarnman Administration App Web GUI

2. Run the OS upgrade file from ssh directory /opt/yarnlab/yarnman

sudo ./scripts/upgrade-baseos18.sh yarnman-linux-upgrade18-bundle-<Ver>-master-<Build>.tar.gz.sig 

Note: this command may require -i at the end depending on source version. It would then be ./scripts/....tar.gz -i                                                                                                                                                        

1. During the upgrade you will be prompted if you want to run a backup - select Y to perform backup

2. On completion - Y to reboot

Local Firewall Configuration

Configure on each host as required using ufw
sudo ufw allow ssh
sudo ufw allow http
sudo ufw allow https
sudo ufw enable
Additional rules are required on the core node for each arm deployed
sudo ufw allow from <ip address of arm> to any proto tcp port 5984,5986
sudo ufw allow from <ip address of arm> to any proto tcp port 6379,6380
Default Terminator Configuration (Testmate)
sudo ufw allow from any proto udp port 6700:6799

External Firewall Ports

ARM → Core

Couchdb tcp/5984 tcp/5986 tcp/6984 Redis tcp/6379 tcp/6380SSH tcp/22

Core → Arm – Patch transfer

SSH tcp/22

User → Yarnman – Access to Yarnman

SSH tcp/22HTTPS tcp/443

Customer → Arm - PWreset/Yarndoor/PrattlerHTTPS tcp/443

Prattler upload

tcp/8444Prattler WS tcp/8081

RTP udp/6700-6799 – required for Media

Arm → Customer UC Apps - T

estmateCTI/QBE. TCP 2748LDAP tcp/389 tcp/636

RTP udp/6700-6799 (configurable)

WS AXL/RIS HTTP tcp/80 tcp/443 tcp/8443

SSH tcp/22

Core ↔ Core - HA only

Couchdb cluster tcp/9100-9200

Redis Cluster tcp/1000

Other AppsArm → CUCDM8 WS tcp/8181 Arm → VOSS4UCWS tcp/443Arm → KurmiWS tcp/443

Certificates

From Yarnman Menu - Select "Certificates"

...

To add a new Certificate - Select "Add New Certificate"

...

Name the Certificate, then "Select a certificate file to upload"

Then select the file to upload → then "Add"

...

To Add a new Certificate Authority, CA

From Yarnman Menu select "Certificates", then from Certificates page, select "Add New Certificate Authority"

...

Type the name of the CA → "Add" 

...

Yarnman SSL Certificates - Generate CSR

To acquire a new certificate you must generate a CSR (Certificate Signing Request). This may be done initially after creating private key or when a certificate expires
Certificate Locations /opt/yarnlab/yarnman/config
/ssl-cert.cert - Standard certificate sent to clients
/ssl-key.pem - Private key file for checking response
Open ssh session to server – go to /opt/yarnlab/yarnman/config
Open Editor 'nano cert.cnf'
In the editor – complete following info

[req]
distinguished_name  = req_distinguished_name
req_extensions = v3_req
[ req_distinguished_name ]
emailAddress      = Email Address (emailAddress_max    = 64)
[ v3_req ]
basicConstraints = CA:FALSE
keyUsage = nonRepudiation, digitalSignature, keyEncipherment
subjectAltName = @alt_names (Recommend using DNS name here)
[alt_names]
DNS.1 = <DNS name>

Image Removed

Backup and Restore

To Backup Yarnman Open SSH session Run command: cd /opt/yarnlab/yarnmanRun the backup script:  ./scripts/backup-yarnman.sh -b Backup script will create Backup Directory /opt/yarnlab/backup and create backup file Restoring BackupOpen SSH sessionEnsure that the backup directory /opt/yarnlab/backup exist with backup file Run command: cd /opt/yarnlab/yarnmanRun the restore script:  ./scripts/backup-yarnman.sh -rThe backup script will identify the latest backup in the backup directory and restore from there

...

External Firewall Ports

User Access to Yarnman

Yarnman to Other Systems

Arm deployment

High Avalilbity deployment

Certificates

From Yarnman Menu - Select "Certificates"

...

To add a new Certificate - Select "Add New Certificate"

...

Name the Certificate, then "Select a certificate file to upload"

Then select the file to upload → then "Add"

...

To Add a new Certificate Authority, CA

From Yarnman Menu select "Certificates", then from Certificates page, select "Add New Certificate Authority"

...

Type the name of the CA → "Add" 

...