Skip to content

Commit 6b2994b

Browse files
achuribooksgithub-actions[bot]
achuribooks
and
github-actions[bot]
authored
docs: PEM-8924: Cluster Template Diff Editor (#8723)
* Small modifications; beginning work * Rough draft complete * Apply suggestions from code review * Optimised images with calibre/image-actions * Minor cleanup; small touchup for multiline variables * Adding repave information; separating review changes into tables for readability * Combining table into one --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent e0fd80c commit 6b2994b

File tree

6 files changed

+106
-59
lines changed

6 files changed

+106
-59
lines changed

‎docs/docs-content/cluster-templates/cluster-templates.md‎

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,9 @@ that define the governance stack. They reference existing cluster profiles and o
2626
and [macros](../clusters/cluster-management/macros.md), allowing you to deploy, manage, and scale a synchronized fleet
2727
of clusters with minimal effort while configuring environment-specific values where needed.
2828

29-
Cluster templates can be created at both the tenant and project scope. Cluster templates do not embed cluster profile
30-
and policy configurations but reference them as objects, allowing you to edit and replace them as needed.
31-
32-
Cluster templates can also be managed using the [API](/api/introduction).
29+
Cluster templates can be created and managed at both the tenant and project scope using the Palette UI or
30+
[API](/api/introduction). Cluster templates do not embed cluster profile and policy configurations but reference them as
31+
objects, allowing you to edit and replace them as needed.
3332

3433
![Diagram of cluster template architecture](/cluster-templates_diagram.webp)
3534

@@ -50,10 +49,10 @@ Once a cluster profile version is linked to a cluster template, that version of
5049

5150
To make changes to a linked cluster profile, you must
5251
[create a new version](../profiles/cluster-profiles/modify-cluster-profiles/version-cluster-profile.md) of the cluster
53-
profile and update the version referenced in the cluster template. This ensures that all clusters using the cluster
54-
template have identical software stacks, preventing configuration drift that can naturally occur with inline, on-the-fly
55-
updates, or by using varied cluster profile versions. Each cluster can be attached to only one cluster template at a
56-
time, further guarding against drift.
52+
profile and [update the version referenced](./modify-cluster-templates.md#update-cluster-profile-version) in the cluster
53+
template. This ensures that all clusters using the cluster template have identical software stacks, preventing
54+
configuration drift that can naturally occur with inline, on-the-fly updates, or by using different cluster profile
55+
versions. Each cluster can be attached to only one cluster template at a time, further guarding against drift.
5756

5857
A cluster profile version cannot be linked to a cluster template if that profile version is already being used by a
5958
cluster that is not attached to a cluster template.
@@ -66,9 +65,9 @@ are the best way to configure environment-specific values per cluster, such as I
6665

6766
Much like deploying clusters with individual cluster profiles, variable values are assigned and propagated when you
6867
deploy a cluster using a cluster template. Once the cluster is deployed, the variables appear on the **Variable values**
69-
tab of your cluster template with an **Assignment** status of **Assigned**.
68+
tab of your cluster template with an **Assignment** status of **Assigned** and the **Running value** listed.
7069

71-
![Variables with a status of Assigned](/cluster-templates_variables-assigned.webp)
70+
![Variables with a status of Assigned and running values](/cluster-templates_variables-assigned.webp)
7271

7372
Cluster templates help with the initial propagation of new variable values, but they are not the source of truth for
7473
ongoing variable management across clusters. The source of truth remains the cluster profile, which defines the schema,
@@ -83,16 +82,16 @@ For information on modifying cluster profile variables post-cluster deployment,
8382
### Cluster Profile vs. Cluster Template Deployment
8483

8584
You can deploy clusters using cluster profiles or cluster templates, which encapsulate cluster profiles. If you plan on
86-
deploying a large number of clusters that use the same software stack and ensure the clusters update together, consider
87-
using cluster templates.
85+
deploying a large number of clusters that use the same software stack and want to ensure the clusters update together,
86+
consider using cluster templates.
8887

8988
The following table compares and contrasts how to update cluster profiles and cluster profile variables depending on
9089
whether your cluster is deployed using individual cluster profiles or a cluster template.
9190

92-
| **Update Type** | **Cluster Profile Workflow** | **Cluster Template Workflow** |
93-
| ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
94-
| **Cluster profiles** | - Initiate updates on a per-cluster basis by selecting a [new cluster profile version](../clusters/cluster-management/cluster-updates.md#enablement) for each cluster or making on-the-fly changes to a cluster. <br / > - Routine, automatic updates are not supported. | - [Update the cluster profile version](./modify-cluster-templates.md#cluster-profiles) in the cluster template. All clusters deployed with the template are updated during the next update window specified by the [maintenance policy](./create-cluster-template-policies/maintenance-policy.md) or by [manually triggering the update](./modify-cluster-templates.md#overview-tab) for all clusters. <br /> - Updating the cluster profile version for a single cluster or making on-the-fly changes to a cluster is not supported. |
95-
| **Cluster profile variables** | - Specify initial values during cluster deployment. <br /> - Edit variable values for _individual clusters_ within [cluster settings](../profiles/cluster-profiles/create-cluster-profiles/define-profile-variables/modify-cluster-profile-variables.md#modify-profile-variable-values-in-an-active-cluster). Values are updated in real time. <br /> - To add or remove variables, or update the schema, [create a new version of the cluster profile](../profiles/cluster-profiles/modify-cluster-profiles/version-cluster-profile.md), and manually [update the version](../clusters/cluster-management/cluster-updates.md#enablement) on each cluster. Values are modified and confirmed at this step. <br /> - Batch updates for multiple clusters using the same profile are not supported. | - Specify initial values during cluster deployment. <br /> - Edit variable values for _individual clusters_ within [cluster settings](../profiles/cluster-profiles/create-cluster-profiles/define-profile-variables/modify-cluster-profile-variables.md#modify-profile-variable-values-in-an-active-cluster). Values are updated in real time. <br /> - To add or remove variables, update a schema, or update a value across _multiple clusters_, [create a new version of the cluster profile](../profiles/cluster-profiles/modify-cluster-profiles/version-cluster-profile.md), and [update the cluster profile version](./modify-cluster-templates.md#cluster-profiles) referenced in the cluster template. Next, update the [**Variable values**](modify-cluster-templates.md#variable-values-tab) for all applicable clusters. Once all values have a status of **Assigned**, all clusters deployed with the template are updated during the next update window specified by the [maintenance policy](./create-cluster-template-policies/maintenance-policy.md) or by [manually triggering the update](./modify-cluster-templates.md#overview-tab) for all clusters. |
91+
| **Update Type** | **Cluster Profile Workflow** | **Cluster Template Workflow** |
92+
| ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
93+
| **Cluster profiles** | **Options** <br />- Initiate updates on a per-cluster basis by selecting a [new cluster profile version](../clusters/cluster-management/cluster-updates.md#enablement) for each cluster or making on-the-fly changes to a cluster. <br / > <br /> **Not Supported** <br /> - Routine, automatic updates. | **Options** <br /> - [Update the cluster profile version](./modify-cluster-templates.md#cluster-profiles) in the cluster template. All clusters deployed with the template are updated during the next update window specified by the [maintenance policy](./create-cluster-template-policies/maintenance-policy.md) or by [manually triggering the update](./modify-cluster-templates.md#overview-tab) for all clusters. <br /> <br /> **Not Supported** <br /> - Updating the cluster profile version for a single cluster. <br /> - Making on-the-fly changes to a cluster. |
94+
| **Cluster profile variables** | **Options** <br /> - Specify initial values during cluster deployment. <br /> - Edit variable values for _individual clusters_ within [cluster settings](../profiles/cluster-profiles/create-cluster-profiles/define-profile-variables/modify-cluster-profile-variables.md#modify-profile-variable-values-in-an-active-cluster). Values are updated in real time. <br /> - To add or remove variables, or update the schema, [create a new version of the cluster profile](../profiles/cluster-profiles/modify-cluster-profiles/version-cluster-profile.md), and manually [update the version](../clusters/cluster-management/cluster-updates.md#enablement) on each cluster. Values are modified and confirmed at this step. <br /> <br /> **Not Supported** <br /> - Batch updates for multiple clusters using the same profile. | **Options** <br /> - Specify initial values during cluster deployment. <br /> - Edit variable values for _individual clusters_ within [cluster settings](../profiles/cluster-profiles/create-cluster-profiles/define-profile-variables/modify-cluster-profile-variables.md#modify-profile-variable-values-in-an-active-cluster). Values are updated in real time. <br /> - To add or remove variables, update a schema, or update a value across _multiple clusters_, [create a new version of the cluster profile](../profiles/cluster-profiles/modify-cluster-profiles/version-cluster-profile.md), and [update the cluster profile version](./modify-cluster-templates.md#cluster-profiles) referenced in the cluster template. Next, update the [**Variable values**](modify-cluster-templates.md#variable-values-tab) for all applicable clusters. Once all values have a status of **Assigned**, all clusters deployed with the template are updated during the next update window specified by the [maintenance policy](./create-cluster-template-policies/maintenance-policy.md) or by [manually triggering the update](./modify-cluster-templates.md#overview-tab) for all clusters. |
9695

9796
## Policy Behavior
9897

0 commit comments

Comments
 (0)