Improve documentation
This commit is contained in:
		
							parent
							
								
									3580a9141b
								
							
						
					
					
						commit
						233e8e4ecf
					
				
					 2 changed files with 16 additions and 8 deletions
				
			
		| 
						 | 
				
			
			@ -1,6 +1,12 @@
 | 
			
		|||
# Installation on existing client
 | 
			
		||||
 | 
			
		||||
An easy method to test the lmn-client is to run the playbook manual on a fresh installed client.
 | 
			
		||||
A straightforward way to test the lmn-client is to manually run the playbook on a freshly installed client.
 | 
			
		||||
 | 
			
		||||
This can be done in the following ways:
 | 
			
		||||
 | 
			
		||||
    On the client using ansible-pull
 | 
			
		||||
    On the client by checking out the lmn-client repository and running the playbook locally
 | 
			
		||||
    On a target device by checking out the lmn-client repository locally and executing the playbook against the target device
 | 
			
		||||
 | 
			
		||||
## Direct call via ansible-pull
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			@ -12,7 +18,7 @@ Steps:
 | 
			
		|||
* Install additional packages: ansible  
 | 
			
		||||
  `sudo apt install ansible`
 | 
			
		||||
* Run Playbook  
 | 
			
		||||
  `ansible-pull -i inventory.yml -l localhost, --url=https://codeberg.org/DigitalSouveraeneSchule/lmn-client.git -C main lmn-client.yml`
 | 
			
		||||
  `sudo ansible-pull --verbose -i inventory-sample.yml -l localhost --url=https://codeberg.org/DigitalSouveraeneSchule/lmn-client.git -C main lmn-client.yml`
 | 
			
		||||
 | 
			
		||||
## Checkout git and run ansible locally
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			@ -26,8 +32,10 @@ Steps:
 | 
			
		|||
  `sudo apt install ansible git`
 | 
			
		||||
* Checkout Repository  
 | 
			
		||||
  `git clone https://codeberg.org/DigitalSouveraeneSchule/lmn-client.git`
 | 
			
		||||
* Change into repository directory  
 | 
			
		||||
  `cd lmn-client`
 | 
			
		||||
* Create inventory  
 | 
			
		||||
  `cp inventory.yml inventory-myschool.yml`
 | 
			
		||||
  `cp inventory-sample.yml inventory-myschool.yml`
 | 
			
		||||
* Edit inventory-myschool.yml  
 | 
			
		||||
  e.g.: `nano inventory-myschool.yml`
 | 
			
		||||
* Run Playbook  
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -42,7 +42,7 @@ menuentry 'Installer Debian bookworm (amd64) + preseed + ansible inventory' {
 | 
			
		|||
   # echo -n "Enter vault password"
 | 
			
		||||
   # read vaultpw
 | 
			
		||||
   linux   (http,ftp.debian.org)/debian/dists/stable/main/installer-amd64/current/images/netboot/debian-installer/amd64/linux auto=true priority=high \
 | 
			
		||||
           url=https://codeberg.org/DigitalSouveraeneSchule/lmn-client/raw/branch/fvs/misc/preseed.cfg interface=auto \
 | 
			
		||||
           url=https://codeberg.org/DigitalSouveraeneSchule/lmn-client/raw/branch/main/misc/preseed.cfg interface=auto \
 | 
			
		||||
           playbook=lmn-client.yml adpw="${adpw}" vaultpw="${vaultpw}" ---
 | 
			
		||||
   initrd  (http,ftp.debian.org)/debian/dists/stable/main/installer-amd64/current/images/netboot/debian-installer/amd64/initrd.gz
 | 
			
		||||
}
 | 
			
		||||
| 
						 | 
				
			
			@ -107,7 +107,7 @@ menuentry 'Installer Debian bookworm (amd64) + preseed + ansible inventory' {
 | 
			
		|||
   # echo -n "Enter vault password"
 | 
			
		||||
   # read vaultpw
 | 
			
		||||
   linux   (http,livebox.example.com)/d-i/n-pkg/images/12/amd64/text/debian-installer/amd64/linux auto=true priority=high \
 | 
			
		||||
           url=https://codeberg.org/MySchool/lmn-client/raw/branch/fvs/misc/preseed-myschool.cfg interface=auto \
 | 
			
		||||
           url=https://codeberg.org/MySchool/lmn-client/raw/branch/main/misc/preseed-myschool.cfg interface=auto \
 | 
			
		||||
           playbook=lmn-client.yml adpw="${adpw}" vaultpw="${vaultpw}" ---
 | 
			
		||||
   initrd  (http,livebox.example.com)/d-i/n-pkg/images/12/amd64/text/debian-installer/amd64/initrd.gz
 | 
			
		||||
}
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
	Add table
		
		Reference in a new issue