Active development

CloudGrange Docs

CloudGrange is in active development. It is not GA and is not currently in Preview. Private Preview is coming soon. These docs describe work in progress.

Register interest Prerequisites GitHub Support →
Start here
Getting started
Install modes (Online / Bundled / Appliance / Azure PaaS), choose your path, and complete the first-run walkthrough.
Before you install
Prerequisites
Hardware, OS, network ports, and Azure RBAC requirements. No service principal or app registration needed for PaaS deployment.
Model B
Azure PaaS
azd up with Bicep. CAF-compliant naming and tagging, per-resource overrides, and bring-your-own existing Azure resources.
Model A
On-premises
Hyper-V VM + Docker Compose. Online / Bundled / Appliance modes. Installer self-bootstraps QEMU + IMAPI2.
Reference
REST API reference
Full endpoint reference with request/response schemas and curl examples for every API endpoint.
Reference
cs CLI reference
Command reference for cs cluster, cs module catalog, and cs platform update.
Reference
PowerShell reference
CloudGrangePS cmdlet reference — Connect-CloudGrange, Get-CSCluster, Install-CSModule, Update-CloudGrange, and more.
Modules
Module catalog
Browse the GHCR-based module catalog, install/uninstall modules, verify cosign signatures.
Reference
Configuration reference
All environment variables, appsettings.json keys, Docker Compose .env variables, and Azure PaaS parameters.
Security
Security and multi-tenancy
RBAC model, org_id isolation, Keycloak integration, and Key Vault secret references.
Reference
System requirements
Hardware, OS, nested-virtualization, ports, and network requirements for both deployment models.