From: John Keeney Date: Fri, 20 Nov 2020 10:43:34 +0000 (+0000) Subject: Merge "Uplift of sub module" X-Git-Tag: 2.1.0~9 X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=c008b8a54aff2ad2566ee904820d95ed7db9a9c1;hp=f35bfa6739d1aae8ecfcd9e15db1beb820287335;p=nonrtric.git Merge "Uplift of sub module" --- diff --git a/enrichment-coordinator-service/.gitignore b/enrichment-coordinator-service/.gitignore new file mode 100644 index 00000000..b83d2226 --- /dev/null +++ b/enrichment-coordinator-service/.gitignore @@ -0,0 +1 @@ +/target/ diff --git a/sdnc-a1-controller/northbound/README.md b/sdnc-a1-controller/northbound/README.md index 0a325f02..436f7766 100644 --- a/sdnc-a1-controller/northbound/README.md +++ b/sdnc-a1-controller/northbound/README.md @@ -1,6 +1,4 @@ -This source repository contains the code for the SDNC-A1 Controller northbound interface. - -It contains an OSGI bundle named "nonrt-ric-api" that provides the interface for A1 operations. +This module builds the sdnc-a1-northbound which inturn creates the nonrt-ric-api-provider & nonrt-ric-api-model bundles. To compile, run "mvn clean install". diff --git a/sdnc-a1-controller/northbound/features/README.md b/sdnc-a1-controller/northbound/features/README.md new file mode 100644 index 00000000..5e0fae11 --- /dev/null +++ b/sdnc-a1-controller/northbound/features/README.md @@ -0,0 +1,21 @@ +This module builds the submodule sdnc-a1-northbound-all,features-sdnc-a1-northbound & installer which creates the features & installers which can be installed in Karaf Server. + +To compile, run "mvn clean install". + +## License + +Copyright (C) 2019 Nordix Foundation. +Licensed under the Apache License, Version 2.0 (the "License") +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. + +For more information about license please see the [LICENSE](LICENSE.txt) file for details. + diff --git a/sdnc-a1-controller/northbound/features/features-sdnc-a1-northbound/README.md b/sdnc-a1-controller/northbound/features/features-sdnc-a1-northbound/README.md new file mode 100644 index 00000000..26339496 --- /dev/null +++ b/sdnc-a1-controller/northbound/features/features-sdnc-a1-northbound/README.md @@ -0,0 +1,21 @@ +This module creates features-sdnc-a1-northbound features from sdnc-a1-northbound-all feature. + +To compile, run "mvn clean install". + +## License + +Copyright (C) 2019 Nordix Foundation. +Licensed under the Apache License, Version 2.0 (the "License") +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. + +For more information about license please see the [LICENSE](LICENSE.txt) file for details. + diff --git a/sdnc-a1-controller/northbound/features/installer/README.md b/sdnc-a1-controller/northbound/features/installer/README.md new file mode 100644 index 00000000..1eaaa688 --- /dev/null +++ b/sdnc-a1-controller/northbound/features/installer/README.md @@ -0,0 +1,21 @@ +This module is responsible for creating sdnc-a1-northbound-features-installer installer which contains sdnc-a1-northbound-all feature. This is then installed into Karaf Server when deployed. + +To compile, run "mvn clean install". + +## License + +Copyright (C) 2019 Nordix Foundation. +Licensed under the Apache License, Version 2.0 (the "License") +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. + +For more information about license please see the [LICENSE](LICENSE.txt) file for details. + diff --git a/sdnc-a1-controller/northbound/features/sdnc-a1-northbound-all/README.md b/sdnc-a1-controller/northbound/features/sdnc-a1-northbound-all/README.md new file mode 100644 index 00000000..6bd2cc14 --- /dev/null +++ b/sdnc-a1-controller/northbound/features/sdnc-a1-northbound-all/README.md @@ -0,0 +1,21 @@ +This module creates the sdnc-a1-northbound-all feature from sdnc-nonrt-ric-api feature. + +To compile, run "mvn clean install". + +## License + +Copyright (C) 2019 Nordix Foundation. +Licensed under the Apache License, Version 2.0 (the "License") +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. + +For more information about license please see the [LICENSE](LICENSE.txt) file for details. + diff --git a/sdnc-a1-controller/northbound/nonrt-ric-api/README.md b/sdnc-a1-controller/northbound/nonrt-ric-api/README.md new file mode 100644 index 00000000..8a349d4b --- /dev/null +++ b/sdnc-a1-controller/northbound/nonrt-ric-api/README.md @@ -0,0 +1,21 @@ +This module builds the model, provider, install & features to create the bundles, features & installers. + +To compile, run "mvn clean install". + +## License + +Copyright (C) 2019 Nordix Foundation. +Licensed under the Apache License, Version 2.0 (the "License") +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. + +For more information about license please see the [LICENSE](LICENSE.txt) file for details. + diff --git a/sdnc-a1-controller/northbound/nonrt-ric-api/features/README.md b/sdnc-a1-controller/northbound/nonrt-ric-api/features/README.md new file mode 100644 index 00000000..6b41cbdd --- /dev/null +++ b/sdnc-a1-controller/northbound/nonrt-ric-api/features/README.md @@ -0,0 +1,21 @@ +This module builds the two submodules sdnc-nonrt-ric-api & features-nonrt-ric-api which creates the A1 northbound feature. + +To compile, run "mvn clean install". + +## License + +Copyright (C) 2019 Nordix Foundation. +Licensed under the Apache License, Version 2.0 (the "License") +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. + +For more information about license please see the [LICENSE](LICENSE.txt) file for details. + diff --git a/sdnc-a1-controller/northbound/nonrt-ric-api/features/features-nonrt-ric-api/README.md b/sdnc-a1-controller/northbound/nonrt-ric-api/features/features-nonrt-ric-api/README.md new file mode 100644 index 00000000..26619937 --- /dev/null +++ b/sdnc-a1-controller/northbound/nonrt-ric-api/features/features-nonrt-ric-api/README.md @@ -0,0 +1,21 @@ +This module creates the features-nonrt-ric-api feature from sdnc-nonrt-ric-api feature + +To compile, run "mvn clean install". + +## License + +Copyright (C) 2019 Nordix Foundation. +Licensed under the Apache License, Version 2.0 (the "License") +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. + +For more information about license please see the [LICENSE](LICENSE.txt) file for details. + diff --git a/sdnc-a1-controller/northbound/nonrt-ric-api/features/sdnc-nonrt-ric-api/README.md b/sdnc-a1-controller/northbound/nonrt-ric-api/features/sdnc-nonrt-ric-api/README.md new file mode 100644 index 00000000..54ab9119 --- /dev/null +++ b/sdnc-a1-controller/northbound/nonrt-ric-api/features/sdnc-nonrt-ric-api/README.md @@ -0,0 +1,21 @@ +This module creates the sdnc-nonrt-ric-api feature from the nonrt-ric-api-model & nonrt-ric-api-provider bundles. + +To compile, run "mvn clean install". + +## License + +Copyright (C) 2019 Nordix Foundation. +Licensed under the Apache License, Version 2.0 (the "License") +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. + +For more information about license please see the [LICENSE](LICENSE.txt) file for details. + diff --git a/sdnc-a1-controller/northbound/nonrt-ric-api/installer/README.md b/sdnc-a1-controller/northbound/nonrt-ric-api/installer/README.md new file mode 100644 index 00000000..10f6790c --- /dev/null +++ b/sdnc-a1-controller/northbound/nonrt-ric-api/installer/README.md @@ -0,0 +1,21 @@ +This module installs the sdnc-nonrt-ric-api feature into the Karaf Server. + +To compile, run "mvn clean install". + +## License + +Copyright (C) 2019 Nordix Foundation. +Licensed under the Apache License, Version 2.0 (the "License") +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. + +For more information about license please see the [LICENSE](LICENSE.txt) file for details. + diff --git a/sdnc-a1-controller/northbound/nonrt-ric-api/model/README.md b/sdnc-a1-controller/northbound/nonrt-ric-api/model/README.md new file mode 100644 index 00000000..0cc666d2 --- /dev/null +++ b/sdnc-a1-controller/northbound/nonrt-ric-api/model/README.md @@ -0,0 +1,21 @@ +This module contains the yang definition of the A1 northbound API and creates the nonrt-ric-api-model bundle. + +To compile, run "mvn clean install". + +## License + +Copyright (C) 2019 Nordix Foundation. +Licensed under the Apache License, Version 2.0 (the "License") +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. + +For more information about license please see the [LICENSE](LICENSE.txt) file for details. + diff --git a/sdnc-a1-controller/northbound/nonrt-ric-api/provider/README.md b/sdnc-a1-controller/northbound/nonrt-ric-api/provider/README.md new file mode 100644 index 00000000..456b92fa --- /dev/null +++ b/sdnc-a1-controller/northbound/nonrt-ric-api/provider/README.md @@ -0,0 +1,21 @@ +This module provides the implementation for the A1 Northbound API and creates the nonrt-ric-api-provider bundle. + +To compile, run "mvn clean install". + +## License + +Copyright (C) 2019 Nordix Foundation. +Licensed under the Apache License, Version 2.0 (the "License") +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. + +For more information about license please see the [LICENSE](LICENSE.txt) file for details. + diff --git a/sdnc-a1-controller/oam/README.md b/sdnc-a1-controller/oam/README.md index ce55f565..5f0619a1 100644 --- a/sdnc-a1-controller/oam/README.md +++ b/sdnc-a1-controller/oam/README.md @@ -1,10 +1,4 @@ -This source repository contains the code for SDNC-A1 Controller operations, administration and maintenance utilities. - -It adds the features from northbound directory and creates the docker image for SDNC-A1 controller. - -It also contains the keystore, the script to start OpenDaylight, and the healthcheck script. - -The docker-compose file is also included in this directory. +This module builds the submodule sdnc-a1 which inturn creates the SDNC A1 docker image To compile, run "mvn clean install". diff --git a/sdnc-a1-controller/oam/installation/README.md b/sdnc-a1-controller/oam/installation/README.md new file mode 100644 index 00000000..ce55f565 --- /dev/null +++ b/sdnc-a1-controller/oam/installation/README.md @@ -0,0 +1,28 @@ +This source repository contains the code for SDNC-A1 Controller operations, administration and maintenance utilities. + +It adds the features from northbound directory and creates the docker image for SDNC-A1 controller. + +It also contains the keystore, the script to start OpenDaylight, and the healthcheck script. + +The docker-compose file is also included in this directory. + +To compile, run "mvn clean install". + +## License + +Copyright (C) 2019 Nordix Foundation. +Licensed under the Apache License, Version 2.0 (the "License") +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. + +For more information about license please see the [LICENSE](LICENSE.txt) file for details. + + diff --git a/sdnc-a1-controller/oam/installation/sdnc-a1/README.md b/sdnc-a1-controller/oam/installation/sdnc-a1/README.md new file mode 100644 index 00000000..f9148d48 --- /dev/null +++ b/sdnc-a1-controller/oam/installation/sdnc-a1/README.md @@ -0,0 +1,22 @@ +This module is responsible for creating Docker images. The feature installers are added into the docker images so that it can be installed in karaf server. + +To compile, run "mvn clean install". + +## License + +Copyright (C) 2019 Nordix Foundation. +Licensed under the Apache License, Version 2.0 (the "License") +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. + +For more information about license please see the [LICENSE](LICENSE.txt) file for details. + + diff --git a/sdnc-a1-controller/oam/platform-logic/README.md b/sdnc-a1-controller/oam/platform-logic/README.md new file mode 100644 index 00000000..e62e6b72 --- /dev/null +++ b/sdnc-a1-controller/oam/platform-logic/README.md @@ -0,0 +1,22 @@ +This module builds the submodule setup & installer + +To compile, run "mvn clean install". + +## License + +Copyright (C) 2019 Nordix Foundation. +Licensed under the Apache License, Version 2.0 (the "License") +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. + +For more information about license please see the [LICENSE](LICENSE.txt) file for details. + + diff --git a/sdnc-a1-controller/oam/platform-logic/installer/README.md b/sdnc-a1-controller/oam/platform-logic/installer/README.md new file mode 100644 index 00000000..5a11efdb --- /dev/null +++ b/sdnc-a1-controller/oam/platform-logic/installer/README.md @@ -0,0 +1,22 @@ +This module builds the platform-logic-installer which contains the DG's but A1 controller in O-RAN doesn't support DG. + +To compile, run "mvn clean install". + +## License + +Copyright (C) 2019 Nordix Foundation. +Licensed under the Apache License, Version 2.0 (the "License") +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. + +For more information about license please see the [LICENSE](LICENSE.txt) file for details. + + diff --git a/sdnc-a1-controller/oam/platform-logic/setup/README.md b/sdnc-a1-controller/oam/platform-logic/setup/README.md new file mode 100644 index 00000000..b9d665dc --- /dev/null +++ b/sdnc-a1-controller/oam/platform-logic/setup/README.md @@ -0,0 +1,22 @@ +This module should contains the Directed Graphs (DG) but A1 controller in O-RAN doesn't support DG. + +To compile, run "mvn clean install". + +## License + +Copyright (C) 2019 Nordix Foundation. +Licensed under the Apache License, Version 2.0 (the "License") +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. + +For more information about license please see the [LICENSE](LICENSE.txt) file for details. + +