Merge "Readme for A1-Adapter"

9 files changed, 193 insertions, 0 deletions

diff --git a/a1-adapter/README.md b/a1-adapter/README.md
new file mode 100644
index 00000000..0bd0b8e5
--- /dev/null
+++ b/a1-adapter/README.md
@@ -0,0 +1,25 @@
+# ONAP A1 Policy Adapter
+
+A1 Policy provides a Northbound Interface for A1 operations to do policy management in Near-RealTime RICs.
+This is the parent repo which has submodules that creates the bundles, features & installers for A1 Policy Operation. 
+
+This makes it very fast to start the controller and also puts less load on the CPU.
+
+This adapter is designed to be added to ONAP CCSDK controllers (e.g. SDNC) thus providing support for mediating connections the A1 interface to/from RAN functions.
+
+## License
+
+Copyright (C) 2020 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/a1-adapter/a1-adapter-api/README.md b/a1-adapter/a1-adapter-api/README.md
new file mode 100644
index 00000000..ecfb290a
--- /dev/null
+++ b/a1-adapter/a1-adapter-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) 2020 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/a1-adapter/a1-adapter-api/feature/README.md b/a1-adapter/a1-adapter-api/feature/README.md
new file mode 100644
index 00000000..0afc6328
--- /dev/null
+++ b/a1-adapter/a1-adapter-api/feature/README.md
@@ -0,0 +1,21 @@
+This module creates the a1-adapter-feature feature from a1-adapter-provider bundle.
+
+To compile, run "mvn clean install".
+
+## License
+
+Copyright (C) 2020 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/a1-adapter/a1-adapter-api/installer/README.md b/a1-adapter/a1-adapter-api/installer/README.md
new file mode 100644
index 00000000..3097cd58
--- /dev/null
+++ b/a1-adapter/a1-adapter-api/installer/README.md
@@ -0,0 +1,21 @@
+This module creates the installer a1-adapter-installer which contains a1-adapter-feature which will be deployed into Karaf Server.
+
+To compile, run "mvn clean install".
+
+## License
+
+Copyright (C) 2020 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/a1-adapter/a1-adapter-api/model/README.md b/a1-adapter/a1-adapter-api/model/README.md
new file mode 100644
index 00000000..e369a068
--- /dev/null
+++ b/a1-adapter/a1-adapter-api/model/README.md
@@ -0,0 +1,21 @@
+This module contains the yang definition of the A1 northbound API and creates the a1-adapter-model bundle.
+
+To compile, run "mvn clean install".
+
+## License
+
+Copyright (C) 2020 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/a1-adapter/a1-adapter-api/provider/README.md b/a1-adapter/a1-adapter-api/provider/README.md
new file mode 100644
index 00000000..bce2bb26
--- /dev/null
+++ b/a1-adapter/a1-adapter-api/provider/README.md
@@ -0,0 +1,21 @@
+This module provides the implementation for the A1 Northbound API and creates the a1-adapter-provider bundle.
+
+To compile, run "mvn clean install".
+
+## License
+
+Copyright (C) 2020 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/a1-adapter/features/README.md b/a1-adapter/features/README.md
new file mode 100644
index 00000000..3dd00fa4
--- /dev/null
+++ b/a1-adapter/features/README.md
@@ -0,0 +1,21 @@
+This module builds the submodule a1-adapter-northbound & installer which creates the features & installers which can be installed in Karaf Server.
+
+To compile, run "mvn clean install".
+
+## License
+
+Copyright (C) 2020 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/a1-adapter/features/a1-adapter-northbound/README.md b/a1-adapter/features/a1-adapter-northbound/README.md
new file mode 100644
index 00000000..53a416b1
--- /dev/null
+++ b/a1-adapter/features/a1-adapter-northbound/README.md
@@ -0,0 +1,21 @@
+This module creates the a1-adapter-northbound feature from a1-adapter-feature feature.
+
+To compile, run "mvn clean install".
+
+## License
+
+Copyright (C) 2020 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/a1-adapter/features/installer/README.md b/a1-adapter/features/installer/README.md
new file mode 100644
index 00000000..1aecf161
--- /dev/null
+++ b/a1-adapter/features/installer/README.md
@@ -0,0 +1,21 @@
+This module is responsible for creating a1-adapter-northbound-installer installer which installs a1-adapter-northbound into Karaf Server when deployed.
+
+To compile, run "mvn clean install".
+
+## License
+
+Copyright (C) 2020 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.
+