Yarnman Photon Powered (YM-PH) - Installation and Upgrade Guide

Owned by Zane England
Last updated: Jun 17, 2024
6 min read

 

Compute Requirements

Hardware

Specification

Virtual Machines

  • 4 vCPU

  • 8 GB vRAM (16GB required for larger deployments)

  • Disks 102GB

    • 1 x 30GB - OS

    • 1 x 60GB - Database

    • 1 x 12GB - Logs

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

For large wrangler deployments the OVA requires 8vCPU and 16GB of vRAM - >20k users/devices in source system

Storage Notes

  • Storage latency < 20 ms (no spikes above)

  • POSIX-compatible filesystem

Virtualization software

VMware vSphere ESXi 6 or higher

VMware Workstation support 12 or higher

Yarnman Deployment

Setup Process

Steps

Purpose

Notes

Dependancies

Steps

Purpose

Notes

Dependancies

1

Deploy OVA

Deploy all yarnman virtual machines

 

 

2

Set IP address

Set static IP address for yarnman

 

 

3

Generate Certificates

Generate service container certificates

 

If changes are required at this step the script can be started

Yarnman Photon Powered (YM-PH) - Command Line Interface Guide (CLI) | ym generate certs.sh

 

4

Install yarnman

Install yarnman and initialise system

If changes are required at this step the script can be started

Yarnman Photon Powered (YM-PH) - Command Line Interface Guide (CLI) | ym install.sh

 

5

Encrypt configuration

Encrypt keys and config using clevis/tang

 

The other nodes must be deployed and initalised before this step can be performed

6

Local node customisation

Customise local node

 

 

7

Enable Couchd clustering

Only required for clustered yarnman deployments

 

Local node customisation

 

Deploy Yarnman OVA

1. Deploy yarnman OVA to VMware 

Yarnman ova can be depoyed either using VMware OVFtool or by uploading the ova to vSphere/ESXi 

OVA file format yarnman-ph4-<version>-<build>.ova

Note that this file format may change



2. Using VMware Console log into Yarnman to bootstrap configuration

1. login to to yarnman using the VMware console

 

2. Set the static ip and other network settings

root@yarnman [ ~ ]# ym-set-static-ip.sh Do you want to set a static IP? Y or Ny set static Please, select a network interface from the numberic index: 0 eth0 1 docker0 0 Selected eth0 *** Please enter the following details: *** Hostname: yarnman-test IP Address: 10.101.10.37 Netmask Bits: 24 Gateway: 10.101.10.1 DNS: 10.101.205.200 Domain: lab.yarnlab.io NTP: 10.101.205.200

 

3. Confirm Network Settings

Applying the following configuration: Interface = eth0 Hostname = yarnman-test IP Address = 10.101.10.37 Netmask = 24 Gateway = 10.101.10.1 DNS = 10.101.205.200 Domain = lab.yarnlab.io NTP = 10.101.205.200 Is this correct? Y or N

Console output from previous set - no action required

setting static ip - netmgr ip4_address --set --interface eth0 --mode static --addr 10.101.10.37/24 --gateway 10.101.10.1 IPv4 Address Mode: static IPv4 Address=10.101.10.37/24 IPv4 Gateway=10.101.10.1 use --dhcp default value 0. use --autoconf default value 0. setting hostname - netmgr hostname --set --name yarnman-test Hostname: yarnman-test # Begin /etc/hosts (network card version) ::1 ipv6-localhost ipv6-loopback 127.0.0.1 localhost.localdomain 127.0.0.1 localhost 127.0.0.1 yarnman # End /etc/hosts (network card version) 10.101.10.37 yarnman-test setting dns servers - netmgr dns_servers --set --mode staic --servers 10.101.205.200 DNSMode=static DNSServers=127.0.0.53 nameserver 10.101.205.200 setting dns servers - netmgr dns_domains --set --domains lab.yarnlab.io Domains=domains. setting dns servers - netmgr ntp_servers --set --servers 10.101.205.200 NTPServers= 10.101.205.200 Bootstrap configuration complete

 

4. Set the password for the yarnman user

 

5. If certificates are not present the script will ask the user to automatically generate local certificates

Certificate verification

Certificate generation output

6. If yarnman has not been installed the script will prompt to set the database password for yarnman

 

 

 

 

7. Web Browser, browse to Yarnman IP and set the administrator account password.

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

  • 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".

  • Login with the username of the administrator and password that you created.

  • Yarnman is installed

 

Upgrade Guide

refer to Yarnman Photon Powered (YM-PH) - Command Line Interface Guide (CLI) | Upgrade

 

yarnlab website