Add documentation about automatic client updater
This commit is contained in:
parent
6f1827ff00
commit
328f3af68b
3 changed files with 128 additions and 0 deletions
63
doc/extrapkg.md
Normal file
63
doc/extrapkg.md
Normal file
|
|
@ -0,0 +1,63 @@
|
|||
# Extra_pkg
|
||||
|
||||
Installs additional packages from stable or backports repositories.
|
||||
|
||||
## Configuration / Variables
|
||||
|
||||
* **extra_pkg**
|
||||
List of packages from the stable repository to be installed.
|
||||
Type: **List of Strings**
|
||||
Default: `[]`
|
||||
|
||||
* **extra_pkg1**
|
||||
List of packages from the stable repository to be installed.
|
||||
Type: **List of Strings**
|
||||
Default: `[]`
|
||||
|
||||
* **extra_pkg2**
|
||||
List of packages from the stable repository to be installed.
|
||||
Type: **List of Strings**
|
||||
Default: `[]`
|
||||
|
||||
* **extra_pkg_bpo**
|
||||
List of packages from the backports repository to be installed.
|
||||
Type: **List of Strings**
|
||||
Default: `[]`
|
||||
|
||||
* **extra_pkg_bpo1**
|
||||
List of packages from the backports repository to be installed.
|
||||
Type: **List of Strings**
|
||||
Default: `[]`
|
||||
|
||||
* **extra_pkg_bpo2**
|
||||
List of packages from the backports repository to be installed.
|
||||
Type: **List of Strings**
|
||||
Default: `[]`
|
||||
|
||||
## Example
|
||||
|
||||
All hosts receive the following packages:
|
||||
* kicad
|
||||
* freecad
|
||||
|
||||
Devices in the teacherlaptops group additionally receive:
|
||||
* plasma-discover
|
||||
* nextcloud-desktop
|
||||
* dolphin-nextcloud
|
||||
|
||||
```yaml
|
||||
inventory.yml
|
||||
all:
|
||||
vars:
|
||||
extra_pkg:
|
||||
- kicad
|
||||
- freecad
|
||||
teacherlaptops:
|
||||
hosts:
|
||||
- nbt[001:999]:
|
||||
vars:
|
||||
extra_pkg1:
|
||||
- plasma-discover
|
||||
- nextcloud-desktop
|
||||
- dolphin-nextcloud
|
||||
```
|
||||
61
doc/updater.md
Normal file
61
doc/updater.md
Normal file
|
|
@ -0,0 +1,61 @@
|
|||
# Updater
|
||||
|
||||
## Description / Use Cases
|
||||
|
||||
The updater service allows clients to be updated automatically. Changes in the Ansible playbook or inventory are applied automatically to all configured clients.
|
||||
|
||||
## Requirements
|
||||
|
||||
* The Ansible playbook must be available via a **public Git repository**.
|
||||
* Hosts in the inventory must be specified by their **hostname**, not by their IP address.
|
||||
|
||||
## Activation / Default
|
||||
|
||||
To install the updater service on clients, set the variable `misc_updater_repository` to a valid Git repository URL. If not set (default: **false**), the service will not be installed.
|
||||
|
||||
To enable the updater service on clients, set the variable `misc_updater_autostart` to **true**.
|
||||
|
||||
## Configuration / Variables
|
||||
|
||||
* **misc_updater_inventory**
|
||||
Name of the Ansible inventory file.
|
||||
Type: **String**
|
||||
|
||||
* **misc_updater_inventory_password**
|
||||
Password for the inventory file if it is protected or encrypted via Ansible Vault.
|
||||
Type: **String**
|
||||
|
||||
* **misc_updater_repository**
|
||||
URL of the public Git repository.
|
||||
Type: **String**
|
||||
|
||||
* **misc_updater_branch**
|
||||
Name of the Git branch.
|
||||
Type: **String**
|
||||
|
||||
* **misc_updater_autostart**
|
||||
Flag to enable the updater service. The updater starts 5 minutes after boot.
|
||||
Type: **Boolean**
|
||||
Values:
|
||||
* `false` — default
|
||||
* `true`
|
||||
|
||||
## Example
|
||||
|
||||
All computers receive the updater service.
|
||||
Automatic updates are installed on all computers except those in the teacherlaptops group.
|
||||
|
||||
```
|
||||
inventory.yml
|
||||
all:
|
||||
vars:
|
||||
misc_updater_inventory: inventory-myschool.yml
|
||||
misc_updater_inventory_password: top-secret
|
||||
misc_updater_repository: https://git.example.com/it-team/lmn-client.git
|
||||
misc_updater_branch: myschool
|
||||
misc_updater_autostart: true
|
||||
|
||||
teacherlaptops:
|
||||
vars:
|
||||
misc_updater_autostart: false
|
||||
```
|
||||
Loading…
Add table
Add a link
Reference in a new issue