-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
95d72eb
commit 4e36ac4
Showing
62 changed files
with
1,396 additions
and
51 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| <!-- | ||
| SPDX-FileCopyrightText: 2019-present Open Networking Foundation <[email protected]> | ||
| SPDX-License-Identifier: Apache-2.0 | ||
| --> | ||
|
|
||
| # onos-a1t | ||
| A1 AP Termination module for ONOS SD-RAN (µONOS Architecture) | ||
|
|
||
| ## Overview | ||
| The `onos-a1t` is the A1 termination node in the near-RT RIC for A1 interface to communicate the near-RT RIC with the non-RT RIC. | ||
| It is the proxy that forwards incoming A1 messages from the non-RT RIC to appropriate xApps or outgoing A1 messages from xApps to the non-RT RIC. | ||
| As per the O-RAN Working Group 2 specification, `onos-a1t` should support A1 messages for (i) the policy management, (ii) the enrichment information, and (iii) the machine learning model management. | ||
| As of today, since the O-RAN A1 specification only defines the policy management data model, `onos-a1t` only supports the policy management service. | ||
|
|
||
| Regarding O-RAN specifications, `onos-a1t` supports A1 Application Protocol v03.01 and A1 Type Definitions v02.00. | ||
|
|
||
| ## Interaction | ||
| The `onos-a1t` interacts with at least three nodes: (i) `onos-topo`, (ii) `A1-enabled xApps` and (iii) `non-RT RIC`. | ||
| To begin with, `onos-a1t` keeps listening the `onos-topo` to check if there is new `A1-enabled xApps` deployed and if there are `A1-enabled xApps` already running. | ||
| Basically, the A1-enabled `xApps` initially stores its A1 interface information, such as supported A1 services (i.e., the policy management, the enrichment information, and the machine learning model management) and A1 interface endpoint (i.e., IP address and port number). | ||
| Listening `onos-topo`, `onos-a1t` scrapes the A1 interface information and store it into the `onos-a1t` local store. | ||
| With the A1 interface information, `onos-a1t` starts creating the gRPC session with appropriate xApps to communicate with each other. | ||
| A gRPC server is the `A1-enabled xApp`, whereas `onos-a1t` acts as the gRPC client (Note that this design is able to support the high availability and reliability by using the replicas for the near future). | ||
| In order to communicate with the non-RT RIC, `onos-a1t` has both an HTTP server and an HTTP client. | ||
| And of course, the non-RT RIC has to have both the HTTP server and the HTTP client for the bi-directional communication over HTTP. | ||
| The HTTP server in `onos-a1t` receives the JSON formatted A1 interface message from the non-RT RIC. | ||
| The HTTP client in `onos-a1t` is the client that sends the JSON formatted outgoing A1 interface messages to the non-RT RIC. | ||
| The HTTP client and server implementations are auto generated from the OpenAPI definitions provided by the A1 Application Protocol specifications. |
Submodule onos-a1t
added at
097563
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| <!-- | ||
| SPDX-FileCopyrightText: 2020-present Open Networking Foundation <[email protected]> | ||
| SPDX-License-Identifier: Apache-2.0 | ||
| --> | ||
|
|
||
| We expect all ONF employees, member companies, and participants to abide by our [Code of Conduct](https://www.opennetworking.org/wp-content/themes/onf/img/onf-code-of-conduct.pdf). | ||
|
|
||
| If you are being harassed, notice that someone else is being harassed, or have any other concerns involving someone’s welfare, please notify a member of the ONF team or email [[email protected]]([email protected]). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| <!-- | ||
| SPDX-FileCopyrightText: 2020-present Open Networking Foundation <[email protected]> | ||
| SPDX-License-Identifier: Apache-2.0 | ||
| --> | ||
|
|
||
| # onos-api | ||
| gRPC API definitions for the µONOS platform | ||
|
|
||
| ## Overview | ||
| This repository houses not only the `.proto` files, but also a number of automatically generated artifacts, e.g. `.pb.go`, `.py` files and similarly for other languages that may be added in the future. | ||
|
|
||
| The source tree structure is paritioned into `proto`, which contains the canonical protobuf definitions and a top-level directory for each of the supported languages. The structure within each of the language-specific directories reflects the idoms and conventions appropriate to each language. | ||
|
|
||
| ## Proto | ||
| The top-level package for the protobuf definitions is `onos` and the next level subpackage is the name of the particular platform subsystem, such as `config`, `topo`, etc. This directory tree should contain exclusively the `.proto` files and not be tainted by any other artifacts, especially any language-specific ones. | ||
|
|
||
| The proto files are compiled and processed via `build/bin/compile-protos.sh` script, which is invoked by the `Makefile`. All protofiles here should follow the established guidelines and must pass the protobuf lint checker enforcing these conventions. | ||
|
|
||
| ## Golang | ||
| The `go` source tree holds the automatically-generated `.pb.go` artifacts and also any manually authored `.go` source files written in support of the Golang bindings. To minimize the churn and to exercise tighter control over versioning, the generated files are also versioned and maintained in the SCM repo. | ||
|
|
||
| The root package of the module is `github.com/onosproject/onos-api/go/onos`, with subpackages being named after each of the platform subsystems, mirroring the structure of the `proto` packages. Golang projects that wish to import µONOS API packages should include the following in the requirements section of their `go.mod` file: | ||
|
|
||
| ```go | ||
| require ( | ||
| ... | ||
| github.com/onosproject/onos-api/go v0.6.1 | ||
| ... | ||
| ) | ||
|
|
||
| ``` | ||
|
|
||
| Additionally, Go bindings are generated with mocks for testing with [gomock]. Mocks of Protobuf interfaces can be constructed via the same package as the interfaces they mock: | ||
|
|
||
| ```go | ||
| import topoapi "github.com/onosproject/onos-api/go/onos/topo" | ||
| ... | ||
| mockClient := topoapi.NewMockTopoClient(ctrl) | ||
| ``` | ||
|
|
||
| ## Python | ||
|
|
||
| The `python` source tree holds gRPC bindings are generated for [Python]. Pyhton bindings are generated with the [python-betterproto] protoc plugin and support Python3's `asyncio` framework. | ||
|
|
||
| [gomock]: https://github.com/golang/mock | ||
| [Go]: https://golang.org/ | ||
| [Protobuf]: https://developers.google.com/protocol-buffers | ||
| [Python]: https://www.python.org | ||
| [python-betterproto]: https://github.com/danielgtaylor/python-betterproto |
Submodule onos-api
added at
fbdd32
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| <!-- | ||
| SPDX-FileCopyrightText: 2019-present Open Networking Foundation <[email protected]> | ||
| SPDX-License-Identifier: Apache-2.0 | ||
| --> | ||
|
|
||
| We expect all ONF employees, member companies, and participants to abide by our [Code of Conduct](https://www.opennetworking.org/wp-content/themes/onf/img/onf-code-of-conduct.pdf). | ||
|
|
||
| If you are being harassed, notice that someone else is being harassed, or have any other concerns involving someone’s welfare, please notify a member of the ONF team or email [[email protected]]([email protected]). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| <!-- | ||
| SPDX-FileCopyrightText: 2019-present Open Networking Foundation <[email protected]> | ||
| SPDX-License-Identifier: Apache-2.0 | ||
| --> | ||
|
|
||
| # onos-cli | ||
| [](https://github.com/onosproject/onos-cli/blob/master/LICENSE) | ||
| [](https://goreportcard.com/report/github.com/onosproject/onos-cli) | ||
| [](https://godoc.org/github.com/onosproject/onos-cli) | ||
|
|
||
| This is the implementation of a consolidated `onos` command-line interface for ONOS (µONOS Architecture) | ||
|
|
||
| The goal is to provide a single CLI executable that can be used as a means to access CLI functionality | ||
| of a number of different ONOS subsystems, e.g. topo, config, control. | ||
|
|
||
| * [Deploying onos-cli with Helm](docs/deployment.md) | ||
| * [ONOS command line client](docs/cli/onos.md) | ||
|
|
||
|
|
||
|
|
Submodule onos-cli
added at
398165
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| <!-- | ||
| SPDX-FileCopyrightText: 2019-present Open Networking Foundation <[email protected]> | ||
| SPDX-License-Identifier: Apache-2.0 | ||
| --> | ||
|
|
||
| We expect all ONF employees, member companies, and participants to abide by our [Code of Conduct](https://www.opennetworking.org/wp-content/themes/onf/img/onf-code-of-conduct.pdf). | ||
|
|
||
| If you are being harassed, notice that someone else is being harassed, or have any other concerns involving someone’s welfare, please notify a member of the ONF team or email [[email protected]]([email protected]). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| <!-- | ||
| SPDX-FileCopyrightText: 2019-present Open Networking Foundation <[email protected]> | ||
| SPDX-License-Identifier: Apache-2.0 | ||
| --> | ||
|
|
||
| # onos-config | ||
| [](https://goreportcard.com/report/github.com/onosproject/onos-config) | ||
| [](https://github.com/gojp/goreportcard/blob/master/LICENSE) | ||
| [](https://coveralls.io/github/onosproject/onos-config?branch=master) | ||
| [](https://godoc.org/github.com/onosproject/onos-config) | ||
|
|
||
|
|
||
| ONOS Configuration subsystem built using the µONOS architecture | ||
|
|
||
| You can find all the documentation under [docs](docs) directory. | ||
| A good place to start is the [README](docs/README.md). | ||
|
|
||
| Overall µONOS documentation is also published on its own [website](https://docs.onosproject.org). |
Submodule onos-config
added at
81df3d
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| <!-- | ||
| SPDX-FileCopyrightText: 2019-present Open Networking Foundation <[email protected]> | ||
| SPDX-License-Identifier: Apache-2.0 | ||
| --> | ||
|
|
||
| We expect all ONF employees, member companies, and participants to abide by our [Code of Conduct](https://www.opennetworking.org/wp-content/themes/onf/img/onf-code-of-conduct.pdf). | ||
|
|
||
| If you are being harassed, notice that someone else is being harassed, or have any other concerns involving someone’s welfare, please notify a member of the ONF team or email [[email protected]]([email protected]). |
Oops, something went wrong.