ansible-collections / vmware.vmware

Ansible VMWare Collection
GNU General Public License v3.0
7 stars 10 forks source link

Add vcsa_settings module #19

Closed machacekondra closed 5 months ago

machacekondra commented 6 months ago

System module is used to Configure system settings of VMware appliance.

mariolenz commented 6 months ago

@machacekondra @bardielle I didn't have a closer look the the code, but could I suggest a different name for the module? system is pretty generic. It looks like this module configures the vCenter / vCSA, not any guest or (ESXi) host or any other system.

If I'm correct, I suggest to call the module vcenter_system or vcsa_system or similar. Additionally, I would update the description. At the moment it says Configure system settings of VMware appliance but there are a lot of VMware appliances. If the module is about the vCenter appliance, as I think it is, it should state this clearly.

Sorry if I understand the module wrong. I didn't have the time for a closer look.

bardielle commented 6 months ago

@mariolenz I agree with you it will be more clear.

mariolenz commented 5 months ago

vcsa_(system_)settings or vcsa_(system_)config might also be good names for the module. I'm not sure what would be the best name, but system alone is a little bit misleading IMHO.

machacekondra commented 5 months ago

@mariolenz What about call it appliance_settings or something? I don't know much of the VMware terminology, so would be great to hear your advice. The module basically configure anything which is exposed by vcenter on port 5480. So I am open to any of your suggestions.

mariolenz commented 5 months ago

@machacekondra I would say that virtual appliance (often delivered in form of an OVF) is still too generic. There are both different virtual appliances from VMware (like Aria Operations, if it's still called that) and others like Cisco, HPE, Dell, NetApp... ESXi itself has an appliance-like quality, too. Although it's not a virtual appliance, usually.

So maybe call it vcsa_settings? vCSA is the official name and stands for vCenter Server Appliance with vCenter Server being the original software to manage ESXi hosts and had to be installed on a Windows Server. The vCSA is, well, the SW delivered in form of a virtual appliance. That is, including an OS. Photon OS, I think :thinking:

BTW I think port 5480 often is called the VAMI (Virtual Appliance Management Interface, or something very similar).

@ihumster What do you think? It's easy to fix a description in the documentation but hard to rename a module. So we should try and have a good name from the beginning.

ihumster commented 5 months ago

Yep, I think vcsa (how abbreviation denoting vCenter Server Appliance) a good name to designate a module that configures appliance.

Modules starts with vcenter_ will configure something inside vCenter Server.

machacekondra commented 5 months ago

Renamed to vcsa_settings, thanks for feedback!

bardielle commented 5 months ago

@mariolenz can we merge this PR? Or do you have any other comments?

mariolenz commented 5 months ago

@bardielle Hmm... I think there are some possible improvements. I'll add some suggestions.

machacekondra commented 5 months ago

I suggest to use Semantic markup in the documentation.

Thank you, Mario.

Andersson007 commented 5 months ago
module: vcsa_settings
short_description: Configure vCenter Server Appliance settings
version_added: 2.0.0

I can see it's been already released in 1.2.0. FYI