diff options
Diffstat (limited to 'docs/developer_info')
12 files changed, 31 insertions, 41 deletions
diff --git a/docs/developer_info/BBUnderstanding.rst b/docs/developer_info/BBUnderstanding.rst index a4984d3b03..99f2cd92b7 100644 --- a/docs/developer_info/BBUnderstanding.rst +++ b/docs/developer_info/BBUnderstanding.rst @@ -669,7 +669,7 @@ will directly return abort without querying policy in table **rainy_day_handler_macro** -.. code-block:: bash +.. code-block:: curl --location --request POST 'http://master2:30277/onap/so/infra/serviceInstantiation/v7/serviceInstances' \ --header 'Accept: application/json' \ diff --git a/docs/developer_info/BPMN-INFRA_Workflow_Understanding.rst b/docs/developer_info/BPMN-INFRA_Workflow_Understanding.rst index 3af3dc8dc9..4f83c9b885 100644 --- a/docs/developer_info/BPMN-INFRA_Workflow_Understanding.rst +++ b/docs/developer_info/BPMN-INFRA_Workflow_Understanding.rst @@ -603,12 +603,13 @@ Response: Response is returned with an empty entity b. Response Body: - { - "service": - { - "serviceId":"8a95e3ac-32cd-4ffb-b9e3-5366b393a7a2", - "operationId":"a970a804-7ac5-4de9-b6db-17352afbc6fa" +.. code-block:: json + { + "service": { + "serviceId":"8a95e3ac-32cd-4ffb-b9e3-5366b393a7a2", + "operationId":"a970a804-7ac5-4de9-b6db-17352afbc6fa" + } } 9. CreateCommunicationService--> generateE2EServiceProfile() diff --git a/docs/developer_info/BPMN_Subprocess_Process_Flows.rst b/docs/developer_info/BPMN_Subprocess_Process_Flows.rst index 098f38ff02..a0de34e9a6 100644 --- a/docs/developer_info/BPMN_Subprocess_Process_Flows.rst +++ b/docs/developer_info/BPMN_Subprocess_Process_Flows.rst @@ -29,4 +29,4 @@ Characteristics Example: VnfAdapterRestV1.bpmn ------------------------------- -.. image:: images/BPMN_Subprocess_process_flows_1.png +.. image:: ../images/BPMN_Subprocess_process_flows_1.png diff --git a/docs/developer_info/CSIT_Macroflow_developer_info.rst b/docs/developer_info/CSIT_Macroflow_developer_info.rst index d8c52a4a71..fe5a8f2707 100644 --- a/docs/developer_info/CSIT_Macroflow_developer_info.rst +++ b/docs/developer_info/CSIT_Macroflow_developer_info.rst @@ -15,7 +15,7 @@ Ensure you have a healthy ONAP Deployment running. The following components will - MultiCloud What is Macroflow? ------------------ +------------------ The SO building blocks are a set of database-driven, configurable and generic process steps to be leveraged through several actions defined as 'Macro' flows. For each of the macro flows, there are a set of actions to be performed which are implemented as building blocks - which then implement generic logic to handle the orchestration of services and various type of resources orchestrated by ONAP, as well as their corresponding actions. @@ -37,6 +37,7 @@ First pull the CSIT repo from Gerrit, either with or without the hooks … code-block:: git clone "https://gerrit.onap.org/r/integration/csit" + or .. code-block:: @@ -79,7 +80,7 @@ If you look at the contents of the plans/so/macroflow you will see the following **docker-compose.yml:** This lists all the requrired docker. How to run tests against specific SO versions --------------------------------------------- +--------------------------------------------- It is possible to run the CSIT Macroflow suite against local docker images although it is not the default. Through this method specific versions of SO can be tested. There are two changes required to make this work. @@ -91,7 +92,7 @@ There are two changes required to make this work. This should be enough to run the CSIT Macroflow test suite locally. CSIT Macroflow Tests High Level Scenarios ---------------------------------------------------- +----------------------------------------- **Step 1:** diff --git a/docs/developer_info/Camunda_Modeler.rst b/docs/developer_info/Camunda_Modeler.rst index 54f3534210..fcc530df9c 100644 --- a/docs/developer_info/Camunda_Modeler.rst +++ b/docs/developer_info/Camunda_Modeler.rst @@ -9,11 +9,11 @@ The Camunda_Modeler_ is the editor for BPMN 2.0 process flows. It is a standalo .. _Camunda_Modeler: https://docs.camunda.org/manual/latest/modeler/camunda-modeler/ -.. image:: images/camunda_modeler_1.png +.. image:: ../images/camunda_modeler_1.png Modeler Templates ------------------ Some work has already been done in MSO to develop templates_ for "building block" subprocess flows. When a template is provided for a BPMN element, the modeler displays a custom form for inputting parameters. This significantly simplifies flow construction and reduces the chance of making mistakes. -.. _templates: https://docs.camunda.org/manual/7.7/modeler/camunda-modeler/element-templates/
\ No newline at end of file +.. _templates: https://docs.camunda.org/manual/7.7/modeler/camunda-modeler/element-templates/ diff --git a/docs/developer_info/SO_Admin_Cockpit_User_Guide.rst b/docs/developer_info/SO_Admin_Cockpit_User_Guide.rst index ed729664a8..81c459f4c7 100644 --- a/docs/developer_info/SO_Admin_Cockpit_User_Guide.rst +++ b/docs/developer_info/SO_Admin_Cockpit_User_Guide.rst @@ -99,7 +99,7 @@ The log files for SO-Admin-Cockpit can be found within the SO-Admin-Cockpit pod. Replacing <namespace> with your environments namespace and <soAdminCockpitPodName> with the full name of your SO-Admin-Cockpit pod. This command will give you some detailed information from the execution of the pod. CORS (Cross-Origin Resource Sharing) Error ----------- +------------------------------------------ Pre-Dublin SO-Monitoring Components may experience CORS issues. diff --git a/docs/developer_info/Working_with_so_monitoring.rst b/docs/developer_info/Working_with_so_monitoring.rst index 246c61deac..3a9b700797 100644 --- a/docs/developer_info/Working_with_so_monitoring.rst +++ b/docs/developer_info/Working_with_so_monitoring.rst @@ -45,7 +45,8 @@ container through configmap. to be restarted. .. code-block:: bash - kubectl -n onap edit configmap dev-so-monitoring-app-configmap + + kubectl -n onap edit configmap dev-so-monitoring-app-configmap .. image:: ../images/configmap.png @@ -53,8 +54,8 @@ Special care needs to be given to the indentation. Spring needs to be inline wit added accordingly. .. warning:: -Attention! The default setup of the OOM makes SO Monitoring password is being automatically generated during ONAP -deployment and injected through k8s secret + Attention! The default setup of the OOM makes SO Monitoring password is being automatically generated during ONAP + deployment and injected through k8s secret 2. Setup, retrieve and edit default SO Monitoring password ---------------------------------------------------------- @@ -132,7 +133,7 @@ Then access the UI of SO Monitoring, by default https://<k8s-worker-ip>:30224/ .. image:: ../images/ui.png 4. Hiding the SO Monitoring service (ClusterIP) ---------------------------------------- +----------------------------------------------- The SO Monitoring service is set to the NodePort type. It is used to expose the service at a static port. Hence there is possibility to contact the NodePort Service, from outside cluster, by requesting <NodeIP>:<NodePort>. diff --git a/docs/developer_info/developer_information.rst b/docs/developer_info/developer_information.rst index 11b515248a..3f72b4bcf6 100644 --- a/docs/developer_info/developer_information.rst +++ b/docs/developer_info/developer_information.rst @@ -12,6 +12,7 @@ SO Developer Information Building_SO.rst Working_with_SO_Docker.rst Working_with_so_monitoring.rst + SO_Admin_Cockpit_User_Guide.rst Camunda_Cockpit_Community_Edition.rst Camunda_Cockpit_Enterprise_Edition.rst Camunda_Modeler.rst @@ -23,7 +24,12 @@ SO Developer Information BPMN-INFRA_Workflow_Understanding.rst pnf_pnp_workflow_migration_to_BB/pnf_pnp_support_in_service_orchestration.rst Docker-Config_Understanding.rst + mso_adapter_restinterface.rst Mso_Openstack_Adapter.rst Cxf_Logging.rst instantiate/index.rst + E2E_Network_Slicing_Understanding.rst + ETSI_CSIT_NFVO_VNFM.rst + ETSI_NFVO_Network_Service_LCM_Setup_Guide.rst + ETSI_VNF_LCM_Setup_Guide.rst FAQs.rst diff --git a/docs/developer_info/instantiate/instantiation/nbi/index.rst b/docs/developer_info/instantiate/instantiation/nbi/index.rst index 96bbc3a8dd..279797e147 100644 --- a/docs/developer_info/instantiate/instantiation/nbi/index.rst +++ b/docs/developer_info/instantiate/instantiation/nbi/index.rst @@ -10,13 +10,7 @@ Service Instantiation via ONAP NBI API (TM Forum) ONAP NBI allow you to use a TM Forum standardized API (serviceOrder API) -Additional info in: - -.. toctree:: - :maxdepth: 1 - :titlesonly: - - NBI Guide <../../../../../submodules/externalapi/nbi.git/docs/offeredapis/offeredapis.rst> +Additional info NBI Guide ONAP NBI will convert that request to ONAP SO request. diff --git a/docs/developer_info/instantiate/instantiation/so2/index.rst b/docs/developer_info/instantiate/instantiation/so2/index.rst index 02a5f70d3c..85e18a2a02 100644 --- a/docs/developer_info/instantiate/instantiation/so2/index.rst +++ b/docs/developer_info/instantiate/instantiation/so2/index.rst @@ -22,12 +22,8 @@ for an Operator to provide "SDNC preload"). Additional info in: -.. toctree:: - :maxdepth: 1 - :titlesonly: - - CDS Documentation <../../../../../submodules/ccsdk/cds.git/docs/index.rst> - CDS vDNS E2E Automation <https://wiki.onap.org/display/DW/vDNS+CDS+Dublin> +- CDS Documentation +- CDS vDNS E2E Automation <https://wiki.onap.org/display/DW/vDNS+CDS+Dublin> Request Example : diff --git a/docs/developer_info/instantiate/instantiation/uui/index.rst b/docs/developer_info/instantiate/instantiation/uui/index.rst index fa57be2717..e1f2b5fd18 100644 --- a/docs/developer_info/instantiate/instantiation/uui/index.rst +++ b/docs/developer_info/instantiate/instantiation/uui/index.rst @@ -6,9 +6,4 @@ e2eServiceInstance mode via ONAP UUI Portal =========================================== - -.. toctree:: - :maxdepth: 1 - :titlesonly: - - ../../../../../submodules/usecase-ui.git/docs/platform/installation/user-guide/index.rst +UUI documentation, see :ref:`UUI <onap-usecase-ui:uui_index>` for details. diff --git a/docs/developer_info/instantiate/instantiation/vid/index.rst b/docs/developer_info/instantiate/instantiation/vid/index.rst index 307ceb9819..8c7657db83 100644 --- a/docs/developer_info/instantiate/instantiation/vid/index.rst +++ b/docs/developer_info/instantiate/instantiation/vid/index.rst @@ -6,8 +6,4 @@ A La Carte mode Service Instantiation via ONAP VID Portal ========================================================= -.. toctree:: - :maxdepth: 1 - :titlesonly: - - ../../../../../submodules/vid.git/docs/humaninterfaces.rst +VID documentation, see :ref:`VID <onap-vid:instantiate>` for details. |