Code Generated Architecture Diagram

Greetings to my fellow Technology Advocates and Specialists.

In this Session, I will demonstrate How to Create Azure Solutions Architecture Diagram by Code.

I had the Privilege to talk on this topic in ONE Azure Community:-

NAME OF THE AZURE COMMUNITY	TYPE OF SPEAKER SESSION
Festive Tech Calendar - 2024	Virtual

EVENT ANNOUNCEMENTS:-
VIRTUAL SESSION:-
LIVE DEMO was Recorded as part of my Presentation in FESTIVE TECH CALENDAR - 2024 Forum/Platform
Duration of My Demo = 49 Mins 02 Secs

AUTOMATION OBJECTIVES:-

#	TOPICS
1.	Example #1: Create "Basic Azure App Service Architecture Diagram" by Code.
2.	Example #2: Create "Gaming Architecture Diagram" by Code.

PRE-REQUISITES:-
1. Python 3.6 or higher.
2. Graphviz
3. pip

VALIDATE PRE-REQUISITES:-

COMMANDS TO VERIFY:-

python --version
dot -V
pip --version

INSTALL DIAGRAMS:-

Install "diagrams" using "pip":-

pip install diagrams

CODE REPOSITORY:-

arindam0310018 / 31-July-2024-DevOps__Diagram-As-Code

DIAGRAM AS CODE

Diagram As Code:-

Greetings to my fellow Technology Advocates and Specialists.

This is "Diagram As Code" Series !

DATE	TOPICS	CONTENT
01.08.2024	Visualizing Cloud Designations with Mermaid	https://dev.to/arindam0310018/visualizing-cloud-designations-with-mermaid-3bl
15.08.2024	Code Generated Architecture Diagram	https://dev.to/arindam0310018/code-generated-architecture-diagram-13o3
19.11.2024	Code Generated Architecture Diagram using Devops	https://dev.to/arindam0310018/code-generated-architecture-diagram-using-azure-devops-2ah4

I had the Privilege to talk on this topic in ONE Azure Communities:-

NAME OF THE AZURE COMMUNITY	TYPE OF SPEAKER SESSION
Festive Tech Calendar - 2024	Virtual

EVENT ANNOUNCEMENTS:-

View on GitHub

REFERENCE LINKS:-
1. Diagram as Code
2. Diagram as Code - Installation
3. Diagram as Code - Examples
4. Diagram as Code - List of Azure Providers

CONCEPTS:-

I.) DIAGRAMS:-
1. Represents a global diagram context.
2. Diagram context can be created with Diagram class.
3. The first parameter of Diagram constructor will be used for output filename.

II.) NODES:-
1. Represents a single system component object.
2. A node object consists of three parts: i) Provider, ii) Resource type and iii) Name.

III.) CLUSTERS:-
1. Allows you group (or clustering) the nodes.

IV.) EDGES:-
1. Represents a connection between Nodes with some additional properties.

Now, we proceed in Creating Architecture Diagram using Diagrams and Python.

CONSTRUCT OF THE PYTHON CODE TO CREATE ARCHITECTURE DIAGRAM:-
1. Import Diagram, Cluster and Edge.
2. Import the Provider Icons for creating diagrams.
3. Creating the building blocks using Nodes and Cluster.
4. Connect the building blocks using Edges.

EXAMPLE #1:

Create "Basic Azure App Service Architecture Diagram" by Code.

Below follows the Python Code (Generate-Basic-Azure-App-service-Arch-Diagram.py):-

############################################################
## Architecture Diagram: Basic Azure App Service:-

## Components include:-
# 1. User
# 2. Azure Entra ID
# 3. Azure Monitor
# 4. Azure Application Insights
# 5. Azure User Assigned Managed Identity
# 6. Azure Key Vault 
# 7. Azure App Services
# 8. Azure SQL Servers

############################################################

######################################################
# Import Diagram, Cluster and Edge.
# Import the Provider Icons for creating diagrams.
######################################################

from diagrams import Cluster, Diagram, Edge
from diagrams.azure.general import Helpsupport, Servicehealth
from diagrams.azure.devops import ApplicationInsights
from diagrams.azure.security import KeyVaults
from diagrams.azure.identity import ManagedIdentities, ActiveDirectory
from diagrams.azure.compute import AppServices
from diagrams.azure.database import SQLServers

#########################################################
# Creating the building blocks using Nodes and Cluster.
#########################################################

with Diagram("Basic Azure App Service Architecture", show=False, direction="TB"):
    usr = Helpsupport("User")

    with Cluster("Compute"):
        components_webapp = [AppServices("AppServices"), KeyVaults("KV"), ManagedIdentities("UMID")]

    with Cluster("Data"):
        components_db = SQLServers("Azure SQL Database")

    with Cluster("Identity"):
        components_identity = [ActiveDirectory("Microsoft Entra ID")]

    with Cluster("Monitoring"):
        components_monitor = [ApplicationInsights("App Insights"), Servicehealth("Azure Monitor")]

############################################
# Connect the building blocks using Edges.
############################################

    usr >> Edge(color="darkorange") >> components_webapp

    components_webapp >> Edge(color="darkgreen") >> components_db

EXECUTE THE PYTHON CODE:-

python.exe .\Generate-Basic-Azure-App-service-Arch-Diagram.py

OUTPUT OF EXAMPLE #1:-

EXAMPLE #2:

Create "Gaming Architecture Diagram" by Code.

Below follows the Python Code (Generate-Gaming-Arch-Diagrams.py):-

############################################################
## Architecture Diagram: Gaming using Azure Cosmos DB:-

## Components include:-
# 1. User
# 2. Azure Traffic Manager
# 3. Azure Content Delivery Network
# 4. Azure Storage
# 5. Azure API Management 
# 6. Azure Cosmos DB
# 7. Azure Databricks
# 8. Azure Functions
# 9. Azure Notification Hubs

############################################################

######################################################
# Import Diagram, Cluster and Edge.
# Import the Provider Icons for creating diagrams.
######################################################

from diagrams import Cluster, Diagram, Edge
from diagrams.azure.general import Helpsupport
from diagrams.azure.network import TrafficManagerProfiles, CDNProfiles
from diagrams.azure.storage import StorageAccounts
from diagrams.azure.integration import APIManagement
from diagrams.azure.database import CosmosDb
from diagrams.azure.analytics import Databricks
from diagrams.azure.compute import FunctionApps
from diagrams.azure.mobile import NotificationHubs

#########################################################
# Creating the building blocks using Nodes and Cluster.
#########################################################

# with Diagram("GAMING ARCHITECTURE", show=False, direction="TB"):
with Diagram("GAMING ARCHITECTURE", show=False):
    usr = Helpsupport("User")

    # atm = TrafficManagerProfiles("Azure Traffic Manager")

    apim = APIManagement("Azure API Apps")

    cosmos = CosmosDb("Azure Cosmos DB")

    dbks = Databricks("Azure Databricks")

    # cdn = CDNProfiles ("Azure CDN")

    # storage = StorageAccounts("Azure Storage (Media Files)")

    functions = FunctionApps("Azure Functions")

    notifyhub = NotificationHubs("Azure Notification Hubs")

    with Cluster(""):
         atm = TrafficManagerProfiles("Traffic Manager")

    with Cluster(""):
         cdn = CDNProfiles ("Azure CDN")

    with Cluster(""):
         storage = StorageAccounts("Azure Storage")

############################################
# Connect the building blocks using Edges.
############################################

    usr >> Edge(color="darkgreen") >> atm
    cdn >> Edge(color="darkblue") >> atm
    storage >> Edge(color="darkpurple") >> cdn
    atm >> Edge(color="darkorange") >> apim
    apim >> Edge(color="darkred") >> cosmos
    cosmos >> Edge(color="darkred") >> apim
    cosmos >> Edge(color="darkblue") >> dbks
    cosmos >> Edge(color="darkblue") >> functions
    functions >> Edge(color="darkbrown") >> notifyhub

EXECUTE THE PYTHON CODE:-

python.exe .\Generate-Gaming-Arch-Diagrams.py

OUTPUT OF EXAMPLE #2:-

Hope You Enjoyed the Session!!!

Stay Safe | Keep Learning | Spread Knowledge