X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Findex.rst;h=5513baa888f548cf40eba7cd33bce76791323b55;hb=0e3bc64f93a316e49bbdeb047e7592840207231d;hp=7cb73bfd7825c107589d6accf194cb49171cf3de;hpb=40caa314d23122f0bd25c0e66b65d10303538164;p=ric-plt%2Fa1.git diff --git a/docs/index.rst b/docs/index.rst index 7cb73bf..5513baa 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,60 +1,21 @@ -.. ================================================================================== -.. 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 -=== - -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/``. - -Running -======= - -Optional ENV Variables ----------------------- +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 -You can set the following ENVs to change the A1 behavior: +Welcome to O-RAN SC A1 Documentation +===================================== -1. ``RMR_RETRY_TIMES`` the number of times failed rmr operations such as -timeouts and send failures should be retried before A1 gives up and -returns a 503. The default is ``4``. +.. toctree:: + :maxdepth: 2 + :caption: Contents: -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 . - -.. _running-1: - -running -~~~~~~~ - -:: + overview.rst + developer-guide.rst + installation-guide.rst + release-notes.rst +.. + user-guide.rst + api-docs.rst - 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 +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search`