first commit

README.md

@@ -0,0 +1,57 @@
+# Adhdgirl Minilab Ansible Project
+
+## To Get Machines Added
+
+1. Generate a set of ssh-keys for the ansible user. Copy both to the files directory. (Expects id_rsa and id_rsa.pub)  
+2. Either make sure that the container has your SSH public key for auth, or allows password auth for the user you wish to use.<br>**_NOTE_** Whichever user you are using must be able to run root commands, either using sudo, or by being root.  
+    * For authenticating using SSH keys, execute<br>`ansible-playbook --ask-vault-pass -e 'ansible_user=<user>' --ask-become-pass -e 'ansible_private_key_file=<path_th_ssh_private_key>' minilab.yml`
+    * For authenticating without using SSH keys, execute<br>`ansible-playbook --ask-vault-pass -e 'ansible_user=<user>' --ask-pass --ask-become-pass minilab.yml`
+3. After the first run. the following will work
+    * `ansible-playbook --ask-vault-pass minilab.yml`
+
+## Included content/ Directory Structure
+
+The directory structure follows best practices recommended by the Ansible
+community. Feel free to customize this template according to your specific
+project requirements.
+
+```
+ ansible-project/
+ |── .devcontainer/
+ |    └── docker/
+ |        └── devcontainer.json
+ |    └── podman/
+ |        └── devcontainer.json
+ |    └── devcontainer.json
+ |── .github/
+ |    └── workflows/
+ |        └── tests.yml
+ |    └── ansible-code-bot.yml
+ |── .vscode/
+ |    └── extensions.json
+ |── collections/
+ |   └── requirements.yml
+ |   └── ansible_collections/
+ |       └── project_org/
+ |           └── project_repo/
+ |               └── README.md
+ |               └── roles/sample_role/
+ |                         └── README.md
+ |                         └── tasks/main.yml
+ |── inventory/
+ |   └── groups_vars/
+ |   └── host_vars/
+ |   └── hosts.yml
+ |── ansible-navigator.yml
+ |── ansible.cfg
+ |── devfile.yaml
+ |── linux_playbook.yml
+ |── network_playbook.yml
+ |── README.md
+ |── site.yml
+```
+
+## Compatible with Ansible-lint
+
+Tested with ansible-lint >=24.2.0 releases and the current development version
+of ansible-core.