Adjusted README

This commit is contained in:
2025-08-24 16:00:49 +02:00
parent 93c8a6e4b9
commit 0703b178dc

View File

@@ -4,11 +4,11 @@ This Ansible setup is designed to automate the configuration and maintenance of
## Directory Structure
- `inventory/`: Contains the inventory files that define the hosts and groups of hosts managed by Ansible. The `hosts.ini` file should be updated with your server details, and `example_hosts.ini` serves as a template.
- `group_vars/`: This directory can be used to store variables that apply to specific groups of hosts defined in the inventory.
- `*.yml` files: These are the Ansible playbooks that define the automation tasks.
- `secrets.yml`: This file is intended to store sensitive data like passwords and API keys. It is recommended to encrypt this file using Ansible Vault. An `example_secrets.yml` is provided as a template.
- `vars.yml`: This file can be used to store non-sensitive variables that are used across multiple playbooks.
- `inventory/`: Contains the inventory files that define the hosts and groups of hosts managed by Ansible.
- `playbooks/`: Contains the Ansible playbooks for various automation tasks.
- `secrets.yml`: This file is intended to store sensitive data like passwords and API keys. It is recommended to encrypt this file using Ansible Vault.
- `example_secrets.yml`: An example secrets file.
- `vars.yml`: This file can be used to store non-sensitive variables that are used across multiple playbooks.
## Getting Started
@@ -17,5 +17,5 @@ This Ansible setup is designed to automate the configuration and maintenance of
3. **Secrets:** Create a `secrets.yml` file based on the `example_secrets.yml` template and encrypt it using Ansible Vault for security.
4. **Run a Playbook:** You can run a playbook using the `ansible-playbook` command. For example:
```bash
ansible-playbook -i inventory/hosts.ini apt_upgrade.yml
```
ansible-playbook -i inventory/hosts.ini playbooks/apt_upgrade.yml
```