From 10a3c4ff9490b66ad88d98dbc810029557d9a350 Mon Sep 17 00:00:00 2001
From: Aleksei Sizov <asizov@mirantis.com>
Date: Thu, 29 Aug 2024 16:35:49 -0500
Subject: [PATCH] Add Azure template docs

---
 README.md                        |  1 +
 docs/azure/machine-parameters.md | 61 ++++++++++++++++++++++++++++++++
 docs/azure/main.md               | 35 ++++++++++++++++++
 3 files changed, 97 insertions(+)
 create mode 100644 docs/azure/machine-parameters.md
 create mode 100644 docs/azure/main.md

diff --git a/README.md b/README.md
index 916c32164..bfbc0990f 100644
--- a/README.md
+++ b/README.md
@@ -36,6 +36,7 @@ Optionally, the following CLIs may be helpful:
 
 Follow the instruction to configure providers. Currently supported providers:
 * [AWS](docs/aws/main.md#prepare-the-aws-infra-provider)
+* [Azure](docs/azure/main.md)
 
 ### Installation
 
diff --git a/docs/azure/machine-parameters.md b/docs/azure/machine-parameters.md
new file mode 100644
index 000000000..9d3e3122d
--- /dev/null
+++ b/docs/azure/machine-parameters.md
@@ -0,0 +1,61 @@
+# Azure machine parameters
+
+## SSH
+
+SSH public key can be passed to `.spec.config.sshPublicKey` (in case of hosted CP)
+parameter or `.spec.config.controlPlane.sshPublicKey` and
+`.spec.config.worker.sshPublicKey` parameters (in case of standalone CP)
+of the `Deployment` object.
+
+It should be encoded in **base64** format.
+
+## VM size
+
+Azure supports various VM sizes which can be retrieved with the following
+command:
+
+```bash
+az vm list-sizes --location "<location>" -o table
+```
+
+Then desired VM size could be passed to the:
+
+- `.spec.config.vmSize` - for hosted CP deployment.
+- `.spec.config.controlPlane.vmSize` - for control plane nodes in the standalone
+  deployment.
+- `.spec.config.worker.vmSize` - for worker nodes in the standalone deployment.
+
+*Example: Standard_A4_v2*
+
+## Root Volume size
+
+Root volume size of the VM (in GB) can be changed through the following
+parameters:
+
+- `.spec.config.rootVolumeSize` - for hosted CP deployment.
+- `.spec.config.controlPlane.rootVolumeSize` - for control plane nodes in the
+  standalone deployment.
+- `.spec.config.worker.rootVolumeSize` - for worker nodes in the standalone
+  deployment.
+
+*Default value: 30*
+
+Please note that this value can't be less than size of the root volume which
+defined in your image.
+
+## VM Image
+
+You can define the image which will be used for you machine using the following
+parameters:
+
+- `.spec.config.image` - for hosted CP deployment.
+- `.spec.config.controlPlane.image` - for control plane nodes in the standalone
+  deployment.
+- `.spec.config.worker.image` - for worker nodes in the standalone deployment.
+
+There are multiple self-excluding ways to define the image source (e.g. Azure
+Compute Gallery, Azure Marketplace, etc.).
+
+Detailed information regarding image can be found in [CAPZ documentation](https://capz.sigs.k8s.io/self-managed/custom-images)
+
+By default, the latest official CAPZ Ubuntu based image is used.
diff --git a/docs/azure/main.md b/docs/azure/main.md
new file mode 100644
index 000000000..0560d3b99
--- /dev/null
+++ b/docs/azure/main.md
@@ -0,0 +1,35 @@
+# Azure provider
+
+## Prerequisites
+
+1. `kubectl` CLI installed locally.
+2. `az` CLI utility installed (part of `azure-cli`).
+3. Azure account with the required resource providers registered.
+
+## Resource providers registration
+
+The following resource providers should be registered in your Azure account:
+
+- `Microsoft.Compute`
+- `Microsoft.Network`
+- `Microsoft.ContainerService`
+- `Microsoft.ManagedIdentity`
+- `Microsoft.Authorization`
+
+You can follow the [official documentation guide](https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/resource-providers-and-types)
+to register the providers.
+
+## Azure cluster parameters
+
+Follow the [Azure cluster parameters](cluster-parameters.md) guide to setup
+mandatory parameters for Azure clusters.
+
+## Azure machine parameters
+
+Follow the [Azure machine parameters](machine-parameters.md) guide if you want to
+setup/modify the default machine parameters.
+
+## Azure hosted control plane
+
+Follow the [Hosted control plane](hosted-control-plane.md) guide to deploy
+hosted control plane cluster on Azure.