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

revises network portion of 2.5 porting guide #37938

Merged
merged 5 commits into from
Mar 27, 2018

Conversation

acozine
Copy link
Contributor

@acozine acozine commented Mar 26, 2018

SUMMARY

Adds more detail, including the persistent connection options to the Network section of the 2.5 Porting Guide.

Fixes #36777

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME
  • Network Documentation
ANSIBLE VERSION

2.5 and higher

@acozine acozine added networking Network category affects_2.5 This issue/PR affects Ansible v2.5 docs This issue/PR relates to or includes documentation. labels Mar 26, 2018
@ansibot
Copy link
Contributor

ansibot commented Mar 26, 2018

@ansibot ansibot added the support:core This issue/PR relates to code supported by the Ansible Engineering Team. label Mar 26, 2018
ansible_become_pass=cisco
ansible_network_os=ios
ansible_password=cisco
ansible_user=cisco

Copy link
Contributor

Choose a reason for hiding this comment

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

Worth linking to network docs here again?

------------------------------------------------------------------

Ansible 2.5 introduces two persistent connection types, ``network_cli`` and ``netconf``. We recommend you use these whenever possible.
Unless you need a ``local`` connection, update your playbooks to use ``network_cli`` or ``netconf`` and to
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe clarify that local is needed when using eAPI/NX-API?

Unless you need a ``local`` connection, update your playbooks to use ``network_cli`` or ``netconf`` and to
specify your connection variables with standard Ansible connection variables:

OLD In Ansible 2.4
Copy link
Contributor

Choose a reason for hiding this comment

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

**OLD** In Ansible 2.4


We recommend setting connection properties in inventory by group. As you update your playbooks and inventory files, you can easily make the change to ``become`` for privilege escalation (on platforms that support it). For more information, see the :ref:`using become with network modules<become-network>` guide and the :ref:`platform documentation<platform_options>`. To update the ``ios_command`` task above, move the connection properties to inventory like this:

NEW In Ansible 2.5
Copy link
Contributor

Choose a reason for hiding this comment

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

**NEW** In Ansible 2.5


Top-level connection arguments like ``username``, ``host``, and ``password`` are deprecated and will be removed in version 2.9.

OLD In Ansible 2.4
Copy link
Contributor

Choose a reason for hiding this comment

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

**OLD** In Ansible 2.4


NEW In Ansible 2.5
Copy link
Contributor

Choose a reason for hiding this comment

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

**NEW** In Ansible 2.5

@acozine
Copy link
Contributor Author

acozine commented Mar 27, 2018

@gundalow I addressed your comments in b3ff9bb - let me know if there are more changes you'd like to see, more links, more emphasis, etc.

@ansibot ansibot added needs_ci This PR requires CI testing to be performed. Please close and re-open this PR to trigger CI. and removed needs_ci This PR requires CI testing to be performed. Please close and re-open this PR to trigger CI. labels Mar 27, 2018
@@ -199,12 +199,16 @@ Porting custom scripts

No notable changes.

Networking
==========
Network
Copy link
Contributor

Choose a reason for hiding this comment

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

I think somewhere prominent in this section we should link to the network guide.

@acozine
Copy link
Contributor Author

acozine commented Mar 27, 2018

Chatted with Scott today - he says "if it looks good to you I'm fine with it." I'm going to take that as a positive review and merge.

@acozine acozine removed the request for review from Qalthos March 27, 2018 19:58
@acozine acozine merged commit b72960f into ansible:devel Mar 27, 2018
acozine pushed a commit to acozine/ansible that referenced this pull request Mar 27, 2018
* revises network portion of 2.5 porting guide
(cherry picked from commit b72960f)
@acozine acozine deleted the porting_guide branch March 27, 2018 20:43
mattclay pushed a commit that referenced this pull request Mar 28, 2018
* revises network portion of 2.5 porting guide
(cherry picked from commit b72960f)
@gundalow gundalow added this to Need CP into 2.5.1 in zzz NOT USED: Networking Bugs Mar 28, 2018
ryancurrah pushed a commit to ryancurrah/ansible that referenced this pull request Apr 4, 2018
* revises network portion of 2.5 porting guide
@gundalow
Copy link
Contributor

gundalow commented Apr 5, 2018

In stable-2.5 so marking as done

@gundalow gundalow moved this from Need CP into 2.5.1 to Done in zzz NOT USED: Networking Bugs Apr 5, 2018
@ansible ansible locked and limited conversation to collaborators Apr 27, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
affects_2.5 This issue/PR affects Ansible v2.5 docs This issue/PR relates to or includes documentation. networking Network category support:core This issue/PR relates to code supported by the Ansible Engineering Team.
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

2.5 Porting Guide to mention network_cli
5 participants