diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..020deb0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,22 @@ +The MIT License (MIT) + +Copyright (c) 2019 Sorin Sbarnea +Copyright (c) 2022 Sine Nomine Associates + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..384b46c --- /dev/null +++ b/README.rst @@ -0,0 +1,55 @@ +*********************** +Molecule Proxmox Plugin +*********************** + +This is an experimental Molecule Driver pluging to manage instances on a +`Proxmox VE`_ hypervisor cluster. Only virtual machines are supported at this +time. Proxmox containers will be supported in a future release. + +Requirements +============ + +* Access to a `Proxmox VE`_ cluster +* One or more ``cloud-init`` enabled virtual machine templates on the Proxmox VE cluster +* Python package `proxmoxer`_ +* Ansible module `proxmox_kvm`_ + +The required Python packages are automatically installed when this package is +installed with ``pip``. The ``proxmox_kvm`` module is included with the +Community.General Collection and is automatically installed when Ansible is +installed with ``pip``. + + +Example +======= + +.. code-block:: yaml + + driver: + name: proxmox + options: + + + platforms: + - name: instance + template: generic/centos8 + memory: 512 + cpus: 1 + + +Authors +======= + +Molecule Proxmox Plugin was created by Michael Meffie based on code from +Molecule. + +License +======= + +The `MIT`_ License. + + +.. _`Proxmox VE`: https://www.proxmox.com/en/proxmox-ve +.. _`proxmoxer`: https://pypi.org/project/proxmoxer/ +.. _`proxmox_kvm`: https://docs.ansible.com/ansible/latest/collections/community/general/proxmox_kvm_module.html +.. _`MIT`: https://github.com/meffie/molecule-proxmox/blob/master/LICENSE