summaryrefslogtreecommitdiff
path: root/roles/uvok_bird/README.md
diff options
context:
space:
mode:
authoruvok cheetah2024-03-19 19:37:36 +0100
committeruvok cheetah2024-03-19 19:37:36 +0100
commit94fd6db6186ea78bb98bb7bbd5092ef7da92ac36 (patch)
tree8981c9d1e53cf8bcb62e8cb01f7c7e837982f2db /roles/uvok_bird/README.md
parente90d8566b369beb66df73eb2638905a86d07cf5f (diff)
Add my bird role
Diffstat (limited to 'roles/uvok_bird/README.md')
-rw-r--r--roles/uvok_bird/README.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/roles/uvok_bird/README.md b/roles/uvok_bird/README.md
new file mode 100644
index 0000000..fd1fe7c
--- /dev/null
+++ b/roles/uvok_bird/README.md
@@ -0,0 +1,38 @@
+Role Name
+=========
+
+Start up my bird setup.
+
+Requirements
+------------
+
+Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.
+
+Role Variables
+--------------
+
+A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.
+
+Dependencies
+------------
+
+None
+
+Example Playbook
+----------------
+
+Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
+
+ - hosts: servers
+ roles:
+ - { role: username.rolename, x: 42 }
+
+License
+-------
+
+MIT
+
+Author Information
+------------------
+
+uvok (https://blog.uvokchee.de/). \ No newline at end of file