Added Infra Requirement in README.md

Author: anand96

ai_services/vision/python/stream-video/README.md

@@ -2,9 +2,9 @@ vision-service python sample for streaming service (detecting object) video usin
 
 # MAC OS:
 
-## 0. Set up 
+## 0. Setup 
 ```
-Follow links below to generate a config file and a key pair in your ~/.oci directory 
+Follow the links below to generate a config file and a key pair in your ~/.oci directory
 https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdkconfig.htm
 https://docs.oracle.com/en-us/iaas/Content/API/Concepts/apisigningkey.htm
 https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/cliinstall.htm#configfile
@@ -16,18 +16,19 @@ b. A key pair named oci_api_key.pem and oci_api_key_public.pem
 
 Now make sure you change the reference of key file in config file (where key file point to private key:key_file=/YOUR_DIR_TO_KEY_FILE/oci_api_key.pem)
 ```
+
 ## 1. Make sure you are in the root directory of this project:
 ```
 cd ~/stream-video
 ```
 
 ## 2. Upload Public Key
 ```
-# Upload your oci_api_key_public.pem to console:
+# Upload your oci_api_key_public.pem to the console:
 https://docs.oracle.com/en-us/iaas/Content/API/Concepts/apisigningkey.htm#three
 
-Just in case you do not have your own config and oci_api_key.pem ready to use, we have
-a pair of keys and a config file in /sample_secrets folder, you can use those to run demo code for testing purposes.
+If you do not have your own config and oci_api_key.pem ready to use, we have
+a pair of keys and a config file in the /sample_secrets folder. You can use those to run the demo code for testing purposes.
 ```
 
 ## 3. Make sure you have python installed on your machine
@@ -39,43 +40,57 @@ And I see following:
 Python 3.9.6
 '''
 
-## 4. Install all dependencies(include our beta version SDK):
+## 4. Install all dependencies (including our beta version SDK):
 ```
-# Make sure you are on either Oracle Corp VPN or OCNA, and have enabled proxy
+# Make sure you are on either Oracle Corp VPN or OCNA, and have enabled the proxy
 export http_proxy=http://www-proxy-adcq7.us.oracle.com:80;
 export https_proxy=http://www-proxy-adcq7.us.oracle.com:80;
 export no_proxy=localhost,127.0.0.1,.us.oracle.com,oraclecorp.com;
 pip install -r requirements.txt
 
 ```
 
-## 5. Stream video python sample scripts usage
+## 5. Private Connectivity via Static IP and Port Forwarding
+```
+Follow these steps to configure secure private connectivity in Oracle Cloud Infrastructure:
+
+### A. Create a Virtual Cloud Network (VCN):
+Set up a new VCN with your chosen CIDR block in the appropriate compartment.
+
+### B. Create a Private Subnet:
+Add a private subnet within your VCN to isolate internal resources.
+
+### C. Create a NAT Gateway:
+Provision a NAT Gateway in the VCN so that private resources can access the internet for updates and patches, while remaining inaccessible from the public internet.
+
+### D. Configure Route Table:
+Add a route table entry to direct all outbound internet traffic from the private subnet through the NAT Gateway.
 
 ```
-usage: stream_video_demo.py [-h] --compartment-id [COMPARTMENT_ID] --subnet-id [SUBNET_ID] --camera-url [CAMERA_URL]       --namespace [NAMESPACE] --bucket [BUCKET] --prefix [PREFIX] [-v]
 
-arguments:
-  -h, --help  show this help message and exit
-  -v, --verbose Print logs
-  --compartment-id, COMPARTMENT_OCID compartment for the resources
-  --subnet-id, SUBNET_ID subnet for the private endpoint
-  --camera-url, CAMERA_URL camera url for the stream
-  --namespace, NAMESPACE namespace of the Bucket
-  --bucket, BUCKET_NAME bucket name
 
-optional arguments:
-  --prefix, PREFIX prefix
+## 5. Stream video python sample scripts usage
 
+```
+usage: stream_video_demo.py [-h] --compartment-id [COMPARTMENT_ID] --subnet-id [SUBNET_ID] --camera-url [CAMERA_URL] --namespace [NAMESPACE] --bucket [BUCKET] [--prefix PREFIX] [-v]
 
+arguments:
+-h, --help Show this help message and exit
+-v, --verbose Print logs
+--compartment-id COMPARTMENT_OCID Compartment OCID for the resources
+--subnet-id SUBNET_ID Subnet for the private endpoint
+--camera-url CAMERA_URL Camera URL for the stream
+--namespace NAMESPACE Namespace of the bucket
+--bucket BUCKET_NAME Bucket name
+optional arguments:
+--prefix PREFIX Prefix
 ```
 
 ## 6. Some examples commands:
 ```
-python3 stream_video_demo.py --compartment-id "ocid1.compartment.oc1..xxxx" --subnet-id "ocid1.subnet.oc1.iad.xxxxxx" --camera-url "stream_url" --namespace "namespace"  --bucket "bucket-name" --prefix "testing"
-
-Above command will create stream source, stream job and stream group, then start and stop stream job and finally delete everything
+python3 stream_video_demo.py --compartment-id "ocid1.compartment.oc1.." --subnet-id "ocid1.subnet.oc1.iad." --camera-url ""rtsp://64.181.159.98:443/weapon" --namespace "namespace"  --bucket "bucket" --prefix "testing"
 
+The above command will create a stream source, stream job, and stream group, then start and stop the stream job, and finally delete everything.
 
 ```
 
-## 7. After running above script, You should see output in json, format is video-file_fps_output-frame-rate_responses.json.

ai_services/vision/python/stream-video/stream_video_demo.py

@@ -13,19 +13,18 @@
 # Supports Python 3
 ##########################################################################
 # Info:
-usage: python3.9 stream_video_demo.py --compartment-id "COMPARTMENT_ID"  --camera-url "RTSP_URL" --namespace "NAMESPACE"  --bucket  "BUCKET_NAME" --prefix "PREFIX"
- [-v]
-
+usage: stream_video_demo.py [-h] --compartment-id [COMPARTMENT_ID] --subnet-id [SUBNET_ID] --camera-url [CAMERA_URL] --namespace [NAMESPACE] --bucket [BUCKET] [--prefix PREFIX] [-v]
+
+arguments:
+-h, --help Show this help message and exit
+-v, --verbose Print logs
+--compartment-id COMPARTMENT_OCID Compartment OCID for the resources
+--subnet-id SUBNET_ID Subnet for the private endpoint
+--camera-url CAMERA_URL Camera URL for the stream
+--namespace NAMESPACE Namespace of the bucket
+--bucket BUCKET_NAME Bucket name
 optional arguments:
-  -h, --help  show this help message and exit
-  -v, --verbose Print logs
-  --compartment-id COMPARTMENT_OCID compartment for the resources
-  --camera-url CAMERA_URL camera url for the stream
-  --namespace NAMESPACE namespace of the Bucket
-  --bucket BUCKET_NAME bucket name
-  --prefix PREFIX prefix
-  --feature FEATURE feature
-
+--prefix PREFIX Prefix
 ##################################################################################
 """
 
@@ -42,7 +41,7 @@
 
 class StreamVideo:
     """
-        A class to
+    Class to use all functionalities of Streaming Service
     """
 
     def __init__(self,compartment_id: str,subnet_id: str,camera_url: str, namespace: str,bucket: str,prefix: str, oci_config: dict, service_endpoint: str):
@@ -109,7 +108,7 @@ def create_private_endpoint(self, display_name="Vision_Private_Endpoint"):
             if status == 'SUCCEEDED':
                 return create_private_endpoint_response.data.id
             elif status == 'FAILED':
-                logger.error("creation of private endpoint failed %s",create_private_endpoint_response)
+                logger.error("creation of private endpoint failed %s",create_private_endpoint_response.headers)
                 sys.exit()
             elif time.time() - start_time > timeout_seconds:
                 raise TimeoutError("Operation timed out after 5 minutes.")
@@ -156,7 +155,7 @@ def create_Stream_Source(self, vision_private_endpoint_ocid, display_name="Visio
             if create_stream_source_work_request.data.status  == 'SUCCEEDED':
                 return create_stream_source_response.data.id
             elif create_stream_source_work_request.data.status == 'FAILED':
-                logger.error("creation of stream source failed %s",create_stream_source_response)
+                logger.error("creation of stream source failed %s",create_stream_source_response.headers)
                 sys.exit()
             elif time.time() - start_time > timeout_seconds:
                 raise TimeoutError("Operation timed out after 2 minutes.")
@@ -224,7 +223,7 @@ def create_Stream_Job(self, stream_source_ocid, display_name="Vision_Stream_Job"
             if create_stream_job_work_request.data.status  == 'SUCCEEDED' :
                 return create_stream_job_response.data.id
             elif create_stream_job_work_request.data.status == 'FAILED':
-                logger.error("creation of stream job failed %s",create_stream_job_response)
+                logger.error("creation of stream job failed %s",create_stream_job_response.headers)
                 sys.exit()
             elif time.time() - start_time > timeout_seconds:
                 raise TimeoutError("Operation timed out after 2 minutes.")
@@ -251,7 +250,7 @@ def create_Stream_Group(self, stream_source_ocid, display_name="Vision_Stream_Gr
             if create_stream_group_work_request.data.status  == 'SUCCEEDED' :
                 return create_stream_group_response.data.id
             elif create_stream_group_work_request.data.status == 'FAILED':
-                logger.error("creation of stream job failed %s",create_stream_group_response)
+                logger.error("creation of stream job failed %s",create_stream_group_response.headers)
                 sys.exit()
             elif time.time() - start_time > timeout_seconds:
                 raise TimeoutError("Operation timed out after 2 minutes.")
@@ -277,7 +276,7 @@ def start_Stream_Job(self, stream_job_ocid):
             if start_stream_job_work_request.data.status  == 'SUCCEEDED' :
                 return stream_job_ocid
             elif start_stream_job_work_request.data.status == 'FAILED':
-                logger.error("starting of stream job failed %s",start_stream_job_response)
+                logger.error("starting of stream job failed %s",start_stream_job_response.headers)
                 sys.exit()
             elif time.time() - start_time > timeout_seconds:
                 raise TimeoutError("Operation timed out after 5 minutes.")
@@ -303,7 +302,7 @@ def stop_Stream_Job(self, stream_job_ocid):
             if stop_stream_job_work_request.data.status  == 'SUCCEEDED' :
                 return stream_job_ocid
             elif stop_stream_job_work_request.data.status == 'FAILED':
-                logger.error("stopping of stream job failed %s",stop_stream_job_response)
+                logger.error("stopping of stream job failed %s",stop_stream_job_response.headers)
                 sys.exit()
             elif time.time() - start_time > timeout_seconds:
                 raise TimeoutError("Operation timed out after 2 minutes.")
@@ -329,7 +328,7 @@ def delete_Stream_Job(self, stream_job_ocid):
             if delete_stream_job_work_request.data.status  == 'SUCCEEDED' :
                 return stream_job_ocid
             elif delete_stream_job_work_request.data.status == 'FAILED':
-                logger.error("Deletion of stream job failed %s",delete_stream_job_response)
+                logger.error("Deletion of stream job failed %s",delete_stream_job_response.headers)
                 sys.exit()
             elif time.time() - start_time > timeout_seconds:
                 raise TimeoutError("Operation timed out after 2 minutes.")
@@ -354,7 +353,7 @@ def delete_Stream_Group(self, stream_group_ocid):
             if delete_stream_group_work_request.data.status  == 'SUCCEEDED' :
                 return stream_group_ocid
             elif delete_stream_group_work_request.data.status == 'FAILED':
-                logger.error("Deletion of stream source failed %s",delete_stream_group_response)
+                logger.error("Deletion of stream source failed %s",delete_stream_group_response.headers)
                 sys.exit()
             elif time.time() - start_time > timeout_seconds:
                 raise TimeoutError("Operation timed out after 2 minutes.")
@@ -379,7 +378,7 @@ def delete_Stream_Source(self, stream_source_ocid):
             if delete_stream_source_work_request.data.status  == 'SUCCEEDED' :
                 return stream_source_ocid
             elif delete_stream_source_work_request.data.status == 'FAILED':
-                logger.error("Deletion of stream source failed %s",delete_stream_source_response)
+                logger.error("Deletion of stream source failed %s",delete_stream_source_response.headers)
                 sys.exit()
             elif time.time() - start_time > timeout_seconds:
                 raise TimeoutError("Operation timed out after 2 minutes.")
@@ -405,7 +404,7 @@ def delete_Vision_Private_Endpoint(self, vision_private_endpoint_ocid):
             if delete_vision_private_endpoint_work_request.data.status == 'SUCCEEDED' :
                 return vision_private_endpoint_ocid
             elif delete_vision_private_endpoint_work_request.data.status == 'FAILED':
-                logger.error("Deletion of stream job failed %s",delete_vision_private_endpoint_work_request)
+                logger.error("Deletion of stream job failed %s",delete_vision_private_endpoint_work_request.headers)
                 sys.exit()
             elif time.time() - start_time > timeout_seconds:
                 raise TimeoutError("Operation timed out after 5 minutes.")
@@ -471,13 +470,17 @@ def delete_Vision_Private_Endpoint(self, vision_private_endpoint_ocid):
 
     stream_group_ocid = stream_videos.create_Stream_Group(stream_source_ocid)
     logger.info("Stream Group created successfully %s", stream_group_ocid)
-        
+
     start_stream_job = stream_videos.start_Stream_Job(stream_job_ocid)
     logger.info("Started Stream Job successfully %s", stream_job_ocid)
 
+    time.sleep(60)
+
     stop_stream_job = stream_videos.stop_Stream_Job(stream_job_ocid)
     logger.info("Stopped Stream Job successfully %s", stream_job_ocid)
 
+    time.sleep(60)
+
     delete_stream_job = stream_videos.delete_Stream_Job(stream_job_ocid)
     logger.info("Stream Job deleted successfully %s", stream_job_ocid)