New module for azure virtual network gateway #44411

Madhura-CSI · 2018-08-20T18:22:09Z

SUMMARY

New module for azure virtual network gateway

ISSUE TYPE

New Module Pull Request

COMPONENT NAME

azure_rm_virtualnetworkgateway

ANSIBLE VERSION

ansible 2.6.2
  config file = /etc/ansible/ansible.cfg
  configured module search path = [u'/home/centos-dev/.ansible/plugins/modules', u'/usr/share/ansible/plugins/modules']
  ansible python module location = /usr/lib/python2.7/site-packages/ansible
  executable location = /usr/bin/ansible
  python version = 2.7.5 (default, Aug  4 2017, 00:39:18) [GCC 4.8.5 20150623 (Red Hat 4.8.5-16)]

ADDITIONAL INFORMATION

Currently we don't have any existing module to create/update/delete virtual network gateway(VPN gateway) in azure cloud. Hence, I would like to contribute this module to community.
Sample module call is as follows:

    - name: Create virtual network gateway without bgp settings
      azure_rm_virtualnetworkgateway:
        resource_group: testrg
        name: testvpngw
        ip_configurations:
          - name: testipconfig
            private_ip_allocation_method: Dynamic
            public_ip_address_name: testipaddr
        virtual_network: testvnet
        tags:
          common: "xyz"
      register: vgw_without_bgp

By default module waits for VPN gateway to be created.(using poller)

Madhura-CSI · 2018-08-20T18:25:28Z

WIP

ansibot · 2018-08-20T18:38:40Z

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

lib/ansible/modules/cloud/azure/azure_rm_virtualnetworkgateway.py:335:20: undefined-variable Undefined variable 'fh'

The test ansible-test sanity --test validate-modules [explain] failed with 9 errors:

lib/ansible/modules/cloud/azure/azure_rm_virtualnetworkgateway.py:0:0: E322 "active_active" is listed in the argument_spec, but not documented in the module
lib/ansible/modules/cloud/azure/azure_rm_virtualnetworkgateway.py:0:0: E322 "gateway_default_site" is listed in the argument_spec, but not documented in the module
lib/ansible/modules/cloud/azure/azure_rm_virtualnetworkgateway.py:0:0: E322 "vpn_client_configuration" is listed in the argument_spec, but not documented in the module
lib/ansible/modules/cloud/azure/azure_rm_virtualnetworkgateway.py:0:0: E325 argument_spec for "active_active" defines type="bool" but documentation does not
lib/ansible/modules/cloud/azure/azure_rm_virtualnetworkgateway.py:0:0: E325 argument_spec for "enable_bgp" defines type="bool" but documentation does not
lib/ansible/modules/cloud/azure/azure_rm_virtualnetworkgateway.py:0:0: E326 Value for "choices" from the argument_spec ([]) for "gateway_type" does not match the documentation (['Vpn', 'ExpressRoute'])
lib/ansible/modules/cloud/azure/azure_rm_virtualnetworkgateway.py:0:0: E326 Value for "choices" from the argument_spec ([]) for "sku" does not match the documentation (['VpnGw1', 'VpnGw2', 'VpnGw3'])
lib/ansible/modules/cloud/azure/azure_rm_virtualnetworkgateway.py:0:0: E326 Value for "choices" from the argument_spec ([]) for "vpn_type" does not match the documentation (['RouteBased', 'PolicyBased'])
lib/ansible/modules/cloud/azure/azure_rm_virtualnetworkgateway.py:167:21: E313 RETURN is not valid YAML

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

lib/ansible/modules/cloud/azure/azure_rm_virtualnetworkgateway.py:167:21: error RETURN: syntax error: expected ',' or '}', but got '<scalar>'

click here for bot help

Fred-sun · 2018-08-28T06:33:57Z

@Madhura-CSI Thanks for the contribution, Could you help confirm the PR ready for review or not？ if yes, I will push to review! Thanks!

ansibot · 2018-08-28T06:36:44Z

cc @haroldwongms @nitzmahone @trstringer @xscript @yuwzho @zikalino
click here for bot help

Fred-sun · 2018-09-20T06:18:08Z

@Madhura-CSI Thanks for the contribution. Could you help finished this PR change? when you finished, I will push to review. Thanks!

Fred-sun · 2018-11-01T07:34:15Z

@Madhura-CSI Thanks for your contribution, Are you still here？Could you help finish the PR changed? if you finished, I will push to review? Thanks!

Madhura-CSI · 2018-11-05T05:20:56Z

Yes @Fred-sun , I am working on this PR. Will need few more days to finish the stuff. I will update here once this is ready for review.

Fred-sun · 2018-11-05T05:42:06Z

@Madhura-CSI Thanks for your update， When you finished changed, I will test,. Thanks!

Fred-sun · 2018-11-26T08:24:10Z

kindly ping

Fred-sun · 2018-12-26T06:01:57Z

kindly ping

zikalino · 2019-01-17T07:24:16Z

@Madhura-CSI I would like to add a few things and also integration tests and merge this pr.
would it be ok for you to add me to your fork?
I would also do the same with local network gateway.

Madhura-CSI · 2019-01-17T08:16:21Z

Sure @zikalino . Please go ahead and make the necessary changes as per your requirement.

zikalino · 2019-01-17T08:19:51Z

@Madhura-CSI great! :-) could you add me as a collaborator to your fork?

Madhura-CSI · 2019-01-17T08:29:01Z

@zikalino One problem I see here is: I think we need to add write access at repository/org level and not at the pull-request level. Can't really do that as of now. Do you see any probable alternative to this? I would be glad to assist.

zikalino · 2019-01-17T08:32:33Z

@Madhura-CSI ok then. no problem. I will just fork your fork and create PR on the top of your branch.
a bit more complex, but should work.

Madhura-CSI · 2019-01-17T08:34:49Z

@zikalino sure, thanks!

zikalino · 2019-02-20T06:18:38Z

lib/ansible/modules/cloud/azure/azure_rm_virtualnetworkgateway.py

+                if not self.ip_configurations:
+                    self.fail('Parameter error: ip_configurations required when creating a vpn gateway')
+                subnet = self.network_models.SubResource(
+                    '/subscriptions/{0}/resourceGroups/{1}/providers/Microsoft.Network/virtualNetworks/{2}/subnets/GatewaySubnet'.format(


@Madhura-CSI i have just started working on this pr, and I have a quick question.
why is GatewaySubned hardcoded here. shouldnt' we refer any subnet?
any special reason?

@zikalino, 'GatewaySubnet' < this name is mandatory for the subnet where we deploy the virtual network gateway virtual machines. AFAIK, we cannot change this name. If we ever do that, network gateway creation will fail at the end. Please confirm this behavior.

@Madhura-CSI thanks! I will create PR to your fork soon :-)

Fred-sun · 2019-03-07T08:42:30Z

@Madhura-CSI Are you still here? Could you give a feedback for zikalino's comments? Thanks!

Madhura-CSI · 2019-03-07T08:59:39Z

@Fred-sun replied to the code review comment above. Please check.

Fred-sun · 2019-03-07T09:28:12Z

@Madhura-CSI Thanks for your update.
@zikalino Once you create PR , please paste link at here! Thanks!

zikalino · 2019-03-25T04:56:24Z

@Madhura-CSI I have created a pr to your fork some time ago. could you take a look and merge it?

Madhura-CSI · 2019-03-26T05:06:22Z

sure @zikalino . I will update this in a day or two and will let you know.

zikalino · 2019-04-04T00:14:57Z

@Madhura-CSI could you try to merge changes today? the freeze is coming :-)
otherwise I may try to merge in a separate pr

ansibot · 2019-04-08T06:43:27Z

@Madhura-CSI this PR contains the following merge commits:

3ec43c2

Please rebase your branch to remove these commits.

click here for bot help

ansibot · 2019-04-08T06:43:28Z

@Madhura-CSI This PR contains @ mentions in at least one commit message. Those mentions can cause cascading notifications through GitHub and need to be removed. Please squash or amend your commits to remove the mentions.

click here for bot help

Madhura-CSI · 2019-04-08T08:48:42Z

@zikalino , sorry for the delay. I have now merged your branch with this one. Please review and proceed with upstream merge if everything looks good to you.
Thanks!

ansibot · 2019-04-08T09:38:58Z

@brusMX @caohai @devigned @gustavomcarmo @haroldwongms @iphilpot @julienstroheker @lmazuel @obsoleted @sozercan @techknowlogick @trstringer @tstringer @xscript @yaweiw @yuwzho

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

mmyyrroonn · 2019-05-17T03:10:18Z

@Madhura-CSI Hello. Thanks for this great PR. Recently, we met a small issue, I just wonder, could you share your design purpose for the subnet option?

ansible/lib/ansible/modules/cloud/azure/azure_rm_virtualnetworkgateway.py

Lines 75 to 78 in a3c3fd9

    
                       subnet: 
        
                           description: 
        
                               - ID of the gateway subnet for VPN. 
        
                           default: GatewaySubnet

Based on the current implementation, it seems that this option is not used in the code now. I checked the sdk, the param of the same name is constructed by the information in the virtual network.

ansible/lib/ansible/modules/cloud/azure/azure_rm_virtualnetworkgateway.py

Lines 313 to 317 in a3c3fd9

    
           subnet = self.network_models.SubResource( 
        
               id='/subscriptions/{0}/resourceGroups/{1}/providers/Microsoft.Network/virtualNetworks/{2}/subnets/GatewaySubnet'.format( 
        
                   self.virtual_network['subscription_id'], 
        
                   self.virtual_network['resource_group'], 
        
                   self.virtual_network['name']))

I think there should be some original reason for you to create this option. we can discuss about it and continue improving this module after our discussion.

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

ansibleazurebot mentioned this pull request Aug 21, 2018

New module for azure virtual network gateway VSChina/ansible-issue-tracker#398

Closed

webknjaz removed the needs_triage Needs a first human triage before being processed. label Aug 21, 2018

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 Sep 5, 2018

zikalino reviewed Feb 20, 2019

View reviewed changes

zikalino mentioned this pull request Mar 21, 2019

[WIP] adding vng -- temporary pr, will be moved to another one #53622

Closed

Madhura-CSI and others added 2 commits April 8, 2019 04:05

module for azure vpn gateway

4d7f1a8

updating vng

980e67f

Madhura-CSI force-pushed the module-azure_rm_virtualnetworkgateway branch from 3ec43c2 to 980e67f Compare April 8, 2019 08:06

ansibot removed merge_commit This PR contains at least one merge commit. Please resolve! needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html labels Apr 8, 2019

Madhura-CSI changed the title ~~[WIP] New module for azure virtual network gateway~~ New module for azure virtual network gateway Apr 8, 2019

ansibot added community_review In order to be merged, this PR must follow the community review workflow. and removed WIP This issue/PR is a work in progress. Nevertheless it was shared for getting input from peers. labels Apr 8, 2019

nitzmahone approved these changes Apr 11, 2019

View reviewed changes

nitzmahone merged commit fe31b7e into ansible:devel Apr 11, 2019

ansible locked and limited conversation to collaborators Jul 25, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New module for azure virtual network gateway #44411

New module for azure virtual network gateway #44411

Madhura-CSI commented Aug 20, 2018

Madhura-CSI commented Aug 20, 2018

ansibot commented Aug 20, 2018

Fred-sun commented Aug 28, 2018

ansibot commented Aug 28, 2018

Fred-sun commented Sep 20, 2018

Fred-sun commented Nov 1, 2018

Madhura-CSI commented Nov 5, 2018

Fred-sun commented Nov 5, 2018

Fred-sun commented Nov 26, 2018

Fred-sun commented Dec 26, 2018

zikalino commented Jan 17, 2019

Madhura-CSI commented Jan 17, 2019

zikalino commented Jan 17, 2019

Madhura-CSI commented Jan 17, 2019

zikalino commented Jan 17, 2019

Madhura-CSI commented Jan 17, 2019

zikalino Feb 20, 2019

Madhura-CSI Mar 7, 2019

zikalino Mar 7, 2019

Fred-sun commented Mar 7, 2019

Madhura-CSI commented Mar 7, 2019

Fred-sun commented Mar 7, 2019

zikalino commented Mar 25, 2019

Madhura-CSI commented Mar 26, 2019

zikalino commented Apr 4, 2019

ansibot commented Apr 8, 2019

ansibot commented Apr 8, 2019

Madhura-CSI commented Apr 8, 2019

ansibot commented Apr 8, 2019

mmyyrroonn commented May 17, 2019

New module for azure virtual network gateway #44411

New module for azure virtual network gateway #44411

Conversation

Madhura-CSI commented Aug 20, 2018

SUMMARY

ISSUE TYPE

COMPONENT NAME

ANSIBLE VERSION

ADDITIONAL INFORMATION

Madhura-CSI commented Aug 20, 2018

ansibot commented Aug 20, 2018

Fred-sun commented Aug 28, 2018

ansibot commented Aug 28, 2018

Fred-sun commented Sep 20, 2018

Fred-sun commented Nov 1, 2018

Madhura-CSI commented Nov 5, 2018

Fred-sun commented Nov 5, 2018

Fred-sun commented Nov 26, 2018

Fred-sun commented Dec 26, 2018

zikalino commented Jan 17, 2019

Madhura-CSI commented Jan 17, 2019

zikalino commented Jan 17, 2019

Madhura-CSI commented Jan 17, 2019

zikalino commented Jan 17, 2019

Madhura-CSI commented Jan 17, 2019

zikalino Feb 20, 2019

Choose a reason for hiding this comment

Madhura-CSI Mar 7, 2019

Choose a reason for hiding this comment

zikalino Mar 7, 2019

Choose a reason for hiding this comment

Fred-sun commented Mar 7, 2019

Madhura-CSI commented Mar 7, 2019

Fred-sun commented Mar 7, 2019

zikalino commented Mar 25, 2019

Madhura-CSI commented Mar 26, 2019

zikalino commented Apr 4, 2019

ansibot commented Apr 8, 2019

ansibot commented Apr 8, 2019

Madhura-CSI commented Apr 8, 2019

ansibot commented Apr 8, 2019

mmyyrroonn commented May 17, 2019