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

Single IP addresses in Device model specified with standard formats instead of patterns #237

Merged
merged 5 commits into from
Dec 1, 2023

Conversation

jlurien
Copy link
Collaborator

@jlurien jlurien commented Nov 20, 2023

What type of PR is this?

  • enhancement/feature

What this PR does / why we need it:

  • IPv6 address in device changed to SingleIpv6Adress. IPv6 address in ApplicationServer is not changed
  • Patterns for single IPv4 and IPv6 adresses, used in device model, substituted for the standards ipv4 and ipv6 formats defined in JSON-schema

Which issue(s) this PR fixes:

Fixes #230

Special notes for reviewers:

Changelog input

* Single IP addresses in Device model specified with standard formats instead of patterns

Additional documentation

* IPv6 address in device changed to SingleIpv6Adress. IPv6 address in ApplicationServer is not changed
* Patterns for single IPv4 and IPv6 adresses, used in device model, substituted for the standards ipv4 and ipv6 formats defined in JSON-schema
@hdamker
Copy link
Collaborator

hdamker commented Nov 20, 2023

See my comment within the issue.

@eric-murray
Copy link
Collaborator

MegaLinter is complaining about trailing spaces again

Trailing space
eric-murray
eric-murray previously approved these changes Nov 28, 2023
hdamker
hdamker previously approved these changes Nov 28, 2023
Copy link
Collaborator

@hdamker hdamker left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @jlurien for the update

@RandyLevensalor
Copy link
Collaborator

@jlurien @eric-murray I thought that this was just a change to the device and not the application server.

We have use cases for supporting subnets for the application server, including 0.0.0.0/0 for all ipv4 traffic from a specific device and similarly for ipv6.

@eric-murray
Copy link
Collaborator

@jlurien @eric-murray I thought that this was just a change to the device and not the application server.

We have use cases for supporting subnets for the application server, including 0.0.0.0/0 for all ipv4 traffic from a specific device and similarly for ipv6.

The modified application server schema still allows for the specification of subnets, including /0 subnets

@jlurien
Copy link
Collaborator Author

jlurien commented Nov 29, 2023

I forgot to remark that I have kept the pattern for ApplicationServerIpv4Address. I think that one is quite safe, but as it is the only one with pattern it may appear as inconsistent with the other definitions. I have doubts here.

@hdamker
Copy link
Collaborator

hdamker commented Nov 29, 2023

I forgot to remark that I have kept the pattern for ApplicationServerIpv4Address. I think that one is quite safe, but as it is the only one with pattern it may appear as inconsistent with the other definitions. I have doubts here.

My vote would go for eliminating the pattern as in ApplicationServerIpv6Address and stay with string and the description.

BTW: I will finalize the release candidate PR #236 under the assumption that we are closing this PR here. At latest in our call on Friday that should get a go.

@hdamker
Copy link
Collaborator

hdamker commented Nov 29, 2023

@jlurien @eric-murray I thought that this was just a change to the device and not the application server.
We have use cases for supporting subnets for the application server, including 0.0.0.0/0 for all ipv4 traffic from a specific device and similarly for ipv6.

The modified application server schema still allows for the specification of subnets, including /0 subnets

@RandyLevensalor you are right that this is an extension of this PR, but I also see that we need to do it for consistency (getting rid of the the complex allOf pattern for IPv6 addresses). With the separate definition of the IP addresses for application server we are exactly allowing here address ranges (including /0) while having a more precise definition on the device object (which is reused within other APIs).

Does that address your concern sufficiently?

@jlurien
Copy link
Collaborator Author

jlurien commented Nov 29, 2023

I forgot to remark that I have kept the pattern for ApplicationServerIpv4Address. I think that one is quite safe, but as it is the only one with pattern it may appear as inconsistent with the other definitions. I have doubts here.

My vote would go for eliminating the pattern as in ApplicationServerIpv6Address and stay with string and the description.

BTW: I will finalize the release candidate PR #236 under the assumption that we are closing this PR here. At latest in our call on Friday that should get a go.

For ApplicationServerIpv6Address, pattern is removed. But there is a pattern also in ApplicationServerIpv4Address.

@hdamker
Copy link
Collaborator

hdamker commented Nov 29, 2023

I forgot to remark that I have kept the pattern for ApplicationServerIpv4Address. I think that one is quite safe, but as it is the only one with pattern it may appear as inconsistent with the other definitions. I have doubts here.

My vote would go for eliminating the pattern as in ApplicationServerIpv6Address and stay with string and the description.
BTW: I will finalize the release candidate PR #236 under the assumption that we are closing this PR here. At latest in our call on Friday that should get a go.

For ApplicationServerIpv6Address, pattern is removed. But there is a pattern also in ApplicationServerIpv4Address.

My "vote" was for removing the pattern also for ApplicationServerIpv4Address. But it don't harm therefore I'm also fine with keeping it, at least for now.

@hdamker
Copy link
Collaborator

hdamker commented Nov 30, 2023

@RandyLevensalor: can you comment/approve if your use case are still covered with the answers above, especially with the one from Eric? If yes we would be good to go here.

@jlurien
Copy link
Collaborator Author

jlurien commented Nov 30, 2023

I forgot to remark that I have kept the pattern for ApplicationServerIpv4Address. I think that one is quite safe, but as it is the only one with pattern it may appear as inconsistent with the other definitions. I have doubts here.

My vote would go for eliminating the pattern as in ApplicationServerIpv6Address and stay with string and the description.
BTW: I will finalize the release candidate PR #236 under the assumption that we are closing this PR here. At latest in our call on Friday that should get a go.

For ApplicationServerIpv6Address, pattern is removed. But there is a pattern also in ApplicationServerIpv4Address.

My "vote" was for removing the pattern also for ApplicationServerIpv4Address. But it don't harm therefore I'm also fine with keeping it, at least for now.

I think this is coherent approach, so implementations do not have to apply different logic per IP address version. I will remove it as well.

@eric-murray
Copy link
Collaborator

@jlurien
Are you still planning to commit additional changes to remove the pattern for IPv4 addresses?

Removed pattern from ApplicationServerIpv4Address
@jlurien jlurien dismissed stale reviews from hdamker and eric-murray via da6a335 November 30, 2023 15:52
@jlurien
Copy link
Collaborator Author

jlurien commented Nov 30, 2023

@jlurien Are you still planning to commit additional changes to remove the pattern for IPv4 addresses?

I've just removed it. It should be complete now.

Copy link
Collaborator

@RandyLevensalor RandyLevensalor left a comment

Choose a reason for hiding this comment

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

@jlurien Thanks for updating the application server addresses.

@hdamker
Copy link
Collaborator

hdamker commented Dec 1, 2023

Counting also Eric's previous approval in, we are done. I merge now to be able to prepare the RC for our call today.

@hdamker hdamker merged commit c77e96f into camaraproject:main Dec 1, 2023
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Single IPv6 addresses within device
5 participants