aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorEgor Tensin <Egor.Tensin@gmail.com>2023-05-21 19:15:07 +0200
committerEgor Tensin <Egor.Tensin@gmail.com>2023-05-21 19:20:12 +0200
commiteef2e9b089a4593ddccc337f47b294a68e615c58 (patch)
tree41d7eec96264d109c93f96ebbe3d032828df61cd
parentfix some ansible-lint warnings (diff)
downloadmaintenance-eef2e9b089a4593ddccc337f47b294a68e615c58.tar.gz
maintenance-eef2e9b089a4593ddccc337f47b294a68e615c58.zip
README: update
-rw-r--r--README.md27
1 files changed, 26 insertions, 1 deletions
diff --git a/README.md b/README.md
index dc8cac6..8c4cc4f 100644
--- a/README.md
+++ b/README.md
@@ -2,4 +2,29 @@ Maintenance
===========
Scripts to maintain my machines via GitHub Actions runs.
-Nothing to see here.
+Nothing to see here really.
+
+Usage
+-----
+
+This is an Ansible playbook; it's very non-generic and heavily customized to
+how my machines are set up.
+The primary usage scenario is going to this repository's Actions and running
+the workflow.
+
+You can also run it manually; first, install the Ansible Galaxy dependencies:
+
+ make deps
+
+Make sure you can SSH to the hosts as the `maintenance` user; then, you can run
+the playbook:
+
+ make run
+
+Reboot everything:
+
+ make reboot
+
+Reboot my cloud servers only:
+
+ make reboot/cloud