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

ACI: New aci_firmware_policy module #48356

Merged
merged 2 commits into from
Feb 27, 2019
Merged

ACI: New aci_firmware_policy module #48356

merged 2 commits into from
Feb 27, 2019

Conversation

sgerhart
Copy link
Contributor

@sgerhart sgerhart commented Nov 8, 2018

SUMMARY

This module creates an ACI firmware policy to be used with the firmware group

ISSUE TYPE
  • New Module Pull Request
COMPONENT NAME

aci_firmware_policy

ANSIBLE VERSION
ansible 2.8.0.dev0 (firmware_policy_module cf3aa62c35) last updated 2018/11/08 10:55:41 (GMT -400)
  config file = None
  configured module search path = [u'/Users/stgerhar/.ansible/plugins/modules', u'/usr/share/ansible/plugins/modules']
  ansible python module location = /Users/stgerhar/Development/Python/github.com/sgerhart/ansible-dev/lib/ansible
  executable location = /Users/stgerhar/Development/Python/github.com/sgerhart/ansible-dev/bin/ansible
  python version = 2.7.14 (default, Mar 10 2018, 00:01:04) [GCC 4.2.1 Compatible Apple LLVM 9.0.0 (clang-900.0.39.2)]
ADDITIONAL INFORMATION

@ansibot
Copy link
Contributor

ansibot commented Nov 8, 2018

Hi @sgerhart, thank you for submitting this pull-request!

click here for bot help

@ansibot
Copy link
Contributor

ansibot commented Nov 8, 2018

cc @brunocalogero @dagwieers @jmcgill298 @schunduri
click here for bot help

@ansibot
Copy link
Contributor

ansibot commented Nov 8, 2018

@sgerhart, just so you are aware we have a dedicated Working Group for network.
You can find other people interested in this in #ansible-network on Freenode IRC
For more information about communities, meetings and agendas see https://github.com/ansible/community

click here for bot help

@ansibot ansibot added aci Cisco ACI community affects_2.8 This issue/PR affects Ansible v2.8 community_review In order to be merged, this PR must follow the community review workflow. module This issue/PR relates to a module. needs_triage Needs a first human triage before being processed. networking Network category new_contributor This PR is the first contribution by a new community member. new_module This PR includes a new module. new_plugin This PR includes a new plugin. support:community This issue/PR relates to code supported by the Ansible community. labels Nov 8, 2018
@ansibot
Copy link
Contributor

ansibot commented Nov 8, 2018

@brunocalogero @jmcgill298 @rost-d @schunduri @smnmtzgr

As a maintainer of a module in the same namespace this new module has been submitted to, your vote counts for shipits. Please review this module and add shipit if you would like to see it merged.

click here for bot help

dagwieers
dagwieers suggested changes Nov 8, 2018
View reviewed changes
Copy link
Contributor

@dagwieers dagwieers left a comment

Choose a reason for hiding this comment

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

The module looks mostly fine, except for indentation and spacious documentation and code. This will not get past CI validation, you can't add double empty lines except where it is required :-) Also, there's no need to add so many empty lines, things could be a lot more concise.

Also, we would definitely need integration tests so future changes are tested against a full range checks.

lib/ansible/modules/network/aci/aci_firmware_policy.py
---
module: aci_firmware_policy

short_description: This creates a firmware policy
Copy link
Contributor

Choose a reason for hiding this comment

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

In the module index it doesn't look good if it starts with 'This creates'.
Simply use Manage firmware policies.

Copy link
Contributor

Choose a reason for hiding this comment

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

The DOCUMENTATION string is very indented, I would prefer we use the same format as the other ACI modules. Only indent when necessary (2 spaces).

lib/ansible/modules/network/aci/aci_firmware_policy.py
version:
description:
- The version of the firmware assoicated with this policy. This value is very import as well as constructing
- it correctly. The syntax for this field is n9000-xx.x. If you look at the firmware repository using the UI
Copy link
Contributor

Choose a reason for hiding this comment

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

This will not render correctly. If you use multiple dashes for the same sentence, they will end up being different paragraphs in the description. You don't need those subsequent dashes.

lib/ansible/modules/network/aci/aci_firmware_policy.py
- each version will have a "Full Version" column, this is the value you need to use. So, if the Full Version
- is 13.1(1i), the value for this field would be n9000-13.1(1i)
required: true
ignoreCompat:
Copy link
Contributor

Choose a reason for hiding this comment

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

We like parameters to be snake case, not mixed case, for a more uniform look and feel.
https://en.wikipedia.org/wiki/Letter_case

lib/ansible/modules/network/aci/aci_firmware_policy.py
description:
- This module creates a firmware policy for firmware groups. The firmware policy is create first and then
- referenced by the firmware group. You will assign the firmware and specify if you want to ignore the compatibility
- check
Copy link
Contributor

Choose a reason for hiding this comment

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

All descriptions (also parameter descriptions) must end with a trailing dot, except the short_description.

lib/ansible/modules/network/aci/aci_firmware_policy.py
required: true
ignoreCompat:
description:
- Check if compatibility checks should be ignored
Copy link
Contributor

Choose a reason for hiding this comment

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

Makes this Whether compatibility checks should be ignored.

@dagwieers
Copy link
Contributor

If you like, I will make the required modifications to your branch ?

@samdoran samdoran removed the needs_triage Needs a first human triage before being processed. label Nov 8, 2018
@ansibot ansibot added needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. and removed community_review In order to be merged, this PR must follow the community review workflow. labels Nov 8, 2018
@ansibot ansibot added the stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. label Nov 16, 2018
@dagwieers
Copy link
Contributor

cc @rsmeyers

@dagwieers dagwieers changed the title ACI firmware policy module ACI: New aci_firmware_policy module Feb 19, 2019
@dagwieers dagwieers added the cisco Cisco technologies label Feb 22, 2019
@dagwieers
Copy link
Contributor

rebuild_merge

@ansibot
Copy link
Contributor

ansibot commented Feb 27, 2019

cc @mtorelli
click here for bot help

@ansibot ansibot added shipit This PR is ready to be merged by Core and removed needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. labels Feb 27, 2019
@dagwieers
Copy link
Contributor

rebuild_merge

@ansibot ansibot merged commit 80bdd21 into ansible:devel Feb 27, 2019
@ansible ansible locked and limited conversation to collaborators Jul 25, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@dagwieers dagwieers dagwieers requested changes

Assignees
No one assigned
Labels
aci Cisco ACI community affects_2.8 This issue/PR affects Ansible v2.8 cisco Cisco technologies module This issue/PR relates to a module. networking Network category new_contributor This PR is the first contribution by a new community member. new_module This PR includes a new module. new_plugin This PR includes a new plugin. shipit This PR is ready to be merged by Core support:community This issue/PR relates to code supported by the Ansible community.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@sgerhart @ansibot @dagwieers @samdoran