Toshiaki Takahashi | 8619f63 | 2022-03-21 10:57:25 +0000 | [diff] [blame] | 1 | .. This work is licensed under a Creative Commons Attribution 4.0 International License. |
| 2 | .. http://creativecommons.org/licenses/by/4.0 |
| 3 | .. (c) <optionally add copywriters name> |
| 4 | |
| 5 | |
| 6 | User Guide |
| 7 | ========== |
| 8 | |
| 9 | This is the user guide of OSC SMO O2. |
| 10 | |
| 11 | .. contents:: |
| 12 | :depth: 3 |
| 13 | :local: |
| 14 | |
| 15 | .. a user guide should be how to use the component or system; it should not be a requirements document |
| 16 | .. delete this content after editing it |
| 17 | |
| 18 | |
| 19 | Description |
| 20 | ----------- |
| 21 | .. Describe the target users of the project, for example, modeler/data scientist, ORAN-OSC platform admin, marketplace user, design studio end user, etc |
| 22 | .. Describe how the target users can get use of a O-RAN SC component. |
| 23 | .. If the guide contains sections on third-party tools, is it clearly stated why the O-RAN-OSC platform is using those tools? Are there instructions on how to install and configure each tool/toolset? |
| 24 | |
| 25 | Feature Introduction |
| 26 | -------------------- |
| 27 | .. Provide enough information that a user will be able to operate the feature on a deployed scenario. content can be added from administration, management, using, Troubleshooting sections perspectives. |
| 28 | |
Ayumu Ueha | a91a325 | 2022-10-21 05:01:46 +0000 | [diff] [blame] | 29 | Tacker |
| 30 | ~~~~~~ |
| 31 | An example of the procedure how to deploy VNF or CNF by using Tacker is shown on the following pages. |
| 32 | If you want to see the other procedure, please refer to `Tacker User Guide`_ |
| 33 | |
Ayumu Ueha | 43821df | 2023-04-07 13:16:50 +0000 | [diff] [blame] | 34 | V1 API |
| 35 | """""" |
| 36 | |
Ayumu Ueha | a91a325 | 2022-10-21 05:01:46 +0000 | [diff] [blame] | 37 | .. toctree:: |
| 38 | :maxdepth: 1 |
| 39 | |
| 40 | tacker-user-guide-vnf.rst |
| 41 | tacker-user-guide-cnf.rst |
Toshiaki Takahashi | 8619f63 | 2022-03-21 10:57:25 +0000 | [diff] [blame] | 42 | |
Ayumu Ueha | 43821df | 2023-04-07 13:16:50 +0000 | [diff] [blame] | 43 | V2 API |
| 44 | """""" |
| 45 | |
| 46 | .. toctree:: |
| 47 | :maxdepth: 1 |
| 48 | |
| 49 | tacker-user-guide-vnf-v2.rst |
| 50 | tacker-user-guide-cnf-v2.rst |
| 51 | |
Toshiaki Takahashi | 7f8191b | 2023-12-06 10:05:08 +0000 | [diff] [blame] | 52 | O2dms FM/PM |
| 53 | """"""""""" |
| 54 | Please refer to the following document for Monitor fault of VNF(App) |
| 55 | using O2dms NFV Profile/SOL002 |
| 56 | |
| 57 | .. toctree:: |
| 58 | :maxdepth: 1 |
| 59 | |
| 60 | https://docs.openstack.org/tacker/latest/user/etsi_cnf_auto_healing_fm.html |
Toshiaki Takahashi | 8619f63 | 2022-03-21 10:57:25 +0000 | [diff] [blame] | 61 | |
Ayumu Ueha | a91a325 | 2022-10-21 05:01:46 +0000 | [diff] [blame] | 62 | .. _Tacker User Guide: https://docs.openstack.org/tacker/latest/user/index.html |