X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Findex.rst;h=5fb0da1a1fa269f756ceca3c9a8f0c017f5e3431;hb=refs%2Fchanges%2F83%2F383%2F2;hp=0172cffa435a092393bd00aa9107a1bc8ac6bc27;hpb=5ad8f03e1fc7683bb59da31f59edc2f6c0b2372b;p=ric-plt%2Fa1.git diff --git a/docs/index.rst b/docs/index.rst index 0172cff..5fb0da1 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,5 +1,22 @@ -A1 -== +.. ================================================================================== +.. Copyright (c) 2019 Nokia +.. Copyright (c) 2018-2019 AT&T Intellectual Property. +.. +.. 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. +.. ================================================================================== + +A1 Mediator +=========== API === @@ -8,28 +25,6 @@ You can see the API (OpenAPI3 spec) at ``a1/openapi.yml``. You can also see the “pretty” version if you run the container at ``http://localhost:10000/ui/``. -Unit Testing -============ - -Note, this requires rmr to be installed! - -:: - - tox - open htmlcov/index.html - -Integration testing -=================== - -This tests A1’s external API with two test receivers. Note, this -currently depends on docker-compose, meaning you cannot run this if -docker-compose is not installed. Note2: this is not fast. It builds the -containers and launches requests against the API so it takes time. - -:: - - tox -c tox-integration.ini - Running ======= @@ -47,12 +42,15 @@ which is an initial delay until the first rcv is tried. 2) timeouts and send failures should be retried before A1 gives up and returns a 503. The default is ``4``. -Docker ------- +K8S +--- +The "real" helm chart for A1 is in the LF it/dep repo. That repo holds all of the helm charts for the RIC platform. There is a helm chart in `integration_tests` here for running the integration tests as discussed above. + +Local Docker +------------ building ~~~~~~~~ - :: docker build --no-cache -t a1:X.Y.Z . @@ -62,8 +60,6 @@ building running ~~~~~~~ -(TODO: this will be enhanced with Helm.) - :: docker run -dt -p 10000:10000 -v /path/to/localrt:/opt/route/local.rt -v /path/to/ricmanifest:/opt/ricmanifest.json a1:X.Y.Z -v