Skip to content

Commit 90392a6

Browse files
benradstonevault-token-factory-spectrocloud[bot]achuribooks
authored
DOC-2024 - Management Appliance Upgrade Steps (#7804)
* docs: Management Appliance Upgrade Journey * docs: upgrade journey progress * docs: finalise upgrade steps draft * docs: additional upgrade steps and tuning * docs: missed props.version inclusion * docs: move upgrade guidance to new pages * docs: Vale suggestions * Optimised images with calibre/image-actions * docs: missed admonition * Optimised images with calibre/image-actions * Optimised images with calibre/image-actions * Optimised images with calibre/image-actions * Optimised images with calibre/image-actions * Optimised images with calibre/image-actions * Optimised images with calibre/image-actions * Optimised images with calibre/image-actions * Optimised images with calibre/image-actions * docs: Apply suggestions from code review Co-authored-by: Amanda Churi Filanowski <[email protected]> * docs: final code review comments * docs: fix tab groups --------- Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com> Co-authored-by: Amanda Churi Filanowski <[email protected]>
1 parent 2f3853b commit 90392a6

14 files changed

+593
-48
lines changed

‎_partials/self-hosted/management-appliance/_upgrade-palette-enablement.mdx‎

Lines changed: 401 additions & 0 deletions
Large diffs are not rendered by default.

‎_partials/self-hosted/management-appliance/_upgrade-palette-prereqs.mdx‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
partial_category: self-hosted
3+
partial_name: upgrade-palette-prereqs
4+
---
5+
6+
- A healthy {props.version} management cluster where you can access the Local UI of the leader node.
7+
8+
- Verify that your local machine can access the Local UI, as airgapped environments may have strict network policies preventing direct access.
9+
10+
- If using an external registry, ensure your local machine has access to the external registry server and you have the necessary permissions to push images to the registry.
11+
12+
- (Optional) The Palette CLI installed on your local machine if you would like to use it to upload content to your external registry. Refer to the <VersionedLink text="Palette CLI" url="/automation/palette-cli"/> guide for installation instructions.
13+
14+
- Access to the [Artifact Studio](https://artifact-studio.spectrocloud.com/) to download the content bundle for {props.version}.
15+
16+
- Check that your upgrade path is supported by referring to the <PaletteVertexUrlMapper edition={props.edition} text="Supported Upgrade Paths" url="/upgrade#supported-upgrade-paths"/>.

‎_partials/self-hosted/management-appliance/_upgrade-palette-validate.mdx‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
partial_category: self-hosted
3+
partial_name: upgrade-palette-validate
4+
---
5+
6+
1. Log in to the Local UI of the leader host of the {props.version} management cluster. By default, Local UI is accessible at `https://<node-ip>:5080`. Replace `<node-ip>` with the IP address of the leader host.
7+
8+
2. From the left main menu, click **Cluster**.
9+
10+
3. Check that the `palette-mgmt-plane` pack displays the upgraded version number and is in a **Running** status.
11+
12+
4. Verify that you can log in to the {props.version} system console and no warning message is displayed.
13+
14+
5. If you have configured a tenant, log in to the tenant console and verify that Palette displays the correct version number.
15+
16+
![Palette version in tenant console](/enterprise-version_install-palette_palette-management-appliance_palette-tenant-version.webp)

‎_partials/self-hosted/management-appliance/_upload-packs-enablement.mdx‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ partial_name: upload-packs-enablement
77

88
<TabItem value="internal-zot-registry" label="Internal Zot Registry">
99

10-
<Tabs>
10+
<Tabs groupId="upload-method">
1111

1212
<TabItem label="Local UI Method" value="local-ui-method">
1313

@@ -34,7 +34,7 @@ partial_name: upload-packs-enablement
3434
The upload process starts automatically once the files are selected. You can monitor the upload progress in
3535
the **Upload Content** dialog.
3636

37-
Wait for the **Upload Successful** confirmation message to appear.
37+
Wait for the **File(s) uploaded successfully** confirmation message or the green check mark to appear next to the upload progress bar.
3838

3939
8. Log in to the {props.version} system console.
4040

@@ -69,9 +69,9 @@ partial_name: upload-packs-enablement
6969

7070
6. Upload the pack bundles to the internal Zot registry using the Palette CLI. Replace `<pack-zst>` with your downloaded pack bundle file and `<management-vip>` with the VIP address of the {props.version} management cluster. If you have changed the default port or the base content path for the Zot registry, replace `30003` with the correct port number and `spectro-content` with the correct content path.
7171

72-
If you are using custom TLS certificates or choosing to skip TLS, use the appropriate flags as shown below.
72+
If you are using custom TLS certificates or choosing to skip TLS, use the appropriate flags as shown in the following examples.
7373

74-
<Tabs>
74+
<Tabs groupId="tls-palette-cli">
7575

7676
<TabItem label="Custom TLS Certificate" value="custom-tls-certificate">
7777

@@ -139,15 +139,15 @@ partial_name: upload-packs-enablement
139139
5. Authenticate with your external registry using the command line or a GUI tool of your choice. The following examples
140140
demonstrate how to authenticate with an OCI registry using the [`oras`](https://oras.land/docs/) CLI tool and the Palette CLI.
141141

142-
<Tabs>
142+
<Tabs groupId="external-registry-type">
143143

144144
<TabItem label="Harbor" value="harbor">
145145

146146
Use `oras` to log in to your OCI registry. Replace the values below with your environment configuration values.
147147
If you are using a Harbor registry with a self-signed certificate, add the `--insecure` flag to the
148148
`oras` command.
149149

150-
<Tabs>
150+
<Tabs groupId="tls-harbor">
151151

152152
<TabItem label="Regular Certificate" value="regular-certificate">
153153

@@ -176,7 +176,7 @@ partial_name: upload-packs-enablement
176176
[AWS ECR Authentication](https://docs.aws.amazon.com/AmazonECR/latest/userguide/getting-started-cli.html#cli-authenticate-registry)
177177
documentation for more information.
178178

179-
<Tabs>
179+
<Tabs groupId="ecr-type">
180180

181181
<TabItem label="Private ECR" value="private-ecr">
182182

@@ -221,11 +221,11 @@ partial_name: upload-packs-enablement
221221

222222
6. Upload the pack bundles to the OCI registry. The following example commands upload a pack bundle to the OCI registry in the `spectro-content` base path. Replace the values below with your environment configuration values.
223223

224-
<Tabs>
224+
<Tabs groupId="external-registry-type">
225225

226-
<TabItem label="Harbor" value="harbor-upload">
226+
<TabItem label="Harbor" value="harbor">
227227

228-
<Tabs>
228+
<Tabs groupId="tls-harbor">
229229

230230
<TabItem label="Regular Certificate" value="regular-certificate">
231231

@@ -247,7 +247,7 @@ partial_name: upload-packs-enablement
247247

248248
</TabItem>
249249

250-
<TabItem label="AWS ECR" value="aws-ecr-upload">
250+
<TabItem label="AWS ECR" value="aws-ecr">
251251

252252
```shell
253253
oras push <aws-ecr-url>/spectro-content/<repository-name>:<tag> --file <path-to-pack-bundle-zst>
@@ -259,9 +259,9 @@ partial_name: upload-packs-enablement
259259

260260
Upload the pack bundles to your external registry using the Palette CLI. Replace `<pack-zst>` with your downloaded pack bundle file, `<registry-dns-or-ip>` with the DNS/IP address of your registry, and `<registry-port>` with the port number of your registry. If you have changed the base content path from the default, replace `spectro-content` with the correct content path.
261261

262-
If you are using custom TLS certificates or choosing to skip TLS, use the appropriate flags as shown below.
262+
If you are using custom TLS certificates or choosing to skip TLS, use the appropriate flags as shown in the following examples.
263263

264-
<Tabs>
264+
<Tabs groupId="tls-palette-cli">
265265

266266
<TabItem label="Custom TLS Certificate" value="custom-tls-certificate">
267267

‎_partials/self-hosted/management-appliance/_upload-packs-validate.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,11 @@ partial_name: upload-packs-validate
2020

2121
1. Use the following example `oras` commands to list the repositories in the OCI registry under the `spectro-content` base path. If you have changed the base content path from the default, replace `spectro-content` with the correct content path. Replace the remaining templated values with your environment configuration values.
2222

23-
<Tabs>
23+
<Tabs groupId="external-registry-type">
2424

25-
<TabItem label="Harbor" value="harbor-list">
25+
<TabItem label="Harbor" value="harbor">
2626

27-
<Tabs>
27+
<Tabs groupId="tls-harbor">
2828

2929
<TabItem label="Regular Certificate" value="regular-certificate">
3030

@@ -46,7 +46,7 @@ partial_name: upload-packs-validate
4646

4747
</TabItem>
4848

49-
<TabItem label="AWS ECR" value="aws-ecr-list">
49+
<TabItem label="AWS ECR" value="aws-ecr">
5050

5151
```shell
5252
oras repo ls <aws-ecr-url>/spectro-content

‎_partials/self-hosted/management-appliance/_upload-third-party-packs-enablement.mdx‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ partial_name: upload-third-party-packs-enablement
77

88
<TabItem value="internal-zot-registry" label="Internal Zot Registry">
99

10-
<Tabs>
10+
<Tabs groupId="upload-method">
1111

1212
<TabItem label="Local UI Method" value="local-ui-method">
1313

@@ -45,7 +45,7 @@ partial_name: upload-third-party-packs-enablement
4545
The upload process starts automatically once the files are selected. You can monitor the upload progress in
4646
the **Upload Content** dialog.
4747

48-
Wait for the **Upload Successful** confirmation message to appear.
48+
Wait for the **File(s) uploaded successfully** confirmation message or the green check mark to appear next to the upload progress bar.
4949

5050
10. Log in to the {props.version} system console.
5151

@@ -91,9 +91,9 @@ partial_name: upload-third-party-packs-enablement
9191

9292
6. Upload the packs to the internal Zot registry using the Palette CLI. Replace `<third-party-zst>` and `<third-party-conformance-zst>` with your downloaded Third Party pack ZST files and `<management-vip>` with the VIP address of the {props.version} management cluster. If you have changed the default port or the base content path for the Zot registry, replace `30003` with the correct port number and `spectro-content` with the correct content path.
9393

94-
If you are using custom TLS certificates or choosing to skip TLS, use the appropriate flags as shown below.
94+
If you are using custom TLS certificates or choosing to skip TLS, use the appropriate flags as shown in the following examples.
9595

96-
<Tabs>
96+
<Tabs groupId="tls-palette-cli">
9797

9898
<TabItem label="Custom TLS Certificate" value="custom-tls-certificate">
9999

@@ -188,15 +188,15 @@ partial_name: upload-third-party-packs-enablement
188188
7. Authenticate with your external registry using the command line or a GUI tool of your choice. The following examples
189189
demonstrate how to authenticate with an OCI registry using the [`oras`](https://oras.land/docs/) CLI tool and the Palette CLI.
190190

191-
<Tabs>
191+
<Tabs groupId="external-registry-type">
192192

193193
<TabItem label="Harbor" value="harbor">
194194

195195
Use `oras` to log in to your OCI registry. Replace the values below with your environment configuration values.
196196
If you are using a Harbor registry with a self-signed certificate, add the `--insecure` flag to the
197197
`oras` command.
198198

199-
<Tabs>
199+
<Tabs groupId="tls-harbor">
200200

201201
<TabItem label="Regular Certificate" value="regular-certificate">
202202

@@ -225,7 +225,7 @@ partial_name: upload-third-party-packs-enablement
225225
[AWS ECR Authentication](https://docs.aws.amazon.com/AmazonECR/latest/userguide/getting-started-cli.html#cli-authenticate-registry)
226226
documentation for more information.
227227

228-
<Tabs>
228+
<Tabs groupId="ecr-type">
229229

230230
<TabItem label="Private ECR" value="private-ecr">
231231

@@ -270,11 +270,11 @@ partial_name: upload-third-party-packs-enablement
270270

271271
8. Upload the packs to the OCI registry. The following example commands upload the packs to the OCI registry in the `spectro-content` base path. Replace the values below with your environment configuration values.
272272

273-
<Tabs>
273+
<Tabs groupId="external-registry-type">
274274

275-
<TabItem label="Harbor" value="harbor-upload">
275+
<TabItem label="Harbor" value="harbor">
276276

277-
<Tabs>
277+
<Tabs groupId="tls-harbor">
278278

279279
<TabItem label="Regular Certificate" value="regular-certificate">
280280

@@ -304,7 +304,7 @@ partial_name: upload-third-party-packs-enablement
304304

305305
</TabItem>
306306

307-
<TabItem label="AWS ECR" value="aws-ecr-upload">
307+
<TabItem label="AWS ECR" value="aws-ecr">
308308

309309
```shell title="Upload Third Party Pack to AWS ECR"
310310
oras push <aws-ecr-url>/spectro-content/<repository-name>:<tag> --file <path-to-third-party-zst>
@@ -320,9 +320,9 @@ partial_name: upload-third-party-packs-enablement
320320

321321
Upload the packs to your external registry using the Palette CLI. Replace `<third-party-zst>` and `<third-party-conformance-zst>` with your downloaded pack bundle files, `<registry-dns-or-ip>` with the DNS/IP address of your registry, and `<registry-port>` with the port number of your registry. If you have changed the base content path from the default, replace `spectro-content` with the correct content path.
322322

323-
If you are using custom TLS certificates or choosing to skip TLS, use the appropriate flags as shown below.
323+
If you are using custom TLS certificates or choosing to skip TLS, use the appropriate flags as shown in the following examples.
324324

325-
<Tabs>
325+
<Tabs groupId="tls-palette-cli">
326326

327327
<TabItem label="Custom TLS Certificate" value="custom-tls-certificate">
328328

‎_partials/self-hosted/management-appliance/_upload-third-party-packs-validate.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ partial_name: upload-third-party-packs-validate
2121

2222
<Tabs>
2323

24-
<TabItem label="Harbor" value="harbor-list">
24+
<TabItem label="Harbor" value="harbor">
2525

2626
<Tabs>
2727

@@ -45,7 +45,7 @@ partial_name: upload-third-party-packs-validate
4545

4646
</TabItem>
4747

48-
<TabItem label="AWS ECR" value="aws-ecr-list">
48+
<TabItem label="AWS ECR" value="aws-ecr">
4949

5050
```shell
5151
oras repo ls <aws-ecr-url>/spectro-content

‎docs/docs-content/enterprise-version/install-palette/palette-management-appliance.md‎

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ Once Palette has been installed, you can download pack bundles and upload them t
2424
external registry. These pack bundles are used to create your cluster profiles. You will then be able to deploy clusters
2525
in your environment.
2626

27+
## Third Party Packs
28+
2729
There is an additional option to download and install the Third Party packs that provide complementary functionality to
2830
Palette. These packs are not required for Palette to function, but they do provide additional features and capabilities
2931
as described in the following table.
@@ -117,14 +119,6 @@ Follow the instructions to upload packs to your Palette instance. Packs are used
117119
[cluster profiles](../../profiles/cluster-profiles/cluster-profiles.md) and deploy workload clusters in your
118120
environment.
119121

120-
:::info
121-
122-
If you are intending to upgrade Palette using a content bundle, you must upload the bundle to the internal Zot registry
123-
using Local UI. This is regardless of whether you are using an external registry or the internal Zot registry for your
124-
pack bundles.
125-
126-
:::
127-
128122
### Prerequisites
129123

130124
<PartialsComponent

‎docs/docs-content/enterprise-version/upgrade/palette-management-appliance.md‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
title: "Upgrade Palette Management Appliance"
3+
sidebar_label: "Palette Management Appliance"
4+
description: "Learn how to upgrade the Palette Management Appliance"
5+
hide_table_of_contents: false
6+
# sidebar_custom_props:
7+
# icon: "chart-diagram"
8+
tags: ["palette management appliance", "self-hosted", "enterprise"]
9+
sidebar_position: 20
10+
---
11+
12+
:::preview
13+
14+
This is a Tech Preview feature and is subject to change. Upgrades from a Tech Preview deployment may not be available.
15+
Do not use this feature in production workloads.
16+
17+
:::
18+
19+
Follow the instructions to upgrade the
20+
[Palette Management Appliance](../install-palette/palette-management-appliance.md) using a content bundle. The content
21+
bundle is used to upgrade the Palette instance to a chosen target version.
22+
23+
:::info
24+
25+
The upgrade process will incur downtime for the Palette management cluster, but your workload clusters will remain
26+
operational.
27+
28+
:::
29+
30+
## Prerequisites
31+
32+
<PartialsComponent
33+
category="self-hosted"
34+
name="upgrade-palette-prereqs"
35+
edition="Palette"
36+
version="Palette"
37+
iso="Palette Enterprise"
38+
app="Palette Management Appliance"
39+
/>
40+
41+
## Upgrade Palette
42+
43+
<PartialsComponent
44+
category="self-hosted"
45+
name="upgrade-palette-enablement"
46+
edition="Palette"
47+
version="Palette"
48+
iso="Palette Enterprise"
49+
app="Palette Management Appliance"
50+
/>
51+
52+
## Validate
53+
54+
<PartialsComponent
55+
category="self-hosted"
56+
name="upgrade-palette-validate"
57+
edition="Palette"
58+
version="Palette"
59+
iso="Palette Enterprise"
60+
app="Palette Management Appliance"
61+
/>

‎docs/docs-content/enterprise-version/upgrade/upgrade.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -460,3 +460,4 @@ Refer to the respective guide for guidance on upgrading your self-hosted Palette
460460
- [Airgap VMware](upgrade-vmware/airgap.md)
461461
- [Non-Airgap Kubernetes](upgrade-k8s/non-airgap.md)
462462
- [Airgap Kubernetes](upgrade-k8s/airgap.md)
463+
- [Palette Management Appliance](palette-management-appliance.md)

0 commit comments

Comments
 (0)