network: allow ability to specify if network's ipaddress usage need to be hidden #3235

rohityadavcloud · 2019-03-25T08:47:25Z

Problem: Admins don’t want to charge for IP address usage on certain (shared) networks.
Root Cause: There is no flag or detail for admins to provide using UI or API when creating networks to specify if they want IP address usage of the network hidden.
Solution: A new boolean hideipaddressusage flag is added to the createNetwork API and a checkbox in the ‘Add guest network’ UI for the root admins to specify if they want the shared network’s IP address usage to be hidden in the listUsageRecords API response. The provided flag is saved as the ‘hideIpAddressUsage’ detail in the cloud.network_details table for the network. For existing (shared) networks, root admins can also specify the same boolean API parameter hideipaddressusage with the updateNetwork API request to configure the behaviour for an existing network. When the detail/flag is true, the IP address usage for the (shared) network is not exported in the listUsageRecords API response. The listNetworks API response will include the details of a network for root admin only. (note usage is still recorded in the usage database but not return by the listUsageRecords API)

The API flag works for any kind of network via the API, but the checkbox is only shown while creating shared networks in the UI.

Types of changes

Breaking change (fix or feature that would cause existing functionality to change)
New feature (non-breaking change which adds functionality)
Bug fix (non-breaking change which fixes an issue)
Enhancement (improves an existing feature and functionality)
Cleanup (Code refactoring and cleanup, that may add test cases)

This adds a new API arg only accessible to admins to specify if they
want the network's ip address usage hidden. This then saves this setting
in the network_details table for a network, and the listUsageRecords
API response creator checks for an IP address if it needs to be exported
or skipped/hidden.

The setting is available only to root admin via the listNetworks API response (details key).
Root admin can also update existing networks by using updateNetwork API and passing hideipaddressusage=true|false

UI screenshot, that adds this checkbox only for admins creating a shared network:

**note: it's possible for all other kinds of networks to have their ip address usages skipped as well, available via the API.

borisstoyanov · 2019-03-27T08:29:10Z

@blueorangutan package

blueorangutan · 2019-03-27T08:30:02Z

@borisstoyanov a Jenkins job has been kicked to build packages. I'll keep you posted as I make progress.

blueorangutan · 2019-03-27T09:09:28Z

Packaging result: ✔centos6 ✔centos7 ✔debian. JID-2649

…dden Signed-off-by: Rohit Yadav <[email protected]>

Signed-off-by: Rohit Yadav <[email protected]>

rohityadavcloud · 2019-04-01T10:32:20Z

@blueorangutan package

blueorangutan · 2019-04-01T10:33:24Z

@rhtyd a Jenkins job has been kicked to build packages. I'll keep you posted as I make progress.

blueorangutan · 2019-04-01T10:53:53Z

Packaging result: ✔centos6 ✔centos7 ✔debian. JID-2664

borisstoyanov

LGTM, IP usage record is now displayed or not depending on the flag of the network
@blueorangutan test

borisstoyanov · 2019-04-02T10:40:22Z

@blueorangutan test

blueorangutan · 2019-04-02T10:40:28Z

@borisstoyanov a Trillian-Jenkins test job (centos7 mgmt + kvm-centos7) has been kicked to run smoke tests

blueorangutan · 2019-04-02T18:12:25Z

Trillian test result (tid-3460)
Environment: kvm-centos7 (x2), Advanced Networking with Mgmt server 7
Total time taken: 25349 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr3235-t3460-kvm-centos7.zip
Smoke tests completed. 70 look OK, 0 have error(s)
Only failed tests results shown below:

Test	Result	Time (s)	Test File

…t in the api response Signed-off-by: Rohit Yadav <[email protected]>

borisstoyanov · 2019-05-31T11:39:04Z

@blueorangutan package

blueorangutan · 2019-05-31T11:39:32Z

@borisstoyanov a Jenkins job has been kicked to build packages. I'll keep you posted as I make progress.

blueorangutan · 2019-05-31T12:06:31Z

Packaging result: ✔centos6 ✔centos7 ✔debian. JID-2824

borisstoyanov · 2019-05-31T12:08:05Z

@blueorangutan test

blueorangutan · 2019-05-31T12:08:33Z

@borisstoyanov a Trillian-Jenkins test job (centos7 mgmt + kvm-centos7) has been kicked to run smoke tests

blueorangutan · 2019-05-31T21:36:20Z

Trillian test result (tid-3628)
Environment: kvm-centos7 (x2), Advanced Networking with Mgmt server 7
Total time taken: 32229 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr3235-t3628-kvm-centos7.zip
Intermittent failure detected: /marvin/tests/smoke/test_privategw_acl.py
Intermittent failure detected: /marvin/tests/smoke/test_vpc_redundant.py
Smoke tests completed. 69 look OK, 1 have error(s)
Only failed tests results shown below:

Test	Result	Time (s)	Test File
test_04_rvpc_network_garbage_collector_nics	`Failure`	296.72	test_vpc_redundant.py

PaulAngus

LGTM manually tested, when hideipaddressusage = true ip usage for the designated network is not shown (list networkusage usagetype=3 )

With this commit, listUsageRecords filters out usages made on IP addresses on networks with "Hide IP Address Usage". This was previously introduced in apache#3235. This requires a DB schema change, to introduce a flag is_hidden in table cloud_usage.cloud_usage.

rohityadavcloud added the status:work-in-progress label Mar 25, 2019

rohityadavcloud added this to the 4.13.0.0 milestone Mar 25, 2019

rohityadavcloud requested review from PaulAngus and borisstoyanov March 25, 2019 08:47

rohityadavcloud changed the title ~~network: allow ability to specify if network's ipaddress usage need to be hidden~~ [WIP DO NOT MERGE] network: allow ability to specify if network's ipaddress usage need to be hidden Mar 29, 2019

rohityadavcloud added 2 commits April 1, 2019 16:00

ui: allow admin option to specify if they want network usage to be hi…

dc505c2

…dden Signed-off-by: Rohit Yadav <[email protected]>

implement backend changes

ea8343b

Signed-off-by: Rohit Yadav <[email protected]>

rohityadavcloud force-pushed the hide-network-usage-in-api-response branch from 1814828 to ea8343b Compare April 1, 2019 10:31

borisstoyanov approved these changes Apr 2, 2019

View reviewed changes

apache deleted a comment from blueorangutan May 30, 2019

borisstoyanov requested review from DagSonsteboSB and andrijapanicsb May 31, 2019 08:14

export the count/size based on the actual number of usage records sen…

c0295ad

…t in the api response Signed-off-by: Rohit Yadav <[email protected]>

PaulAngus approved these changes Jun 18, 2019

View reviewed changes

rohityadavcloud changed the title ~~[WIP DO NOT MERGE] network: allow ability to specify if network's ipaddress usage need to be hidden~~ network: allow ability to specify if network's ipaddress usage need to be hidden Jun 19, 2019

rohityadavcloud removed the status:work-in-progress label Jun 19, 2019

rohityadavcloud merged commit 0e87040 into apache:master Jun 19, 2019

olivierlemasle mentioned this pull request Jul 1, 2020

Wrong count in listUsageRecords response #4191

Closed

olivierlemasle mentioned this pull request Sep 7, 2020

Fix usage record count #4193

Merged

5 tasks

olivierlemasle mentioned this pull request Sep 14, 2020

Re-enable IP address usage hiding #4327

Merged

5 tasks

network: allow ability to specify if network's ipaddress usage need to be hidden #3235

network: allow ability to specify if network's ipaddress usage need to be hidden #3235

Uh oh!

Conversation

rohityadavcloud commented Mar 25, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Types of changes

Uh oh!

borisstoyanov commented Mar 27, 2019

Uh oh!

blueorangutan commented Mar 27, 2019

Uh oh!

blueorangutan commented Mar 27, 2019

Uh oh!

rohityadavcloud commented Apr 1, 2019

Uh oh!

blueorangutan commented Apr 1, 2019

Uh oh!

blueorangutan commented Apr 1, 2019

Uh oh!

borisstoyanov left a comment

Choose a reason for hiding this comment

Uh oh!

borisstoyanov commented Apr 2, 2019

Uh oh!

blueorangutan commented Apr 2, 2019

Uh oh!

blueorangutan commented Apr 2, 2019

Uh oh!

borisstoyanov commented May 31, 2019

Uh oh!

blueorangutan commented May 31, 2019

Uh oh!

blueorangutan commented May 31, 2019

Uh oh!

borisstoyanov commented May 31, 2019

Uh oh!

blueorangutan commented May 31, 2019

Uh oh!

blueorangutan commented May 31, 2019

Uh oh!

PaulAngus left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

rohityadavcloud commented Mar 25, 2019 •

edited

Loading