From 7d104e8efcd91d2c9d18718ec1d4e81df98d20e1 Mon Sep 17 00:00:00 2001 From: uumas Date: Mon, 8 Nov 2021 01:33:13 +0200 Subject: [PATCH] improve docs --- docs/general.md | 25 +------------------------ docs/packages.md | 16 ++++++++++++++++ docs/users.md | 16 ++++++++++++++++ 3 files changed, 33 insertions(+), 24 deletions(-) create mode 100644 docs/packages.md create mode 100644 docs/users.md diff --git a/docs/general.md b/docs/general.md index 2d5c3c8..3ecd8c2 100644 --- a/docs/general.md +++ b/docs/general.md @@ -1,30 +1,7 @@ # Required variables -These variables are required by some roles. Example values included. +These variables might be required by multiple roles and need to be defined. Example values below. ``` email: 'admin@domain.tld' ``` -# Default variables -These variables have default values (shown below) which can be overridden. - -``` -install_packages: - - vim - - git - - etckeeper - - net-tools - - nmap - - ncdu - - fish - - parted -``` - -# Optional variables -These variables are not required and not defined by default. Example values included. - -``` -delete_packages: - - nano - - curl -``` diff --git a/docs/packages.md b/docs/packages.md new file mode 100644 index 0000000..3b45006 --- /dev/null +++ b/docs/packages.md @@ -0,0 +1,16 @@ +Installs packages defined in `install_packages` variable, which has the following defaults: + +``` +install_packages: + - vim + - git + - etckeeper + - net-tools + - nmap + - ncdu + - fish + - parted +``` + +Also deletes packages defined in `delete_packages` if defined + diff --git a/docs/users.md b/docs/users.md new file mode 100644 index 0000000..0cfbaba --- /dev/null +++ b/docs/users.md @@ -0,0 +1,16 @@ +--- + +Creates users specified in the `users` variable. Syntax: + +``` +users: + - name: username + password: hashed password + ssh_pubkey: 'ssh-rsa...' + - name: 'user1' + password: '$6$...' + ssh_pubkey: 'ssh-ed25519...' + shell: '/usr/bin/fish' +``` + +Specifying `shell` is optional