Skip to content

Commit 441c4af

Browse files
authored
Reverting PE-7908 due to 4.8.b shift (#9053)
1 parent b45adf0 commit 441c4af

File tree

8 files changed

+81
-44
lines changed

8 files changed

+81
-44
lines changed

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

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

3636
## Limitations
3737

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

4341
- ARM64 architecture
@@ -46,12 +44,30 @@ The following are architectural highlights of Palette-provisioned Edge native cl
4644
- [Network overlay](../networking/vxlan-overlay/) in locally managed Edge clusters.
4745
- High availability mode with one or two nodes.
4846

49-
<!-- prettier-ignore-end -->
50-
5147
- When scaling down a Palette Optimized Canonical Kubernetes cluster with two nodes, ensure you do not delete the leader
5248
node. In this configuration, one node is the leader (and voter), while the other is a spare. Deleting the leader will
5349
render the cluster inaccessible, as database updates are not replicated to the spare node.
5450

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

5773
All Edge hosts must meet the following minimum hardware requirements. For specific features, additional hardware
@@ -74,12 +90,19 @@ ARM64 support is only verified for the Nvidia Jetson Orin device family.
7490

7591
Palette provides the following distributions for edge installations.
7692

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

84107
## Supported Configurations
85108

@@ -90,7 +113,7 @@ table below describes these aspects and the available options.
90113
| --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
91114
| 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. |
92115
| OS | - Ubuntu<br/>- OpenSUSE<br/>- Bring Your Own OS (BYOOS) |
93-
| 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" /> |
116+
| 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 |
94117
| 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 |
95118
| FIPS Mode | - True: Enforce usage of FIPS packs and other required FIPS configuration to meet FIPS compliance<br/>- False |
96119
| 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/edgeforge-workflow/palette-canvos/build-installer-iso.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,14 @@ 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+
99107
7. Customize these arguments to use during the build process. The following is an example `.arg` file.
100108

101109
```

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,14 @@ 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+
162170
11. (Optional) If you want to build multiple versions of provider images using different Kubernetes versions, remove the
163171
`K8S_VERSION` argument from the `.arg` file. Open the `k8s_version.json` file in the `CanvOS` directory. Remove the
164172
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: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,14 @@ 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+
150158
Using the arguments defined in the `.arg` file, the final provider images you generate will have the following naming
151159
convention, `[IMAGE_REGISTRY]/[IMAGE_REPO]:[CUSTOM_TAG]`. For example, one of the provider images will be
152160
`spectrocloud/ubuntu:k3s-1.27.2-v4.4.12-palette-learn`.
@@ -590,6 +598,14 @@ required Edge artifacts.
590598
OS distribution. The `.arg` file uses the default values for the remaining arguments. Refer to
591599
[Edge Artifact Build Configurations](./arg.md) for all available configuration parameters.
592600
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+
593609
```bash
594610
cat << EOF > .arg
595611
IMAGE_REGISTRY=$IMAGE_REGISTRY

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

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -33,23 +33,14 @@ 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-start -->
37-
36+
<!-- prettier-ignore -->
3837
- For multi-node clusters, do not use the
3938
<VersionedLink text="Local Path Provisioner Pack" url="/integrations/packs/?pack=csi-local-path-provisioner" />. This
4039
is because whenever a node is drained during an upgrade or for any other reason, the volumes will not dynamically move
4140
with the local path provisioner.
4241

43-
<!-- prettier-ignore-end -->
44-
4542
- Two-node clusters operating in high availability mode only support K3s and no other Kubernetes distributions.
46-
47-
<!-- prettier-ignore-start -->
48-
49-
- <VersionedLink text="Palette Optimized Canonical" url="/integrations/packs/?pack=edge-canonical" /> Kubernetes
50-
clusters require at least three nodes to operate in high availability mode.
51-
52-
<!-- prettier-ignore-end -->
43+
- Palette Optimized Canonical Kubernetes clusters require at least three nodes to operate in high availability mode.
5344

5445
### Prerequisites
5546

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

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

2626
## Limitations
2727

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

3331
- Non-Edge environments
@@ -36,7 +34,8 @@ The following are architectural highlights of clusters deployed using agent mode
3634
- Palette VerteX
3735
- Custom installation paths for Kubernetes and its dependencies in [Agent Mode](./agent-mode.md)
3836
- [Network overlay](../../clusters/edge/networking/vxlan-overlay.md) in locally managed Edge clusters.
39-
- High availability mode with one or two nodes.
37+
38+
<!-- prettier-ignore-start -->
4039

4140
- Edge clusters deployed in agent mode with a Palette cluster agent version prior to 4.7.7 do not support upgrading to
4241
the following Kubernetes pack versions released in 4.7.20:
@@ -68,14 +67,16 @@ The following are architectural highlights of clusters deployed using agent mode
6867

6968
Agent mode deployments support the following Kubernetes distributions:
7069

71-
<!-- prettier-ignore-start -->
70+
- PXK-E
71+
- K3s
72+
- Canonical
7273

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" />
74+
:::preview
7775

78-
<!-- prettier-ignore-end -->
76+
The **Palette Optimized Canonical** distribution that supports Canonical Kubernetes is a Tech Preview feature and is
77+
subject to change. Do not use this feature in production workloads.
78+
79+
:::
7980

8081
## Minimum Device Requirements
8182

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

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

6969
#### Improvements
7070

71-
<!-- prettier-ignore-start -->
72-
73-
- The <VersionedLink text="Palette Optimized Canonical" url="/integrations/packs/?pack=edge-canonical" /> pack has exited Tech Preview and is now ready for production workloads.
74-
75-
<!-- prettier-ignore-end -->
76-
7771
- [Trusted Boot](../clusters/edge/trusted-boot/trusted-boot.md) has exited Tech Preview and is now ready for production
7872
workloads.
7973

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

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -362,14 +362,10 @@ 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-
<!-- 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
365+
When rebooting nodes in an Edge cluster using Palette Optimized Canonical deployed in a proxied environment, the nodes
368366
may fail to come back online. To prevent this, add the second IP address in the `service_cidr` range from the Canonical
369367
pack to the `NO_PROXY` list in your Edge installer `user-data`.
370368

371-
<!-- prettier-ignore-end -->
372-
373369
### Debug Steps
374370

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

0 commit comments

Comments
 (0)