Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents


Prerequisites

Hardware

Specification

Virtual Machines

  • 4 vCPU

  • 8 GB vRAM

  • 1 x 100 GB vDisk

    • latency < 20 ms (no spikes above)

    • POSIX-compatible filesystem

Note

NFS datastores are not supported by the underlying yarnman database (Couchdb) and using NFS could lead to dataloss if NFS connectivity is interupted during write operations

Virtualization software

VMware vSphere ESXi 6 or higher

VMware Workstation support 12 or higher

...

Info

If using Ovftool to deploy

  1. ovftool --name="<VMNAME>" --powerOn --datastore="<datastore>" --net:"nat"="<network name>" <Yarnman OVA> "<VI path >"

  2. VI Paths

  3. Direct ESXI "vi://<vmware username>@<ESXI IP>"

  4. Direct ESXI with resource pool "vi://<vmware username>@<ESXI IP>/<resource Pool>"

  5. vSphere Host "vi://<vmware username>@<vSphere>/<datacenter name/host/<Host IP or name>"

  6. vSphere Cluster "vi://<vmware username>@<vSphere>/<datacenter name/host/<cluster name>/<Host IP or name>"

  • if you use a "@" or any other special characters in your username or password it must be converted to ASCI and prefixed with % e.g. test@yarnlab.io is test%40yarnlab.io 

...

  • Set the IP address using the VMware console.

  • cd /opt/yarnlab/yarnman

  • sudo ./scripts/bootstrap.sh

    1. Do you want to set a static IP? Y or N : Enter Y to set static IP

    2. You will be asked to select network interface : select number adjacent to ensXX

    3. enter Ip address : Enter the required IP address

    4. enter netmask : to accept default press Enter, otherwise enter required netmask

    5. enter gateway : enter the required gateway address

    6. enter dns server1 : to accept default, press Enter, otherwise enter required DNS server address

    7. You will be asked if you want to change hostname : to accept existing hostname press N otherwise, Y + enter new hostname
      At this point, network will restart

    8. You will be asked if you wish to change SSH password : enter N to keep default or Y to change password

    9. You will be asked if you wish to change yarnman-protected password : Enter N to keep default or Y to change the protected password

  • To change the password at any time SSH and run the passwd command.


It is strongly recommended to change the default password for SSH access
Update hostname if required via /etc/hosts

Deploy as a Standalone Core

Follow these steps to install the Migration Assistant as a core server. This configuration automatically sets up the server and all required services.

  1. Log in to the Yarnman server as user yarnman using ssh client.

  2. Change the directory by typing cd /opt/yarnlab/yarnman

  3. Run the install script using node and sudo:
    sudo node ./scripts/install-as-core-standalone.js -p <password> --couchport <couchport> --redisport <redisport> and substitute the <value>
    sudo node ./scripts/install-as-core-standalone.js -p <password> --couchport 5984 --redisport 6379

    Note: If copying sample line above, ensure that <password> is replaced with an appropriate database password to be used for the installation

  4. On completion of installation from step 3, Open10 Web Browser, browse to Yarnman IP and set the administrator account password.

  5. Accept the End User License Agreement by selecting the check box.

  6. Under the Set Administrator Password option, enter the password that is used later to log in to the GUI & click "Save Acceptance and Update Administrator".

    Image Modified
  7. Login with the username of the administrator and password that you created.


It is strongly recommended to change the default password for web access this is done by going into the default access policy then users

Install As Arm

Note

This is only required for distributed yarnman deployments where network traversal is required

Only follow these steps if you are deploying Yarnman as a distributed system (multiple VMs)
Note that configuration is required on the core node for allowing connectivity from the Arm to the Core describe in https://yarnlab.atlassian.net/wiki/spaces/YSP/pages/2730393636/Yarnman+Administration#Local-Firewall-Configuration
This will install the OVA as a node of Yarnman, connect to the central core database and enroll. Once accepted by the core services, interfaces may be added to it
Target full path of the core's Redis - redis://<some host or ipaddress>:<port - likely 6378>

  1. CD to /opt/yarnlab/yarnman/

  2. Run the script using node and sudo: 

sudo node ./scripts/install-as-arm.js -n <node name> -c <couchpath> -r <redispath> 

with values prepared above substituted for <value>.

  • Node name to appear on the enrollment screen in AdminApp of the core.

  • Target full path of the core's CouchDB - http(s)://<some host or ipaddress>:<port - likely 5984>

sudo node ./scripts/install-as-arm.js -n <name> -c http://<core ip>:5984 -r redis://<core ip>:6379'

  1. Go to the Core's Administration App → Enrollments and accept the new node, you may add services and interface in the normal way.

  2. The enrollment process will auto-generate credentials for the Arm.

Setup NTP Synchronization

By default time is synchronized from the virtual host, for distributed deployments it is recommended to setup NTP on both the core and arm nodes

  1. Edit the following file and setting NTP server required replacing 1.2.3.4

    Code Block
    sudo nano /etc/systemd/timesyncd.conf
    NTP=1.2.3.4
  2. Restart time service

    Code Block
    sudo systemctl restart systemd-timesyncd.service
  3. Verify time is correct after 5 minutes

    Code Block
    yarnman@yarnman-arm:~$ timedatectl status
    Local time: Wed 2021-06-16 13:13:10 UTC
    Universal time: Wed 2021-06-16 13:13:10 UTC
    RTC time: Wed 2021-06-16 13:13:10
    Time zone: Etc/UTC (UTC, +0000)