Yarnlab Support

https://yarnlab.atlassian.net/wiki/spaces/YSP/
Admin
Yarnlab Support provides comprehensive documentation, troubleshooting articles, and release notes...
Tokens:166,153
Snippets:1,635
Trust Score:10
Update:8 months ago
Show doc for...
Tokens:
Raw
### Example Final ip4save File Content

Source: https://yarnlab.atlassian.net/wiki/spaces/YSP/pages/3428548614/MOP%2B-%2BYarnman%2Bu18%2BMigration

Illustrates the complete content of the ip4save file after applying the necessary modifications. This example includes the initial filter chain setup, rules for local and established connections, SSH access, and the specific DOCKER-USER rules for Redis and CouchDB traffic.

```bash
# init *filter :INPUT DROP [0:0] :FORWARD DROP [0:0] :OUTPUT DROP [0:0] :DOCKER-USER - [0:0] # Allow local-only connections -A INPUT -i lo -j ACCEPT -A INPUT -m conntrack --ctstate RELATED,ESTABLISHED -j ACCEPT #keep commented till upgrade issues are sorted #-A INPUT -j LOG --log-prefix "FIREWALL:INPUT " -A INPUT -p tcp -m tcp --dport 22 -j ACCEPT -A OUTPUT -j ACCEPT -A DOCKER-USER -i eth0 -p tcp -s 10.101.10.160,10.101.10.161 --dport 6379 -m comment --comment "Allow yarnman Redis Traffic - " -j RETURN -A DOCKER-USER -i eth0 -p tcp -s 0.0.0.0/0 --dport 6379 -m comment --comment "block Redis - " -m limit --limit 2/min -j LOG --log-prefix "REDIS DROP-" -A DOCKER-USER -i eth0 -p tcp -s 0.0.0.0/0 --dport 6379 -m comment --comment "block Redis Traffic - " -j DROP -A DOCKER-USER -i eth0 -p tcp -s 10.101.10.160,10.101.10.161 --dport 6984 -m comment --comment "Allow yarnman Couchdb Traffic - " -j RETURN -A DOCKER-USER -i eth0 -p tcp -s 0.0.0.0/0 --dport 6984 -m comment --comment "block Couchdb - " -m limit --limit 2/min -j LOG --log-prefix "COUCHDB DROP-" -A DOCKER-USER -i eth0 -p tcp -s 0.0.0.0/0 --dport 6984 -m comment --comment "block Couchdb Traffic - " -j DROP COMMIT
```

--------------------------------

### SFTP Backup Setup and Restore using ym-backup-actions.sh

Source: https://yarnlab.atlassian.net/wiki/spaces/YSP/pages/2919563378

This script sequence sets up SFTP for backups, copies SSH keys, establishes an SFTP connection, takes snapshots, and performs a restore operation. It requires root privileges for initial setup and uses SFTP for backup and restore actions. The restore process includes a confirmation step for restoring to a different node.

```bash
sudo ym-backup-setup.sh
sudo ym-backup-actions.sh -p sftp -a sftp-user-setup as root user

sudo -u ym-backup-user ssh-copy-id -i /home/ym-backup-user/.ssh/id_rsa.pub sftpbackup@10.101.10.86

sudo ym-backup-actions.sh -p sftp -a sftp-setup-connection
sudo ym-backup-actions.sh -p sftp -a snapshots
sudo ym-backup-actions.sh -p sftp -a restore -r xxxxx
```

--------------------------------

### Example of Yarnman Remote Migration Interaction

Source: https://yarnlab.atlassian.net/wiki/spaces/YSP/pages/3428548614/MOP%2B-%2BYarnman%2Bu18%2BMigration

This snippet demonstrates the command-line interaction during a Yarnman u18 remote migration, including prompts for connection details and database wiping confirmation.

```bash
root@yarnman-core-2614 [ /var/home/yarnman ]# ym-migrate-u18.sh remote
Local system configured, continuing...
Starting Remote Mig
Using remote migration
Enter yarnman IP to copy from: 10.101.205.120
Enter yarnman user to copy from: yarnman
Enter yarnman password to copy from: test
connection OK
Do you want to wipe existing database and migrate Y or N y
```

--------------------------------

### Setup Local Backup Service Account and Passphrase (Shell)

Source: https://yarnlab.atlassian.net/wiki/spaces/YSP/pages/2919563378/Yarnman%2BPhoton%2BPowered%2BYM-PH%2B-%2BBackup%2Band%2BRestore%2BGuide

This script sets up the local backup service account on the yarnman node and configures the passphrase for backups. It handles password initialization and checks for existing configurations.

```shell
sudo ym-backup-setup.sh
Starting yarnman ph4 backup
Backup password not set
Set Backup password: 
Backup password (again): 
Clevis not setup using local backup password
no backup configuration file found
creating
yarnman@node1 [ ~ ]$
```

--------------------------------

### Example CSR Generation

Source: https://yarnlab.atlassian.net/wiki/spaces/YSP/pages/2915991850

Provides a concrete example of the OpenSSL command for CSR generation, demonstrating how to substitute the placeholders with actual values for a specific environment.

```bash
openssl req -config /var/opt/yarnlab/yarnman/config/yarnman-ssl.cnf -new -subj "/C=AU/ST=NSW/L=SYDNEY/O=yarnlab/OU=lab/CN=yarnman.test.yarnlab.io" \ 
 -out /var/opt/yarnlab/yarnman/config/yarnman-ssl.csr -key /var/opt/yarnlab/yarnman/config/ssl-key.pem -passin pass:yarnman -sha512 -newkey rsa:4096
```

--------------------------------

### SFTP Backup Setup and Restore Script Execution

Source: https://yarnlab.atlassian.net/wiki/spaces/YSP/pages/2919563378/Yarnman%2BPhoton%2BPowered%2BYM-PH%2B-%2BBackup%2Band%2BRestore%2BGuide

This snippet demonstrates the execution of shell commands to set up SFTP for backups, copy SSH keys, establish an SFTP connection, and initiate a restore operation. It assumes the `yarnman` environment and requires root privileges for some commands. The restore process involves confirming restoration to a different node.

```shell
sudo ym-backup-setup.sh
sudo ym-backup-actions.sh -p sftp -a sftp-user-setup
sudo -u ym-backup-user ssh-copy-id -i /home/ym-backup-user/.ssh/id_rsa.pub sftpbackup@10.101.10.86
sudo ym-backup-actions.sh -p sftp -a sftp-setup-connection
sudo ym-backup-actions.sh -p sftp -a snapshots
sudo ym-backup-actions.sh -p sftp -a restore -r xxxxx
```

--------------------------------

### Set Yarnman User Password (Shell Command)

Source: https://yarnlab.atlassian.net/wiki/spaces/YSP/pages/2916941825/Yarnman%2BPhoton%2BPowered%2BYM-PH%2B-%2BInstallation%2Band%2BUpgrade%2BGuide

This section demonstrates setting a password for the 'yarnman' user. It includes an example of a bad password attempt due to length constraints and the successful password update.

```shell
yarnman user not found adding now Set yarnman password New password: BAD PASSWORD: The password is shorter than 8 characters New password: Retype new password: passwd: password updated successfully Adding yarnman-user to SSH allowed groups
```

--------------------------------

### Start Yarnman Service

Source: https://yarnlab.atlassian.net/wiki/spaces/YSP/pages/3428548614/MOP%2B-%2BYarnman%2Bu18%2BMigration

This snippet shows the command to start the Yarnman service after all configuration and permission resets are complete. It uses `systemctl start yarnman` to initiate the service.

```bash
systemctl start yarnman
```

--------------------------------

### Manual SFTP Snapshot and Restore using ym-backup-actions.sh

Source: https://yarnlab.atlassian.net/wiki/spaces/YSP/pages/2919563378

This provides an alternate manual method for taking SFTP snapshots and performing restores. It requires the `ym-backup-setup.sh` script to be run beforehand and specifies the SFTP server IP and path. This method is not recommended due to current limitations with the snapshot command in manual mode.

```bash
sudo ym-backup-setup.sh

sudo ym-backup-actions.sh -p manual -a manual-sftp-snapshots -i 10.101.10.86 -k /home/sftpbackup/path/
sudo ym-backup-actions.sh -p manual -a manual-sftp-restore -i 10.101.10.86 -k /home/sftpbackup/path/ -r xxxxx
```

--------------------------------

### Yarnman OVA Deployment VI Paths

Source: https://yarnlab.atlassian.net/wiki/spaces/YSP/pages/2916941825

These are examples of VI (Virtual Infrastructure) paths used with OVFtool for deploying the Yarnman OVA to different VMware targets. These paths specify the connection details to ESXi hosts or vSphere environments, including options for resource pools and specific hosts or clusters.

```bash
Direct ESXI "vi://<vmware username>@<ESXI IP>"
Direct ESXI with resource pool "vi://<vmware username>@<ESXI IP>/<resource Pool>"
vSphere Host "vi://<vmware username>@<vSphere>/<datacenter name/host/<Host IP or name>"
vSphere Cluster "vi://<vmware username>@<vSphere>/<datacenter name/host/<cluster name>/<Host IP or name>"
```

--------------------------------

### Initialize SFTP Backup Repository

Source: https://yarnlab.atlassian.net/wiki/spaces/YSP/pages/2919563378

Initializes a new backup repository using SFTP. This action can only be performed once per repository. The script uses a provided password for SFTP authentication and creates a restic repository at the specified path. Losing the password will result in irrecoverable data loss.

```bash
sudo ym-backup-actions.sh -p sftp -a init
```

--------------------------------

### Start Yarnman Services with ym-service-commands.sh

Source: https://yarnlab.atlassian.net/wiki/spaces/YSP/pages/2916745332/Yarnman%2BPhoton%2BPowered%2BYM-PH%2B-%2BCommand%2BLine%2BInterface%2BGuide%2BCLI

This command starts the Yarnman services. It is essential to run all Yarnman service commands with sudo privileges. The command initiates the yarnman.service, which in turn uses docker-compose to bring up the necessary containers.

```shell
sudo ym-service-commands.sh start
```

--------------------------------

### Disable Redis and CouchDB Services (Bash)

Source: https://yarnlab.atlassian.net/wiki/spaces/YSP/pages/2883289099/Yarnman%2BManual%2BUpgrade

Disables the Redis and CouchDB services from starting automatically on boot for the arm node. This is typically done before reconfiguring or resetting the services.

```bash
sudo systemctl disable redis
sudo systemctl disable couchdb
```

--------------------------------

### Create CA Directory and Add Certificates

Source: https://yarnlab.atlassian.net/wiki/spaces/YSP/pages/2915991850/Yarnman%2BPhoton%2BPowered%2BYM-PH%2B-%2BAdvanced%2BPlatform%2BConfiguration

This snippet demonstrates how to create a directory for intermediate CA certificates and add them in the correct order. Certificates must be named with a numerical prefix (e.g., '1-name.crt') and end with '.crt'.

```bash
mkdir /var/opt/yarnlab/yarnman/config/ca
ls -lh /var/opt/yarnlab/yarnman/config/ca
# Example: 1-name.crt 2-name.crt 3-name.crt
```

--------------------------------

### Yarngate Authentication Database Setup

Source: https://yarnlab.atlassian.net/wiki/spaces/YSP/pages/2726985729

This section details the process of creating and configuring an authentication database for Yarngate. It involves selecting the 'Databases' option from the Administration Menu, naming the database, and defining required roles such as Yarngate-Admin and Yarngate-User. These roles dictate user permissions within the Yarngate application post-authentication.

```text
1. From Administration Menu select **Databases** to create an authentication database
2. Name the LDAP authentication database
3. Configure the required roles 
4. Configure the required roles for yarngate application, it is expected that there would be both a Yarngate-Admin and Yarngate-User. These permissions control what options are available in the yarngate application after a user is Authenticated and Authorised. Repeat this process for as many roles as required
```

--------------------------------

### Enable Local Redis Access for Yarnman

Source: https://yarnlab.atlassian.net/wiki/spaces/YSP/pages/3428548614/MOP%2B-%2BYarnman%2Bu18%2BMigration

This command enables local Redis access, which is only required when a remote ARM setup is being used with Yarnman. Run this command with root privileges or sudo.

```bash
ym-edit-config.sh enable-local-redis-access
```
Tokens:
Raw