radar231
/
role_pve-deploy
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

updated README.md

This commit is contained in:
Radar231 2023-12-18 19:46:25 -05:00
parent 576712923d
commit d6948de1f1
1 changed files with 10 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
README.md
View File

@ -1,38 +1,14 @@
Role Name
=========
# Ansible Role: pve-deploy
A brief description of the role goes here.
## Introduction
Requirements
------------
Role to deploy a new guest to a proxmox host.
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.
This role will first use a proxmox ansible module to deploy either
a container (community.general.proxmox) or a VM (community.general.proxmox_kvm).
It will then use the setup-host.yml playbook to run through a number of
roles to do package and user configuration, before finishing up with custom
configurations for the specific target host, based on the contents of the
host_config variable in the inventory file.
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
------------
A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.
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
-------
BSD
Author Information
------------------
An optional section for the role authors to include contact information, or a website (HTML is not allowed).