Infoblox scenario guide #45664

samccann · 2018-09-14T18:53:48Z

SUMMARY

Closes issue #42964

Create Infoblox Scenario Guide

ISSUE TYPE

Docs Pull Request

COMPONENT NAME

docs.ansible.com

ANSIBLE VERSION

2.8

ADDITIONAL INFORMATION

ansibot · 2018-09-14T19:09:50Z

The test ansible-test sanity --test rstcheck [explain] failed with 2 errors:

docs/docsite/rst/scenario_guides/guide_infoblox.rst:124:0: (bash) `<...output omitted...>'
docs/docsite/rst/scenario_guides/guide_infoblox.rst:124:0: (bash) syntax error near unexpected token `newline'

click here for bot help

ansibot · 2018-09-14T19:09:50Z

cc @acozine
click here for bot help

ansibot · 2018-09-14T19:49:50Z

The test ansible-test sanity --test rstcheck [explain] failed with 2 errors:

docs/docsite/rst/scenario_guides/guide_infoblox.rst:133:0: (bash) `    }'
docs/docsite/rst/scenario_guides/guide_infoblox.rst:133:0: (bash) syntax error near unexpected token `}'

click here for bot help

ansibot · 2018-09-14T20:07:22Z

The test ansible-test sanity --test rstcheck [explain] failed with 2 errors:

docs/docsite/rst/scenario_guides/guide_infoblox.rst:135:0: (bash) `    }'
docs/docsite/rst/scenario_guides/guide_infoblox.rst:135:0: (bash) syntax error near unexpected token `}'

click here for bot help

acozine

Nice work. I made a few suggestions for making it even better.

docs/docsite/rst/scenario_guides/guide_infoblox.rst

acozine · 2018-09-14T19:59:20Z

docs/docsite/rst/scenario_guides/guide_infoblox.rst

+Module list
+============
+
+See :ref:`nios_net tools_modules` for a full list of NIOS modules for this release.


In the published doc, this is rendered as "See Nios for a full list of NIOS modules for this release." That looks a bit weird to my eye. How about tightening this up and specifying the text for the link - something like:

You can review simple example tasks in the documentation for any of the :ref:`NIOS modules <nios_net tools_modules>` or look at the `Use cases with modules` section for more elaborate examples.

Actually, I might get rid of the "Module list" heading and put the shortened content in the Introduction.

acozine · 2018-09-14T20:03:55Z

docs/docsite/rst/scenario_guides/guide_infoblox.rst

+Retrieving all network views
+----------------------------
+
+This example playbook uses the ``set_fact`` module with the ``nios`` lookup plugin to retrieve all the network views, which are then saved in the ``networkviews`` variable:


I think "this example playbook" is fluff - how about rewording these examples using the pattern: To do X, use Y: <example_playbook>? So for this one:

To retrieve all network views and save them in a variable, use the `set_fact` module with the `nios` lookup plugin:

acozine · 2018-09-14T20:07:25Z

docs/docsite/rst/scenario_guides/guide_infoblox.rst

+
+You can use ``nios`` modules in tasks to simplify common Infoblox workflows.
+
+For these examples, you need to set up your NIOS credentials. See `Credentials and authenticating`_.


What do you think about shortening this section by putting the link in the sentence?

You can use the ``nios`` modules in tasks to simplify common Infoblox workflows. Be sure to set up your `NIOS credentials <nios_credentials>` before following these examples.

or something like that?

acozine · 2018-09-14T20:08:53Z

docs/docsite/rst/scenario_guides/guide_infoblox.rst

+
+To use the Infoblox dynamic inventory script:
+
+1. Download the ``infoblox.yaml`` file and save it in the ``/etc/ansible`` directory.


Do you want these to be hard-coded numbers, or a #-style list?

acozine · 2018-09-14T20:09:47Z

docs/docsite/rst/scenario_guides/guide_infoblox.rst

+
+You can also implicitly use the Infoblox dynamic inventory script by including it in your inventory directory (``etc/ansible/hosts`` by default).
+
+See :ref:`dynamic_inventory` for more details.


I feel like the whitespace in the rendered HTML makes it hard to parse the page - maybe try having fewer paragraphs/newlines?

ansibot · 2018-09-14T20:40:53Z

The test ansible-test sanity --test rstcheck [explain] failed with 2 errors:

docs/docsite/rst/scenario_guides/guide_infoblox.rst:135:0: (bash) `    }'
docs/docsite/rst/scenario_guides/guide_infoblox.rst:135:0: (bash) syntax error near unexpected token `}'

click here for bot help

ansibot · 2018-09-17T15:55:52Z

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

docs/docsite/rst/scenario_guides/guide_infoblox.rst:51:0: undefined-label: undefined label: set_fact (if the link has no caption the label must precede a section header)

click here for bot help

abenokraitis · 2018-09-18T14:33:42Z

Please take a look at the draft in stage:

http://docs.testing.ansible.com/ansible/latest/scenario_guides/guide_infoblox.html

NOTE: This link may or may not work due to QA workflows

gundalow · 2018-09-19T12:00:54Z

docs/docsite/rst/scenario_guides/guide_infoblox.rst

+Use cases with modules
+======================
+
+You can use the ``nios`` modules in tasks to simplify common Infoblox workflows. Be sure to set up your `NIOS credentials <nios_credentials>`_ before following these examples.


Currently this looks like a link to a new file, rather than a relative link
http://docs.testing.ansible.com/ansible/latest/scenario_guides/nios_credentials

housysadm · 2018-09-21T22:38:46Z

I really appreciate this document being created.

I was a little confused though by the mention of the WAPI only in one specific spot. I assume the modules can ONLY talk to the WAPI so maybe a statement specifying that near the top and then no other mention of it.

Would it be appropriate to mention in the prerequisites or authentication section that you need a NIOS account with the WAPI feature enabled? Or is that outside the scope of the document?

* creates infoblox scenario guide * adds link to infoblox guide from modules * adds WAPI to prerequisites (cherry picked from commit df36559)

samccann added networking Network category docs This issue/PR relates to or includes documentation. labels Sep 14, 2018

samccann requested a review from acozine September 14, 2018 18:53

samccann added this to Docsite work in Ansible-maintained Collections Documentation via automation Sep 14, 2018

ansibot added ci_verified Changes made in this PR are causing tests to fail. and removed ci_verified Changes made in this PR are causing tests to fail. labels Sep 14, 2018

ansibot added the ci_verified Changes made in this PR are causing tests to fail. label Sep 14, 2018

acozine reviewed Sep 14, 2018

View reviewed changes

ansibot removed the ci_verified Changes made in this PR are causing tests to fail. label Sep 17, 2018

ansibot added ci_verified Changes made in this PR are causing tests to fail. and removed ci_verified Changes made in this PR are causing tests to fail. labels Sep 17, 2018

samccann changed the title ~~[WIP] Infoblox scenario guide~~ Infoblox scenario guide Sep 17, 2018

samccann requested a review from gundalow September 17, 2018 17:15

gundalow reviewed Sep 19, 2018

View reviewed changes

samccann added 21 commits September 24, 2018 12:21

clarified nios lookup example

7139cd1

fixed nit

cecf49b

fixed first playbook

1f04de2

trimmed role content for first release

de959f6

updated procedures

65a0553

reorg to put plugin first

a2a5045

verified creating a host record

d4942a3

use glob for scenario guide toc

4d91fb3

add reverse zone example

4834ee4

fixed index glob error

2c0ef10

cleaned up links

3d75c30

copyedit

1338486

shippable test fix

d047d86

add full output

25200f2

change to code-block:: none to remove shippable error

4564c2c

implemented initial doc feedback

2de6f89

fix set_fact ref

176a0a7

add link to infoblox guide from modules

d078b43

clarify lookup statement

aa9d892

fixed link

752b64f

added WAPI to prerequisites

6ed7724

samccann force-pushed the infoblox-guide branch from 972e0ad to 6ed7724 Compare September 24, 2018 16:22

acozine merged commit df36559 into ansible:devel Sep 24, 2018

Ansible-maintained Collections Documentation automation moved this from Docsite work to Done Sep 24, 2018

samccann mentioned this pull request Sep 25, 2018

NIOS infoblox User Guide #42964

Closed

samccann added a commit to samccann/ansible that referenced this pull request Nov 5, 2018

Infoblox scenario guide (ansible#45664)

0fe3022

* creates infoblox scenario guide * adds link to infoblox guide from modules * adds WAPI to prerequisites (cherry picked from commit df36559)

samccann mentioned this pull request Nov 5, 2018

Backport/2.7/doc rst batch #48126

Merged

abadger pushed a commit that referenced this pull request Nov 5, 2018

Infoblox scenario guide (#45664)

30acec7

* creates infoblox scenario guide * adds link to infoblox guide from modules * adds WAPI to prerequisites (cherry picked from commit df36559)

samccann deleted the infoblox-guide branch December 6, 2018 21:32

ansible locked and limited conversation to collaborators Jul 22, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Infoblox scenario guide #45664

Infoblox scenario guide #45664

samccann commented Sep 14, 2018

ansibot commented Sep 14, 2018

ansibot commented Sep 14, 2018

ansibot commented Sep 14, 2018

ansibot commented Sep 14, 2018

acozine left a comment

acozine Sep 14, 2018

acozine Sep 14, 2018

acozine Sep 14, 2018

acozine Sep 14, 2018

acozine Sep 14, 2018

acozine Sep 14, 2018

ansibot commented Sep 14, 2018

ansibot commented Sep 17, 2018

abenokraitis commented Sep 18, 2018 •

edited

gundalow Sep 19, 2018

housysadm commented Sep 21, 2018


		You can use ``nios`` modules in tasks to simplify common Infoblox workflows.

		For these examples, you need to set up your NIOS credentials. See `Credentials and authenticating`_.


		To use the Infoblox dynamic inventory script:

		1. Download the ``infoblox.yaml`` file and save it in the ``/etc/ansible`` directory.


		You can also implicitly use the Infoblox dynamic inventory script by including it in your inventory directory (``etc/ansible/hosts`` by default).

		See :ref:`dynamic_inventory` for more details.

Infoblox scenario guide #45664

Infoblox scenario guide #45664

Conversation

samccann commented Sep 14, 2018

SUMMARY

ISSUE TYPE

COMPONENT NAME

ANSIBLE VERSION

ADDITIONAL INFORMATION

ansibot commented Sep 14, 2018

ansibot commented Sep 14, 2018

ansibot commented Sep 14, 2018

ansibot commented Sep 14, 2018

acozine left a comment

Choose a reason for hiding this comment

acozine Sep 14, 2018

Choose a reason for hiding this comment

acozine Sep 14, 2018

Choose a reason for hiding this comment

acozine Sep 14, 2018

Choose a reason for hiding this comment

acozine Sep 14, 2018

Choose a reason for hiding this comment

acozine Sep 14, 2018

Choose a reason for hiding this comment

acozine Sep 14, 2018

Choose a reason for hiding this comment

ansibot commented Sep 14, 2018

ansibot commented Sep 17, 2018

abenokraitis commented Sep 18, 2018 • edited

gundalow Sep 19, 2018

Choose a reason for hiding this comment

housysadm commented Sep 21, 2018

abenokraitis commented Sep 18, 2018 •

edited