docs: add cluster templates tutorial skeleton DOC-2542 #9513
+115
−0
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| { | ||
| "label": "Cluster Templates", | ||
| "position": 10 | ||
| } |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,110 @@ | ||||||
| --- | ||||||
| sidebar_position: 0 | ||||||
| sidebar_label: "Standardize Clusters with Cluster Templates" | ||||||
| title: "Standardize Cluster Provisioning and Maintenance with Cluster Templates" | ||||||
| description: | ||||||
| "A tutorial that shows how to standardize cluster provisioning, apply maintenance windows, and roll out upgrades using | ||||||
| cluster templates and Terraform." | ||||||
| tags: ["cluster templates", "tutorial", "terraform", "profiles", "aws", "azure"] | ||||||
| --- | ||||||
|
|
||||||
| When you manage many Kubernetes clusters, configuring and upgrading them one by one does not scale. You need a way to | ||||||
| apply the same configuration and upgrade rules across multiple clusters. | ||||||
|
|
||||||
| Palette supports this workflow with **cluster templates**. Cluster templates let you reuse a cluster configuration, | ||||||
| control when upgrades happen, and apply changes to multiple clusters at once. | ||||||
|
|
||||||
| Cluster templates are built from two related concepts: | ||||||
|
|
||||||
| - [Cluster profiles](../../../../../profiles/cluster-profiles/create-cluster-profiles/), which define the software stack | ||||||
| and infrastructure configuration of a cluster. | ||||||
| - [Cluster template policies](../../../cluster-templates/create-cluster-template-policies/create-cluster-template-policies.md), | ||||||
| which define how clusters created from a template are operated, such as when upgrades are allowed to run. | ||||||
|
Contributor
There was a problem hiding this comment. I'm confused about the term "operated" here. Perhaps you mean managed or maintained? |
||||||
|
|
||||||
| A [maintenance policy](../../../cluster-templates/create-cluster-template-policies/maintenance-policy.md) is one type of | ||||||
| cluster template policy. Maintenance policies define a maintenance window that controls when upgrades can run. | ||||||
| Currently, maintenance policies are the only cluster template policy type available in Palette. | ||||||
|
|
||||||
| Cluster templates link cluster profiles and policies. When you create clusters from the same template, those clusters | ||||||
| share the same base configuration and follow the same operational rules. | ||||||
|
|
||||||
| In this tutorial, you will: | ||||||
|
|
||||||
| - Create a cluster profile | ||||||
| - Create a cluster template policy | ||||||
| - Create a cluster template that uses the profile and policy | ||||||
|
Comment on lines
+33
to
+35
Contributor
There was a problem hiding this comment. Can we collapse these 3 lines into 1 so there is less repetition? |
||||||
| - Deploy two clusters (**dev** and **prod**) from the same template | ||||||
| - Use different | ||||||
|
Contributor
There was a problem hiding this comment.
Suggested change
|
||||||
| [cluster profile variables](../../../../../profiles/cluster-profiles/create-cluster-profiles/define-profile-variables/) | ||||||
| to apply environment-specific settings | ||||||
| - Update the template and upgrade both clusters together | ||||||
|
Contributor
There was a problem hiding this comment.
Suggested change
Contributor
There was a problem hiding this comment. It's not really going to happen together. |
||||||
|
|
||||||
| Cluster templates can be used across all supported environments in Palette. This tutorial demonstrates two workflows: | ||||||
|
Contributor
There was a problem hiding this comment.
Suggested change
|
||||||
| [Palette UI on AWS](#provision-and-upgrade-clusters-using-the-palette-ui-for-aws) and | ||||||
| [Terraform on AWS or Azure](#provision-and-upgrade-clusters-using-terraform). Choose the workflow that fits your | ||||||
| preferred way of working. | ||||||
|
|
||||||
| ## Prerequisites | ||||||
|
|
||||||
| - A Palette account with permission to create cluster profiles, cluster template policies, cluster templates, and | ||||||
|
Contributor
There was a problem hiding this comment.
Suggested change
|
||||||
| clusters. | ||||||
| - A cloud account registered in Palette. Refer to [AWS](../../../clusters/public-cloud/aws/add-aws-accounts.md) for the | ||||||
| Palette UI workflow, or [AWS](../../../clusters/public-cloud/aws/add-aws-accounts.md) and | ||||||
| [Azure](../../../clusters/public-cloud/azure/azure-cloud.md) for the Terraform workflow. | ||||||
|
Comment on lines
+51
to
+53
Contributor
There was a problem hiding this comment. Again, this looks like we only support AWS and Azure. You need to provide steps for AWS, Azure, GCP and VMware. Use the setup page in Getting Started. Also, you don't need to separate the cloud account prereqs between UI and TF at this point. |
||||||
| - Ensure that the | ||||||
| [Palette Community Registry](../../../registries-and-packs/registries/registries.md#default-registries) is available | ||||||
| in your Palette environment. | ||||||
|
|
||||||
| If you plan to use Terraform: | ||||||
|
|
||||||
| - Terraform version 1.x installed. | ||||||
| - A [Palette API key](../../getting-started/palette/aws/setup.md#create-a-palette-api-key) set as an environment | ||||||
| variable. | ||||||
|
|
||||||
| ## Provision and Upgrade Clusters Using the Palette UI for AWS | ||||||
|
|
||||||
| ### Import a Cluster Profile | ||||||
|
|
||||||
| ### Create a Cluster Template Policy (Maintenance) | ||||||
|
|
||||||
| ### Create a Cluster Template | ||||||
|
|
||||||
| ### Deploy a Dev Cluster from the Template | ||||||
|
|
||||||
| ### Deploy a Prod Cluster from the Template | ||||||
|
|
||||||
| ### Validate the Deployments | ||||||
|
|
||||||
| ### Create a New Cluster Profile Version | ||||||
|
|
||||||
| ### Update the Cluster Template to the New Profile Version | ||||||
|
|
||||||
| ### Upgrade Clusters | ||||||
|
|
||||||
| ### Validate the Upgrades | ||||||
|
|
||||||
| ### Cleanup | ||||||
|
|
||||||
| ## Provision and Upgrade Clusters Using Terraform | ||||||
|
|
||||||
| ### Configure the Terraform Provider | ||||||
|
|
||||||
| ### Create a Cluster Profile | ||||||
|
|
||||||
| ### Create a Cluster Template Policy (Maintenance) | ||||||
|
|
||||||
| ### Create a Cluster Template | ||||||
|
|
||||||
| ### Deploy Dev and Prod Clusters with Different Variable Values | ||||||
|
|
||||||
| ### Validate the Deployments | ||||||
|
|
||||||
| ### Create a New Cluster Profile Version | ||||||
|
|
||||||
| ### Update the Cluster Template to the New Profile Version | ||||||
|
|
||||||
| ### Upgrade Clusters | ||||||
|
|
||||||
| ### Validate the Upgrades | ||||||
|
|
||||||
| ### Cleanup | ||||||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We use bold for UI elements.