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

IntroduceReferenceImplementationRepositories #73

Merged
merged 3 commits into from
Dec 9, 2022

Conversation

MarkusKuemmerle
Copy link
Collaborator

No description provided.

@shilpa-padgaonkar
Copy link
Contributor

A template repo needs to be provided which includes the default files(codeowner, license etc.)needed for implementation repos. This repo is then used to create new repos. If this is fine, it needs to be added to the doc as well.

@patrice-conil
Copy link

patrice-conil commented Nov 22, 2022

I think end-to-end RI is too strongly tied to the Southern ecosystem to be useful to all partners. To be able to use it, we would need to have a southern reference ecosystem.
How about an RI that would only respond to pre-determined requests with well-formed pre-defined responses to give API consumers a chance to validate their client implementation? By the way, requests with associated replies would give us a BDD input to validate our implementations.
Such an implementation would not rely on SCEF / NEF ecosystems and would be easy to deploy/use.
What do you thik about?

@MarkusKuemmerle
Copy link
Collaborator Author

A template repo needs to be provided which includes the default files(codeowner, license etc.)needed for implementation repos. This repo is then used to create new repos. If this is fine, it needs to be added to the doc as well.

Agreed! I'll do that if the reviewers are fine with the concept presented in this pull request

@MarkusKuemmerle
Copy link
Collaborator Author

I think end-to-end RI is too strongly tied to the Southern ecosystem to be useful to all partners. To be able to use it, we would need to have a southern reference ecosystem. How about an RI that would only respond to pre-determined requests with well-formed pre-defined responses to give API consumers a chance to validate their client implementation? By the way, requests with associated replies would give us a BDD input to validate our implementations. Such an implementation would not rely on SCEF / NEF ecosystems and would be easy to deploy/use. What do you thik about?

We already have a southern reference ecosystem (NEF service provided by Nokia). For other topics beyond NEF we may need a different southern reference ecosystem. But that's something different as proposed in this pull request. Here we focus only on reference implementations for the transformation functions Southbound --> Northbound for our APIs.

@patrice-conil
Copy link

We already have a southern reference ecosystem (NEF service provided by Nokia). For other topics beyond NEF we may need a different southern reference ecosystem. But that's something different as proposed in this pull request. Here we focus only on reference implementations for the transformation functions Southbound --> Northbound for our APIs.

It was my mistake

@MarkusKuemmerle
Copy link
Collaborator Author

We already have a southern reference ecosystem (NEF service provided by Nokia). For other topics beyond NEF we may need a different southern reference ecosystem. But that's something different as proposed in this pull request. Here we focus only on reference implementations for the transformation functions Southbound --> Northbound for our APIs.

It was my mistake

Don't worry, Your idea is a good one. Let's see when it's the right time to start working on such a Southbound Mock

@MarkusKuemmerle
Copy link
Collaborator Author

A template repo needs to be provided which includes the default files(codeowner, license etc.)needed for implementation repos. This repo is then used to create new repos. If this is fine, it needs to be added to the doc as well.

Agreed! I'll do that if the reviewers are fine with the concept presented in this pull request

Templates created, description added to ProjectStructureAndRoles.md

hdamker
hdamker previously approved these changes Nov 27, 2022
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.

Good direction, in QoD we are waiting for it!


A reference implementation repository only must have a CODEOWNERS file, a license file, a GOVERNANCE.MD file (pointing to the Governance repository) and a subdirectory /code/API_code. Writing permission to a Sub Project reference implementation repository only codeowners should have.

For ease of use there are templates for both types of repositories containing all necessary files which can be cloned and adapted.

Choose a reason for hiding this comment

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

Maybe a reference to template files may help. Or something like templates could be found in CAMARA root repository.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Choose a reason for hiding this comment

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

Yes I found them ... but a reference to these repositories in the doc may help to find them quickly.

Copy link
Contributor

@shilpa-padgaonkar shilpa-padgaonkar left a comment

Choose a reason for hiding this comment

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

There were comments here camaraproject/WorkingGroups#63 which say that the word reference used here is not correct.

@jordonezlucena
Copy link
Contributor

I think end-to-end RI is too strongly tied to the Southern ecosystem to be useful to all partners. To be able to use it, we would need to have a southern reference ecosystem. How about an RI that would only respond to pre-determined requests with well-formed pre-defined responses to give API consumers a chance to validate their client implementation? By the way, requests with associated replies would give us a BDD input to validate our implementations. Such an implementation would not rely on SCEF / NEF ecosystems and would be easy to deploy/use. What do you thik about?

We already have a southern reference ecosystem (NEF service provided by Nokia). For other topics beyond NEF we may need a different southern reference ecosystem. But that's something different as proposed in this pull request. Here we focus only on reference implementations for the transformation functions Southbound --> Northbound for our APIs.

Agree on the need of having a ref implementation for the transformation function. Question as for the southbound side: Should we use the network API from the standard or should we rely on the solution made available by a vendor? For example, if the network API == NEF API, should we rely on OAS captured in TS 29.522 or on the Nokia NEF? I also have the question on whether the Nokia southbound ecosystem is open for every CAMARA partner, and if so, how we can make use of it.

@MarkusKuemmerle
Copy link
Collaborator Author

There were comments here camaraproject/WorkingGroups#63 which say that the word reference used here is not correct.

Have checked it, found no necessary change

@MarkusKuemmerle
Copy link
Collaborator Author

I think end-to-end RI is too strongly tied to the Southern ecosystem to be useful to all partners. To be able to use it, we would need to have a southern reference ecosystem. How about an RI that would only respond to pre-determined requests with well-formed pre-defined responses to give API consumers a chance to validate their client implementation? By the way, requests with associated replies would give us a BDD input to validate our implementations. Such an implementation would not rely on SCEF / NEF ecosystems and would be easy to deploy/use. What do you thik about?

We already have a southern reference ecosystem (NEF service provided by Nokia). For other topics beyond NEF we may need a different southern reference ecosystem. But that's something different as proposed in this pull request. Here we focus only on reference implementations for the transformation functions Southbound --> Northbound for our APIs.

Agree on the need of having a ref implementation for the transformation function. Question as for the southbound side: Should we use the network API from the standard or should we rely on the solution made available by a vendor? For example, if the network API == NEF API, should we rely on OAS captured in TS 29.522 or on the Nokia NEF? I also have the question on whether the Nokia southbound ecosystem is open for every CAMARA partner, and if so, how we can make use of it.

We decided to use the Nokia web service as current reference NEF for CAMARA. This service is open for everybody. As soon as we get more NEF services from other partners we also can use them.

@patrice-conil
Copy link

Hi @MarkusKuemmerle
Is https://swagger.open5glab.net the southern reference you mention ?

@MarkusKuemmerle
Copy link
Collaborator Author

Hi @MarkusKuemmerle Is https://swagger.open5glab.net the southern reference you mention ?

It's this one: https://www.nokia.com/developer/open5glab#nef-in-open-5g-lab

@jordonezlucena
Copy link
Contributor

I think end-to-end RI is too strongly tied to the Southern ecosystem to be useful to all partners. To be able to use it, we would need to have a southern reference ecosystem. How about an RI that would only respond to pre-determined requests with well-formed pre-defined responses to give API consumers a chance to validate their client implementation? By the way, requests with associated replies would give us a BDD input to validate our implementations. Such an implementation would not rely on SCEF / NEF ecosystems and would be easy to deploy/use. What do you thik about?

We already have a southern reference ecosystem (NEF service provided by Nokia). For other topics beyond NEF we may need a different southern reference ecosystem. But that's something different as proposed in this pull request. Here we focus only on reference implementations for the transformation functions Southbound --> Northbound for our APIs.

Agree on the need of having a ref implementation for the transformation function. Question as for the southbound side: Should we use the network API from the standard or should we rely on the solution made available by a vendor? For example, if the network API == NEF API, should we rely on OAS captured in TS 29.522 or on the Nokia NEF? I also have the question on whether the Nokia southbound ecosystem is open for every CAMARA partner, and if so, how we can make use of it.

We decided to use the Nokia web service as current reference NEF for CAMARA. This service is open for everybody. As soon as we get more NEF services from other partners we also can use them.

So for those CAMARA APIs who are built upon NEF, the approach is to go for a transformation function which maps the corresponding CAMARA API (e.g., QoD) into Nokia web service API, right?

Copy link
Contributor

@shilpa-padgaonkar shilpa-padgaonkar left a comment

Choose a reason for hiding this comment

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

Same comment as before. Reference word is not preferred. Provider could be an alternative.

@MarkusKuemmerle
Copy link
Collaborator Author

Same comment as before. Reference word is not preferred. Provider could be an alternative.

OK, then I'll change "Reference" to "Provider" after merging this Pull Request.
I don't want to loose the approvals again...

@patrice-conil
Copy link

I think end-to-end RI is too strongly tied to the Southern ecosystem to be useful to all partners. To be able to use it, we would need to have a southern reference ecosystem. How about an RI that would only respond to pre-determined requests with well-formed pre-defined responses to give API consumers a chance to validate their client implementation? By the way, requests with associated replies would give us a BDD input to validate our implementations. Such an implementation would not rely on SCEF / NEF ecosystems and would be easy to deploy/use. What do you thik about?

We already have a southern reference ecosystem (NEF service provided by Nokia). For other topics beyond NEF we may need a different southern reference ecosystem. But that's something different as proposed in this pull request. Here we focus only on reference implementations for the transformation functions Southbound --> Northbound for our APIs.

Agree on the need of having a ref implementation for the transformation function. Question as for the southbound side: Should we use the network API from the standard or should we rely on the solution made available by a vendor? For example, if the network API == NEF API, should we rely on OAS captured in TS 29.522 or on the Nokia NEF? I also have the question on whether the Nokia southbound ecosystem is open for every CAMARA partner, and if so, how we can make use of it.

We decided to use the Nokia web service as current reference NEF for CAMARA. This service is open for everybody. As soon as we get more NEF services from other partners we also can use them.

So for those CAMARA APIs who are built upon NEF, the approach is to go for a transformation function which maps the corresponding CAMARA API (e.g., QoD) into Nokia web service API, right?

FYI, I went from E/// SCEF to Nokia NEF just by switching URL...everything works like a charm.

@MarkusKuemmerle MarkusKuemmerle merged commit b6c5017 into main Dec 9, 2022
@MarkusKuemmerle MarkusKuemmerle deleted the IntroduceReferenceImplementationRepositories branch April 21, 2023 09:38
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.

5 participants