Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

VMware: Add basic vmware module related guide #35128

Merged
merged 5 commits into from
Jan 31, 2018
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
62 changes: 62 additions & 0 deletions docs/docsite/rst/guide_vmware.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
Getting Started with VMware
===========================

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add table of contents with:
.. contents:: Topics

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, we don't need a TOC here.

Introduction
````````````

Ansible provides various modules to manage VMware infrastructure which includes datacenter, cluster,
host system and virtual machine etc.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Link to VMware module list?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK.

Requirements
````````````

Ansible VMware modules are written on top of `pyVmomi <https://github.com/vmware/pyvmomi>`_.
pyVmomi is the Python SDK for the VMware vSphere API that allows user to manage ESX, ESXi,
and vCenter infrastcture. User can install pyVmomi using
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

infrastcture/infrastructure/

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK.


.. code-block:: bash

$ pip install pyvmomi


vmware_guest module
```````````````````

The ``vmware_guest`` module is used to manage various operations related to virtual machines in
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The :ref:vmware_guest <vmware_guest> module...

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok.

the given ESXi or vCenter server.

Prior to Ansible version 2.5, ``folder`` was an optional parameter with value as ``/vm``. Folder parameter
was used to find about virtual machine in the given infrastructure.

From Ansible version 2.5 and onwards, ``folder`` is still an optional parameter with no default value.
This parameter will be now used to identify user desired virtual machine, if multiple virtual machines or virtual
machine templates are found with same name. VMware does not restrict system administrator from creating virtual
machine with same name.

Debugging
`````````

In order to understand the issue related to VMware modules, one must understand infrastucture details. So, while
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

infrastructure

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK.

create a new issue, please provide information about user VMware infrastructure. User can get this information using
`govc <https://github.com/vmware/govmomi/tree/master/govc>`_ like -


.. code-block:: bash

$ export GOVC_USERNAME=<ESXI_OR_VCENTER_USERNAME>
$ export GOVC_PASSWORD=<ESXI_OR_VCENTER_PASSWORD>
$ export GOVC_URL=https://<ESXI_OR_VCENTER_HOSTNAME>:443
$ govc find /


Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you want to mention the VMware working group?
github.com/ansible/community/tree/master/group-vmware

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't see any references of working group in other guides, so I didn't add it here.

.. seealso::

`pyVmomi <https://github.com/vmware/pyvmomi>`_
The GitHub Page of pyVmomi
`pyVmomi Issue Tracker <https://github.com/vmware/pyvmomi/issues>`_
The issue tracker for the pyVmomi project
`govc <https://github.com/vmware/govmomi/tree/master/govc>`_
govc is a vSphere CLI built on top of govmomi.
:doc:`playbooks`
An introduction to playbooks

1 change: 1 addition & 0 deletions docs/docsite/rst/guides.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,6 @@ This section is new and evolving. The idea here is to explore particular use ca
guide_rolling_upgrade
guide_docker
guide_packet
guide_vmware

Pending topics may include: Docker, Jenkins, Google Compute Engine, Linode/DigitalOcean, Continuous Deployment, and more.