VMware: restructure docs (#43065)

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
pull/43439/head
Abhijeet Kasurde 6 years ago committed by Alicia Cozine
parent 1c082e93ef
commit d1c0b7a597

@ -59,7 +59,6 @@ Ansible releases a new major release of Ansible approximately every two months.
scenario_guides/guide_rax scenario_guides/guide_rax
scenario_guides/guide_rolling_upgrade scenario_guides/guide_rolling_upgrade
scenario_guides/guide_vagrant scenario_guides/guide_vagrant
scenario_guides/guide_vmware
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2

@ -1,59 +0,0 @@
Getting Started with VMware
===========================
Introduction
````````````
Ansible provides various modules to manage VMware infrastructure, which includes datacenter, cluster,
host system and virtual machine.
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. You can install pyVmomi using pip:
.. code-block:: bash
$ pip install pyvmomi
vmware_guest module
```````````````````
The :ref:`vmware_guest<vmware_guest_module>` module manages various operations related to virtual machines in the given ESXi or vCenter server.
Prior to Ansible version 2.5, ``folder`` was an optional parameter with a default value of ``/vm``. The folder parameter
was used to discover information about virtual machines in the given infrastructure.
Starting with Ansible version 2.5, ``folder`` is still an optional parameter with no default value.
This parameter will be now used to identify a user's virtual machine, if multiple virtual machines or virtual
machine templates are found with same name. VMware does not restrict the system administrator from creating virtual
machines with same name.
Debugging
`````````
When debugging or creating a new issue, you will need information about your VMware infrastructure. You can get this information using
`govc <https://github.com/vmware/govmomi/tree/master/govc>`_, For example:
.. 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 /
.. 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
:ref:`working_with_playbooks`
An introduction to playbooks

@ -16,6 +16,5 @@ This section is new and evolving. The idea here is to explore particular use ca
guide_rolling_upgrade guide_rolling_upgrade
guide_docker guide_docker
guide_packet guide_packet
guide_vmware
Pending topics may include: Docker, Jenkins, Google Compute Engine, Linode/DigitalOcean, Continuous Deployment, and more. Pending topics may include: Docker, Jenkins, Google Compute Engine, Linode/DigitalOcean, Continuous Deployment, and more.

@ -10,4 +10,17 @@ vmware_guest
Can I deploy a virtual machine on a standalone ESXi server ? Can I deploy a virtual machine on a standalone ESXi server ?
------------------------------------------------------------ ------------------------------------------------------------
Yes. vmware_guest can deploy a virtual machine with required settings on a standalone ESXi server. Yes. ``vmware_guest`` can deploy a virtual machine with required settings on a standalone ESXi server.
Is ``/vm`` required for ``vmware_guest`` module ?
-------------------------------------------------
Prior to Ansible version 2.5, ``folder`` was an optional parameter with a default value of ``/vm``.
The folder parameter was used to discover information about virtual machines in the given infrastructure.
Starting with Ansible version 2.5, ``folder`` is still an optional parameter with no default value.
This parameter will be now used to identify a user's virtual machine, if multiple virtual machines or virtual
machine templates are found with same name. VMware does not restrict the system administrator from creating virtual
machines with same name.

@ -4,9 +4,40 @@
Introduction to Ansible for VMware Introduction to Ansible for VMware
********************************** **********************************
Make the case. What does it do? .. contents:: Topics
* Cool thing 1 Introduction
* Cool thing 2 ============
* Cool thing 3
Ansible provides various modules to manage VMware infrastructure, which includes datacenter, cluster,
host system and virtual machine.
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 infrastructure. You can install pyVmomi using pip:
.. code-block:: bash
$ pip install pyvmomi
vmware_guest module
===================
The :ref:`vmware_guest<vmware_guest_module>` module manages various operations related to virtual machines in the given ESXi or vCenter server.
.. 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
:ref:`working_with_playbooks`
An introduction to playbooks

@ -4,8 +4,25 @@
Troubleshooting Ansible for VMware Troubleshooting Ansible for VMware
********************************** **********************************
.. contents:: Topics
This section lists things that can go wrong and possible ways to fix them. This section lists things that can go wrong and possible ways to fix them.
Debugging
=========
When debugging or creating a new issue, you will need information about your VMware infrastructure. You can get this information using
`govc <https://github.com/vmware/govmomi/tree/master/govc>`_, For example:
.. 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 /
Troubleshooting Item Troubleshooting Item
==================== ====================

Loading…
Cancel
Save