# CloudSkew Architecture
CloudSkew is a free online diagram editor for sketching cloud architecture diagrams (see a quick demo video (opens new window)). Icons for AWS, Azure, GCP, Kubernetes, Alibaba Cloud, IBM Cloud, Oracle Cloud (OCI) etc are already included in the app. All diagrams are securely saved in the cloud. Here are some sample diagrams created with CloudSkew. The full list of CloudSkew's features & capabilities can be seen here. Currently, the product is in public preview.
In this document, we'll do a deep-dive on CloudSkew's building blocks while also discussing the lessons learnt, key decisions & trade offs made (this living document will be frequently updated as the architecture evolves). The diagram below represents the overall architecture of CloudSkew.
CloudSkew's infrastructure has been built on top of various Azure services - snapped together like lego blocks. Let's now take a look at the individual pieces.
This article is a part of the #FestiveTechCalendar2020 (https://festivetechcalendar.com/) (opens new window), #AppliedCloudStoriesContest (aka.ms/applied-cloud-stories) (opens new window) and #AzureDevStories (http://konf.me/ds) (opens new window) initiatives.
The video below recaps how CloudSkew was built. You can skip reading the rest of the article and watch this video instead!
At it's core, CloudSkew's front-end consists of two web apps:
The landing page is a static VuePress site, with all pages authored in markdown. The default VuePress theme is used without any customization, although we're loading some marketplace plugins for image zoom, google analytics, sitemap generation etc. All images on this site are loaded from a CDN. The choice of VuePress for SSG was mainly down to its simplicity.
The diagram editor (opens new window) is an Angular 8 SPA written in TypeScript (more details on the internals of this app will be shared in future articles). To access the app, users are required to login using their GitHub or LinkedIn credentials. This app too loads all its static assets from a CDN, while relying on the back-end web APIs for fetching dynamic content. The choice of Angular as the front-end framework was mainly driven by our familiarity with it from prior projects.
# Web APIs
The back-end consists of two web API apps, both authored using ASP.NET Core 3.1:
The CloudSkew APIs facilitates CRUD operations over diagrams, diagram templates and user profiles.
The DiagramHelper APIs are required for printing or exporting (as PNG/JPG/JSON) diagrams. These APIs are isolated in a separate app since the memory footprint is higher causing the process to recycle more often.
Using ASP.NET Core's middleware (opens new window), we ensure that:
- JWT authentication is enforced. Use of policy-based authorization (opens new window) for RBAC ensures that claims mapping to user permissions are present in the JWT.
- Only the diagram editor (front-end app) can invoke these APIs (CORS settings (opens new window)).
- Brotli response compression (opens new window) is enabled for reducing payload sizes.
The web APIs are stateless and operate under the assumption that they can be restarted/redeployed any time. No sticky sessions & affinities, no in-memory state, all state is persisted to DBs using EF Core (opens new window) (an ORM).
Separate DTO/REST and DBContext/SQL models are maintained for all entities, with AutoMapper (opens new window) rules being used for conversions between the two.
# Identity, AuthN & AuthZ
Auth0 (opens new window) is used as the (OIDC compliant) identity platform for CloudSkew. Users can login via Github or LinkedIn; the handshake with these identity providers is managed by Auth0 itself. Using authorization code grant (with PKCE), ID and access tokens (JWTs) are granted to the diagram editor app. Auth0's Angular SDK (opens new window) makes all this really trivial to implement. All calls to the back-end web APIs use the access token as the bearer.
Auth0 creates & maintains the user profiles for all signed-up users. Authorization/RBAC is managed by assigning Auth0 roles (opens new window) to these user profiles. Each role contains a collections of permissions that can be assigned to the users (they show up as custom claims in the JWTs).
Auth0 rules (opens new window) are used to inject custom claims in the JWT and whitelist/blacklist users.
SQL Azure (opens new window) is used for persisting user data; primarily three entities:
UserProfile. User credentials are not stored in CloudSkew's database (that part is handled by Auth0). User contact details like emails are MD5 hashed.
Because of CloudSkew's auto-save feature, updates to the
Diagram table happens very frequently. Some steps have been taken to optimize this:
- Debouncing (opens new window) the auto-save requests from the diagram editor UI to the Web API.
- Use of a queue for load-leveling the update requests (see this section for details).
For the preview version, the SQL Azure SKU being used in production is
Standard/S0 with 20 DTUs (single database). Currently, the DB is only available in one region. Auto-failover groups & active geo-replication (read-replicas) are not being used at present.
SQL Azure's built-in geo-redundant DB backups (opens new window) offer weekly full DB backups, differential DB backups every 12 hours and transaction log backups every 5 - 10 minutes. SQL Azure internally stores the backups in RA-GRS storage for 7 days. RTO is 12 hrs and RPO is 1 hr. Perhaps less than ideal, but we'll look to improve matters here once CloudSkew's usage grows.
Azure CosmosDB (opens new window)'s usage is purely experimental at this point, mainly for the analysis of anonymized, read-only user data in graph format over gremlin APIs (opens new window) (more details on this will be shared in a future article). Technically speaking, this database can be removed without any impact to user-facing features.
# Hosting & Storage
Two Azure Storage Accounts (opens new window) are provisioned for hosting the front-end apps: landing page & diagram editor. The apps are served via the
$web blob containers for static sites.
Two more storage accounts are provisioned for serving the static content (mostly icon SVGs) and user-uploaded images (PNG, JPG files) as blobs.
- For CloudSkew's preview version we're using the
B1 (100 ACU, 1.75 GB Mem)plan which unfortunately does not include automatic horizontal scale-outs (i.e. scale-outs have to be done manually).
- Managed Identity is enabled for both app services, required for accessing the Key Vault.
Always Onsettings have been enabled.
- An Azure Container Registry (opens new window) is also provisioned. The deployment pipeline packages the API apps as docker images and pushes to the container registry. The app services pull from it (using webhook notifications).
# Caching & Compression
An Azure CDN profile (opens new window) is provisioned with four endpoints, the first two using the hosted front-end apps (landing page & diagram editor) as origins and the other two pointing to the storage accounts (for icon SVGs & user-uploaded images).
In addition to caching at global POPs, content compression at POPs (opens new window) is also enabled.
# Subdomains & DNS records
All CDN endpoints have
<subdomain>.cloudskew.com custom domain hostnames enabled on them. This is facilitated by using Azure DNS (opens new window) to create CNAME records that map
<subdomain>.cloudskew.com to their CDN endpoint counterparts.
# HTTPS & TLS Certificates
Custom domain HTTPS is enabled and the TLS certificates are managed by Azure CDN itself (opens new window).
HTTP-to-HTTPS redirection is also enforced via CDN rules (opens new window).
# Externalized Configuration & Self-Bootstrapping
Azure Key Vault (opens new window) is used as a secure, external, central key-value store. This helps decouple back-end web API apps from their configuration settings (passwords, connection strings, endpoint urls, IP addresses, hostnames etc).
The web API apps have managed identities (opens new window) which are RBAC'ed for Key Vault access.
The web API apps self-bootstrap by reading their configuration settings from the Key Vault at startup. The handshake with the Key Vault is facilitated using the Key Vault Configuration Provider (opens new window).
# Queue-Based Load Leveling
Even after debouncing calls to the API, the volume of PUT (UPDATE) requests generated by auto-save feature causes the SQL Azure DB's DTU consumption (opens new window) to spike, resulting in service degradation. To smooth out this burst of requests, an Azure Service bus (opens new window) is used as an intermediate buffer. Instead of writing directly to the DB, the web API instead queues up all PUT requests into the service bus; to be drained asynchronously later.
An Azure Function app (opens new window) is responsible for serially dequeueing the brokered messages off the bus using the service bus trigger (opens new window). Once the function receives a peek-locked (opens new window) messages, it commits the PUT (UPDATE) to the SQL Azure DB. If the function fails to process any messages, the messages automatically gets pushed onto the service bus' dead-letter queue (opens new window). An Azure monitor alert is triggered when this happens.
The Azure Function app shares the same app service plan as the back-end web APIs (i.e. uses the dedicated app service plan (opens new window) instead of the regular consumption plan)
Overall this queue-based load-leveling pattern (opens new window) has helped plateau the load on the Sql Azure DB.
E.g. We're interested in tracking the names of icons that the users couldn't find in the icon palette (via the icon search box). This helps us add these frequently searched icons into the palette later on.
# Infrastructure Monitoring
Azure Portal Dashboards (opens new window) are used to visualize metrics from the various azure resources deployed by CloudSkew.
# Incident Management
- [Sev 0] 5xx errors in the web APIs required for printing/exporting diagrams.
- [Sev 1] 5xx errors in other CloudSkew web APIs
- [Sev 1] Any messages in the Service Bus' dead-letter queue.
- [Sev 2] Response time of web APIs crossing specified thresholds.
- [Sev 2] Spikes in DTU consumption in SQL Azure DBs.
- [Sev 3] Spikes in E2E latency for blob storage requests.
Metrics are evaluated/sampled at 15 mins frequency with 1 hr aggregation windows.
Currently, 100% of the incoming metrics are sampled. Over time, as usage grows, we'll start filtering out outliers at P99.
# Resource Provisioning
Terraform (opens new window) scripts are used to provision all of the Azure resources & services shown in the architecture diagram (storage accounts, app services, CDN, DNS zone, container registry, functions, sql server, service bus etc). Use of terraform allows us to easily achieve parity in dev, test & prod environments. Although these three environments are mostly identical clones of each other, there are some minor differences:
- Across the dev, test and prod environments, the app configuration data stored in the Key Vaults will have the same key names but different values. This helps apps to bootstrap accordingly.
- The dev environments are ephemeral, created on demand and are disposed when not in use.
- For cost reasons, smaller resource SKUs are used in dev & test environments (e.g. Basic/B 5 DTUs SQL Azure in test environment as compared to Standard/S0 20 DTU in production).
The Auth0 tenant has been set up manually since there are no terraform providers for it. However it looks like it might be possible to automate the provisioning using Auth0's Deploy CLI (opens new window).
CloudSkew's provisioning script are being migrated from terraform to pulumi (opens new window). This article will be updated as soon as the migration is complete.
# Continuous Integration
The source code is split across multiple private Azure Repos (opens new window). The "one repository per app" rule of thumb is enforced here. An app is deployed to dev, test & prod environments from the same repo.
Feature development & bug fixes happen in private/feature branches which are ultimately merged into master branches via pull requests.
Azure Pipelines (opens new window) are used for continuous integration: checkins are built, unit tested, packaged and deployed to the test environment. CI pipelines are automatically triggered both on pull request creation as well as checkins to master branches.
Azure pipelines' built-in tasks (opens new window) are heavily leveraged for deploying changes to azure app services, functions, storage accounts, container registry etc. Access to azure resource is authorized via service connections (opens new window).
# Deployment & Release
The deployment & release process is very simple at moment (blue-green deployments, canary deployments and feature flags are not being used). Checkins that pass the CI process become eligible for release to production environment.
Azure Pipelines deployment jobs (opens new window) are used to target the releases to production environment.
Manual approvals (opens new window) are used to authorize the releases.
# Future Architectural Changes
As more features will be added and as usage grows, some architectural enhancements will have to be considered:
- HA with multi-regional deployments and using Traffic Manager (opens new window) for routing traffic.
- Move to a higher App Service SKU to avail of slot swapping, horizontal auto-scaling etc.
- Use of caching in the back-end (Azure Cache for Redis (opens new window), ASP.NET's IMemoryCache (opens new window))
- Changes to the deployment & release model with blue-green deployments and adoption of feature flags etc.
- PowerBI/Grafana dashboard for tracking business KPIs.
Again, any of these enhancements will ultimately be need-driven.
# Closing Notes
CloudSkew is in very early stages of development and there are some simple thumb rules it abides by:
- Preferring PaaS/serverless over IaaS: Pay as you go, no server management overhead (aside: this is also why K8s clusters are not in the picture yet).
- Preferring microservices over monoliths: Individual lego blocks can be independently deployed & scaled up/out.
- Always keeping the infrastructure stable: Everything infra-related is automated: from provisioning to scaling to monitoring. An "it just works" infra helps maintain the core focus on user-facing features.
- Releasing Frequently: The goal is to rapidly go from idea -> development -> deployment -> release. Having ultra-simple CI, deployment & release processes go a long way in helping achieve that.
- No premature optimization: All changes for making things more "efficient" is done just-in-time and has to be need-driven (e.g: Redis cache is currently not required at the back-end since API response times are within acceptable thresholds).
When CloudSkew reaches critical mass in the future, this playbook will of course have to be modified.
Please feel free to email us in case you have any questions, comments or suggestions regarding this article. Happy Diagramming!