This section describes the setup of yarnman and use of the administration application
Logging in to Yarnman administration, https://<ip address or DNS name>
Enter Username and Password to log in
Nodes
Select 'Nodes' on the left side menu. The following screen will open:
The Nodes option provides a view of deployed core node arm and any remote arms deployed.
The status of each node can be check by pressing refresh status
Note: More results and in order to see all the created services in excel format, just click on "Download Results" – a file will be downloaded, that may be opened in Excel.
Nodes may be filtered by the filter of field Name, Customer, Type, Version, Build, IPAddress, Hostname, External Address, IP Source Connected, Uptime and Status. In order to do so, click on the corresponding arrow right next to the field name and select the appropriate choice.
In order to see the corresponding node, click on the nodes name itself. The following screen will open:
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.
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.
To ask the system to display the disk usage here. Press "Show Disk Usage" and the following details will display:
Pressing "Submit" to confirm the changes; or Pressing "Delete Node" will delete the node completely and return to the first Node Overview screen.
To display additional details, select the "Interfaces" or "Ports" tab, which will take you directly to the corresponding interfaces, ports and their details. Services
Services
The Services Option allows for the view/ addition/ alteration of services and applications attached to deployed Yarnman nodes
Click on 'Services' on the left side menu. The following screen will open:
This will display existing services.
Note: More results and in order to see all the created services in excel format, just select "Download Results" – a file will be downloaded that may be opened in Excel.
Services may be filtered by Services, Node and Customer. They can also be filtered by the condition of field Name, Type, Node, Ports, Customer and Status. In order to do this, select the corresponding arrow right next to the field name and select your choice.
Alternatively , a service name may be entered in the search field to search for it directly.
In order to see the corresponding Service, the service name itself may be selected which will display the following screen:
This displays the existing settings / details for this service, such as the Unique ID, the Service Name and the corresponding Node / Arm, these may be changed as required.
Pressing "Delete Configuration" will delete the whole configuration for this service and bring you back to the Service Overview.
Pressing "Cancel" will cancel the current change of the configuration for this service and bring you back to the Service Overview.
Pressing "Submit" will tell you, that the configuration has been updated and that the service will restart correspondingly.
Alternatively, you may also restart the service by clicking "Restart" in the upper right corner.
Selecting 'Services' on the left side menu will bring you back to the corresponding Services Overview.
All the services statuses on the overview page may be viewed by selecting "Refresh Statuses" in the upper right corner. The following screen will then display all the statuses for the different services in the overview:
To add a new Service, select "+ Add Service" in the upper right corner. A drop-down-menu will open, where you can choose, which service or app you want to add. Select the requested app and the following screen will display:
You can now select options and enter details, such as Service Name, Node /Arm, Associated Customer and Host.
Pressing "Cancel" will cancel the action and bring you back to the Services Overview.
Pressing "Submit" will tell you, that the configuration has been updated and that the service will restart correspondingly.
You will now also have the option to delete the whole new configuration, by pressing the new "Delete Configuration" button in the bottom right corner. It will then bring you back to the corresponding Services Overview.
Customer Clusters and Interfaces
Interfaces are where the connection details for the various systems can be added
Interfaces can be optionally grouped by Clusters and customers
Bulk import of Customers/Cluster/Interfaces can be done via excel import Bulk import of Customers/Cluster/Interfaces
Customer(s)
Click on 'Customers' on the left side menu. The following screen will open:
Displayed are all existing Customers.
Note: The screen will display the first 25 rows, if there are more than 25 customers, these may be displayed by pressing the "Load All Results" button. Additionally, the view may be downloaded in Excel format by selecting "Download Results".
Customers mays be filtered by filter on field Name, Description, Nodes, Interfaces and Services. In order to do so, just click on the corresponding arrow right next to the field name and select your choice.
You can also enter a customer name in the search field and search for it directly.
In order to see the corresponding Customer, you can just click on the Customers name itself. The following screen will open:
You can now see the Customers name
Pressing "Cancel" will bring you back to the Customers Overview.
Pressing "Delete Customer" will delete the whole customer and bring you back to the corresponding customers overview.
Pressing "Submit" will let you know, that your changes have been saved correspondingly, as on following screen:
If you go to "Customers" on the left side menu again now, you can see your newly created customer there correspondingly.
Clusters
Click on 'Clusters' on the left side menu. The following screen will open:
You can now see all the created Clusters.
Note: The screen will display the first 25 rows, if there are more than 25 Clusters, these may be displayed by pressing the "Load All Results" button. Additionally, the view may be downloaded in Excel format by selecting "Download Results".
Clusters can be filtered by field Name, Description, Subnet, and Interfaces. In order to do so, just click on the according arrow right next to the field name and select your choice.
You can also enter a cluster name in the search field and search for it directly.
In order to see the corresponding Cluster, you can just click on the Clusters name itself. The following screen will open:
You can now see and change certain details of the cluster, such as Name, Description and Subnet.
Pressing "Cancel" will bring you back to the Cluster Overview.
Pressing "Delete Cluster" will delete the whole cluster and bring you back to the corresponding clusters overview.
Pressing "Submit" will let you know that your changes have been saved as per following screen:
To get back to the overview, press 'Clusters' on the left side menu.
Interfaces
To add, view or modify Interfaces, select 'Interfaces' on the left side menu. The following screen will open:
This will display any existing interfaces.
Note: The screen will display the first 25 rows, if there are more than 25 interfaces, these may be displayed by pressing the "Load All Results" button. Additionally, the view may be downloaded in Excel format by selecting "Download Results".
Interfaces may be filtered by Customer, Cluster and Node. They can also be filtered by the condition of field Name, Type, Customer, Cluster and Associated Nodes. In order to do so, just click on the corresponding arrow right next to the field name and select your choice.
Alternatively, you can also enter an interface name in the search field and search for it directly.
In order to see the corresponding Interfaces, click on the Interface name itself. The following screen will open:
Displayed are details and options for this interface, such as interface name, description, associated customer and so on.
Pressing "Submit" will let you know that your changes have been saved. See following screen:
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 select the corresponding tab (as seen above).
To go back to the Interfaces Overview, click on ‘Interfaces' on the left side menu again.
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:
You can now see details for Yarnapp Brandings, such as Name and Targets.
In order to see the corresponding Branding, you can just click on the Brandings name itself. The following screen will open:
You can now see the uploaded details for this branding and some more options.
Pressing "Delete Branding" will delete the whole branding package and bring you back to the corresponding overview.
Pressing "Back to Branding" will take you back to the branding overview.
Pressing "Migrate to this Package" will migrate to the selected branding package
To upload or install a new Branding, click on "+ Upload / Install Branding" in the upper right corner. This will open your explorer, where you can now pick the according file. Press 'open', the following screen occurs:
You can now see the uploaded details for this branding and some more options.
Pressing "Delete Branding" will delete the whole branding package and bring you back to the corresponding overview.
Pressing "Back to Branding" will take you back to the branding overview (which now shows your newly created branding) as per following screen:
Pressing "Migrate to this Package" will Migrate existing apps with an old package to the new selected branding package
Collecting Yarnman Logs
There may be instances where there is a requirement to collect logs to interrogate issues that may be encountered requiring further details. These logs are then downloaded in Tar format.
Click on 'Yarnman Logs' on the left side menu. The following screen will open:
You can now see a list of all the Yarnman Log Requests.
Note: The screen will display the first 25 rows, if there are more than 25 Logs, these may be displayed by pressing the "Load All Results" button. Additionally, the view may be downloaded in Excel format by selecting "Download Results".
In order to see the corresponding details of a log request, you can just click on 'view' in front of a log request and the following screen will open:
Displayed are the details concerning that very log request.
You also have the possibility to delete the corresponding tasks and logs, by pressing the "Delete Task & Logs" button in the upper right corner. This action will delete the selected logs and bring you back to the overview screen.
On top of the overview screen, you may also enter the corresponding node, the time frame and then request new logs accordingly. Once done, the following screen will open, you may now view all the details as per below screen shot:
In the upper right corner, under "Filename", you can also click on the corresponding Tar file, which then starts downloading.
To collect a new log, select the relevant node from drop down, select time period for log and select if task events should be added to log or not (generally this is not required)
Then select "Request Logs"
To download the new log (Tar) file, select the highlighted link
Authentication Databases
Yarnman users are authenticated against an authentication database where users and roles are managed. To access, select "Database" from left side menu which will bring up below screen
By default, there is a Central DB database for authentication where users and roles may be added. There is also the option to create new authentication databases as required
Selecting Database will bring up screen
Define Name, Description and optional association with Customer may be defined. From top right side of screen may be selected Users and Roles. Selecting the "Roles" option that is used to define roles for access brings up screen as below
where there are tabs for each of the existing Yarnlab applications configured. By default, there is a "default" role under each app where access can be defined using toggles. New role may be defined by selecting "+New Role" from top right hand of screen.
By selecting each of the tabs for corresponding app, the type of access for the relevant role may be defined using the toggles
To add/ manage users, select the "Users" tab from right hand main Database screen
New users may be added or existing users managed. To add a new user, select "+ New User"
Define username and password (if LDAP authentication is used, leave blank) populate details name, email, company as required, then select access Roles from dropdown, Submit
Authentication Access Policies
Authentication access policies defines items such as authentication method (local DB, LDAP or UDS) and the linked Database
Select "Access Policies" from menu. By default, there will be a Central DB-Only Policy that may be selected or modified or new policies may be defined as required
Selecting the policy will display screen
Here, you may populate/ change name, select authentication method from drop down menu, and the linked authentication database
Yarnman Management/ Utilities/ Specifications
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
Copy the patch file: yarnman-app-<version>.tar.gz to /opt/yarnlab/install via SFTP
ssh into the server
Run command: cd /opt/yarnlab/yarnman
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
Copy the update file: yarnman-linux-bundle-master-<version>.tar.gz.sig to /opt/yarnlab/install via SFTP
ssh into the server
Run command: cd /opt/yarnlab/yarnman
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
Download Linux Upgrade Script + Application Patch from Yarnlab web site
https://yldev.blob.core.windows.net/packages/yarnman-app-<Ver>-master-<Build>.tar.gz.sig
SFTP file on to yarnman server - place in install directory /opt/yarnlab/install
Take a Snapshot
ssh to yarnman server
CD /opt/yarnlab/yarnman
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
Verify that app installed correctly in Yarnman Administration App Web GUI
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
During the upgrade you will be prompted if you want to run a backup - select Y to perform backup
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>
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
