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

Shortens Scenario Guides, incorporates vmware guide #54554

Merged
merged 2 commits into from
Apr 4, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
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
14 changes: 5 additions & 9 deletions docs/docsite/rst/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,16 +47,12 @@ Ansible releases a new major release of Ansible approximately three to four time

.. toctree::
:glob:
:maxdepth: 2
:caption: Scenario Guides

scenario_guides/guide_*

.. toctree::
:maxdepth: 2
:caption: Ansible for VMWare
:maxdepth: 1
:caption: Common Ansible Scenarios

vmware/index
scenario_guides/cloud_guides
scenario_guides/network_guides
scenario_guides/virt_guides

.. toctree::
:maxdepth: 2
Expand Down
21 changes: 21 additions & 0 deletions docs/docsite/rst/scenario_guides/cloud_guides.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
.. _cloud_guides:

*******************
Public Cloud Guides
*******************

The guides in this section cover using Ansible with a range of public cloud platforms. They explore particular use cases in greater depth and provide a more "top-down" explanation of some basic features.

.. toctree::
:maxdepth: 1

guide_alicloud
guide_aws
guide_cloudstack
guide_gce
guide_azure
guide_online
guide_packet
guide_rax
guide_scaleway
guide_vultr
8 changes: 2 additions & 6 deletions docs/docsite/rst/scenario_guides/guide_docker.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Getting Started with Docker
===========================
Docker Guide
============

Ansible offers the following modules for orchestrating Docker containers:

Expand Down Expand Up @@ -327,7 +327,3 @@ For the default host and each host in the hosts list define the following attrib
description: The port containers use for SSH
required: false
default: 22




5 changes: 2 additions & 3 deletions docs/docsite/rst/scenario_guides/guide_kubernetes.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Getting Started with Kubernetes and OpenShift
=============================================
Kubernetes and OpenShift Guide
==============================

Modules for interacting with the Kubernetes (K8s) and OpenShift API are under development, and can be used in preview mode. To use them, review the requirements, and then follow the installation and use instructions.

Expand Down Expand Up @@ -53,4 +53,3 @@ Filing issues
If you find a bug or have a suggestion regarding individual modules or the role, please file issues at `OpenShift Rest Client issues <https://github.com/openshift/openshift-restclient-python/issues>`_.

There is also a utility module, k8s_common.py, that is part of the `Ansible <https://github.com/ansible/ansible>`_ repo. If you find a bug or have suggestions regarding it, please file issues at `Ansible issues <https://github.com/ansible/ansible/issues>`_.

6 changes: 3 additions & 3 deletions docs/docsite/rst/scenario_guides/guide_online.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
*************************
Using Ansible with Online
*************************
****************
Online.net Guide
****************

Introduction
============
Expand Down
6 changes: 3 additions & 3 deletions docs/docsite/rst/scenario_guides/guide_scaleway.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _guide_scaleway:

***************************
Using Scaleway with Ansible
***************************
**************
Scaleway Guide
**************

.. _scaleway_introduction:

Expand Down
5 changes: 2 additions & 3 deletions docs/docsite/rst/scenario_guides/guide_vagrant.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Using Vagrant and Ansible
=========================
Vagrant Guide
=============

.. _vagrant_intro:

Expand Down Expand Up @@ -151,4 +151,3 @@ The "Tips and Tricks" chapter of the `Ansible Provisioner documentation
The open issues for the Ansible provisioner in the Vagrant project
:ref:`working_with_playbooks`
An introduction to playbooks

30 changes: 30 additions & 0 deletions docs/docsite/rst/scenario_guides/guide_vmware.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
.. _vmware_ansible:

******************
VMware Guide
******************

Welcome to the Ansible for VMware Guide!

The purpose of this guide is to teach you everything you need to know about using Ansible with VMware.

To get started, please select one of the following topics.

.. toctree::
:maxdepth: 1

vmware_scenarios/vmware_intro
vmware_scenarios/vmware_concepts
vmware_scenarios/vmware_requirements
vmware_scenarios/vmware_inventory
vmware_scenarios/vmware_scenarios
vmware_scenarios/vmware_troubleshooting
vmware_scenarios/vmware_external_doc_links
vmware_scenarios/faq
.. comments look like this - start with two dots
.. getting_started content not ready
.. vmware_scenarios/vmware_getting_started
.. module index page not ready
.. vmware_scenarios/vmware_module_reference
.. always exclude the template file
.. vmware_scenarios/vmware_scenario_1
39 changes: 33 additions & 6 deletions docs/docsite/rst/scenario_guides/guides.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,42 @@
:orphan:

***************
.. unified index page included for backwards compatibility

******************
Scenario Guides
***************
******************

The guides in this section cover integrating Ansible with a variety of
platforms, products, and technologies. They explore particular use cases in greater depth and provide a more "top-down" explanation of some basic features.

.. toctree::
:maxdepth: 1
:caption: Public Cloud Guides

The guides in this section explore particular use cases in greater depth and provide a more "top-down" explanation of some basic features.
guide_alicloud
guide_aws
guide_cloudstack
guide_gce
guide_azure
guide_online
guide_packet
guide_rax
guide_scaleway
guide_vultr

.. toctree::
:glob:
:maxdepth: 1
:caption: Network Technology Guides

guide_aci
guide_meraki
guide_infoblox

guide_*
.. toctree::
:maxdepth: 1
:caption: Virtualization & Containerization Guides

Pending topics may include: Jenkins, Linode/DigitalOcean, Continuous Deployment, and more.
guide_docker
guide_kubernetes
guide_vagrant
guide_vmware
16 changes: 16 additions & 0 deletions docs/docsite/rst/scenario_guides/network_guides.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
.. _network_guides:

*************************
Network Technology Guides
*************************

The guides in this section cover using Ansible with specific network technologies. They explore particular use cases in greater depth and provide a more "top-down" explanation of some basic features.

.. toctree::
:maxdepth: 1

guide_aci
guide_meraki
guide_infoblox

To learn more about Network Automation with Ansible, see :ref:`network_getting_started` and :ref:`network_advanced`.
15 changes: 15 additions & 0 deletions docs/docsite/rst/scenario_guides/virt_guides.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
.. _virtualization_guides:

******************************************
Virtualization and Containerization Guides
******************************************

The guides in this section cover integrating Ansible with popular tools for creating virtual machines and containers. They explore particular use cases in greater depth and provide a more "top-down" explanation of some basic features.

.. toctree::
:maxdepth: 1

guide_docker
guide_kubernetes
guide_vagrant
guide_vmware
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@
Ansible for VMware Concepts
***************************

These concepts are common to all uses of Ansible, including VMware automation. You need to understand them to use Ansible for VMware automation. This basic introduction provides the background you need to follow the examples in this guide.
Some of these concepts are common to all uses of Ansible, including VMware automation; some are specific to VMware. You need to understand them to use Ansible for VMware automation. This introduction provides the background you need to follow the :ref:`scenarios<vmware_scenarios>` in this guide.

.. contents:: Topics
.. contents::
:local:

Control Node
============
Expand All @@ -16,20 +17,18 @@ Any machine with Ansible installed. You can run commands and playbooks, invoking
Delegation
==========

If you want to perform a VMware specific task on one host with reference to ESXi server or vCenter server, use the ``delegate_to`` keyword on a task. This delegation host will be any host where you have ``pyVmomi`` installed. Your control node and ``delegate_to`` host can be same or different.
Delegation allows you to select the system that executes a given task. If you do not have ``pyVmomi`` installed on your control node, use the ``delegate_to`` keyword on VMware-specific tasks to execute them on any host where you have ``pyVmomi`` installed.

Modules
=======

The units of code Ansible executes. Each module has a particular use, from creating virtual machines on vCenter to managing distributed virtual switches on vCenter environment. You can invoke a single module with a task, or invoke several different modules in a playbook. For an idea of how many modules Ansible includes, take a look at the :ref:`list of VMware modules<vmware_cloud_modules>`.

The units of code Ansible executes. Each module has a particular use, from creating virtual machines on vCenter to managing distributed virtual switches in the vCenter environment. You can invoke a single module with a task, or invoke several different modules in a playbook. For an idea of how many modules Ansible includes, take a look at the :ref:`list of cloud modules<cloud_modules>`, which includes VMware modules.

Playbooks
=========

Ordered lists of tasks, saved so you can run those tasks in that order repeatedly. Playbooks can include variables as well as tasks. Playbooks are written in YAML and are easy to read, write, share and understand.


pyVmomi
=======

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
.. _vmware_external_doc_links:

******************************
List of useful links to VMware
******************************

Following is the list of various external documentation and guides which can helpful in further readings.
*****************************
Other useful VMware resources
*****************************

* `PyVmomi Documentation <https://github.com/vmware/pyvmomi/tree/master/docs>`_
* `VMware API and SDK Documentation <https://www.vmware.com/support/pubs/sdk_pubs.html>`_
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _vmware_ansible_getting_started:

***************************************
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
:orphan:

.. _vmware_ansible_module_index:

***************************
Ansible VMware Module Guide
***************************

This will be a listing similar to the module index in our core docs.
This will be a listing similar to the module index in our core docs.
Original file line number Diff line number Diff line change
Expand Up @@ -4,28 +4,22 @@
VMware Prerequisites
********************

.. contents:: Topics
.. contents::
:local:

Installing SSL Certificates
===========================

Installing SSL Certificate
==========================
All vCenter and ESXi servers require SSL encryption on all connections to enforce secure communication. You must enable SSL encryption for Ansible by installing the server's SSL certificates on your Ansible control node or delegate node.

All vCenter and ESXi servers require SSL encryption on all connections to enforce secure communication.
If the SSL certificate of your vCenter or ESXi server is not correctly installed on your Ansible control node, you will see the following warning when using Ansible VMware modules:

If you see the following warning while using Ansible VMware modules [warning], you need to enable SSL encryption for Ansible by installing the server's SSL certificates on your Ansible control node or delegate node.
``Unable to connect to vCenter or ESXi API at xx.xx.xx.xx on TCP/443: [SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed (_ssl.c:777)``

```
Unable to connect to vCenter or ESXi API at xx.xx.xx.xx on TCP/443: [SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed (_ssl.c:777)
```
To install the SSL certificate for your VMware server, and run your Ansible VMware modules in encrypted mode, please follow the instructions for the server you are running with VMware.

then, this means you need to add/install SSL certificate of vCenter or ESXi server in your Ansible control node.

The following instructions allow you to run your Ansible VMware modules with encrypted mode (viz. ``validate_certs=True``).

Please follow the instructions depending upon your server to install SSL certificate.

vCenter
-------
Installing vCenter SSL certificates for Ansible
-----------------------------------------------

* From any web browser, go to the base URL of the vCenter Server without port number like ``https://vcenter-domain.example.com``

Expand All @@ -38,9 +32,8 @@ vCenter
* Install the certificate files are trusted certificates by the process that is appropriate for your operating system.



ESXi
----
Installing ESXi SSL certificates for Ansible
--------------------------------------------

* Enable SSH Service on ESXi either by using Ansible VMware module `vmware_host_service_manager <https://github.com/ansible/ansible/blob/devel/lib/ansible/modules/cloud/vmware/vmware_host_config_manager.py>`_ or manually using vSphere Web interface.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _vmware_scenario_1:
:orphan:

**********************************
Sample Scenario for Ansible VMware
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,13 @@
Ansible for VMware Scenarios
****************************

Welcome to the Ansible for VMWare Guide!

The purpose of this guide is to teach you everything you need to know about using Ansible with VMWare.

To get started, please select one of the following topics.

These scenarios teach you how to accomplish common VMware tasks using Ansible. To get started, please select the task you want to accomplish.

.. toctree::
:maxdepth: 2
:maxdepth: 1

scenario_clone_template
scenario_rename_vm
scenario_remove_vm
scenario_find_vm_folder
scenario_vmware_http
vmware_scenario_1