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

WIP vmware: vmware_guidelines.rst #56814

Open
wants to merge 1 commit into
base: devel
from

Conversation

Projects
None yet
5 participants
@goneri
Copy link
Contributor

commented May 22, 2019

SUMMARY

VMware specific documentat that explain:

  • how to run the functional tests
  • and the conventions.
ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

vmware

@ansibot

This comment has been minimized.

Copy link
Contributor

commented May 22, 2019

Test environment
----------------

By default, the tests are run against a vcenter API simulator called `vcsim <https://github.com/vmware/govmomi/tree/master/vcsim>`. ``ansible-test`` will automatically pull a vcsim container and use it to set-up the test environment.

This comment has been minimized.

Copy link
@Akasurde

Akasurde May 23, 2019

Member
Suggested change
By default, the tests are run against a vcenter API simulator called `vcsim <https://github.com/vmware/govmomi/tree/master/vcsim>`. ``ansible-test`` will automatically pull a vcsim container and use it to set-up the test environment.
By default, the tests run against a vCenter API simulator called `govcsim <https://github.com/vmware/govmomi/tree/master/vcsim>`. ``ansible-test`` will automatically pull a `govcsim container <https://quay.io/repository/ansible/vcenter-test-container>` and use it to set-up the test environment.

This comment has been minimized.

Copy link
@goneri

goneri Jun 10, 2019

Author Contributor

Thanks

source hacking/env-setup
ansible-test integration --python 3.7 vcenter_folder
You will need to install a couple of Python dependencies, like pyVim, pyvmomi and requests.

This comment has been minimized.

Copy link
@Akasurde

Akasurde May 23, 2019

Member
Suggested change
You will need to install a couple of Python dependencies, like pyVim, pyvmomi and requests.
You will need to install a couple of Python dependencies, like `pyvmomi <https://github.com/vmware/pyvmomi/tree/master/pyVmomi>` and `requests <https://2.python-requests.org/en/master/>`.
You will need to install a couple of Python dependencies, like pyVim, pyvmomi and requests.

``vcsim`` is handy because it's much more fast that than a regular test environment. However, it does not

This comment has been minimized.

Copy link
@Akasurde

Akasurde May 23, 2019

Member
Suggested change
``vcsim`` is handy because it's much more fast that than a regular test environment. However, it does not
``govcsim`` is handy because it's much faster that than a regular test environment. However, it does not

This comment has been minimized.

Copy link
@goneri

goneri Jun 10, 2019

Author Contributor

Applied

You will need to install a couple of Python dependencies, like pyVim, pyvmomi and requests.

``vcsim`` is handy because it's much more fast that than a regular test environment. However, it does not
support all the ESXi or vcenter features.

This comment has been minimized.

Copy link
@Akasurde

Akasurde May 23, 2019

Member
Suggested change
support all the ESXi or vcenter features.
support all the ESXi or vCenter features.

This comment has been minimized.

Copy link
@goneri

goneri Jun 10, 2019

Author Contributor

Ok, I added a typographic convention section in the doc :-).


When `PR #55772 <https://github.com/ansible/ansible/pull/55772>` and `PR #56605 <https://github.com/ansible/ansible/pull/56605>` will be merged, you will also be able
to target a regular VMware environment.
For this purpose, you need to prepare a configuration file that discribe your set-up. The file

This comment has been minimized.

Copy link
@Akasurde

Akasurde May 23, 2019

Member
Suggested change
For this purpose, you need to prepare a configuration file that discribe your set-up. The file
For this purpose, you need to prepare a configuration file that describes your set-up. The file

@ansibot ansibot removed the needs_triage label May 23, 2019

datacenter argument with ESXi
-----------------------------

``datacenter`` parameter should not use ``ha-datacenter`` by default. This because the user may

This comment has been minimized.

Copy link
@Akasurde

Akasurde May 23, 2019

Member
Suggested change
``datacenter`` parameter should not use ``ha-datacenter`` by default. This because the user may
``datacenter`` parameter should not use ``ha-datacenter`` by default. This is because the user may
esxi_hostname should not be mandatory
-------------------------------------

Some modules can seamlessly works with a vcenter or an ESXi.

This comment has been minimized.

Copy link
@Akasurde

Akasurde May 23, 2019

Member
Suggested change
Some modules can seamlessly works with a vcenter or an ESXi.
Some modules can seamlessly work with vCenter or an ESXi (depending upon the functionality provided by ESXi or vCenter)

This comment has been minimized.

Copy link
@goneri

goneri Jun 10, 2019

Author Contributor

I rephrased to: Depending upon the functionality provided by ESXi or vCenter, some modules can seamlessly work with both.

esxi_hostname = module.params.get('esxi_hostname')
if not esxi_hostname:
self.module.fail_json("esxi_hostname parameter is mandatory")
)

This comment has been minimized.

Copy link
@Akasurde

Akasurde May 23, 2019

Member
Suggested change
)

This comment has been minimized.

Copy link
@goneri

goneri Jun 10, 2019

Author Contributor

oops

@Akasurde Akasurde requested review from acozine, Akasurde, jillr and samccann May 23, 2019

Show resolved Hide resolved docs/docsite/rst/dev_guide/index.rst
.. _VMware_module_development:

***********************************************
Guidelines for VMware module module development

This comment has been minimized.

Copy link
@samccann

samccann May 30, 2019

Contributor
Suggested change
Guidelines for VMware module module development
Guidelines for VMware module development

This comment has been minimized.

Copy link
@goneri

goneri Jun 10, 2019

Author Contributor

done

***********************************************

The VWware modules and these guidelines are maintained by the VMware Working Group. For
further information the team community page: `https://github.com/ansible/community/wiki/VMware`.

This comment has been minimized.

Copy link
@samccann

samccann May 30, 2019

Contributor
Suggested change
further information the team community page: `https://github.com/ansible/community/wiki/VMware`.
further information see the team community page: `https://github.com/ansible/community/wiki/VMware`.

This comment has been minimized.

Copy link
@goneri

goneri Jun 10, 2019

Author Contributor

done

``vcsim`` is handy because it's much more fast that than a regular test environment. However, it does not
support all the ESXi or vcenter features.

When `PR #55772 <https://github.com/ansible/ansible/pull/55772>` and `PR #56605 <https://github.com/ansible/ansible/pull/56605>` will be merged, you will also be able

This comment has been minimized.

Copy link
@samccann

samccann May 30, 2019

Contributor
Suggested change
When `PR #55772 <https://github.com/ansible/ansible/pull/55772>` and `PR #56605 <https://github.com/ansible/ansible/pull/56605>` will be merged, you will also be able
When _`PR #55772 <https://github.com/ansible/ansible/pull/55772>`_ and _`PR #56605 <https://github.com/ansible/ansible/pull/56605>`_ are merged, you will also be able

This comment has been minimized.

Copy link
@jillr

jillr Jun 5, 2019

Contributor

55772 is merged now.

This comment has been minimized.

Copy link
@goneri

goneri Jun 10, 2019

Author Contributor

done

source hacking/env-setup
env VMWARE_TEST_PLATFORM=worldstream ansible-test integration --python 3.7 vmware_host_firewall_manager
convention and best practice

This comment has been minimized.

Copy link
@samccann

samccann May 30, 2019

Contributor
Suggested change
convention and best practice
Convention and best practice
-----------------------------

``datacenter`` parameter should not use ``ha-datacenter`` by default. This because the user may
not realize that Ansible silently target the wrong datacenter.

This comment has been minimized.

Copy link
@samccann

samccann May 30, 2019

Contributor
Suggested change
not realize that Ansible silently target the wrong datacenter.
not realize that Ansible silently targets the wrong data center.

This comment has been minimized.

Copy link
@goneri

goneri Jun 10, 2019

Author Contributor

Thanks @samccann, since datacenter has a specific meaning in the VMware world, I prefer to keep it unchanged.

Guidelines for VMware module module development
***********************************************

The VWware modules and these guidelines are maintained by the VMware Working Group. For

This comment has been minimized.

Copy link
@samccann

samccann May 30, 2019

Contributor
Suggested change
The VWware modules and these guidelines are maintained by the VMware Working Group. For
The VMware modules and these guidelines are maintained by the VMware Working Group. For

This comment has been minimized.

Copy link
@goneri

goneri Jun 10, 2019

Author Contributor

done

@ansibot ansibot added the stale_ci label Jun 5, 2019

``vcsim`` is handy because it's much more fast that than a regular test environment. However, it does not
support all the ESXi or vcenter features.

When `PR #55772 <https://github.com/ansible/ansible/pull/55772>` and `PR #56605 <https://github.com/ansible/ansible/pull/56605>` will be merged, you will also be able

This comment has been minimized.

Copy link
@jillr

jillr Jun 5, 2019

Contributor

55772 is merged now.

should be called :file:`test/integration/cloud-config-vcenter.ini` and based on
:file:`test/integration/cloud-config-vcenter.ini.template`.

In addition to this file, you may need to adjust to match the configuration of your lab

This comment has been minimized.

Copy link
@jillr

jillr Jun 5, 2019

Contributor
Suggested change
In addition to this file, you may need to adjust to match the configuration of your lab
In addition, you may need to adjust the variables in the following file to match the configuration of your lab
Show resolved Hide resolved docs/docsite/rst/dev_guide/platforms/vmware_guidelines.rst

@goneri goneri force-pushed the goneri:vmware_doc branch from 0dae5d3 to cb169f6 Jun 10, 2019

@ansibot

This comment has been minimized.

Copy link
Contributor

commented Jun 10, 2019

The test ansible-test sanity --test docs-build [explain] failed with 1 error:

docs/docsite/rst/dev_guide/platforms/vmware_guidelines.rst:41:0: block-quote-missing-blank-line: Block quote ends without a blank line; unexpected unindent.

click here for bot help

@ansibot ansibot added ci_verified and removed stale_ci labels Jun 10, 2019

vmware: vmware_guidelines.rst
VMware specific documentation that explains:

- how to run the functional tests
- and the conventions.

@goneri goneri force-pushed the goneri:vmware_doc branch from cb169f6 to 4162684 Jun 11, 2019

@ansibot ansibot removed the ci_verified label Jun 11, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.