HMC-337: Updated Azure Docs #7
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
p5ntangle
reviewed
Oct 7, 2024
PrashantR30
force-pushed
the
HMC-337
branch
2 times, most recently
from
52fe4fb
to
ab6dbea
Compare
PrashantR30
changed the title
a13x5
requested changes
Oct 14, 2024
There was a problem hiding this comment.
Cluster identity section should be rewritten.
Several notes on style.
One major note here:
Please don't use extra long lines in markdown. Use 75-80 columns rule, lines longer than that should be broke down. If there is no empty line between markdown will render it as a single line anyway (see other documents as a reference).
| @@ -158,5 +158,5 @@ placed to finish cluster deletion. | |||
| In case if have orphaned `AzureMachines` left you have to delete finalizers on | |||
| them manually after making sure that no VMs are present in Azure. | |||
|
|
|||
| *Note: since Azure admission prohibits orphaned objects mutation you'll have to | |||
| > **Important:**: since Azure admission prohibits orphaned objects mutation you'll have to | |||
There was a problem hiding this comment.
Please use proper syntax for call-outs. See markdown-callouts for more details.
| @@ -1,35 +1,9 @@ | |||
| # Azure provider | |||
| # Installations methods | |||
|
|
||
| Follow the [Hosted control plane](hosted-control-plane.md) guide to deploy | ||
| hosted control plane cluster on Azure. | ||
| - [Hosted Control Plane (Kosmotron) Guide](./hosted-control-plane.md) |
| 3. **Azure Account:** | ||
| Ensure you have access to an Azure account with the necessary permissions to manage resources. You will need to register specific resource providers, which are listed below. | ||
|
|
||
| ## Register Resource Providers |
There was a problem hiding this comment.
Should be h3, since it's a part of prerequisites section
| az provider register --namespace Microsoft.ManagedIdentity | ||
| az provider register --namespace Microsoft.Authorization | ||
| ``` | ||
| --- |
Comment on lines
+117
to
+148
| ## Azure Machine Parameters | ||
| To properly configure Azure VMs for your Kubernetes clusters, the following parameters allow you to define SSH access, VM size, root volume, and VM images. | ||
|
|
||
| ### SSH Access | ||
| You can pass an SSH public key to allow access to the cluster's VMs: | ||
|
|
||
| - For a **hosted control plane (CP)**, set the SSH key in the `.spec.config.sshPublicKey` field. | ||
| - For a **standalone control plane**, use `.spec.config.controlPlane.sshPublicKey` for control plane nodes and `.spec.config.worker.sshPublicKey` for worker nodes. | ||
|
|
||
| Ensure the SSH public key is encoded in base64 format before adding it to the configuration. | ||
|
|
||
| ### VM Size | ||
| Azure offers a variety of VM sizes suitable for different workloads. To view the available VM sizes for your location, run the following command: | ||
|
|
||
| ```bash | ||
| az vm list-sizes --location "<location>" -o table | ||
| ``` | ||
|
|
||
| Specify your desired VM size using the appropriate parameter: | ||
|
|
||
| - For a **hosted CP deployment**, use `.spec.config.vmSize`. | ||
| - For a **standalone CP, use** `.spec.config.controlPlane.vmSize` for control plane nodes and `.spec.config.worker.vmSize` for worker nodes. | ||
| Example VM size: Standard_A4_v2. | ||
|
|
||
| ### Root Volume Size | ||
| You can adjust the root volume size (in GB) of the VM using the following parameters: | ||
|
|
||
| - For **hosted CP**, use `.spec.config.rootVolumeSize`. | ||
| - For **standalone CP**, use `.spec.config.controlPlane.rootVolumeSize` for control plane nodes and `.spec.config.worker.rootVolumeSize` for worker nodes. | ||
|
|
||
| *Default value: 30 GB.* | ||
| > **Important:** The root volume size cannot be smaller than the root volume size defined in your chosen VM image. |
There was a problem hiding this comment.
This ought to be a quick-start guide. I believe copying the whole cluster parameters section here missing the point. Just reference cluster-parameters.md in case user needs more detail.
Comment on lines
+150
to
+158
| ### VM Image | ||
| You can define the image used for your VMs using the following parameters: | ||
|
|
||
| For a **hosted CP**, use `.spec.config.image`. | ||
| For a **standalone CP**, use `.spec.config.controlPlane.image` for control plane nodes and `.spec.config.worker.image` for worker nodes. | ||
|
|
||
| There are multiple ways to specify the VM image, such as using an image from the Azure Compute Gallery or Azure Marketplace. For detailed options, refer to the [CAPZ documentation](https://capz.sigs.k8s.io/self-managed/custom-images). | ||
|
|
||
| By default, the latest official CAPZ Ubuntu-based image is used unless otherwise specified. |
There was a problem hiding this comment.
Again since we have default, you can omit this section.
| - For **standalone CP**, use `.spec.config.controlPlane.rootVolumeSize` for control plane nodes and `.spec.config.worker.rootVolumeSize` for worker nodes. | ||
|
|
||
| *Default value: 30 GB.* | ||
| > **Important:** The root volume size cannot be smaller than the root volume size defined in your chosen VM image. |
| ``` | ||
|
|
||
|
|
||
| > **Important:** Save these credentials securely, as they will be used to create the `AzureClusterIdentity` and its secret, and should be treated like passwords. |
|
|
||
| ## Hosted Control Plane | ||
| For more advanced setups, follow the [Hosted Control Plane (Kosmotron) Guide](./hosted-control-plane.md) to configure a hosted control plane. | ||
| > **Note:** In this setup, all control plane components for managed clusters will reside within the management cluster, offering centralized control and easier management. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is the incremental development of Azure Docs resolving Mirantis/hmc#337
Preview is found at : https://prashantr30.github.io/project-2a-docs-2/