Script to create all templates needed to run E2E NS Option2

[demo.git] / tutorials / 5GE2ENetworkSlicing / Option2 / README.md

diff --git a/tutorials/5GE2ENetworkSlicing/Option2/README.md b/tutorials/5GE2ENetworkSlicing/Option2/README.md
index 6f9ec3f..6cb6786 100644 (file)
--- a/tutorials/5GE2ENetworkSlicing/Option2/README.md
+++ b/tutorials/5GE2ENetworkSlicing/Option2/README.md
@@ -1 +1,61 @@
-# In this directory put files/scripts related to Option2
+Before running python scripts, some settings for onapsdk with information about ONAP endpoints (and proxies if needed) 
+must be be provided. ONAP SDK can be configured by exporting `ONAP_PYTHON_SDK_SETTINGS` which points to configuration python file. 
+
+Example setting are below
+
+```
+# ============LICENSE_START=======================================================
+# Copyright (C) 2021 Orange
+# Copyright (C) 2022 Samsung Electronics
+# ================================================================================
+# 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.
+#
+# ============LICENSE_END=========================================================
+
+"""Global settings module."""  # pylint: disable=bad-whitespace
+# needed when socks proxy is used to connect to cluster
+#from onapsdk.onap_service import OnapService
+
+######################
+#                    #
+# ONAP SERVICES URLS #
+#                    #
+######################
+
+AAI_URL     = "https://aai.api.sparky.simpledemo.onap.org:30233"
+AAI_API_VERSION = "v20"
+CDS_URL     = "http://portal.api.simpledemo.onap.org:30449"
+MSB_URL     = "https://msb.api.simpledemo.onap.org:30283"
+SDC_BE_URL  = "https://sdc.api.be.simpledemo.onap.org:30204"
+SDC_FE_URL  = "https://sdc.api.fe.simpledemo.onap.org:30207"
+SDNC_URL    = "https://sdnc.api.simpledemo.onap.org:30267"
+SO_URL      = "http://so.api.simpledemo.onap.org:30277"
+SO_API_VERSION = "v7"
+VID_URL     = "https://vid.api.simpledemo.onap.org:30200"
+VID_API_VERSION = "/vid"
+CLAMP_URL   = "https://clamp.api.simpledemo.onap.org:30258"
+VES_URL = "https://ves.api.simpledemo.onap.org:30417"
+DMAAP_URL = "http://dmaap.api.simpledemo.onap.org:3904"
+
+# needed when socks proxy is used to connect to cluster
+#OnapService.set_proxy({'http': 'socks5h://127.0.0.1:8081', 'https': 'socks5h://127.0.0.1:8081'})
+
+# execute in the shell to apply these settings
+# export ONAP_PYTHON_SDK_SETTINGS="onap_settings"
+```
+which are saved in onap_settings.py one needs to set evirnioment like below:
+
+```
+(automation) ubuntu@onap:~/automation$ export ONAP_PYTHON_SDK_SETTINGS="onap_settings"
+```
+