Document autoscale for Azure IaaS and refactor the doc #1798
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
ritawatson
changed the title
ritawatson
requested review from
karl-cardenas-coding,
addetz and
lennessyy
and removed request for
a team
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
docs/docs-content/clusters/public-cloud/azure/create-azure-cluster.md
Outdated
Show resolved
Hide resolved
docs/docs-content/clusters/public-cloud/azure/create-azure-cluster.md
Outdated
Show resolved
Hide resolved
docs/docs-content/clusters/public-cloud/azure/create-azure-cluster.md
Outdated
Show resolved
Hide resolved
docs/docs-content/clusters/public-cloud/azure/create-azure-cluster.md
Outdated
Show resolved
Hide resolved
docs/docs-content/clusters/public-cloud/azure/create-azure-cluster.md
Outdated
Show resolved
Hide resolved
ritawatson
added
auto-backport
ritawatson
changed the title
karl-cardenas-coding
requested changes
Nov 22, 2023
docs/docs-content/clusters/public-cloud/azure/create-azure-cluster.md
Outdated
Show resolved
Hide resolved
docs/docs-content/clusters/public-cloud/azure/create-azure-cluster.md
Outdated
Show resolved
Hide resolved
docs/docs-content/clusters/public-cloud/azure/create-azure-cluster.md
Outdated
Show resolved
Hide resolved
| |**Account Name**| A custom account name.| | ||
| |**Tenant ID**| Unique tenant ID from Azure Management Portal.| | ||
| |**Client ID**| Unique client ID from Azure Management Portal.| | ||
| |**Client Secret**| Azure secret for authentication. Refer to Microsoft's reference guide for creating a [Client Secret](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#create-an-azure-active-directory-application) | |
There was a problem hiding this comment.
There is a validate button right next to the credentials. We need to mention this.
| 2. Click on **Clusters** from the left **Main Menu**. | ||
| If you need help creating a custom storage account or container, check out the [Create a Storage Account](https://learn.microsoft.com/en-us/azure/storage/common/storage-account-create?tabs=azure-portal) guide or the [Manage Blob Containers](https://learn.microsoft.com/en-us/azure/storage/blobs/blob-containers-portal). | ||
|
|
||
| - If you do not provide your own Virtual Network (VNet), Palette creates one for you with compute, network, and storage resources in Azure when it provisions Kubernetes clusters. Ensure there is sufficient capacity in the preferred Azure region to create the following resources. Note that Palette does not create these resources if you specify an existing VNet. |
There was a problem hiding this comment.
This feels a bit odd. If the user does not need to provide a VNet, then it's not a prerequisite.
There was a problem hiding this comment.
Similar wording is used/approved in the refactored AWS EKS. I think it needs to be a prereq. in the event the user doesn't provide their own VNet. I've removed the last sentence and slightly reworded to clarify:
docs/docs-content/clusters/public-cloud/azure/create-azure-cluster.md
Outdated
Show resolved
Hide resolved
docs/docs-content/clusters/public-cloud/azure/create-azure-cluster.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Karl Cardenas <karl@spectrocloud.com>
|
|
||
| For this, we first need to create an Azure Active Directory (AAD) Application which can be used with role-based access control. Follow the steps below to create a new AAD application, assign roles, and create the client secret: | ||
| When you disable network calls from Palette, you need to create a [Microsoft Entra](https://learn.microsoft.com/en-us/entra/) application, which can be used with Role-Based Access Control (RBAC). Follow the summary steps below to create a new Microsoft Entra application, assign roles, and create the client secret. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Entra'?
|
|
||
| For this, we first need to create an Azure Active Directory (AAD) Application which can be used with role-based access control. Follow the steps below to create a new AAD application, assign roles, and create the client secret: | ||
| When you disable network calls from Palette, you need to create a [Microsoft Entra](https://learn.microsoft.com/en-us/entra/) application, which can be used with Role-Based Access Control (RBAC). Follow the summary steps below to create a new Microsoft Entra application, assign roles, and create the client secret. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Entra'?
|
|
||
| Azure autoscale allows you to provision nodes to support the demand of your application. Within Azure, you can add resources to handle increases in load or scale back resources when they are not needed. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'autoscale'?
|
|
||
| 6. Type in the name of the cluster and click on **OK** | ||
| Azure autoscale allows you to provision nodes to support the demand of your application. Azure VMs autoscale using virtual machine **scale sets**, or virtual machine pool. Within Azure, you can scale out VMs to handle increases in load or scale in VMs when they are not needed. For more information, review Microsoft's [Overview of autoscale in Azure](https://learn.microsoft.com/en-us/azure/azure-monitor/autoscale/autoscale-overview). |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'autoscale'?
|
|
||
| 6. Type in the name of the cluster and click on **OK** | ||
| Azure autoscale allows you to provision nodes to support the demand of your application. Azure VMs autoscale using virtual machine **scale sets**, or virtual machine pool. Within Azure, you can scale out VMs to handle increases in load or scale in VMs when they are not needed. For more information, review Microsoft's [Overview of autoscale in Azure](https://learn.microsoft.com/en-us/azure/azure-monitor/autoscale/autoscale-overview). |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'autoscale'?
|
|
||
| 6. Type in the name of the cluster and click on **OK** | ||
| Azure autoscale allows you to provision nodes to support the demand of your application. Azure VMs autoscale using virtual machine **scale sets**, or virtual machine pool. Within Azure, you can scale out VMs to handle increases in load or scale in VMs when they are not needed. For more information, review Microsoft's [Overview of autoscale in Azure](https://learn.microsoft.com/en-us/azure/azure-monitor/autoscale/autoscale-overview). |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'autoscale'?
|
|
||
| <br /> | ||
| To use Autoscale capability, you must log in to the [Azure Portal](https://portal.azure.com/#home) and create a VM and a VM scale set. To learn how to create a scale set in Azure, review [Create virtual machines in a scale set using Azure portal](https://learn.microsoft.com/en-us/azure/virtual-machine-scale-sets/flexible-virtual-machine-scale-sets-portal). |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Autoscale'?
|
|
||
| Basic autoscaling options are available for host-based scaling when you create your scale set. To create custom autoscale rules based on schedule or metrics, you need to use Custom Autoscale. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'autoscale'?
|
|
||
| Basic autoscaling options are available for host-based scaling when you create your scale set. To create custom autoscale rules based on schedule or metrics, you need to use Custom Autoscale. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Autoscale'?
|
|
||
| A force delete can result in resources Palette provisioned being missed in the removal process. Verify there are no remaining Palette provisioned resources such as: | ||
| Once you create your VM scale set, you can find Autoscale under the **Monitor** service, the **Resource Groups** service, or by searching *Autoscale*. To learn how you can scale resources based on metrics you define, refer to Microsoft's [Get started with Autoscale in Azure](https://learn.microsoft.com/en-us/azure/azure-monitor/autoscale/autoscale-get-started) reference guide. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Autoscale'?
|
|
||
| A force delete can result in resources Palette provisioned being missed in the removal process. Verify there are no remaining Palette provisioned resources such as: | ||
| Once you create your VM scale set, you can find Autoscale under the **Monitor** service, the **Resource Groups** service, or by searching *Autoscale*. To learn how you can scale resources based on metrics you define, refer to Microsoft's [Get started with Autoscale in Azure](https://learn.microsoft.com/en-us/azure/azure-monitor/autoscale/autoscale-get-started) reference guide. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Autoscale'?
|
|
||
| 3. Click on the cluster that you want to remove. | ||
| Azure autoscale allows you to provision nodes to support the demand of your application. Azure VMs autoscale using a *virtual machine scale set*. The scale set serves as a virtual machine pool. Within [Azure Portal](https://portal.azure.com/#home), you can scale out VMs to handle increases in load or scale in VMs when they are not needed. For more information, review Microsoft's [Overview of autoscale in Azure](https://learn.microsoft.com/en-us/azure/azure-monitor/autoscale/autoscale-overview). |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'autoscale'?
|
|
||
| 3. Click on the cluster that you want to remove. | ||
| Azure autoscale allows you to provision nodes to support the demand of your application. Azure VMs autoscale using a *virtual machine scale set*. The scale set serves as a virtual machine pool. Within [Azure Portal](https://portal.azure.com/#home), you can scale out VMs to handle increases in load or scale in VMs when they are not needed. For more information, review Microsoft's [Overview of autoscale in Azure](https://learn.microsoft.com/en-us/azure/azure-monitor/autoscale/autoscale-overview). |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'autoscale'?
|
|
||
| 3. Click on the cluster that you want to remove. | ||
| Azure autoscale allows you to provision nodes to support the demand of your application. Azure VMs autoscale using a *virtual machine scale set*. The scale set serves as a virtual machine pool. Within [Azure Portal](https://portal.azure.com/#home), you can scale out VMs to handle increases in load or scale in VMs when they are not needed. For more information, review Microsoft's [Overview of autoscale in Azure](https://learn.microsoft.com/en-us/azure/azure-monitor/autoscale/autoscale-overview). |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'autoscale'?
|
|
||
| 4. Click on the **Settings** drop-down menu. | ||
| When using Autoscale capability, |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Autoscale'?
|
|
||
| The cluster status is updated to **Deleting** while cluster resources are being deleted. Once all resources are successfully deleted, the cluster status is updated to **Deleted** and is removed from the list of clusters. | ||
| Basic autoscaling options are available for host-based scaling when you create your scale set. Use **Custom autoscale** to create custom autoscale rules based on metrics or a schedule. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'autoscale'?
|
|
||
| :::caution | ||
| To learn how you can scale resources based on metrics you define, refer to Microsoft's [Get started with Autoscale in Azure](https://learn.microsoft.com/en-us/azure/azure-monitor/autoscale/autoscale-get-started) reference guide. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Autoscale'?
|
|
||
| A force delete can result in resources Palette provisioned being missed in the removal process. Verify there are no remaining Palette provisioned resources such as: | ||
| A [Microsoft video](https://learn.microsoft.com/en-us/azure/azure-monitor/autoscale/autoscale-get-started?WT.mc_id=Portal-Microsoft_Azure_Monitoring#discover-the-autoscale-settings-in-your-subscription) in [Get started with Autoscale in Azure](https://learn.microsoft.com/en-us/azure/azure-monitor/autoscale/autoscale-get-started) recommends for every scale rule you add to scale out resources, a matching rule should be added to scale in when the resources are no longer needed. This best practice avoids extra costs that could be incurred for unused provisioned resources. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Autoscale'?
|
Images automagically compressed by Calibre's image-actions ✨ Compression reduced images by 37.1%, saving 124.44 KB.
507 images did not require optimisation. |
|
|
||
| 3. Click on the cluster that you want to remove. | ||
| Azure Autoscale allows you to provision nodes to support workload demand on your application. Within [Azure Portal](https://portal.azure.com/#home), you can scale out VMs to handle increases in load or scale in VMs when they are not needed. Azure VMs autoscale using a *virtual machine scale set*, which you create. The scale set serves as a virtual machine pool. For more information, review Microsoft's [Overview of Autoscale in Azure](https://learn.microsoft.com/en-us/azure/azure-monitor/autoscale/autoscale-overview). |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Autoscale'?
|
|
||
| 3. Click on the cluster that you want to remove. | ||
| Azure Autoscale allows you to provision nodes to support workload demand on your application. Within [Azure Portal](https://portal.azure.com/#home), you can scale out VMs to handle increases in load or scale in VMs when they are not needed. Azure VMs autoscale using a *virtual machine scale set*, which you create. The scale set serves as a virtual machine pool. For more information, review Microsoft's [Overview of Autoscale in Azure](https://learn.microsoft.com/en-us/azure/azure-monitor/autoscale/autoscale-overview). |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'autoscale'?
|
|
||
| 3. Click on the cluster that you want to remove. | ||
| Azure Autoscale allows you to provision nodes to support workload demand on your application. Within [Azure Portal](https://portal.azure.com/#home), you can scale out VMs to handle increases in load or scale in VMs when they are not needed. Azure VMs autoscale using a *virtual machine scale set*, which you create. The scale set serves as a virtual machine pool. For more information, review Microsoft's [Overview of Autoscale in Azure](https://learn.microsoft.com/en-us/azure/azure-monitor/autoscale/autoscale-overview). |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Autoscale'?
|
|
||
| 4. Click on the **Settings** drop-down menu. | ||
| To use Custom Autoscale capability, the following applies regarding scale sets: |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Autoscale'?
|
|
||
| - Custom Autoscale requires the creation of a virtual machine scale set. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Autoscale'?
|
|
||
| ## Force Delete a Cluster | ||
| Basic autoscaling options are available for host-based scaling when you create your scale set. However, to create custom autoscale rules based on metrics or a schedule, use **Custom autoscale**. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'autoscale'?
|
|
||
| :::caution | ||
|
|
||
| A [Microsoft video](https://learn.microsoft.com/en-us/azure/azure-monitor/autoscale/autoscale-get-started?WT.mc_id=Portal-Microsoft_Azure_Monitoring#discover-the-autoscale-settings-in-your-subscription) in [Get started with Autoscale in Azure](https://learn.microsoft.com/en-us/azure/azure-monitor/autoscale/autoscale-get-started) recommends adding matching scale-in and scale-out rules to avoid extra costs that could be incurred for unused provisioned resources. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Autoscale'?
|
|
||
| ::: | ||
|
|
||
| ## Validate | ||
| To learn how you can scale resources based on metrics you define, refer to Microsoft's [Get started with Autoscale in Azure](https://learn.microsoft.com/en-us/azure/azure-monitor/autoscale/autoscale-get-started) reference guide. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Autoscale'?
ritawatson
added
do-not-merge/work-in-progress
karl-cardenas-coding
approved these changes
Dec 22, 2023
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
|
Closing this PR as #1857 carries over the work. |
karl-cardenas-coding
deleted the
azure-missing-autoscaler-and-refactor
branch
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.
Describe the Change
This PR provides missing autoscaler information in the Azure IaaS doc and refactors the doc. Because the doc refers to a couple of related docs, this PR also makes wording improvements to the Register and Manage Azure Account and Cluster Removal docs.
Review Changes
💻 Preview URL
🎫 DOC-897