diff --git a/README.md b/README.md index 98bbc04d..0597de73 100644 --- a/README.md +++ b/README.md @@ -24,20 +24,43 @@ Name | Description [cloud.vmware_ops.provision_vcenter](https://github.com/redhat-cop/cloud.vmware_ops/blob/main/roles/provision_vcenter/README.md)|A role to provison Vcenter on ESXi host. [cloud.vmware_ops.provision_vm](https://github.com/redhat-cop/cloud.vmware_ops/blob/main/roles/provision_vm/README.md)|A role to create/manage virtual machines on VMware. [cloud.vmware_ops.system_settings](https://github.com/redhat-cop/cloud.vmware_ops/blob/main/roles/system_settings/README.md)|A role to manage system settings on VMware. +[cloud.vmware_ops.cluster_settings](https://github.com/redhat-cop/cloud.vmware_ops/tree/main/roles/cluster_settings/README.md)|A role to define cluster settings in vCenter. +[cloud.vmware_ops.content_library](https://github.com/redhat-cop/cloud.vmware_ops/tree/main/roles/content_library/README.md)|A role to manage VMWare content libaries. +[cloud.vmware_ops.deploy_ovf](https://github.com/redhat-cop/cloud.vmware_ops/tree/main/roles/deploy_ovf/README.md)|A role to deploy a VM from an OVF file. +[cloud.vmware_ops.esxi_maintenance_mode](https://github.com/redhat-cop/cloud.vmware_ops/tree/main/roles/esxi_maintenance_mode/README.md)|Either put an ESXI host in maintenance mode or take the host out of maintenance mode. +[cloud.vmware_ops.export_vm_as_ovf](https://github.com/redhat-cop/cloud.vmware_ops/tree/main/roles/export_vm_as_ovf/README.md)|A role to export a VM from VCenter or ESXi as an OVF. +[cloud.vmware_ops.info](https://github.com/redhat-cop/cloud.vmware_ops/tree/main/roles/info/README.md)|A role that gather information from vCenter. +[cloud.vmware_ops.manage_folder](https://github.com/redhat-cop/cloud.vmware_ops/tree/main/roles/manage_folder/README.md)|A role to create, delete, or update a folder or folder tree in VCenter. +[cloud.vmware_ops.provision_virtual_esxi](https://github.com/redhat-cop/cloud.vmware_ops/tree/main/roles/provision_virtual_esxi/README.md)|A role to provision one or more virtual ESXi hosts. +[cloud.vmware_ops.snapshot_management](https://github.com/redhat-cop/cloud.vmware_ops/tree/main/roles/snapshot_management/README.md)|A role to manages virtual machines snapshots in vCenter. +[cloud.vmware_ops.vcenter_host_connection](https://github.com/redhat-cop/cloud.vmware_ops/tree/main/roles/vcenter_host_connection/README.md)|A role to add, remove, connect, disconnect, or reconnect an ESXi host from a VCenter. ### Playbooks Name | Description --- | --- [cloud.vmware_ops.provision_vcenter](https://github.com/redhat-cop/cloud.vmware_ops/blob/main/playbooks/provision_vcenter/provision_vcsa_on_esxi.yml)|A playbook to provison Vcenter on ESXi host. -[cloud.vmware_ops.provision_vm](https://github.com/redhat-cop/cloud.vmware_ops/blob/main/playbooks/provision_vm/manage_vm.yml)|A playbook to create/manage virtual machines on VMware. [cloud.vmware_ops.system_settings](https://github.com/redhat-cop/cloud.vmware_ops/blob/main/playbooks/system_settings.yml)|A playbook to manage system settings on VMware. +[cloud.vmware_ops.cluster_settings](https://github.com/redhat-cop/cloud.vmware_ops/blob/main/playbooks/cluster_settings)|A set of playbook to manage cluster settings. +[cloud.vmware_ops.esxi_management](https://github.com/redhat-cop/cloud.vmware_ops/blob/main/playbooks/esxi_management)|A set of playbooks to manage esxi in a cluster. +[cloud.vmware_ops.provision_vcenter](https://github.com/redhat-cop/cloud.vmware_ops/blob/main/playbooks/provision_vcenter/provision_vcsa_on_esxi.yml)|A playbook to provision vCenter applicationm on ESXi host. +[cloud.vmware_ops.provision_vm](https://github.com/redhat-cop/cloud.vmware_ops/blob/main/playbooks/provision_vm)|A set of playbooks to manage provisioning VM. +[cloud.vmware_ops.snapshot_management](https://github.com/redhat-cop/cloud.vmware_ops/blob/main/playbooks/snapshot_management)|A set of playbooks to manage VM snapshots on vCenter. +[cloud.vmware_ops.export_vm_as_ovf](https://github.com/redhat-cop/cloud.vmware_ops/blob/main/playbooks/export_vm_as_ovf.yml)|A playbook to export vm as OVF file. +[cloud.vmware_ops.info](https://github.com/redhat-cop/cloud.vmware_ops/blob/main/playbooks/info.yml)|A playbook to gather information from vCenter. +[cloud.vmware_ops.manage_content_library](https://github.com/redhat-cop/cloud.vmware_ops/blob/main/playbooks/manage_content_library.yml)|A playbook to manage content libraries in vCenter. +[cloud.vmware_ops.manage_folder](https://github.com/redhat-cop/cloud.vmware_ops/blob/main/playbooks/manage_folder.yml)|A playbook to manage folders in vCenter. ## Installation and Usage ### Requirements -The [community.vmware](https://github.com/ansible-collections/community.vmware) (>=4.4.0), [vmware.vmware_rest](https://github.com/ansible-collections/vmware.vmware_rest), [vmware.vmware](https://github.com/ansible-collections/vmware.vmware) and [community.general](https://github.com/ansible-collections/community.general) collections MUST be installed in order for this collection to work. +The [community.vmware](https://github.com/ansible-collections/community.vmware) (>=4.4.0), +[vmware.vmware_rest](https://github.com/ansible-collections/vmware.vmware_rest), +[vmware.vmware](https://github.com/ansible-collections/vmware.vmware), +[community.general](https://github.com/ansible-collections/community.general) and +[ansible.posix](https://github.com/ansible-collections/ansible.posix) +collections MUST be installed in order for this collection to work. ### Installation diff --git a/changelogs/fragments/92_issue_fixes.yml b/changelogs/fragments/92_issue_fixes.yml new file mode 100644 index 00000000..a4625ef6 --- /dev/null +++ b/changelogs/fragments/92_issue_fixes.yml @@ -0,0 +1,5 @@ +minor_changes: + - Fix role names in the README files to be consistent with the ansible-role-template + - Fix the example of guest_os in provision_vm README role to use RHEL guest OS + - Update the dependencies collections in galaxy.yml and in the execution-environment/requirements.yml + - Update the roles and playbooks in the README in the root directory \ No newline at end of file diff --git a/execution-environment/requirements.yml b/execution-environment/requirements.yml index dbd97e3d..fed04ccc 100644 --- a/execution-environment/requirements.yml +++ b/execution-environment/requirements.yml @@ -2,3 +2,7 @@ collections: - type: git name: https://github.com/redhat-cop/cloud.vmware_ops.git - name: community.general + - name: community.vmware + - name: vmware.vmware + - name: vmware.vmware_rest + - name: ansible.posix diff --git a/galaxy.yml b/galaxy.yml index 426fc2a7..385a180a 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -23,3 +23,5 @@ dependencies: "vmware.vmware_rest": ">=2.3.1" "community.vmware": ">=4.4.0" "vmware.vmware": ">=1.4.0" + "community.general": ">=9.2.0" + "ansible.posix": ">=1.5.4" diff --git a/roles/cluster_settings/README.md b/roles/cluster_settings/README.md index 3639be91..f487a718 100644 --- a/roles/cluster_settings/README.md +++ b/roles/cluster_settings/README.md @@ -1,4 +1,4 @@ -# Cluster settings role +# cluster_settings A role to define cluster settings in vCenter. diff --git a/roles/content_library/README.md b/roles/content_library/README.md index f3fc14bd..e2483e16 100644 --- a/roles/content_library/README.md +++ b/roles/content_library/README.md @@ -1,4 +1,4 @@ -# Content Library Role +# content_library A role to manage VMWare content libaries. You can create or delete both local and subscribed content libraries. diff --git a/roles/deploy_ovf/README.md b/roles/deploy_ovf/README.md index 90ce1351..33e86e89 100644 --- a/roles/deploy_ovf/README.md +++ b/roles/deploy_ovf/README.md @@ -1,4 +1,4 @@ -# Deploy OVF role +# deploy_ovf A role to deploy a VM from an OVF file. The OVF can be located on the `ansible_host` filesystem, at a URL, or located in a content library. diff --git a/roles/export_vm_as_ovf/README.md b/roles/export_vm_as_ovf/README.md index 58ccf75e..9328c022 100644 --- a/roles/export_vm_as_ovf/README.md +++ b/roles/export_vm_as_ovf/README.md @@ -1,4 +1,4 @@ -# Export VM As OVF Role +# export_vm_as_ovf A role to export a VM from VCenter or ESXi as an OVF. The VM is exported to the local filesystem of the host running the tasks (anisble_host). diff --git a/roles/info/README.md b/roles/info/README.md index 86f68048..bdf7a6df 100644 --- a/roles/info/README.md +++ b/roles/info/README.md @@ -1,4 +1,4 @@ -# Gather information from vcenter +# info A role that gather information from vcenter. diff --git a/roles/manage_folder/README.md b/roles/manage_folder/README.md index 839192e6..a1bfe446 100644 --- a/roles/manage_folder/README.md +++ b/roles/manage_folder/README.md @@ -1,4 +1,4 @@ -# Manage Folder Role +# manage_folder A role to create, delete, or update a folder or folder tree in VCenter. diff --git a/roles/provision_vm/README.md b/roles/provision_vm/README.md index 7075ec7a..14d5912e 100644 --- a/roles/provision_vm/README.md +++ b/roles/provision_vm/README.md @@ -1,4 +1,4 @@ -# Provision virtual machine +# provision_vm A role to provision a virtual machine, create associated resources if they don't exist (subnets, vCPU, memory configuration, storage configuration, etc) This includes cloning and building from VM templates. @@ -793,7 +793,7 @@ Create a ``playbook.yml`` file like this: provision_vm_hardware: memory_mb: 512 num_cpus: 4 - provision_vm_guest_id: "centos64Guest" + provision_vm_guest_id: "rhel9_64Guest" ``` Run the playbook: diff --git a/roles/snapshot_management/README.md b/roles/snapshot_management/README.md index 2323bf84..03cb0a10 100644 --- a/roles/snapshot_management/README.md +++ b/roles/snapshot_management/README.md @@ -1,4 +1,4 @@ -# Provision virtual machine +# snapshot_management A role to manages virtual machines snapshots in vCenter. This role can be used to create, delete and update snapshot(s) of the given virtual machine. diff --git a/roles/system_settings/README.md b/roles/system_settings/README.md index cd5a4cdd..6cc49181 100644 --- a/roles/system_settings/README.md +++ b/roles/system_settings/README.md @@ -1,4 +1,4 @@ -# System settings role +# system_settings A role to define system settings for vCenter.