Document cidrlist parameter deprecation

[onitake]

Description

Amend the description for the cidrlist parameter in CreatePortForwardingRule and CreateFirewallRule to state that it is deprecated and shouldn't be used.

Passing this parameter will always result in an error.

Fixes: #4036

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)

Screenshots (if appropriate):

How Has This Been Tested?

See the original bug report for an explanation.

[DaanHoogland]

@onitake can you update this (and maybe make sure the cidr lists are actually ignored and don't throw an exception)?

[rohityadavcloud]

@onitake conflicts on this PR, please fix.

[rohityadavcloud]

ping @onitake is this still relevant?

[sureshanaparti]

Hi @onitake Can you please resolve conflicts in this PR?

[onitake]

I combined the documentation strings. Hope that's ok?

[DaanHoogland]

doc only; lgtm

[nvazquez]

@onitake looks good, only one question: if the parameter is deprecated and must not be used why not then remove it? cc. @rhtyd @DaanHoogland

[DaanHoogland]

@onitake looks good, only one question: if the parameter is deprecated and must not be used why not then remove it? cc. @rhtyd @DaanHoogland

For backward compatibility reasons for scripts, but you are right @nvazquez. Unknown parameters are ignored, so if we are sure it is completely ignored. I didn't think of that. I'd say let's keep them in like this for a few versions and then remove them.

[nvazquez]

Ok thanks @DaanHoogland
@blueorangutan package

[blueorangutan]

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

[blueorangutan]

Packaging result: ✔️ centos7 ✔️ centos8 ✔️ debian. SL-JID 439

[nvazquez]

@blueorangutan test

[blueorangutan]

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

[onitake]

@sureshanaparti @DaanHoogland Woops, thank you. 😅

[sureshanaparti]

changes LGTM

[sureshanaparti]

@blueorangutan package

[blueorangutan]

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

[blueorangutan]

Packaging result: ✔️ el7 ✔️ el8 ✔️ debian. SL-JID 508

[blueorangutan]

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

Test	Result	Time (s)	Test File

[sureshanaparti]

Merging this based on approvals and test results

[weizhouapache]

@sureshanaparti @DaanHoogland @onitake
I think cidrlist is not deprecated in CreateFirewallRuleCmd.java.
Please revert this merge.

@onitake could you please create another pr for CreatePortForwardingRuleCmd.java, CreateLoadBalancerRuleCmd.java and CreateIpForwardingRuleCmd.java which cidrlist is deprecated ?

(localcloud) SBCM5> > create firewallrule ipaddressid=997f8efd-2ec7-46f4-a054-de837e196cc2 startport=22 endport=22 cidrlist=10.10.10.0/24 protocol=tcp
{
  "firewallrule": {
    "cidrlist": "10.10.10.0/24",
    "endport": 22,
    "fordisplay": true,
    "id": "f0b7270d-77b0-4d97-8c02-d95a0e774561",
    "ipaddress": "10.0.52.5",
    "ipaddressid": "997f8efd-2ec7-46f4-a054-de837e196cc2",
    "networkid": "5528f815-c365-4702-8a6b-b59a1d33e8c5",
    "protocol": "tcp",
    "startport": 22,
    "state": "Active",
    "tags": []
  }
}

[onitake]

@weizhouapache Couldn't you have said this a few days earlier? This PR has been open for more than a year. 😞

Sure, I can submit another PR that reverts this... But only if it's confirmed that this isn't deprecated. @rhtyd @DaanHoogland ?

[weizhouapache]

@weizhouapache Couldn't you have said this a few days earlier? This PR has been open for more than a year.

Sure, I can submit another PR that reverts this... But only if it's confirmed that this isn't deprecated. @rhtyd @DaanHoogland ?

@onitake I found the problem right after this pr is merged...

maybe it is unnecessary to revert the pr as it is not an major issue, you can create a PR to (1) revert the change in CreateFirewallRuleCmd.java; (2) change CreateLoadBalancerRuleCmd.java and CreateIpForwardingRuleCmd.java

[weizhouapache]

@onitake
as I mentioned above, could you please create another pr to fix the issue ?
it is not urgent, but do not forget it.