DEVOPS-263 updated readme

Author: githubofkrishnadhas

README.md

@@ -9,7 +9,7 @@ This app helps in displaying image details available in an azure container regis
  that belongs to other teams. 
 
 * As an example there is a platform engineering team that maintains docker imagges which are widely used and frequeently built,
-    and if teams wont have access to the registry they won't be able to list out the differnt versions of images available.
+    and if teams won't have access to the registry they won't be able to list out the differnt versions of images available.
 
 ➦ This application can resolve above mentioned problem.
 
@@ -28,6 +28,32 @@ This app helps in displaying image details available in an azure container regis
 * Microsoft Azure Container Registry Client Library for Python is used to list all images and tags in a ACR.
   [azure-containerregistry](https://learn.microsoft.com/en-us/python/api/overview/azure/containerregistry-readme?view=azure-python)
 
+* Microsoft Azure Resource Graph Client Library [azure-mgmt-resourcegraph](https://learn.microsoft.com/en-us/python/api/azure-mgmt-resourcegraph/azure.mgmt.resourcegraph?view=azure-python)
+  used to list the containers to verify and validate the user input container name.
+
+# Architecture diagram
+![app-to-get-image-details-from-acr.jpg](app-to-get-image-details-from-acr.jpg)
+
+* User access the streamlit app. inputs an acr name
+
+* The user input is passed from streamlit ui to python program as an input.
+
+* Python program lists all containers available in azure using resource graph query and checks if the input is valid
+
+```mermaid
+  flowchart TD
+    A[User Input] -->B[Submit]
+    B --> C{Python program}
+    C -->|Valid user input| D[proceeds to retrieve image details]
+    C -->|Invalid user input| E[Throws error]
+```
+
+* If the user input which is a acr name is wrong, gets the below error
+
+   ![wrong-acr-name-error.jpeg](wrong-acr-name-error.jpeg) 
+
+
+
 
 
 

acr_images.py

@@ -6,7 +6,6 @@
 from azure.identity import DefaultAzureCredential, EnvironmentCredential
 from azure.containerregistry import ContainerRegistryClient
 from date_time import date_time
-from azure_resource_graph_query import validate_input_acr_name
 from azure.core.exceptions import HttpResponseError, ClientAuthenticationError
 
 
@@ -26,15 +25,15 @@ def list_image_tag_details(acr_name: str):
 	:param acr_name:
 	:return:
 	"""
+	from azure_resource_graph_query import validate_input_acr_name
 	credential = EnvironmentCredential()
+	# validate acr input
+	valid = validate_input_acr_name(acr_name=acr_name)
 
 	repositories = get_image_names_from_acr(acr_name=acr_name)
 	acr_url = return_acr_endpoint(acr_name=acr_name)
-	print(f'Image details will be fetched from : {acr_url}')
-	# validate acr input
-	valid = validate_input_acr_name(acr_name=acr_name)
+	# print(f'Image details will be fetched from : {acr_url}')
 
-	# Image - tag count
 	image_tag_count = {}
 	client = ContainerRegistryClient(endpoint=acr_url, credential=credential)
 	for repository in repositories:

app-to-get-image-details-from-acr.jpg

@@ -49,7 +49,9 @@ def validate_input_acr_name(acr_name: str):
         print(f"{acr} is valid.")
     else:
         print(f"ACR {acr} can not be found in azure")
-        st.text(f"ACR {acr} can not be found in azure 🚫")
+        # displaying error in streamlit ui
+        st.text(f"Azure container resistry with name '{acr}' can not be found in azure 🚫")
+        st.text(f"Please verify & provide right ACR name")
         sys.exit(f"Error: ACR {acr} can not be found in azure")
         return False
 
@@ -61,7 +63,7 @@ def main():
     """
     load_dotenv()
     logging.info("ARG query being prepared......")
-    run_azure_rg_query(subscription_name="TECH-ARCHITECTS-NONPROD")
+    acr = run_azure_rg_query()
     logging.info("ARG query Completed......")