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.

Sign up for GitHub

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

Jump to bottom

VMware: Add basic vmware module related guide #35128

Merged
merged 5 commits into from Jan 31, 2018
Merged

VMware: Add basic vmware module related guide #35128

merged 5 commits into from Jan 31, 2018

Conversation

Akasurde
Copy link
Member

SUMMARY

This fix adds page which tries to consolidate various information related
to vmware modules and debugging related information.

Signed-off-by: Abhijeet Kasurde akasurde@redhat.com

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

docs/docsite/rst/guide_vmware.rst
docs/docsite/rst/guides.rst

ANSIBLE VERSION
2.5devel

@Akasurde
VMware: Add basic vmware module related guide
80f9be4 
This fix adds page tries to consolidate various information related
to vmware modules and debugging related information.

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
@ansibot ansibot added affects_2.5 This issue/PR affects Ansible v2.5 docs_pull_request needs_triage Needs a first human triage before being processed. support:core This issue/PR relates to code supported by the Ansible Engineering Team. labels Jan 20, 2018
@ansibot
Copy link
Contributor

ansibot commented Jan 20, 2018

The test ansible-test sanity --test rstcheck [?] failed with the following errors:

docs/docsite/rst/guide_vmware.rst:45:0: (bash) `$ export GOVC_USERNAME=<ESXI_OR_VCENTER_USERNAME>'
docs/docsite/rst/guide_vmware.rst:45:0: (bash) syntax error near unexpected token `newline'

click here for bot help

@ansibot ansibot added ci_verified Changes made in this PR are causing tests to fail. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. labels Jan 20, 2018
@gundalow gundalow added vmware VMware community and removed needs_triage Needs a first human triage before being processed. labels Jan 22, 2018
gundalow
gundalow requested changes Jan 22, 2018
View reviewed changes
docs/docsite/rst/guide_vmware.rst Outdated

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.

docs/docsite/rst/guide_vmware.rst
@@ -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.

docs/docsite/rst/guide_vmware.rst Outdated

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.

docs/docsite/rst/guide_vmware.rst Outdated
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.

docs/docsite/rst/guide_vmware.rst Outdated
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.

docs/docsite/rst/guide_vmware.rst Outdated
$ 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.

dharmabumstead
dharmabumstead approved these changes Jan 31, 2018
View reviewed changes
Copy link
Contributor

@dharmabumstead dharmabumstead left a comment

Choose a reason for hiding this comment

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

OK with some edits.

docs/docsite/rst/guide_vmware.rst
@@ -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.

No, we don't need a TOC here.

@ansibot ansibot removed the ci_verified Changes made in this PR are causing tests to fail. label Jan 31, 2018
@ansibot
Copy link
Contributor

ansibot commented Jan 31, 2018

The test ansible-test sanity --test rstcheck [?] failed with the following errors:

docs/docsite/rst/guide_vmware.rst:43:0: (bash) `$ export GOVC_USERNAME=<ESXI_OR_VCENTER_USERNAME>'
docs/docsite/rst/guide_vmware.rst:43:0: (bash) syntax error near unexpected token `newline'

click here for bot help

@ansibot ansibot added the ci_verified Changes made in this PR are causing tests to fail. label Jan 31, 2018
@ansibot ansibot removed the ci_verified Changes made in this PR are causing tests to fail. label Jan 31, 2018
@ansibot ansibot removed the needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. label Jan 31, 2018
@dharmabumstead dharmabumstead merged commit 9d3ba7e into ansible:devel Jan 31, 2018
Lujeni pushed a commit to Lujeni/ansible that referenced this pull request Feb 1, 2018
@Akasurde @Lujeni
VMware: Add basic vmware module related guide (ansible#35128)
f69c1f1 
* VMware: Add basic vmware module related guide

This fix adds page tries to consolidate various information related
to vmware modules and debugging related information.

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>

* Copy edits

* Added module reference

* Edits

* Fixing invalid characters
@ansibot ansibot added the docs This issue/PR relates to or includes documentation. label Mar 4, 2018
@Akasurde Akasurde deleted the vmware_guide branch March 20, 2018 14:43
@ansible ansible locked and limited conversation to collaborators Apr 26, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@gundalow gundalow gundalow approved these changes

@dharmabumstead dharmabumstead dharmabumstead approved these changes

Assignees
No one assigned
Labels
affects_2.5 This issue/PR affects Ansible v2.5 cloud docs This issue/PR relates to or includes documentation. support:core This issue/PR relates to code supported by the Ansible Engineering Team. vmware VMware community
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@Akasurde @ansibot @gundalow @dharmabumstead @dagwieers