Skip to content

Commit ba164f4

Browse files
author
Lenny Chen
committed
docs: backport pause upgrades
1 parent 291e689 commit ba164f4

File tree

1 file changed

+72
-1
lines changed

1 file changed

+72
-1
lines changed

docs/docs-content/clusters/cluster-management/palette-lock-cluster.md

Lines changed: 72 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,78 @@ upgraded when Palette is upgraded. The use cases of this feature are:
2121
- Pause Updates for all the Clusters within the Project Scope
2222
- Pause Updates for all Clusters within the Tenant Scope
2323

24-
<br />
24+
:::info
25+
26+
This feature only pauses upgrades for Palette agents, not updates to the clusters themselves.
27+
28+
:::
29+
30+
### Pause Agent Upgrade Scopes
31+
32+
Agent upgrades can be paused and resumed in the following scopes:
33+
34+
- Pause agent upgrades for a single cluster
35+
- Pause agent upgrades for all clusters within a project
36+
- Pause agent upgrades for all clusters within a tenant
37+
38+
When determining if the agent upgrades for one cluster is paused or not, you only need to look at the setting for the
39+
cluster itself. Agent upgrade settings are always applied based on individual cluster settings. Project and tenant agent
40+
upgrade settings are not inherited - instead cluster level settings are set to match _each time_ project and tenant
41+
level settings are changed.
42+
43+
Pausing or resuming agent upgrades at a higher-level scope will automatically pause or resume agent upgrades in the
44+
lower-level scopes. For example, if you pause agent upgrades at the tenant level, then agent upgrades will be paused for
45+
all projects within that tenant, and all clusters within those projects. Similarly, if you resume upgrades at the
46+
project level, then all clusters within that project will have their agent upgrades resumed.
47+
48+
This is a one-time change that happens at the moment when you pause or resume upgrades in the project or tenant scope,
49+
and it does not mandate that the same setting be kept at the lower scopes. If you pause or resume agent upgrades in a
50+
lower-level scope, it will override the setting from the higher-level scope. For example, even if all agent upgrades are
51+
paused at the tenant level, you can override the tenant-level pause by resuming upgrades in a specific project or a
52+
specific cluster.
53+
54+
:::warning
55+
56+
Overrides of agent upgrade settings are not permanent. When the pause agent settings at the project or tenant scope
57+
change, the agent upgrade setting in the cluster or project scopes will always be set to match the higher-level scope
58+
setting regardless. If you want to override the project or tenant level agent upgrade setting, you must change the agent
59+
upgrade setting in the lower scope _after_ the change in the higher scope.
60+
61+
:::
62+
63+
The following table lists some example upgrade configurations and whether the Palette agent will be upgrades in those
64+
settings. Note that only the settings at the cluster level determines whether the Palette agent will be upgraded.
65+
66+
| Tenant | Project | Cluster | Outcome |
67+
| ---------------- | ---------------- | ---------------- | ----------------------------------------- |
68+
| Upgrades paused | Upgrades paused | Upgrades enabled | Palette agent will upgrade automatically. |
69+
| Upgrades enabled | Upgrades enabled | Upgrade paused | Palette agent upgrades are paused. |
70+
71+
### Agent Upgrades for PCG and Edge Hosts
72+
73+
Aside from clusters, you can also pause the agent upgrades on Private Cloud Gateways (PCG) and Edge hosts that are
74+
registered with Palette but are not part of a cluster.
75+
76+
Since PCGs are scoped to tenants, you can pause the agent upgrades on a PCG by pausing agent upgrades on the tenant to
77+
which the PCG is associated. You can also pause or resume upgrades for a PCG in the PCG details page through **Cluster
78+
Settings**. Similar to clusters, pausing and resuming upgrades at the tenant level will pause or resume agent upgrades
79+
for all PCGs in the tenant. Pausing and resuming upgrades for a PCG individually will override the tenant-level setting.
80+
81+
Edge hosts that are part of a cluster have their agent upgrades managed by the settings of their cluster. Edge hosts
82+
that are not part of a cluster have their agent upgrades managed at the project and tenant level. Similar to clusters,
83+
pausing or resuming agent upgrades at the tenant level will automatically pause or resume agent upgrades for all
84+
projects within that tenant. However, you can override the tenant level setting by manually changing the upgrade setting
85+
at the project level.
86+
87+
The following is a table showing the scopes at which you can pause agent upgrades for different objects. The same
88+
relationship between the scopes applies: Changing the setting in a higher scope will trigger a one-time change to the
89+
lower scopes, and changing the setting at the lower scope will override the setting in the higher scope.
90+
91+
| | Individual Cluster/PCG | Project | Tenant |
92+
| --------------- | ---------------------- | ------- | ------ |
93+
| Cluster ||||
94+
| PCG ||||
95+
| Idle Edge hosts ||||
2596

2697
### Pause Updates for Single Cluster
2798

0 commit comments

Comments
 (0)