improved readme

secshellnet · Aug 26, 2023 · 792c9fe · 792c9fe
1 parent caa6a3e
commit 792c9fe
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -3,8 +3,6 @@
 This repository template provides a ansible inventory to manage cloud server in 
 hetzner cloud (hcloud). It performes some basic linux hardening (unattended upgrades, 
 ssh, fail2ban) and can be extended by roles or tasks to perform whatever you need.
-It also supports git ops (github executes your playbook when you change things, so 
-you don't have to do it yourself).
 
 ## Getting started
 1. Create a reporitory from this template repository and clone it:
@@ -48,9 +46,16 @@ you don't have to do it yourself).
    ```
 
 ### gitops
-7. Create a variable
-set secrets: ENABLE_GITOPS=1 and SSH_KEY to the key
+7. Create github actions variables and secrets
+   - Variable: `ENABLE_GITOPS` to value `1`
+   - Secret: `SSH_KEY` to content of [`.keys/id_ecdsa`](./keys/id_ecdsa)
+   - Secret: `ANSIBLE_KEYS_ALL` to the content of [`.keys/all`](./keys/all)
+   ![Create github actions variables](./img/github-create-action-variable.png)![Create github actions variables](./img/github-create-action-variable-enable_gitops.png)
+   ![Create github actions secrets](./img/github-create-action-secret.png)![Create github actions secrets](./img/github-create-action-secret-sshkey.png)
 
+8. Commit and push the create vault and modified inventory.yaml onto github actions
+
+9. Wait for github actions to deploy your cloud servers.
 
 ### Manual usage
 7. Install the required ansible and python modules:

diff --git a/img/github-create-action-secret-sshkey.png b/img/github-create-action-secret-sshkey.png
diff --git a/img/github-create-action-secret.png b/img/github-create-action-secret.png
diff --git a/img/github-create-action-variable-enable_gitops.png b/img/github-create-action-variable-enable_gitops.png
diff --git a/img/github-create-action-variable.png b/img/github-create-action-variable.png