Skip to content

Commit ab8d98b

Browse files
authored
docs: PE-7908: Palette Optimized Canonical TP Exit (#9390)
* docs: PE-7908: Palette Optimized Canonical TP Exit * Empty commit to trigger netlify preview * Apply suggestion from @achuribooks * Apply suggestion from @achuribooks * ci: auto-formatting prettier issues * Additional edits * Apply suggestion from @achuribooks * Apply suggestion from @achuribooks * ci: auto-formatting prettier issues --------- Co-authored-by: achuribooks <[email protected]>
1 parent fdca1c0 commit ab8d98b

File tree

9 files changed

+44
-85
lines changed

9 files changed

+44
-85
lines changed

docs/docs-content/clusters/edge/architecture/architecture.md

Lines changed: 11 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -35,37 +35,16 @@ The following are architectural highlights of Palette-provisioned Edge native cl
3535

3636
## Limitations
3737

38-
- The Palette Optimized Canonical distribution that supports Canonical Kubernetes is a Tech Preview feature and does not
38+
<!-- prettier-ignore-start -->
39+
40+
- The <VersionedLink text="Palette Optimized Canonical" url="/integrations/packs/?pack=edge-canonical" /> pack does not
3941
support the following:
4042

4143
- ARM64 architecture
4244
- Palette VerteX
4345
- Custom installation paths for Kubernetes and its dependencies in [agent mode](../../../deployment-modes/agent-mode/)
44-
- High availability mode with one or two nodes.
45-
46-
- When scaling down a Palette Optimized Canonical Kubernetes cluster with two nodes, ensure you do not delete the leader
47-
node. In this configuration, one node is the leader (and voter), while the other is a spare. Deleting the leader will
48-
render the cluster inaccessible, as database updates are not replicated to the spare node.
49-
50-
:::info
5146

52-
The Palette Optimized Canonical Kubernetes distribution uses distributed SQLite (Dqlite) as its datastore. Each node
53-
assumes one of the following roles at any given time:
54-
55-
- Voter - replication and leader election voting are enabled.
56-
- Stand-by - only replication is enabled.
57-
- Spare - neither replication nor election is enabled.
58-
59-
Run the `k8s status` command on a control plane node to view the current roles of all nodes in the cluster.
60-
61-
```bash hideClipboard title="Example output"
62-
cluster status: ready
63-
control plane nodes: 10.10.216.81:6400 (voter), 10.10.217.4:6400 (voter), 10.10.220.115:6400 (voter)
64-
high availability: yes
65-
datastore: k8s-dqlite
66-
```
67-
68-
:::
47+
<!-- prettier-ignore-end -->
6948

7049
## Minimum Device Requirements
7150

@@ -89,19 +68,12 @@ ARM64 support is only verified for the Nvidia Jetson Orin device family.
8968

9069
Palette provides the following distributions for edge installations.
9170

92-
| Name | Kubernetes Distribution | OS | CNIs | CSIs |
93-
| ----------------------------------------------------------------------------------------------------------- | ----------------------- | ---------------- | --------------- | --------- |
94-
| Palette Optimized K3s | K3s | openSUSE, Ubuntu | Calico, Flannel | Rook Ceph |
95-
| Palette Optimized RKE2 | RKE2 | openSUSE, Ubuntu | Calico, Flannel | Rook Ceph |
96-
| [Palette eXtended Kubernetes Edge (PXK-E)](../../../glossary-all.md#palette-extended-kubernetes-edge-pxk-e) | CNCF | openSUSE, Ubuntu | Calico, Flannel | Rook Ceph |
97-
| Palette Optimized Canonical | Canonical Kubernetes | Ubuntu | Calico, Cilium | Longhorn |
98-
99-
:::preview
100-
101-
The **Palette Optimized Canonical** Kubernetes distribution is a Tech Preview feature and is subject to change. Do not
102-
use this feature in production workloads.
103-
104-
:::
71+
| Name | Kubernetes Distribution | OS | CNIs | CSIs |
72+
| ---------------------------------------------------------------------------------------------------------- | ----------------------- | ---------------- | --------------- | --------- |
73+
| <VersionedLink text="Palette eXtended Kubernetes Edge (PXK-E)" url="/integrations/packs/?pack=edge-k8s" /> | CNCF | openSUSE, Ubuntu | Calico, Flannel | Rook Ceph |
74+
| <VersionedLink text="Palette Optimized Canonical" url="/integrations/packs/?pack=edge-canonical" /> | Canonical Kubernetes | Ubuntu | Calico, Cilium | Longhorn |
75+
| <VersionedLink text="Palette Optimized K3s" url="/integrations/packs/?pack=edge-k3s" /> | K3s | openSUSE, Ubuntu | Calico, Flannel | Rook Ceph |
76+
| <VersionedLink text="Palette Optimized RKE2" url="/integrations/packs/?pack=edge-rke2" /> | RKE2 | openSUSE, Ubuntu | Calico, Flannel | Rook Ceph |
10577

10678
## Supported Configurations
10779

@@ -112,7 +84,7 @@ table below describes these aspects and the available options.
11284
| --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
11385
| Management Mode | - Central: The site has a connection to Palette and is managed centrally via Palette Management Console<br/> - Local: The site does not have a connection to Palette and is managed locally. |
11486
| OS | - Ubuntu<br/>- OpenSUSE<br/>- Bring Your Own OS (BYOOS) |
115-
| Kubernetes Flavor | - Palette eXtended K8s for Edge FIPS (PXK-E) <br /> - Palette eXtended K8s for Edge (PXK-E) <br/> - Palette Optimized K3s <br/> - Palette Optimized RKE2<br/>- Palette Optimized Canonical |
87+
| Kubernetes Flavor | - <VersionedLink text="Palette eXtended Kubernetes Edge (PXK-E)" url="/integrations/packs/?pack=edge-k8s" /> (FIPS and non-FIPS) <br/> - <VersionedLink text="Palette Optimized Canonical" url="/integrations/packs/?pack=edge-canonical" /> <br/> - <VersionedLink text="Palette Optimized K3s" url="/integrations/packs/?pack=edge-k3s" /> <br/>- <VersionedLink text="Palette Optimized RKE2" url="/integrations/packs/?pack=edge-rke2" /> |
11688
| Kubernetes Version | - 1.26.x<br/>- 1.27.x<br/>- 1.28.x<br/>- 1.29.x<br/>- 1.30.x<br/>- 1.31.x<br/>- 1.32.x <br/>- 1.33.x |
11789
| FIPS Mode | - True: Enforce usage of FIPS packs and other required FIPS configuration to meet FIPS compliance<br/>- False |
11890
| Edge Host Registration Mode | - Manual: A unique Edge host ID is manually entered into the Palette Management Console <br/> - Auto: Edge hosts automatically register with the Palette through the usage of a registration token supplied in the user-data<br/>- QR Code: Scan a QR code that takes you to a web application that registers the Edge host with Palette. This method is considered advanced with the benefit of simplifying the Edge host registration without needing a tenant token or a manual entry. |

docs/docs-content/clusters/edge/architecture/two-node.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,8 @@ change the number of nodes.
5252
[Deployment Modes](../../../deployment-modes/deployment-modes.md).
5353
- Two-node clusters can only have exactly two nodes in the control plane pool. You cannot adjust the number of the nodes
5454
in the control plane pool after cluster creation.
55-
- Two-node clusters only support K3s. Other Kubernetes distributions are not supported.
55+
- Two-node clusters only support K3s and Palette Optimized Canonical Kubernetes. Other Kubernetes distributions are not
56+
supported.
5657

5758
## Use Cases
5859

docs/docs-content/clusters/edge/edgeforge-workflow/palette-canvos/build-installer-iso.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -96,14 +96,6 @@ Use the following instructions to build the Edge Installer ISO. The optional ste
9696
the provider images. Refer to [Edge Artifact Build Configuration](./arg.md) for all available configuration
9797
parameters.
9898

99-
:::preview
100-
101-
The `K8S_DISTRIBUTION` argument, defined in the `.arg` file, accepts `canonical` as a valid value. This value
102-
corresponds to the **Palette Optimized Canonical** pack, which is a Tech Preview feature and is subject to change. Do
103-
not use this feature in production workloads.
104-
105-
:::
106-
10799
7. Customize these arguments to use during the build process. The following is an example `.arg` file.
108100

109101
```

docs/docs-content/clusters/edge/edgeforge-workflow/palette-canvos/build-provider-images.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -159,14 +159,6 @@ artifacts at the same time.
159159
160160
Refer to [Edge Artifact Build Configurations](./arg.md) for all available configuration parameters.
161161
162-
:::preview
163-
164-
The `K8S_DISTRIBUTION` argument, defined in the `.arg` file, accepts `canonical` as a valid value. This value
165-
corresponds to the **Palette Optimized Canonical** pack, which is a Tech Preview feature and is subject to change.
166-
Do not use this feature in production workloads.
167-
168-
:::
169-
170162
11. (Optional) If you want to build multiple versions of provider images using different Kubernetes versions, remove the
171163
`K8S_VERSION` argument from the `.arg` file. Open the `k8s_version.json` file in the `CanvOS` directory. Remove the
172164
Kubernetes versions that you don't need from the JSON object corresponding to your Kubernetes distribution.

docs/docs-content/clusters/edge/edgeforge-workflow/palette-canvos/palette-canvos.md

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -147,14 +147,6 @@ customization.
147147

148148
Refer to [Edge Artifact Build Configurations](./arg.md) for all available configuration parameters.
149149

150-
:::preview
151-
152-
The `K8S_DISTRIBUTION` argument, defined in the `.arg` file, accepts `canonical` as a valid value. This value
153-
corresponds to the **Palette Optimized Canonical** pack, which is a Tech Preview feature and is subject to change. Do
154-
not use this feature in production workloads.
155-
156-
:::
157-
158150
Using the arguments defined in the `.arg` file, the final provider images you generate will have the following naming
159151
convention, `[IMAGE_REGISTRY]/[IMAGE_REPO]:[CUSTOM_TAG]`. For example, one of the provider images will be
160152
`spectrocloud/ubuntu:k3s-1.27.2-v4.4.12-palette-learn`.
@@ -598,14 +590,6 @@ required Edge artifacts.
598590
OS distribution. The `.arg` file uses the default values for the remaining arguments. Refer to
599591
[Edge Artifact Build Configurations](./arg.md) for all available configuration parameters.
600592
601-
:::preview
602-
603-
The `K8S_DISTRIBUTION` argument, defined in the `.arg` file, accepts `canonical` as a valid value. This value
604-
corresponds to the **Palette Optimized Canonical** pack, which is a Tech Preview feature and is subject to change.
605-
Do not use this feature in production workloads.
606-
607-
:::
608-
609593
```bash
610594
cat << EOF > .arg
611595
IMAGE_REGISTRY=$IMAGE_REGISTRY

docs/docs-content/clusters/edge/site-deployment/cluster-deployment.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,22 @@ Use the following steps to create a new host cluster so that you can add Edge ho
3333
- In a multi-node cluster with PXK-E as its Kubernetes layer, you cannot change custom Network Interface Card (NIC).
3434
When you add an Edge host to such a cluster, leave the NIC field as its default value.
3535

36-
<!-- prettier-ignore -->
36+
<!-- prettier-ignore-start -->
37+
3738
- For multi-node clusters, do not use the
3839
<VersionedLink text="Local Path Provisioner Pack" url="/integrations/packs/?pack=csi-local-path-provisioner" />. This
3940
is because whenever a node is drained during an upgrade or for any other reason, the volumes will not dynamically move
4041
with the local path provisioner.
4142

42-
- Two-node clusters operating in high availability mode only support K3s and no other Kubernetes distributions.
43-
- Palette Optimized Canonical Kubernetes clusters require at least three nodes to operate in high availability mode.
43+
<!-- prettier-ignore-end -->
44+
45+
- Two-node clusters operating in high availability mode only support K3s and Palette Optimized Canonical Kubernetes.
46+
Other Kubernetes distributions are not supported.
47+
48+
<!-- prettier-ignore-start -->
49+
50+
51+
<!-- prettier-ignore-end -->
4452

4553
### Prerequisites
4654

docs/docs-content/deployment-modes/agent-mode/architecture.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,9 @@ The following are architectural highlights of clusters deployed using agent mode
2525

2626
## Limitations
2727

28-
- The Palette Optimized Canonical distribution that supports Canonical Kubernetes is a Tech Preview feature and does not
28+
<!-- prettier-ignore-start -->
29+
30+
- The <VersionedLink text="Palette Optimized Canonical" url="/integrations/packs/?pack=edge-canonical" /> distribution does not
2931
support the following:
3032

3133
- Non-Edge environments
@@ -66,16 +68,14 @@ The following are architectural highlights of clusters deployed using agent mode
6668

6769
Agent mode deployments support the following Kubernetes distributions:
6870

69-
- PXK-E
70-
- K3s
71-
- Canonical
72-
73-
:::preview
71+
<!-- prettier-ignore-start -->
7472

75-
The **Palette Optimized Canonical** distribution that supports Canonical Kubernetes is a Tech Preview feature and is
76-
subject to change. Do not use this feature in production workloads.
73+
- <VersionedLink text="Palette eXtended Kubernetes Edge (PXK-E)" url="/integrations/packs/?pack=edge-k8s" />
74+
- <VersionedLink text="Palette Optimized Canonical" url="/integrations/packs/?pack=edge-canonical" />
75+
- <VersionedLink text="Palette Optimized K3s" url="/integrations/packs/?pack=edge-k3s" />
76+
- <VersionedLink text="Palette Optimized RKE2" url="/integrations/packs/?pack=edge-rke2" />
7777

78-
:::
78+
<!-- prettier-ignore-end -->
7979

8080
## Minimum Device Requirements
8181

docs/docs-content/release-notes/release-notes.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,12 @@ The [CanvOS](https://github.com/spectrocloud/CanvOS) version corresponding to th
6969

7070
#### Improvements
7171

72+
<!-- prettier-ignore-start -->
73+
74+
- The <VersionedLink text="Palette Optimized Canonical" url="/integrations/packs/?pack=edge-canonical" /> pack has exited Tech Preview and is now ready for production workloads.
75+
76+
<!-- prettier-ignore-end -->
77+
7278
#### Bug Fixes
7379

7480
### VerteX

docs/docs-content/troubleshooting/edge/edge.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -362,10 +362,14 @@ remove the container manually. The kubelet then restarts the component using the
362362

363363
## Scenario - Canonical Edge Clusters in Proxied Environments Experience Failure upon Reboot
364364

365-
When rebooting nodes in an Edge cluster using Palette Optimized Canonical deployed in a proxied environment, the nodes
365+
<!-- prettier-ignore-start -->
366+
367+
When rebooting nodes in an Edge cluster using <VersionedLink text="Palette Optimized Canonical" url="/integrations/packs/?pack=edge-canonical" /> deployed in a proxied environment, the nodes
366368
may fail to come back online. To prevent this, add the second IP address in the `service_cidr` range from the Canonical
367369
pack to the `NO_PROXY` list in your Edge installer `user-data`.
368370

371+
<!-- prettier-ignore-end -->
372+
369373
### Debug Steps
370374

371375
1. Log in to [Palette](https://console.spectrocloud.com).

0 commit comments

Comments
 (0)