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

PSD to Spectrum Power units change #30

Merged
merged 4 commits into from
Dec 6, 2019
Merged

PSD to Spectrum Power units change #30

merged 4 commits into from
Dec 6, 2019

Conversation

ejbrever
Copy link
Contributor

@aashaikh Can you please review? This is a continuation of the model change which moved away from the PSD units. Thanks!

@googlebot
Copy link

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here with @googlebot I signed it! and we'll verify it.


What to do if you already signed the CLA

Individual signers
Corporate signers

ℹ️ Googlers: Go here for more info.

@ejbrever
Copy link
Contributor Author

ejbrever commented Nov 21, 2019 via email

@googlebot
Copy link

CLAs look good, thanks!

ℹ️ Googlers: Go here for more info.

@@ -23,7 +23,7 @@ import "github.com/openconfig/gnoi/types/types.proto";
option (types.gnoi_version) = "0.1.0";
Copy link
Contributor

Choose a reason for hiding this comment

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

this version will need to be updated -- do we know if there are implementations of this RPC already?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Nope, fortunately, we caught this early on. With some luck, there will be implementations in 2020 :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Version is now updated. Can you please take another look?

rpc AdjustPSD(AdjustPSDRequest) returns (stream AdjustPSDResponse) {}
// triggered by a client can be cancelled unless the CancelAdjustSpectrum
// RPC is used.
rpc AdjustSpectrum(AdjustSpectrumRequest) returns (stream AdjustSpectrumResponse) {}
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we need to consider add a new rpc rather than just replacing this one? (is there an easier migration path?)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Since there are not yet any implementations, I think this will be the cleanest way long term.

Copy link
Contributor

Choose a reason for hiding this comment

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

After some additional discussion, I think we should consider adding a new RPC rather than just wholesale replacing. We can mark the existing rpc or message fields as deprecated, and remove it in a subsequent revision.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure, the RPCs are marked as deprecated. I can remove in a subsequent revision. Please let me know if this needs anything else.

// CancelAdjustSpectrum cancels an in-progress AdjustSpectrum request. If an
// adjustment is not being performed for the provided request, then the RPC
// should return successfully.
rpc CancelAdjustSpectrum(AdjustSpectrumRequest) returns (CancelAdjustSpectrumResponse) {}
}

message AdjustPSDRequest {
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we need to mark these messages deprecated as well ? What is the proto best practice?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I learned something new that a message can be marked deprecated :)

message AdjustSpectrumRequest {
// Absolute path to the /components/component list member in the OpenConfig
// model corresponding to the port to perform the adjustment for.
// (e.g., /components/component[name=amp-1-1])
Copy link
Contributor

Choose a reason for hiding this comment

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

wouldn't this be a port on the ROADM (not AMP?) in the case where they are combined, are the ports named for amplifier?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The important part is to indicate directionality to the system as these adjustments are made on a per direction basis. Some vendors use the amp port as a convenient way, but I agree, it logically makes more sense in the example for this to be a waverouter port (it also aligns well with the name of the proto :)

Copy link
Contributor Author

@ejbrever ejbrever left a comment

Choose a reason for hiding this comment

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

@aashaikh can you please take another look?

message AdjustSpectrumRequest {
// Absolute path to the /components/component list member in the OpenConfig
// model corresponding to the port to perform the adjustment for.
// (e.g., /components/component[name=amp-1-1])
Copy link
Contributor Author

Choose a reason for hiding this comment

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

The important part is to indicate directionality to the system as these adjustments are made on a per direction basis. Some vendors use the amp port as a convenient way, but I agree, it logically makes more sense in the example for this to be a waverouter port (it also aligns well with the name of the proto :)

// CancelAdjustSpectrum cancels an in-progress AdjustSpectrum request. If an
// adjustment is not being performed for the provided request, then the RPC
// should return successfully.
rpc CancelAdjustSpectrum(AdjustSpectrumRequest) returns (CancelAdjustSpectrumResponse) {}
}

message AdjustPSDRequest {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I learned something new that a message can be marked deprecated :)

Copy link
Contributor

@aashaikh aashaikh 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 for the updates!

@ejbrever ejbrever merged commit b4d663a into master Dec 6, 2019
@ejbrever ejbrever deleted the gnoi-psd branch December 6, 2019 15:51
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.

3 participants