summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAbhijeet Kasurde <akasurde@redhat.com>2018-07-30 21:30:00 +0530
committerAlicia Cozine <cozi@visi.com>2018-07-30 11:00:00 -0500
commitd1c0b7a597944baed20af28c8833d51451791f69 (patch)
treecf045eef9b5739dcf5b7189f9ef68b1b85f2214c /docs
parent1c082e93ef50cffc9833884b79f0c8a80c9dd0de (diff)
downloadansible-d1c0b7a597944baed20af28c8833d51451791f69.tar.gz
VMware: restructure docs (#43065)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/docsite/rst/index.rst1
-rw-r--r--docs/docsite/rst/scenario_guides/guide_vmware.rst59
-rw-r--r--docs/docsite/rst/scenario_guides/guides.rst1
-rw-r--r--docs/docsite/rst/vmware/faq.rst15
-rw-r--r--docs/docsite/rst/vmware/vmware_intro.rst39
-rw-r--r--docs/docsite/rst/vmware/vmware_troubleshooting.rst17
6 files changed, 66 insertions, 66 deletions
diff --git a/docs/docsite/rst/index.rst b/docs/docsite/rst/index.rst
index b6a920cc19..6002b80716 100644
--- a/docs/docsite/rst/index.rst
+++ b/docs/docsite/rst/index.rst
@@ -59,7 +59,6 @@ Ansible releases a new major release of Ansible approximately every two months.
scenario_guides/guide_rax
scenario_guides/guide_rolling_upgrade
scenario_guides/guide_vagrant
- scenario_guides/guide_vmware
.. toctree::
:maxdepth: 2
diff --git a/docs/docsite/rst/scenario_guides/guide_vmware.rst b/docs/docsite/rst/scenario_guides/guide_vmware.rst
deleted file mode 100644
index 6ca118408e..0000000000
--- a/docs/docsite/rst/scenario_guides/guide_vmware.rst
+++ /dev/null
@@ -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
-
diff --git a/docs/docsite/rst/scenario_guides/guides.rst b/docs/docsite/rst/scenario_guides/guides.rst
index 8c574f6d5e..6358864484 100644
--- a/docs/docsite/rst/scenario_guides/guides.rst
+++ b/docs/docsite/rst/scenario_guides/guides.rst
@@ -16,6 +16,5 @@ 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.
diff --git a/docs/docsite/rst/vmware/faq.rst b/docs/docsite/rst/vmware/faq.rst
index 49a45ff235..5dd04cb0f5 100644
--- a/docs/docsite/rst/vmware/faq.rst
+++ b/docs/docsite/rst/vmware/faq.rst
@@ -10,4 +10,17 @@ vmware_guest
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.
diff --git a/docs/docsite/rst/vmware/vmware_intro.rst b/docs/docsite/rst/vmware/vmware_intro.rst
index e5fdce83fa..911d63fcdb 100644
--- a/docs/docsite/rst/vmware/vmware_intro.rst
+++ b/docs/docsite/rst/vmware/vmware_intro.rst
@@ -4,9 +4,40 @@
Introduction to Ansible for VMware
**********************************
-Make the case. What does it do?
+.. contents:: Topics
-* Cool thing 1
-* Cool thing 2
-* Cool thing 3
+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 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
diff --git a/docs/docsite/rst/vmware/vmware_troubleshooting.rst b/docs/docsite/rst/vmware/vmware_troubleshooting.rst
index f3c219f008..3b8752fa5b 100644
--- a/docs/docsite/rst/vmware/vmware_troubleshooting.rst
+++ b/docs/docsite/rst/vmware/vmware_troubleshooting.rst
@@ -4,8 +4,25 @@
Troubleshooting Ansible for VMware
**********************************
+.. contents:: Topics
+
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
====================