From 07f3305dca3c8eb5b5035488fb1976fa87b94094 Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Thu, 16 May 2024 11:06:10 -0700 Subject: [PATCH 01/25] docs: DOC-1186 PCP-2886 --- .../release-notes/release-notes.md | 254 ++---------------- 1 file changed, 15 insertions(+), 239 deletions(-) diff --git a/docs/docs-content/release-notes/release-notes.md b/docs/docs-content/release-notes/release-notes.md index 4410b80ed9..81b80b4e01 100644 --- a/docs/docs-content/release-notes/release-notes.md +++ b/docs/docs-content/release-notes/release-notes.md @@ -11,200 +11,45 @@ tags: ["release-notes"] -## April 29, 2024 - Release 4.3.7 +## Jun 1, 2024 - Release 4.4.0 - 4.4.X -### Bug Fixes - -- Fixed an issue when creating a DNS mapping for the - [System PCG](../clusters/pcg/architecture.md#system-private-gateway) that caused errors in the User Interface (UI) and - prevented the mapping from being created. The issue has been resolved, and you can now create DNS mappings for the - System PCG without any issues. - -- Resolved an issue where complex pack presets would not get injected into the cluster profile layer's YAML file. - -## April 14, 2024 - Release 4.3.0 - 4.3.6 - -This release contains several new exciting Technical Preview features, including the Edge Local UI and Cluster Profile -variables. Other notable features include enhancements to the Palette CLI, support for deploying Konvoy clusters, Azure -AKS support for VerteX, and adding multiple system administrators to the Palette and VerteX system consoles. Check out -the following sections for a complete list of features, improvements, and known issues. +Sit et beatae expedita rerum odit ullam quos id non voluptas quae et nisi. Est commodi excepturi accusamus sed incidunt +doloribus. Praesentium qui accusantium amet. Eaque voluptates impedit sint amet omnis delectus velit tempora eos maxime +laudantium corporis iure. Nesciunt nihil et asperiores dolore suscipit dolor architecto. Fugit distinctio iste maxime +saepe ut fugit ea ut architecto quae consequatur. ### Security Notices -- Kubernetes version 1.27.9 is deprecated due to a security vulnerability. We recommend upgrading to a newer version of - Kubernetes, such as 1.27.11, to avoid issues. - - Review the [Security Bulletins](../security-bulletins/security-bulletins.md) page for the latest security advisories. ### Palette -#### Features - - -- Cluster Profile variables, a new feature that allows you to define variables in a cluster profile. This - feature is in Tech Preview and is available only for Edge clusters using Local UI. Profile variables allow you to define variable - types, apply validation, and narrow the scope of variables to a cluster profile. - Check out [Cluster Profile Variables](../profiles/cluster-profiles/create-cluster-profiles/define-profile-variables.md) to learn more about - profile variables. - -- MAAS clusters using Palette eXtended Kubernetes (PXK) now support the ability to specify a custom MAAS API endpoint - URL and port during cluster creation. This feature allows you to use a custom DNS server or Virtual IP (VIP) that is - not resolvable outside of the MAAS network. Refer to the [PXK](../integrations/kubernetes.md#custom-maas-endpoint) - documentation for more details. - -- Support for [Konvoy](../integrations/konvoy.md) is now available in Palette. You can create a custom image using the - Konvoy image builder project and use it to deploy a Konvoy cluster. Check out the - [Red Hat Linux Enterprise and Konvoy](../byoos/usecases/vmware/konvoy.md) guide to learn how to create a custom image - and deploy a Konvoy cluster. - -- Multiple system administrators can now be added to the self-hosted Palette system console to help manage and maintain - the Palette instance. The feature helps organizations embrace the separation of duties by delegating different - responsibilities to system administrators. Refer to the - [System Administrators](../enterprise-version/system-management/account-management/account-management.md#system-administrators) - page to learn more about system administrators. - -#### Improvements - -- Nutanix cluster deployments now display YAML variables and expose them as input fields in the User - Interface (UI) during the cluster deployment process. Previously, the UI did not display the YAML variables for - Nutanix clusters and users had to update the machine template YAML manually. You can learn more about Nutanix in the - [Create and Manage Nutanix Cluster](../clusters/data-center/nutanix/create-manage-nutanix-cluster.md) guide. - -- The cluster deployment user flow experience has been improved to streamline the cluster creation process. You can now - select between IaaS and managed Kubernetes clusters from the initial platform selection screen. The update combines - the selection of platform and type of Kubernetes cluster while also detecting and notifying if a prerequisite is not - met. - -- When installing a Private Cloud Gateway (PCG) or a self-hosted Palette instance through the Palette CLI, you can now - benefit from additional checks and user feedback that ensure the installation process is successful. This new feedback - experience gives you a better understanding of the components being installed and the progress of the installation. In - case of a failure, the failed component is highlighted, and an error message is displayed. - -- Imported clusters now support updating network proxy configurations as a Day-2 operation. - -- The [Validator AWS](https://github.com/spectrocloud-labs/validator-plugin-aws) plugin now reports IAM permissions - issues that are caused by - [Service control policies](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_scps.html). - Refer to the Palette CLI [Validator](../automation/palette-cli/commands/validator.md) page to learn how to use - Validator with the Palette CLI. - -- Packs that are marked as _Disabled_ are no longer displayed in the cluster profile creation wizard. Existing cluster - profiles containing disabled packs are not affected and continue to work as expected. Refer to the - [maintenance policy](../integrations/maintenance-policy.md#pack-deprecations) page to learn more. +#### Breaking Changes -- Several enhancements have been added to the Palette CLI [Validator](../automation/palette-cli/commands/validator.md) - command that improves the user experience. The enhancements include a Validator upgrade feature, a describe subcommand - that displays results more clearly, an interactive re-configure option, the ability to restart the wizard, and more. +- Google Cloud Platform (GCP) does not support the ability for users to specify a patch version for the Kubernetes + version used in GKE clusters. In this release, Palette aligns with GCP's behavior and removes the ability to specify a + patch version when creating a cluster profile for GKE. Only the major and minor versions are available for selection. -- Cox Edge has been removed as a supported platform for Edge clusters. Cox stopped supporting the platform and is no - longer available for new deployments. All Cox Edge-related resources and API endpoints have been removed. +#### Features -- PCG deployments using the Palette CLI for MAAS and VMware vSphere now use Kubernetes version 1.27.11. Palette CLI - installs targeting an OpenStack environment will use Kubernetes version 1.24.10. Existing PCG clusters installed - through Palette CLI will be eligible for a cluster profile update. We recommend you review the - [Upgrade a PCG](../clusters/pcg/manage-pcg/pcg-upgrade.md) guide to learn more about updating a PCG. +#### Improvements -- Self-hosted Palette instances now use Kubernetes version 1.27.11. This new version of Kubernetes will cause node - repave events during the upgrade process. If you have multiple self-hosted Palette instances in a VMware environment, - take a moment and review the [Known Issues](#known-issues) section below for potential issues that may arise during - the upgrade process. +#### Deprecations and Removals #### Known Issues -- Conducting cluster node scaling operations on a cluster undergoing a backup can lead to issues and potential - unresponsiveness. To avoid this, ensure no backup operations are in progress before scaling nodes or performing other - cluster operations that change the cluster state. - -- Palette automatically creates a security group for worker nodes using the format `-node`. If a security - group with the same name already exists in the VPC, the cluster creation process fails. To avoid this, ensure that no - security group with the same name exists in the VPC before creating a cluster. - -- K3s version 1.27.7 has been marked as _Deprecated_. This version has a known issue that causes clusters to crash. - Upgrade to a newer version of K3s to avoid the issue, such as versions 1.26.12, 1.28.5, and 1.27.11. You can learn - more about the issue in the [K3s GitHub issue](https://github.com/k3s-io/k3s/issues/9047). - -- When deploying a multi-node AWS EKS cluster with the Container Network Interface (CNI) - [Calico](../integrations/calico.md), the cluster deployments fail. A workaround is to use the AWS VPC CNI in the - interim while the issue is resolved. - -- If a Kubernetes cluster deployed onto VMware is deleted, and later re-created with the same name, the cluster creation - process fails. The issue is caused by existing resources remaining inside PCG, or System PCG, that are not cleaned up - during the cluster deletion process. Refer to the - [VMware Resources Remain After Cluster Deletion](../troubleshooting/pcg.md#scenario---vmware-resources-remain-after-cluster-deletion) - troubleshooting guide for resolution steps. - - - -- In a VMware environment, self-hosted Palette instances do not receive a unique cluster ID when deployed, which can - cause issues during a node repave event, such as a Kubernetes version upgrade. Specifically, Persistent Volumes (PVs) - and Persistent Volume Claims (PVCs) will experience start problems due to the lack of a unique cluster ID. To resolve - this issue, refer to the - [Volume Attachment Errors Volume in VMware Environment](../troubleshooting/palette-upgrade.md#volume-attachment-errors-volume-in-vmware-environment) - troubleshooting guide. - -- Day-2 operations related to infrastructure changes, such as modifying the node size, and node count, when using - MicroK8s are not taking effect. +- MicroK8s ### Edge #### Breaking Changes -- Edge hosts now require a minimum storage capacity of 100 GB. The previous minimum storage capacity was 60 GB. Refer to - the [Minimum Device Requirements](../clusters/edge/hardware-requirements.md) page to learn more about the minimum - requirements for Edge hosts. - #### Features -- The Edge Local UI is a new feature that provides a local management interface for Edge clusters in an airgap - environment. The local UI is a web-based interface that allows you to manage Edge hosts in your network locally, - upload content bundles containing images, Helm charts, and packs, and create Edge clusters locally in disconnected - environments without connections to a Palette instance. To get started with local UI, refer to the - [Edge Local UI](../clusters/edge/local-ui/local-ui.md) documentation. - - -- Edge hosts using a local [image registry through Harbor](../integrations/harbor-edge.md) can now also use a - [private external image registry](../clusters/edge/site-deployment/deploy-custom-registries/deploy-external-registry.md) alongside the local - registry. The feature allows the cluster to pull image from a private external image registry and store them in the - local registry. Images for the add-on layers of the cluster will be pulled from the local registry, reducing bandwidth - needs and improving service availability. - #### Improvements -- Improved Edge cluster upgrade experience. In the past, most upgrades would trigger a repave when not always necessary. - The enhancement applies more intelligence to the upgrade process and determines if a reboot, service reload, or repave - is required. Refer to the [Edge Cluster Upgrade Behavior](../clusters/edge/upgrade-behavior.md) page to learn more - about the upgrade behavior. - -- New Edge clusters can now retrieve provider images from authenticated registries. Previously, only public registries - were supported for non-airgapped clusters. Now, you can use authenticated registries to store your provider images and - retrieve them during cluster deployment. For more information, refer to the - [Deploy Cluster with a Private Registry](../clusters/edge/site-deployment/deploy-custom-registries/deploy-private-registry.md) - guide. - -- Edge hosts using RKE2 as the Kubernetes distribution can now use the - [network overlay](../clusters/edge/networking/vxlan-overlay.md) feature. - -- Edge hosts using a local image registry through Harbor can now turn off image pulls from the local registry through - namespace annotations. Refer to the - [Harbor Edge](../integrations/harbor-edge.md#enable-image-download-from-outside-of-harbor) reference page to learn - more about the feature. - #### Known issues -- If a cluster that uses the Rook-Ceph pack experiences network issues, it's possible for the file mount to become - unavailable and will remain unavailable even after network is restored. This a known issue disclosed in the - [Rook GitHub repository](https://github.com/rook/rook/issues/13818). To resolve this issue, refer to - [Rook-Ceph](../integrations/rook-ceph.md#file-mount-becomes-unavailable-after-cluster-experiences-network-issues) pack - documentation. - -- Edge clusters on Edge hosts with ARM64 processors may experience instability issues that causes cluster failures. - -- During the cluster provisioning process of new edge clusters, the palette webhook pods may not always deploy - successfully, causing the cluster to be stuck in the provisioning phase. This issue does not impact deployed clusters. - Review the - [Palette Webhook Pods Fail to Start](../troubleshooting/edge.md#scenario---palette-webhook-pods-fail-to-start) - troubleshooting guide for resolution steps. - ### Virtual Machine Orchestrator (VMO) #### Improvements @@ -216,66 +61,20 @@ the following sections for a complete list of features, improvements, and known #### Features -- VerteX now supports deploying clusters on Azure Kubernetes Service (AKS). Refer to the - [Create and Manage Azure AKS Cluster](../clusters/public-cloud/azure/aks.md) guide to learn how to deploy an AKS - cluster. - -- Support for [Konvoy](../integrations/konvoy.md) is now available in VerteX. You can create a custom image using the - Konvoy image builder project and use it to deploy a Konvoy cluster. Check out the - [Red Hat Linux Enterprise and Konvoy](../byoos/usecases/vmware/konvoy.md) guide to learn how to create a custom image - and deploy a Konvoy cluster. - -- Support for TLS 1.3 is now available in VerteX. Clusters deployed through VerteX and the VerteX instance cluster - itself now support TLS 1.3. - -- Multiple system administrators can now be added to the VerteX system console to help manage and maintain the VerteX - instance. The feature helps organizations embrace the separation of duties by delegating different responsibilities to - system administrators. Refer to the - [System Administrators](../vertex/system-management/account-management/account-management.md#system-administrators) - page to learn more about system administrators. - -- The Palette CLI now supports the ability to scan deployed clusters and check for FIPS compliance using the - `fips-validate` command. The command scans the cluster and reports the FIPS compliance status of images. The command - also supports checking exposed service endpoints for approved ciphers and TLS versions. Images and service endpoints - that are not compliant are reported with either a failed or unknown status. Refer to the - [FIPS Validate](../automation/palette-cli/commands/fips-validate.md) guide to learn more about the command. - -- VerteX instances now use Kubernetes version 1.27.11. This new version of Kubernetes will cause node repave events - during the upgrade process. If you have multiple self-hosted Palette instances in a VMware environment, take a moment - and review the Palette [Known Issues](#known-issues) section above for potential issues that may arise during the - upgrade process. - #### Improvements -- Password enforcement for VerteX system administrators has been improved to comply with NIST password specifications, - NIST 800-53 and NIST 800-63B. Refer to - [Password Requirements and Security](../vertex/system-management/account-management/credentials.md#password-requirements-and-security) - page for more details. - ### Terraform #### Features -- Version 0.18.0 of the +- Version 0.19.0 of the [Spectro Cloud Terraform provider](https://registry.terraform.io/providers/spectrocloud/spectrocloud/latest/docs) is available. For more details, refer to the Terraform provider [release page](https://github.com/spectrocloud/terraform-provider-spectrocloud/releases). ### Docs and Education -- A new Getting Started experience is now available for new users. The new experience guides users through the key - Palette concepts and features to help them get started with Palette. Check out the - [Getting Started](../getting-started/getting-started.md) page to learn more. - -- A new tutorial [Deploy Cluster Profile Updates](../clusters/cluster-management/update-k8s-cluster.md) is now available - that guides you through the process of updating a cluster profile. - -- A new pack, [Hello Universe](https://github.com/spectrocloud/pack-central/tree/main/packs/hello-universe-1.1.1) is now - available in the Pack community repository. - -- A new documentation section for PCG has been added to the Palette documentation. The new section consolidates - information about the PCG and how to install and configure it. Refer to the - [Private Cloud Gateway](../clusters/pcg/pcg.md) page to learn more about PCG. +- ### Packs @@ -360,27 +159,4 @@ the following sections for a complete list of features, improvements, and known #### Deprecations and Removals -- PXK, PXK-E, and RKE2, versions prior to 1.27.x are deprecated. We recommend upgrading to a newer version of Kubernetes - to support the latest features and security updates. - -- All Kubernetes pack versions prior to 1.25.0 are disabled across the following distributions: - - - PXK, - - PXK-E - - K3s - - RKE2 - Edge - - GKE - - AKS - - Kubernetes versions for GKE and AKS prior to verison 1.25 are removed as they are no longer available upstream. AKS - 1.26 is deprecated as it reached End Of Life (EOL). - - - Exceptions - OpenStack and PXK 1.24 packs have been reverted to _Deprecated_ state from _Disabled_ state. EKS 1.24 - is also back in deprecated state as support has been extended by AWS. - -- An upstream issue in K3s could prevent clusters from starting up successfully when a node is rebooted. This issue can - be potentially be seen in patch versions 1.26.10, 1.26.4, 1.26.8 for 1.26, 1.27.2 ,1.27.5 and 1.27.7 for 1.27 and - 1.28.2, 1.28.4 for 1.28. All these versions have been deprecated. We recommend you use Kubernetes versions 1.26.14, - 1.27.11 or 1.28.7 as these versions contain the fix for the upstream issue. - - Check out the [Deprecated Packs](../integrations/deprecated-packs.md) page for a list of all deprecated packs. From 7f9b1f0298d23ff6691d8e4054dd60ce8a8ab248 Mon Sep 17 00:00:00 2001 From: Carolina Delwing Rosa Date: Fri, 17 May 2024 12:04:10 -0400 Subject: [PATCH 02/25] docs: add microk8s known issues --- .../release-notes/known-issues.md | 3 ++ .../release-notes/release-notes.md | 13 +++++++- .../troubleshooting/pack-issues.md | 31 +++++++++++++++---- 3 files changed, 40 insertions(+), 7 deletions(-) diff --git a/docs/docs-content/release-notes/known-issues.md b/docs/docs-content/release-notes/known-issues.md index 22bf1503cb..4e7cfd50b0 100644 --- a/docs/docs-content/release-notes/known-issues.md +++ b/docs/docs-content/release-notes/known-issues.md @@ -26,6 +26,9 @@ The following table lists all known issues that are currently active and affecti | If a cluster that uses the Rook-Ceph pack experiences network issues, it's possible for the file mount to become and remain unavailable even after the network is restored. | This a known issue disclosed in the [Rook GitHub repository](https://github.com/rook/rook/issues/13818). To resolve this issue, refer to [Rook-Ceph](../integrations/rook-ceph.md#file-mount-becomes-unavailable-after-cluster-experiences-network-issues) pack documentation. | April 14, 2024 | Packs, Edge | | Edge clusters on Edge hosts with ARM64 processors may experience instability issues that cause cluster failures. | ARM64 support is limited to a specific set of Edge devices. Currently, Nvidia Jetson devices are supported. | April 14, 2024 | Edge | | During the cluster provisioning process of new edge clusters, the palette webhook pods may not always deploy successfully, causing the cluster to be stuck in the provisioning phase. This issue does not impact deployed clusters. | Review the [Palette Webhook Pods Fail to Start](../troubleshooting/edge.md#scenario---palette-webhook-pods-fail-to-start) troubleshooting guide for resolution steps. | April 14, 2024 | Edge | +| At this time, [MicroK8s](../integrations/microk8s.md) does not support multi-node control plane clusters. Therefore, the `InPlaceUpgrade` strategy is the only one available for use. | No workaround is available. | June 1, 2024 | Packs | +| In clusters using [MicroK8s](../integrations/microk8s.md) as the Kubernetes distribution, the control plane node fails to upgrade when using the `InPlaceUpgrade` strategy for sequential upgrades, such as upgrading from version 1.25.x to version 1.26.x and then to version 1.27.x. | Refer to the [Control Plane Node Fails to Upgrade in Sequential MicroK8s Upgrades](../troubleshooting/pack-issues.md) troubleshooting guide for resolution steps. | June 1, 2024 | Packs | +| In clusters using [MicroK8s](../integrations/microk8s.md) as the Kubernetes distribution, using the `RollingUpgrade` strategy for clusters with less than three control plane nodes may cause the API server to be down during the upgrade, making the cluster inaccessible. | A workaround is to deploy clusters with three or more control plane nodes. | June 1, 2024 | Packs | ## Resolved Known Issues diff --git a/docs/docs-content/release-notes/release-notes.md b/docs/docs-content/release-notes/release-notes.md index 81b80b4e01..25aa43f0a0 100644 --- a/docs/docs-content/release-notes/release-notes.md +++ b/docs/docs-content/release-notes/release-notes.md @@ -38,7 +38,18 @@ saepe ut fugit ea ut architecto quae consequatur. #### Known Issues -- MicroK8s +- At this time, [MicroK8s](../integrations/microk8s.md) does not support multi-node control plane clusters. Therefore, + the `InPlaceUpgrade` strategy is the only one available for use. + +- In clusters using [MicroK8s](../integrations/microk8s.md) as the Kubernetes distribution, the control plane node fails + to upgrade when using the `InPlaceUpgrade` strategy for sequential upgrades, such as upgrading from version 1.25.x to + version 1.26.x and then to version 1.27.x. Refer to the + [Control Plane Node Fails to Upgrade in Sequential MicroK8s Upgrades](../troubleshooting/pack-issues.md) + troubleshooting guide for resolution steps. + +- In clusters using [MicroK8s](../integrations/microk8s.md) as the Kubernetes distribution, using the `RollingUpgrade` + strategy for clusters with less than three control plane nodes may cause the API server to be down during the + upgrade, making the cluster inaccessible. A workaround is to deploy clusters with three or more control plane nodes. ### Edge diff --git a/docs/docs-content/troubleshooting/pack-issues.md b/docs/docs-content/troubleshooting/pack-issues.md index 3930ef9dbc..ef10fa6316 100644 --- a/docs/docs-content/troubleshooting/pack-issues.md +++ b/docs/docs-content/troubleshooting/pack-issues.md @@ -1,16 +1,35 @@ --- sidebar_label: "Packs" -title: "Troubleshooting steps for errors during a cluster deployment" -description: "Troubleshooting steps for errors during a cluster deployment." +title: "Packs" +description: "Troubleshooting steps for common Pack scenarios." icon: "" hide_table_of_contents: false sidebar_position: 30 tags: ["troubleshooting", "packs"] --- -# Packs +The following are common scenarios that you may encounter when using Packs. -Packs documentation contains usage and other related documentation, such as troubleshooting steps. If any issue is -encountered with Pack, visit the respective Pack documentation for troubleshooting steps. +## Scenario - Control Plane Node Fails to Upgrade in Sequential MicroK8s Upgrades -
+In clusters that use [MicroK8s](../integrations/microk8s.md) as the Kubernetes distribution, there is a known issue when +using the `InPlaceUpgrade` strategy for sequential Kubernetes upgrades. For example, upgrading from version 1.25.x to +version 1.26.x and then to version 1.27.x may cause the control plane node to fail to upgrade. Use the following steps +to troubleshoot and resolve the issue. + +### Debug Steps + +1. Execute the first MicroK8s upgrade in your cluster. For example, upgrade from version 1.25.x to version 1.26.x. + +2. Ensure you can access your cluster using kubectl. Refer to the + [Access Cluster with CLI](../clusters/cluster-management/palette-webctl.md) guide for more information. + +3. After the first upgrade is complete, issue the following command to delete the pod named `upgrade-pod`. + + ```shell + kubectl delete pod upgrade-pod --namespace default + ``` + +4. Once the pod is deleted, proceed to the next upgrade. For example, upgrade from version 1.26.x to version 1.27.x. + +5. Within a few minutes, the control plane node will be upgraded correctly. From 5bf5a7f7013d627a5bcc3a9ec77a40e3d2e2a506 Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Fri, 17 May 2024 09:17:33 -0700 Subject: [PATCH 03/25] chore: updated notes --- .../automation/crossplane/crossplane.md | 2 +- .../release-notes/release-notes.md | 136 +++++++++--------- 2 files changed, 70 insertions(+), 68 deletions(-) diff --git a/docs/docs-content/automation/crossplane/crossplane.md b/docs/docs-content/automation/crossplane/crossplane.md index 9738d81c1d..1bc71d2633 100644 --- a/docs/docs-content/automation/crossplane/crossplane.md +++ b/docs/docs-content/automation/crossplane/crossplane.md @@ -23,7 +23,7 @@ provider API to request the creation of the resource within the provider's envir You can use the Palette Crossplane Provider to interact with the Palette API and create resources declaratively. -Refer to the [Palette Provider](https://marketplace.upbound.io/providers/crossplane-contrib/provider-palette/v0.12.0) +Refer to the [Palette Provider](https://marketplace.upbound.io/providers/crossplane-contrib/provider-palette/latest) page for a complete list of managed resources and examples. ## Get Started diff --git a/docs/docs-content/release-notes/release-notes.md b/docs/docs-content/release-notes/release-notes.md index 81b80b4e01..c68ff7e41a 100644 --- a/docs/docs-content/release-notes/release-notes.md +++ b/docs/docs-content/release-notes/release-notes.md @@ -32,36 +32,80 @@ saepe ut fugit ea ut architecto quae consequatur. #### Features +- The upgrade experience for MicroK8s has been improved by the introduction of new upgrade strategies. Users can now + choose between a RollingUpgrade, InPlaceUpgrade, or SmartUpgrade. To learn more about the new upgrade strategies, + refer to the [MicroK8s pack documentation](../integrations/microk8s.md). + #### Improvements +- You can now upload a custom pack to a self-hosted OCI registry multiple times by using different namespaces in the OCI + repository. + +- This release removes terminology that may be culturally insensitive or create a barrier to inclusion. We removed the + term "master" from our product and replaced it with "control-plane". This work aligns with the Linux Foundation + initiative for [Diversity & Inclusivity](https://www.linuxfoundation.org/about/diversity-inclusivity). + +#### Bug Fixes + +- The issue where Google GKE cluster deployments failed is now resolved. You can now deploy GKE clusters using the + latest available GKE versions. + #### Deprecations and Removals +- The term _master_ is removed from Palette and replaced with the term, _control plane_. This change is reflected in the + UI, API and documentation. The following API endpoints are affected as a the payload object `includeMasterMachines` is + deprecated and replaced with the new object, `includeControlPlaneMachines`: + + - POST `/v1/dashboard/spectroclusters/resources/usage` + - POST `/v1/dashboard/spectroclusters/resources/cost` + - POST `/v1/dashboard/spectroclusters/{uid}/resources/consumption` + - POST `/v1/dashboard/spectroclusters/resources/consumption` + - GET `/v1/metrics/{resourceKind}/{resourceUid}/values` + - GET `/v1/metrics/{resourceKind}/values` + + After six months, the `includeMasterMachines` object will be removed from the API. Use the + `includeControlPlaneMachines` object moving forward. + #### Known Issues -- MicroK8s +- MicroK8s does not support a multi-node cluster deployment and is limited to a single-node cluster. As a result, the + only supported upgrade strategy is _InPlace_. ### Edge -#### Breaking Changes + +- Trusted Boot is an exciting new Edge capability part of the [SENA + framework](https://www.spectrocloud.com/product/sena). Trusted Boot is a hardware-based security feature that ensures that the system boots securely and that the boot process has + not been tampered with. Trusted Boot does several significant things, all working in concert, to enhance security: + - Ensures that only trusted software can boot on the system. Any modification to any part of the hard disk will be detected. + - Encrypts all sensitive data using hardware security Trusted Platform Module (TPM). + - Ensures that the TPM will only decrypt sensitive data if the boot process is clean and untampered.. + + Unlike similar solutions, Trusted Boot utilizes a secure boot, measured boot, and encryption to protect + the booting system far more than other solutions. To learn more about Edge Trusted Boot, check out the + [Edge Trusted Boot documentation](../clusters/edge/edge.md). #### Features #### Improvements -#### Known issues +#### Known Issues ### Virtual Machine Orchestrator (VMO) #### Improvements -- Internal VMO components, including KubeVirt, KubeVirt Container Data Importer, and Snapshot Controller, have been - updated to ensure compatibility with the latest versions of KubeVirt and associated components. +- The KubeVirt version in use is now v1.2.0. Other minor maintenance updates in support of Kubevirt 1.2.0 are also + included. ### VerteX #### Features -#### Improvements +- You can now deploy Palette VerteX using Red Hat Linux Enterprise (RHEL) as the Operating System (OS) for the VerteX + instance nodes. Using RHEL as the base OS is available for VerteX when deployed to a VMware vSphere environment using + the Palette CLI. A prompt will ask you to select the OS during the VerteX deployment process. Refer to the Palette + VerteX installation [guide](../vertex/install-palette-vertex/install-on-vmware/install.md) for more details. ### Terraform @@ -74,88 +118,46 @@ saepe ut fugit ea ut architecto quae consequatur. ### Docs and Education -- +- [Palette's Crossplane provider](https://marketplace.upbound.io/providers/crossplane-contrib/provider-palette/latest) + now has a dedicated documentation section. The new section also includes a few guides on how to deploy a Kubernetes + clusters using Crossplane. Check out the [Crossplane Provider](../automation/crossplane/crossplane.md) documentation + for more details. ### Packs #### Pack Notes -- Several Kubernetes versions are [deprecated](../integrations/maintenance-policy.md#pack-deprecations) and removed in - this release. Review the [Deprecation](#deprecations-and-removals) section for a list of deprecated packs. - -- OpenStack support is limited to Palette eXtended Kubernetes (PXK) for version 1.24.x. +- The BYOOS pack is now available for Palette VerteX deployments. This allows users to bring their own operating system + (OS) image to deploy VerteX instances. RHEL is the only custom OS supported for VerteX deployments at this time. -- Local Path Provisioner CSI for Edge is now a [verified pack](../integrations/verified_packs.md). +- MicroK8s now support of BootCommands, PreRunCommands and PostRunCommands. Our MicroK8s implementation now supports + boot, preRun and postRun commands on cloud-init. This allows users to execute custom commands before and after their + MicroK8s deployment processes, providing enhanced flexibility and control over deployment environments. #### Kubernetes -| Pack | New Version | -| ------------------------------------------ | ----------- | -| K3s | 1.26.14 | -| K3s | 1.27.11 | -| K3s | 1.28.7 | -| K3s | 1.29.2 | -| Konvoy | 1.27.6 | -| Palette eXtended Kubernetes (PXK) | 1.29.0 | -| Palette eXtended Kubernetes - Edge (PXK-E) | 1.29.0 | -| RKE2 | 1.29.0 | -| RKE2 - Edge | 1.26.14 | -| RKE2 - Edge | 1.27.11 | -| RKE2 - Edge | 1.28.7 | -| RKE2 - Edge | 1.29.3 | +| Pack | New Version | +| ---- | ----------- | #### CNI -| Pack | New Version | -| ----------- | ----------- | -| AWS VPC CNI | 1.15.5 | -| Calico | 3.27.0 | -| Cilium OSS | 1.13.12 | -| Cilium OSS | 1.14.7 | -| Cilium OSS | 1.15.1 | -| Flannel | 0.24.0 | +| Pack | New Version | +| ---- | ----------- | #### CSI -| Pack | New Version | -| ----------------------------------- | ------------- | -| AWS EBS CSI | 1.26.1 | -| GCE Persistent Disk Driver | 1.12.4 | -| Local Path Provisioner CSI for Edge | 0.0.25 | -| Longhorn CSI | 1.6.0 | -| Rook Ceph (manifests) | 1.13.1 | -| vSphere CSI | 3.1.0 , 3.1.2 | +| Pack | New Version | +| ---- | ----------- | #### Add-on Packs -| Pack | New Version | -| ----------------------------- | ----------- | -| AWS Application Load Balancer | 2.6.2 | -| Cilium Tetragon | 0.10.1 | -| Cluster Autoscaler for AWS | 1.27.5 | -| Cluster Autoscaler for AWS | 1.28.2 | -| External DNS | 0.13.6 | -| External Secrets Operator | 0.9.11 | -| HashiCorp Vault | 0.27.0 | -| Istio | 1.20.1 | -| MetalLB | 0.13.12 | -| Nginx Ingress | 1.9.5 | -| Prometheus Grafana | 55.8.3 | +| Pack | New Version | +| ---- | ----------- | #### FIPS Packs -| Pack | New Version | -| ------------------------------------------ | ----------- | -| AKS | 1.27 | -| AKS | 1.28 | -| AWS EBS CSI | 1.26.1 | -| Calico CNI | 3.26.3 | -| Konvoy | 1.27.6 | -| Palette eXtended Kubernetes (PXK) | 1.26.12 | -| Palette eXtended Kubernetes (PXK) | 1.27.11 | -| Palette eXtended Kubernetes - Edge (PXK-E) | 1.26.12 | -| Palette eXtended Kubernetes - Edge (PXK-E) | 1.27.11 | -| RKE2 - Edge | 1.26.12 | +| Pack | New Version | +| ---- | ----------- | #### Deprecations and Removals From 1a30a139d9c97bab161913dd089802665b541fef Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Fri, 17 May 2024 11:34:04 -0700 Subject: [PATCH 04/25] save --- docs/docs-content/release-notes/release-notes.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/docs-content/release-notes/release-notes.md b/docs/docs-content/release-notes/release-notes.md index ecd1cf5042..078469fe8d 100644 --- a/docs/docs-content/release-notes/release-notes.md +++ b/docs/docs-content/release-notes/release-notes.md @@ -83,6 +83,8 @@ saepe ut fugit ea ut architecto quae consequatur. ### Edge +#### Features + - Trusted Boot is an exciting new Edge capability part of the [SENA framework](https://www.spectrocloud.com/product/sena). Trusted Boot is a hardware-based security feature that ensures that the system boots securely and that the boot process has @@ -95,10 +97,11 @@ saepe ut fugit ea ut architecto quae consequatur. the booting system far more than other solutions. To learn more about Edge Trusted Boot, check out the [Edge Trusted Boot documentation](../clusters/edge/edge.md). -#### Features - #### Improvements + +- Cluster Profile Variables + #### Known Issues ### Virtual Machine Orchestrator (VMO) @@ -121,7 +124,7 @@ saepe ut fugit ea ut architecto quae consequatur. #### Features -- Version 0.19.0 of the +- Version 0.20.0 of the [Spectro Cloud Terraform provider](https://registry.terraform.io/providers/spectrocloud/spectrocloud/latest/docs) is available. For more details, refer to the Terraform provider [release page](https://github.com/spectrocloud/terraform-provider-spectrocloud/releases). From e5656065f6f8dc1c3cca14475a17d2ec1ae7b180 Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Fri, 17 May 2024 14:20:25 -0700 Subject: [PATCH 05/25] docs: updated release notes --- docs/docs-content/release-notes/release-notes.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/docs/docs-content/release-notes/release-notes.md b/docs/docs-content/release-notes/release-notes.md index 078469fe8d..78477c3178 100644 --- a/docs/docs-content/release-notes/release-notes.md +++ b/docs/docs-content/release-notes/release-notes.md @@ -90,7 +90,7 @@ saepe ut fugit ea ut architecto quae consequatur. framework](https://www.spectrocloud.com/product/sena). Trusted Boot is a hardware-based security feature that ensures that the system boots securely and that the boot process has not been tampered with. Trusted Boot does several significant things, all working in concert, to enhance security: - Ensures that only trusted software can boot on the system. Any modification to any part of the hard disk will be detected. - - Encrypts all sensitive data using hardware security Trusted Platform Module (TPM). + - Encrypts all sensitive data on disk using hardware security Trusted Platform Module (TPM). - Ensures that the TPM will only decrypt sensitive data if the boot process is clean and untampered.. Unlike similar solutions, Trusted Boot utilizes a secure boot, measured boot, and encryption to protect @@ -100,7 +100,17 @@ saepe ut fugit ea ut architecto quae consequatur. #### Improvements -- Cluster Profile Variables +- The Cluster Profile Variables user experience has been improved. Users can now identify where a variable is used, preview the variable during creation time, and change the order of the variables displayed. An improved Day-2 management experience is also available. You can learn more about these new features in the [Cluster Profile Variables](../profiles/cluster-profiles/create-cluster-profiles/define-profile-variables.md) documentation. + + + +- Edge clusters managed by [LocalUI](../clusters/edge/local-ui/local-ui.md) now receive automatic SSL certificate updates for Kubernetes. Users can also manually trigger the SSL certificate update process. For more information, refer to the [LocalUI](../clusters/edge/local-ui/local-ui.md) documentation. + +- [LocalUI](../clusters/edge/local-ui/local-ui.md) now includes tools to help users troubleshoot network issues. The tools include ping and traceroute. For more information, refer to the [LocalUI](../clusters/edge/local-ui/local-ui.md) documentation. + +- Clusters managed by [LocalUI](../clusters/edge/local-ui/local-ui.md) now include a new feature that allows users to download diagnostic logs from the LocalUI interface. This feature reduces the friction of troubleshooting issues on the cluster as the need to SSH into the cluster is reduced. + +- Support for custom links, URLs, and static pages is now available in LocalUI. You can populate custom links in the left **Main Menu** of [LocalUI](../clusters/edge/local-ui/local-ui.md), which will either load content into in an iframe or act as en external link. You can also can host static pages from LocalUI. This is useful when you need to deploy and host custom or specific content for a site and want to avoid introducing additional services to host a static site #### Known Issues From 79dabf5f99ba172cd5e4db2235db630476968889 Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Mon, 20 May 2024 07:55:12 -0700 Subject: [PATCH 06/25] chore: updated release notes --- .../release-notes/known-issues.md | 1 - .../release-notes/release-notes.md | 19 ++++++++++++------- 2 files changed, 12 insertions(+), 8 deletions(-) diff --git a/docs/docs-content/release-notes/known-issues.md b/docs/docs-content/release-notes/known-issues.md index 7776f49798..d1d030348c 100644 --- a/docs/docs-content/release-notes/known-issues.md +++ b/docs/docs-content/release-notes/known-issues.md @@ -18,7 +18,6 @@ The following table lists all known issues that are currently active and affecti | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------- | ----------------- | | [MicroK8s](../integrations/microk8s.md) does not support multi-node control plane clusters. The upgrade strategy, `InPlaceUpgrade`, is the only option available for use. | No workaround is available. | June 1, 2024 | Packs | | Clusters using [MicroK8s](../integrations/microk8s.md) as the Kubernetes distribution, the control plane node fails to upgrade when using the `InPlaceUpgrade` strategy for sequential upgrades, such as upgrading from version 1.25.x to version 1.26.x and then to version 1.27.x. | Refer to the [Control Plane Node Fails to Upgrade in Sequential MicroK8s Upgrades](../troubleshooting/pack-issues.md) troubleshooting guide for resolution steps. | June 1, 2024 | Packs | -| Clusters usig [MicroK8s](../integrations/microk8s.md) as the Kubernetes distribution, using the `RollingUpgrade` strategy for clusters with less than three control plane nodes may cause the API server to be down during the upgrade, making the cluster inaccessible. | A workaround is to deploy clusters with three or more control plane nodes. | June 1, 2024 | Packs | | Conducting cluster node scaling operations on a cluster undergoing a backup can lead to issues and potential unresponsiveness. | To avoid this, ensure no backup operations are in progress before scaling nodes or performing other cluster operations that change the cluster state | April 14, 2024 | Clusters | | Palette automatically creates an AWS security group for worker nodes using the format `-node`. If a security group with the same name already exists in the VPC, the cluster creation process fails. | To avoid this, ensure that no security group with the same name exists in the VPC before creating a cluster. | April 14, 2024 | Clusters | | K3s version 1.27.7 has been marked as _Deprecated_. This version has a known issue that causes clusters to crash. | Upgrade to a newer version of K3s to avoid the issue, such as versions 1.26.12, 1.28.5, and 1.27.11. You can learn more about the issue in the [K3s GitHub issue](https://github.com/k3s-io/k3s/issues/9047) page. | April 14, 2024 | Packs, Clusters | diff --git a/docs/docs-content/release-notes/release-notes.md b/docs/docs-content/release-notes/release-notes.md index 78477c3178..8cdcc35c73 100644 --- a/docs/docs-content/release-notes/release-notes.md +++ b/docs/docs-content/release-notes/release-notes.md @@ -28,13 +28,15 @@ saepe ut fugit ea ut architecto quae consequatur. - Google Cloud Platform (GCP) does not support the ability for users to specify a patch version for the Kubernetes version used in GKE clusters. In this release, Palette aligns with GCP's behavior and removes the ability to specify a - patch version when creating a cluster profile for GKE. Only the major and minor versions are available for selection. + patch version when creating a cluster profile for AKS, EKS, and GKE. Only the major and minor versions are available + for selection. The underlying cloud provider will automatically select the latest patch version available for the + selected major and minor version. #### Features -- The upgrade experience for MicroK8s has been improved by the introduction of new upgrade strategies. Users can now - choose between a RollingUpgrade, InPlaceUpgrade, or SmartUpgrade. To learn more about the new upgrade strategies, - refer to the [MicroK8s pack documentation](../integrations/microk8s.md). +- The upgrade experience for MicroK8s has been improved by the introduction of new upgrade strategies. Users + can now choose between a RollingUpgrade, InPlaceUpgrade, or SmartUpgrade. To learn more about the new upgrade + strategies, refer to the [MicroK8s pack documentation](../integrations/microk8s.md). #### Improvements @@ -153,9 +155,12 @@ saepe ut fugit ea ut architecto quae consequatur. - The BYOOS pack is now available for Palette VerteX deployments. This allows users to bring their own operating system (OS) image to deploy VerteX instances. RHEL is the only custom OS supported for VerteX deployments at this time. -- MicroK8s now support of BootCommands, PreRunCommands and PostRunCommands. Our MicroK8s implementation now supports - boot, preRun and postRun commands on cloud-init. This allows users to execute custom commands before and after their - MicroK8s deployment processes, providing enhanced flexibility and control over deployment environments. +- MicroK8s now supports boot, preRun and postRun commands on cloud-init. This allows users to execute custom commands + before and after their MicroK8s deployment processes, providing enhanced flexibility and control over deployment + environments. + +- The Kubernetes pack parameter `k8sHardening` is removed and no longer used as the method for hardening images during + the image creation process. This change does not impact users. #### Kubernetes From be39708d71731918d1544cdded056e4f09a82ce1 Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Wed, 22 May 2024 08:43:54 -0700 Subject: [PATCH 07/25] docs: add bc note --- docs/docs-content/release-notes/release-notes.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/docs-content/release-notes/release-notes.md b/docs/docs-content/release-notes/release-notes.md index 8cdcc35c73..ec63d6ea2e 100644 --- a/docs/docs-content/release-notes/release-notes.md +++ b/docs/docs-content/release-notes/release-notes.md @@ -32,6 +32,12 @@ saepe ut fugit ea ut architecto quae consequatur. for selection. The underlying cloud provider will automatically select the latest patch version available for the selected major and minor version. +- Validator Helm Charts have migrated from `https://github.com/spectrocloud-labs/validator` to + `https://github.com/validator-labs/validator`. Former versions of the Palette CLI will point to the former repository + when prompted for the Helm chart location and require a manual URL change. The new version of the Palette CLI will + point to the new repository. Refer to the [Validator](../automation/palette-cli/commands/validator.md) CLI page + documentation for more details. + #### Features - The upgrade experience for MicroK8s has been improved by the introduction of new upgrade strategies. Users From 6989a8dcc7e2c0f4d9093066d8292af379303394 Mon Sep 17 00:00:00 2001 From: yuliiiah Date: Fri, 24 May 2024 20:37:47 +0200 Subject: [PATCH 08/25] docs: Start filling out the packs tables in RN --- _partials/index.ts | 2 +- .../release-notes/release-notes.md | 53 +++++++++++++++---- 2 files changed, 44 insertions(+), 11 deletions(-) diff --git a/_partials/index.ts b/_partials/index.ts index 6c691941af..dfdeb6e845 100644 --- a/_partials/index.ts +++ b/_partials/index.ts @@ -1,2 +1,2 @@ // This file is generated. DO NOT EDIT! -export * as partialexample2689 from "@site/_partials/_partial_example.mdx"; +export * as partialexample29969 from '@site/_partials/_partial_example.mdx'; diff --git a/docs/docs-content/release-notes/release-notes.md b/docs/docs-content/release-notes/release-notes.md index ec63d6ea2e..140e2a5d6e 100644 --- a/docs/docs-content/release-notes/release-notes.md +++ b/docs/docs-content/release-notes/release-notes.md @@ -170,28 +170,61 @@ saepe ut fugit ea ut architecto quae consequatur. #### Kubernetes -| Pack | New Version | -| ---- | ----------- | +| Pack | New Version | +| ---------- | ----------- | +| Kubernetes | 1.29 | +| GKE | 1.29 | #### CNI -| Pack | New Version | -| ---- | ----------- | +| Pack | New Version | +| ------------------ | ----------- | +| AWS VPC CNI (Helm) | 1.17.1 | +| Calico | 3.27.2 | +| Calico Azure | 3.27.2 | +| Cilium OSS | 1.15.3 | +| Flannel | 0.24.3 | #### CSI -| Pack | New Version | -| ---- | ----------- | +| Pack | New Version | +| ----------------------- | ----------- | +| Amazon EFS | 1.7.6 | +| Azure Disk CSI Driver | 1.30.0 | +| GCE Persistent Disk CSI | 1.13.2 | +| Portworx Operator | 3.1.0 | #### Add-on Packs -| Pack | New Version | -| ---- | ----------- | +| Pack | New Version | +| ---------------------------- | ----------- | +| AWS Application Loadbalancer | 2.7.2 | +| AWS Cluster Autoscaler Helm | 1.29.2 | +| Amazon EFS | 1.7.6 | +| Cisco AppDynamics Collectors | 1.21.1264 | +| Cisco AppDynamics Operators | 1.21.368 | +| ECK Operator | 2.12.1 | +| ECK Stack | 0.10.0 | +| MetalLB (Helm) | 0.14.3 | +| Nginx | 1.10.0 | +| OpenPolicyAgent | 3.15.1 | +| Portworx Operator | 3.1.0 | +| Prometheus - Grafana | 57.0.1 | +| Strimzi Kafka | 0.4.0 | +| unCtl | 1.1.0 | #### FIPS Packs -| Pack | New Version | -| ---- | ----------- | +| Pack | New Version | +| ---------------------------------------- | --------------------------- | +| AWS VPC CNI (Helm) | 1.1.17 | +| Calico Azure | 3.26.3 | +| Cilium | 1.14.3 | +| Longhorn | 1.5.3 | +| Palette eXtended Kubernetes Edge (PXK-E) | 1.29.5 | +| Palette Optimized RKE2 | 1.29.4 | +| Palette eXtended Kubernetes | 1.29.4 | +| RKE2 | 1.29.4-rke2r1-build20240416 | #### Deprecations and Removals From b6650ca0331462017130c94e761ecdd66f4b931f Mon Sep 17 00:00:00 2001 From: yuliiiah Date: Tue, 28 May 2024 14:20:39 +0200 Subject: [PATCH 09/25] docs: Update pack lists in the 4.4 release notes --- _partials/index.ts | 2 - .../release-notes/release-notes.md | 39 ++++++++----------- 2 files changed, 17 insertions(+), 24 deletions(-) delete mode 100644 _partials/index.ts diff --git a/_partials/index.ts b/_partials/index.ts deleted file mode 100644 index dfdeb6e845..0000000000 --- a/_partials/index.ts +++ /dev/null @@ -1,2 +0,0 @@ -// This file is generated. DO NOT EDIT! -export * as partialexample29969 from '@site/_partials/_partial_example.mdx'; diff --git a/docs/docs-content/release-notes/release-notes.md b/docs/docs-content/release-notes/release-notes.md index 140e2a5d6e..2cac328a76 100644 --- a/docs/docs-content/release-notes/release-notes.md +++ b/docs/docs-content/release-notes/release-notes.md @@ -170,10 +170,11 @@ saepe ut fugit ea ut architecto quae consequatur. #### Kubernetes -| Pack | New Version | -| ---------- | ----------- | -| Kubernetes | 1.29 | -| GKE | 1.29 | +| Pack | New Version | +| ---------------------------------------- | ---------------------------------------- | +| Palette eXtended Kubernetes Edge (PXK-E) | 1.27.11
1.28.9 | +| Kubernetes | 1.29 | +| GKE | 1.26
1.27
1.28
1.29 | #### CNI @@ -192,7 +193,7 @@ saepe ut fugit ea ut architecto quae consequatur. | Amazon EFS | 1.7.6 | | Azure Disk CSI Driver | 1.30.0 | | GCE Persistent Disk CSI | 1.13.2 | -| Portworx Operator | 3.1.0 | +| Portworx /w Operator | 3.1.0 | #### Add-on Packs @@ -201,30 +202,24 @@ saepe ut fugit ea ut architecto quae consequatur. | AWS Application Loadbalancer | 2.7.2 | | AWS Cluster Autoscaler Helm | 1.29.2 | | Amazon EFS | 1.7.6 | -| Cisco AppDynamics Collectors | 1.21.1264 | -| Cisco AppDynamics Operators | 1.21.368 | -| ECK Operator | 2.12.1 | -| ECK Stack | 0.10.0 | | MetalLB (Helm) | 0.14.3 | | Nginx | 1.10.0 | | OpenPolicyAgent | 3.15.1 | -| Portworx Operator | 3.1.0 | +| Portworx /w Operator | 3.1.0 | | Prometheus - Grafana | 57.0.1 | -| Strimzi Kafka | 0.4.0 | -| unCtl | 1.1.0 | #### FIPS Packs -| Pack | New Version | -| ---------------------------------------- | --------------------------- | -| AWS VPC CNI (Helm) | 1.1.17 | -| Calico Azure | 3.26.3 | -| Cilium | 1.14.3 | -| Longhorn | 1.5.3 | -| Palette eXtended Kubernetes Edge (PXK-E) | 1.29.5 | -| Palette Optimized RKE2 | 1.29.4 | -| Palette eXtended Kubernetes | 1.29.4 | -| RKE2 | 1.29.4-rke2r1-build20240416 | +| Pack | New Version | +| ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | +| AWS VPC CNI (Helm) | 1.1.17 | +| Calico Azure | 3.25.1
3.26.3 | +| Cilium | 1.13.4
1.14.3 | +| Longhorn | 1.4.1
1.5.3 | +| Palette eXtended Kubernetes Edge (PXK-E) | 1.24.13
1.25.9
1.26.15
1.27.14
1.28.10
1.29.5 | +| Palette Optimized RKE2 | 1.24.6
1.26.15
1.27.13
1.28.9
1.29.4 | +| Palette eXtended Kubernetes | 1.27.13
1.27.2
1.28.9
1.29.4 | +| RKE2 | 1.27.13-rke2r1-build20240416
1.28.9-rke2r1-build20240416
1.29.0-rke2r1-build20231213
1.29.4-rke2r1-build20240416 | #### Deprecations and Removals From aa809ab9eeb76961690c385911290394b959727e Mon Sep 17 00:00:00 2001 From: yuliiiah Date: Tue, 28 May 2024 14:27:11 +0200 Subject: [PATCH 10/25] docs: Remove deprecated packs from the pack lists (added them by mistake) --- docs/docs-content/release-notes/release-notes.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/docs-content/release-notes/release-notes.md b/docs/docs-content/release-notes/release-notes.md index 2cac328a76..9d40eb3acd 100644 --- a/docs/docs-content/release-notes/release-notes.md +++ b/docs/docs-content/release-notes/release-notes.md @@ -216,8 +216,8 @@ saepe ut fugit ea ut architecto quae consequatur. | Calico Azure | 3.25.1
3.26.3 | | Cilium | 1.13.4
1.14.3 | | Longhorn | 1.4.1
1.5.3 | -| Palette eXtended Kubernetes Edge (PXK-E) | 1.24.13
1.25.9
1.26.15
1.27.14
1.28.10
1.29.5 | -| Palette Optimized RKE2 | 1.24.6
1.26.15
1.27.13
1.28.9
1.29.4 | +| Palette eXtended Kubernetes Edge (PXK-E) | 1.27.14
1.28.10
1.29.5 | +| Palette Optimized RKE2 | 1.27.13
1.28.9
1.29.4 | | Palette eXtended Kubernetes | 1.27.13
1.27.2
1.28.9
1.29.4 | | RKE2 | 1.27.13-rke2r1-build20240416
1.28.9-rke2r1-build20240416
1.29.0-rke2r1-build20231213
1.29.4-rke2r1-build20240416 | From d8769af2c0a67e6c37d05a69bb112830aef0ca6b Mon Sep 17 00:00:00 2001 From: yuliiiah Date: Wed, 29 May 2024 19:05:59 +0200 Subject: [PATCH 11/25] docs: Implement peer review --- .../release-notes/release-notes.md | 47 +++++++++++++------ 1 file changed, 32 insertions(+), 15 deletions(-) diff --git a/docs/docs-content/release-notes/release-notes.md b/docs/docs-content/release-notes/release-notes.md index 9d40eb3acd..bce09887fd 100644 --- a/docs/docs-content/release-notes/release-notes.md +++ b/docs/docs-content/release-notes/release-notes.md @@ -170,11 +170,15 @@ saepe ut fugit ea ut architecto quae consequatur. #### Kubernetes -| Pack | New Version | -| ---------------------------------------- | ---------------------------------------- | -| Palette eXtended Kubernetes Edge (PXK-E) | 1.27.11
1.28.9 | -| Kubernetes | 1.29 | -| GKE | 1.26
1.27
1.28
1.29 | +| Pack | New Version | +| ---------------------------------------- | ----------- | +| Palette eXtended Kubernetes Edge (PXK-E) | 1.27.11 | +| Palette eXtended Kubernetes Edge (PXK-E) | 1.28.9 | +| Kubernetes Azure AKS | 1.29 | +| Kubernetes Google GKE | 1.26 | +| Kubernetes Google GKE | 1.27 | +| Kubernetes Google GKE | 1.28 | +| Kubernetes Google GKE | 1.29 | #### CNI @@ -210,16 +214,29 @@ saepe ut fugit ea ut architecto quae consequatur. #### FIPS Packs -| Pack | New Version | -| ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | -| AWS VPC CNI (Helm) | 1.1.17 | -| Calico Azure | 3.25.1
3.26.3 | -| Cilium | 1.13.4
1.14.3 | -| Longhorn | 1.4.1
1.5.3 | -| Palette eXtended Kubernetes Edge (PXK-E) | 1.27.14
1.28.10
1.29.5 | -| Palette Optimized RKE2 | 1.27.13
1.28.9
1.29.4 | -| Palette eXtended Kubernetes | 1.27.13
1.27.2
1.28.9
1.29.4 | -| RKE2 | 1.27.13-rke2r1-build20240416
1.28.9-rke2r1-build20240416
1.29.0-rke2r1-build20231213
1.29.4-rke2r1-build20240416 | +| Pack | New Version | +| ---------------------------------------- | ----------- | +| AWS VPC CNI (Helm) | 1.1.17 | +| Calico Azure | 3.25.1 | +| Calico Azure | 3.26.3 | +| Cilium | 1.13.4 | +| Cilium | 1.14.3 | +| Longhorn | 1.4.1 | +| Longhorn | 1.5.3 | +| Palette eXtended Kubernetes Edge (PXK-E) | 1.27.14 | +| Palette eXtended Kubernetes Edge (PXK-E) | 1.28.10 | +| Palette eXtended Kubernetes Edge (PXK-E) | 1.29.5 | +| Palette Optimized RKE2 | 1.27.13 | +| Palette Optimized RKE2 | 1.28.9 | +| Palette Optimized RKE2 | 1.29.4 | +| Palette eXtended Kubernetes | 1.27.13 | +| Palette eXtended Kubernetes | 1.27.2 | +| Palette eXtended Kubernetes | 1.28.9 | +| Palette eXtended Kubernetes | 1.29.4 | +| RKE2 | 1.27.13 | +| RKE2 | 1.28.9 | +| RKE2 | 1.29.0 | +| RKE2 | 1.29.4 | #### Deprecations and Removals From 1c4e24416075408d3f0bfeacf84abd945b49f2d3 Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Mon, 3 Jun 2024 10:59:15 -0700 Subject: [PATCH 12/25] chore: updated rl notes --- docs/docs-content/release-notes/release-notes.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/docs-content/release-notes/release-notes.md b/docs/docs-content/release-notes/release-notes.md index bce09887fd..5d377738bf 100644 --- a/docs/docs-content/release-notes/release-notes.md +++ b/docs/docs-content/release-notes/release-notes.md @@ -85,10 +85,6 @@ saepe ut fugit ea ut architecto quae consequatur. [Control Plane Node Fails to Upgrade in Sequential MicroK8s Upgrades](../troubleshooting/pack-issues.md) troubleshooting guide for resolution steps. -- In clusters using [MicroK8s](../integrations/microk8s.md) as the Kubernetes distribution, using the `RollingUpgrade` - strategy for clusters with less than three control plane nodes may cause the API server to be down during the - upgrade, making the cluster inaccessible. A workaround is to deploy clusters with three or more control plane nodes. - ### Edge #### Features From 014d3ca9c1819b34c3288078a5cdf991509241b1 Mon Sep 17 00:00:00 2001 From: Romain Decker Date: Tue, 4 Jun 2024 11:46:46 +0200 Subject: [PATCH 13/25] Add K8s 1.29.4 known issue --- docs/docs-content/release-notes/release-notes.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/docs-content/release-notes/release-notes.md b/docs/docs-content/release-notes/release-notes.md index 21acac0954..5e2f67c565 100644 --- a/docs/docs-content/release-notes/release-notes.md +++ b/docs/docs-content/release-notes/release-notes.md @@ -76,6 +76,8 @@ saepe ut fugit ea ut architecto quae consequatur. #### Known Issues +- RKE2 and Palette eXtended Kubernetes (PXK) 1.29.4 have a known issue that prevent its usage with Canonical MAAS. Support will be added in an upcoming release. + - [MicroK8s](../integrations/microk8s.md) does not support a multi-node cluster deployment and is limited to a single-node cluster. As a result, the only supported upgrade strategy is InPlaceUpgrade. From 3acc95c1ef3c8500d92835ca1c9d1c7c16d69173 Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Tue, 4 Jun 2024 12:21:30 -0700 Subject: [PATCH 14/25] docs: updated release notes --- .../release-notes/known-issues.md | 5 +- .../release-notes/release-notes.md | 74 +++++++++++++------ 2 files changed, 53 insertions(+), 26 deletions(-) diff --git a/docs/docs-content/release-notes/known-issues.md b/docs/docs-content/release-notes/known-issues.md index 2478c843a7..57694c0fe3 100644 --- a/docs/docs-content/release-notes/known-issues.md +++ b/docs/docs-content/release-notes/known-issues.md @@ -16,8 +16,9 @@ The following table lists all known issues that are currently active and affecti | Description | Workaround | Publish Date | Product Component | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- | ----------------- | -| [MicroK8s](../integrations/microk8s.md) does not support multi-node control plane clusters. The upgrade strategy, `InPlaceUpgrade`, is the only option available for use. | No workaround is available. | June 1, 2024 | Packs | -| Clusters using [MicroK8s](../integrations/microk8s.md) as the Kubernetes distribution, the control plane node fails to upgrade when using the `InPlaceUpgrade` strategy for sequential upgrades, such as upgrading from version 1.25.x to version 1.26.x and then to version 1.27.x. | Refer to the [Control Plane Node Fails to Upgrade in Sequential MicroK8s Upgrades](../troubleshooting/pack-issues.md) troubleshooting guide for resolution steps. | June 1, 2024 | Packs | +| An issue prevents RKE2 and Palette eXtended Kubernetes (PXK) on version 1.29.4 from operating correctly with Canonical MAAS. | A temporary workaround is using a version lower than 1.29.4 when using MAAS. | June 8, 2024 | Packs, Clusters | +| [MicroK8s](../integrations/microk8s.md) does not support multi-node control plane clusters. The upgrade strategy, `InPlaceUpgrade`, is the only option available for use. | No workaround is available. | June 8, 2024 | Packs | +| Clusters using [MicroK8s](../integrations/microk8s.md) as the Kubernetes distribution, the control plane node fails to upgrade when using the `InPlaceUpgrade` strategy for sequential upgrades, such as upgrading from version 1.25.x to version 1.26.x and then to version 1.27.x. | Refer to the [Control Plane Node Fails to Upgrade in Sequential MicroK8s Upgrades](../troubleshooting/pack-issues.md) troubleshooting guide for resolution steps. | June 8, 2024 | Packs | | Deploying self-hosted Palette or VerteX to a vSphere environment fails if vCenter has standalone hosts directly under a Datacenter. Persistent Volume (PV) provisioning fails due to an upstream issue with the vSphere Container Storage Interface (CSI) for all versions before v3.2.0. Palette and VerteX use the vSphere CSI version 3.1.2 internally. The issue may also occur in workload clusters deployed on vSphere using the same vSphere CSI for storage volume provisioning. | If you encounter the following error message when deploying self-hosted Palette or VerteX: `'ProvisioningFailed failed to provision volume with StorageClass "spectro-storage-class". Error: failed to fetch hosts from entity ComputeResource:domain-xyz` then use the following workaround. Remove standalone hosts directly under the Datacenter from vCenter and allow the volume provisioning to complete. After the volume is provisioned, you can add the standalone hosts back. You can also use a service account that does not have access to the standalone hosts as the user that deployed Palette. | May 21, 2024 | Self-Hosted | | Conducting cluster node scaling operations on a cluster undergoing a backup can lead to issues and potential unresponsiveness. | To avoid this, ensure no backup operations are in progress before scaling nodes or performing other cluster operations that change the cluster state | April 14, 2024 | Clusters | | Palette automatically creates an AWS security group for worker nodes using the format `-node`. If a security group with the same name already exists in the VPC, the cluster creation process fails. | To avoid this, ensure that no security group with the same name exists in the VPC before creating a cluster. | April 14, 2024 | Clusters | diff --git a/docs/docs-content/release-notes/release-notes.md b/docs/docs-content/release-notes/release-notes.md index 5e2f67c565..4d84718516 100644 --- a/docs/docs-content/release-notes/release-notes.md +++ b/docs/docs-content/release-notes/release-notes.md @@ -26,11 +26,10 @@ saepe ut fugit ea ut architecto quae consequatur. #### Breaking Changes -- Google Cloud Platform (GCP) does not support the ability for users to specify a patch version for the Kubernetes - version used in GKE clusters. In this release, Palette aligns with GCP's behavior and removes the ability to specify a - patch version when creating a cluster profile for AKS, EKS, and GKE. Only the major and minor versions are available - for selection. The underlying cloud provider will automatically select the latest patch version available for the - selected major and minor version. +- In this release, Palette aligns Google Cloud Platform GKE behavior with Azure AKS and AWS EKS and removes the ability + to specify a patch version when creating a cluster profile for AKS, EKS, and GKE. Only the major and minor versions + are available for selection. The underlying cloud provider will automatically select the latest patch version + available for the selected major and minor version. - Validator Helm Charts have migrated from `https://github.com/spectrocloud-labs/validator` to `https://github.com/validator-labs/validator`. Former versions of the Palette CLI will point to the former repository @@ -40,9 +39,10 @@ saepe ut fugit ea ut architecto quae consequatur. #### Features -- The upgrade experience for MicroK8s has been improved by the introduction of new upgrade strategies. Users - can now choose between a RollingUpgrade, InPlaceUpgrade, or SmartUpgrade. To learn more about the new upgrade - strategies, refer to the [MicroK8s pack documentation](../integrations/microk8s.md). +- The MicroK8s pack layer now expose `bootCommands`, `preRunCommands` and `postRunCommands`. You can use + these commands to customize and configure MicroK8s as needed. MicroK8s is delivered as a Technical Preview for AWS and + Canonical MAAS in this release. To learn more, refer to the MicroK8s pack + [documentation](../integrations/microk8s.md). #### Improvements @@ -76,7 +76,8 @@ saepe ut fugit ea ut architecto quae consequatur. #### Known Issues -- RKE2 and Palette eXtended Kubernetes (PXK) 1.29.4 have a known issue that prevent its usage with Canonical MAAS. Support will be added in an upcoming release. +- An issue prevents RKE2 and Palette eXtended Kubernetes (PXK) on version 1.29.4 from operating correctly with Canonical + MAAS. A temporary workaround is using a version lower than 1.29.4 when using MAAS.. - [MicroK8s](../integrations/microk8s.md) does not support a multi-node cluster deployment and is limited to a single-node cluster. As a result, the only supported upgrade strategy is InPlaceUpgrade. @@ -155,6 +156,9 @@ saepe ut fugit ea ut architecto quae consequatur. #### Pack Notes +- Cluster Autoscaler version 1.29.2 is a Helm based pack. Previous version were manifest based. Upgrades to the new + version require you to select the new Helm based pack. + - The BYOOS pack is now available for Palette VerteX deployments. This allows users to bring their own operating system (OS) image to deploy VerteX instances. RHEL is the only custom OS supported for VerteX deployments at this time. @@ -165,17 +169,31 @@ saepe ut fugit ea ut architecto quae consequatur. - The Kubernetes pack parameter `k8sHardening` is removed and no longer used as the method for hardening images during the image creation process. This change does not impact users. +- Cluster Autoscaler is now a verified pack. Refer to the [Verified Packs](../integrations/verified_packs.md) page for + more details on verified packs. + #### Kubernetes | Pack | New Version | | ---------------------------------------- | ----------- | +| Palette eXtended Kubernetes Edge (PXK-E) | 1.26.15 | | Palette eXtended Kubernetes Edge (PXK-E) | 1.27.11 | | Palette eXtended Kubernetes Edge (PXK-E) | 1.28.9 | +| Palette eXtended Kubernetes | 1.27.13 | +| Palette eXtended Kubernetes | 1.28.9 | +| Palette eXtended Kubernetes | 1.29.4 | | Kubernetes Azure AKS | 1.29 | | Kubernetes Google GKE | 1.26 | | Kubernetes Google GKE | 1.27 | | Kubernetes Google GKE | 1.28 | | Kubernetes Google GKE | 1.29 | +| RKE2 | 1.27.13 | +| RKE2 | 1.28.9 | +| RKE2 | 1.29.4 | +| RKE2 - Edge | 1.26.15 | +| RKE2 - Edge | 1.27.13 | +| RKE2 - Edge | 1.28.9 | +| RKE2 - Edge | 1.29.4 | #### CNI @@ -191,49 +209,57 @@ saepe ut fugit ea ut architecto quae consequatur. | Pack | New Version | | ----------------------- | ----------- | -| Amazon EFS | 1.7.6 | +| AWS EFS | 1.7.6 | +| AWS EBS CSI | 1.28.0 | | Azure Disk CSI Driver | 1.30.0 | | GCE Persistent Disk CSI | 1.13.2 | | Portworx /w Operator | 3.1.0 | #### Add-on Packs -| Pack | New Version | -| ---------------------------- | ----------- | -| AWS Application Loadbalancer | 2.7.2 | -| AWS Cluster Autoscaler Helm | 1.29.2 | -| Amazon EFS | 1.7.6 | -| MetalLB (Helm) | 0.14.3 | -| Nginx | 1.10.0 | -| OpenPolicyAgent | 3.15.1 | -| Portworx /w Operator | 3.1.0 | -| Prometheus - Grafana | 57.0.1 | +| Pack | New Version | +| ----------------------------- | ----------- | +| AWS Application Loadbalancer | 2.7.2 | +| AWS Cluster Autoscaler (Helm) | 1.29.2 | +| MetalLB (Helm) | 0.14.3 | +| Nginx | 1.10.0 | +| OpenPolicyAgent | 3.15.1 | +| Portworx /w Operator | 3.1.0 | +| Prometheus - Grafana | 57.0.1 | #### FIPS Packs | Pack | New Version | | ---------------------------------------- | ----------- | +| AWS EBS CSI | 1.28.0 | | AWS VPC CNI (Helm) | 1.1.17 | | Calico Azure | 3.25.1 | | Calico Azure | 3.26.3 | | Cilium | 1.13.4 | | Cilium | 1.14.3 | +| Cilium | 1.14.5 | | Longhorn | 1.4.1 | | Longhorn | 1.5.3 | +| Palette eXtended Kubernetes Edge (PXK-E) | 1.26.15 | | Palette eXtended Kubernetes Edge (PXK-E) | 1.27.14 | | Palette eXtended Kubernetes Edge (PXK-E) | 1.28.10 | | Palette eXtended Kubernetes Edge (PXK-E) | 1.29.5 | | Palette Optimized RKE2 | 1.27.13 | | Palette Optimized RKE2 | 1.28.9 | | Palette Optimized RKE2 | 1.29.4 | -| Palette eXtended Kubernetes | 1.27.13 | -| Palette eXtended Kubernetes | 1.27.2 | -| Palette eXtended Kubernetes | 1.28.9 | -| Palette eXtended Kubernetes | 1.29.4 | +| Palette eXtended Kubernetes (PXK) | 1.27.13 | +| Palette eXtended Kubernetes (PXK) | 1.27.2 | +| Palette eXtended Kubernetes (PXK) | 1.28.9 | +| Palette eXtended Kubernetes (PXK) | 1.29.4 | | RKE2 | 1.27.13 | | RKE2 | 1.28.9 | | RKE2 | 1.29.0 | | RKE2 | 1.29.4 | +| RKE2 - Edge | 1.27.13 | +| RKE2 - Edge | 1.28.9 | +| RKE2 - Edge | 1.29.4 | +| vSphere CSI | 3.1.0 | +| vSphere CSI | 3.1.2 | #### Deprecations and Removals From 3fcf1ce36089c96504039ef25998895d38f80b7a Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Tue, 4 Jun 2024 12:26:17 -0700 Subject: [PATCH 15/25] chore: intro sentence --- docs/docs-content/release-notes/release-notes.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/docs-content/release-notes/release-notes.md b/docs/docs-content/release-notes/release-notes.md index 4d84718516..f48847035a 100644 --- a/docs/docs-content/release-notes/release-notes.md +++ b/docs/docs-content/release-notes/release-notes.md @@ -13,10 +13,12 @@ tags: ["release-notes"] ## Jun 1, 2024 - Release 4.4.0 - 4.4.X -Sit et beatae expedita rerum odit ullam quos id non voluptas quae et nisi. Est commodi excepturi accusamus sed incidunt -doloribus. Praesentium qui accusantium amet. Eaque voluptates impedit sint amet omnis delectus velit tempora eos maxime -laudantium corporis iure. Nesciunt nihil et asperiores dolore suscipit dolor architecto. Fugit distinctio iste maxime -saepe ut fugit ea ut architecto quae consequatur. +This release contains various new features and improvements. One new feature is the introduction of Trusted Boot for +Edge. Trusted Boot is a hardware-based security feature that ensures that the system boots securely and that the boot +process has not been tampered with. We also improved the MicroK8s experience by exposing lifecycle commands. Other +improvements include enhancements to the Cluster Profile Variables user experience, automatic SSL certificate updates +Edge clusters in airgap environments, and new network troubleshooting tools in LocalUI. Check out the full release notes +to learn more about this release's new features and improvements. ### Security Notices From a9e5b4b2eacb58ca3bfce045bf211b8bc09a7345 Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Tue, 4 Jun 2024 12:41:13 -0700 Subject: [PATCH 16/25] chore: updates --- .../docs-content/release-notes/release-notes.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/docs/docs-content/release-notes/release-notes.md b/docs/docs-content/release-notes/release-notes.md index f48847035a..4ba0343b31 100644 --- a/docs/docs-content/release-notes/release-notes.md +++ b/docs/docs-content/release-notes/release-notes.md @@ -120,8 +120,6 @@ to learn more about this release's new features and improvements. - Support for custom links, URLs, and static pages is now available in LocalUI. You can populate custom links in the left **Main Menu** of [LocalUI](../clusters/edge/local-ui/local-ui.md), which will either load content into in an iframe or act as en external link. You can also can host static pages from LocalUI. This is useful when you need to deploy and host custom or specific content for a site and want to avoid introducing additional services to host a static site -#### Known Issues - ### Virtual Machine Orchestrator (VMO) #### Improvements @@ -138,15 +136,16 @@ to learn more about this release's new features and improvements. the Palette CLI. A prompt will ask you to select the OS during the VerteX deployment process. Refer to the Palette VerteX installation [guide](../vertex/install-palette-vertex/install-on-vmware/install.md) for more details. -### Terraform - -#### Features +### Automation -- Version 0.20.0 of the +- Terraform version 0.20.0 of the [Spectro Cloud Terraform provider](https://registry.terraform.io/providers/spectrocloud/spectrocloud/latest/docs) is available. For more details, refer to the Terraform provider [release page](https://github.com/spectrocloud/terraform-provider-spectrocloud/releases). +- Palette Crossplane provider version 0.20.0 is available. For more details, refer to the provider + [release page](https://github.com/crossplane-contrib/provider-palette/releases) + ### Docs and Education - [Palette's Crossplane provider](https://marketplace.upbound.io/providers/crossplane-contrib/provider-palette/latest) @@ -154,12 +153,14 @@ to learn more about this release's new features and improvements. clusters using Crossplane. Check out the [Crossplane Provider](../automation/crossplane/crossplane.md) documentation for more details. +- + ### Packs #### Pack Notes -- Cluster Autoscaler version 1.29.2 is a Helm based pack. Previous version were manifest based. Upgrades to the new - version require you to select the new Helm based pack. +- Cluster Autoscaler version 1.29.2 is a Helm-based pack. Previous versions of the pack were manifest-based. Upgrades to + the new version requires you to select the new Helm-based pack. - The BYOOS pack is now available for Palette VerteX deployments. This allows users to bring their own operating system (OS) image to deploy VerteX instances. RHEL is the only custom OS supported for VerteX deployments at this time. From fc5c0ab5930bbc19c16db8d8f8790166a1af23b9 Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Thu, 6 Jun 2024 10:14:29 -0700 Subject: [PATCH 17/25] docs: comment out vertex --- docs/docs-content/release-notes/release-notes.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/docs-content/release-notes/release-notes.md b/docs/docs-content/release-notes/release-notes.md index 4ba0343b31..12595ff273 100644 --- a/docs/docs-content/release-notes/release-notes.md +++ b/docs/docs-content/release-notes/release-notes.md @@ -127,14 +127,14 @@ to learn more about this release's new features and improvements. - The KubeVirt version in use is now v1.2.0. Other minor maintenance updates in support of Kubevirt 1.2.0 are also included. -### VerteX + ### Automation From 245b3bbe23efc2d5b609c45fd8fcc62debb1db03 Mon Sep 17 00:00:00 2001 From: Lenny Chen Date: Thu, 6 Jun 2024 11:25:24 -0700 Subject: [PATCH 18/25] docs: add known issue about manual enrollment --- docs/docs-content/release-notes/release-notes.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/docs-content/release-notes/release-notes.md b/docs/docs-content/release-notes/release-notes.md index 4ba0343b31..e524fdf9e3 100644 --- a/docs/docs-content/release-notes/release-notes.md +++ b/docs/docs-content/release-notes/release-notes.md @@ -90,6 +90,10 @@ to learn more about this release's new features and improvements. [Control Plane Node Fails to Upgrade in Sequential MicroK8s Upgrades](../troubleshooting/pack-issues.md) troubleshooting guide for resolution steps. +- If you did not configure the Trusted Boot keys to auto-enroll, manual enrollment could take several times to be + successful. For more information about key enrollment, refer to + [Enroll Trusted Boot Keys in Edge Host](../clusters/edge/trusted-boot/deployment-day2/install.md#enroll-secure-boot-keys-into-edge-device). + ### Edge #### Features From b51ad5028920f423408f0b0e8fa866d887b2d43b Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Thu, 6 Jun 2024 11:29:34 -0700 Subject: [PATCH 19/25] chore: updated release notes --- .../release-notes/known-issues.md | 8 +++--- .../release-notes/release-notes.md | 26 ++++++++++++------- 2 files changed, 21 insertions(+), 13 deletions(-) diff --git a/docs/docs-content/release-notes/known-issues.md b/docs/docs-content/release-notes/known-issues.md index 57694c0fe3..f783c9a001 100644 --- a/docs/docs-content/release-notes/known-issues.md +++ b/docs/docs-content/release-notes/known-issues.md @@ -16,9 +16,11 @@ The following table lists all known issues that are currently active and affecti | Description | Workaround | Publish Date | Product Component | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- | ----------------- | -| An issue prevents RKE2 and Palette eXtended Kubernetes (PXK) on version 1.29.4 from operating correctly with Canonical MAAS. | A temporary workaround is using a version lower than 1.29.4 when using MAAS. | June 8, 2024 | Packs, Clusters | -| [MicroK8s](../integrations/microk8s.md) does not support multi-node control plane clusters. The upgrade strategy, `InPlaceUpgrade`, is the only option available for use. | No workaround is available. | June 8, 2024 | Packs | -| Clusters using [MicroK8s](../integrations/microk8s.md) as the Kubernetes distribution, the control plane node fails to upgrade when using the `InPlaceUpgrade` strategy for sequential upgrades, such as upgrading from version 1.25.x to version 1.26.x and then to version 1.27.x. | Refer to the [Control Plane Node Fails to Upgrade in Sequential MicroK8s Upgrades](../troubleshooting/pack-issues.md) troubleshooting guide for resolution steps. | June 8, 2024 | Packs | +| The VerteX enterprise cluster is unable to complete backup operations. | No workaround is available. | June 15, 2024 | VerteX | +| The GKE cluster's Kubernetes pods are failing to start because the Kubernetes patch version is unavailable. This is encountered during pod restarts or node scaling operations. | Deploy a new cluster and use a GKE cluster profile that does not contain a Kubernetes pack layer with a patch version. Migrate the workloads from the existing cluster to the new cluster. This is a breaking change introduced in Palette 4.4.0 | June 15, 2024 | Packs, Clusters | +| An issue prevents RKE2 and Palette eXtended Kubernetes (PXK) on version 1.29.4 from operating correctly with Canonical MAAS. | A temporary workaround is using a version lower than 1.29.4 when using MAAS. | June 15, 2024 | Packs, Clusters | +| [MicroK8s](../integrations/microk8s.md) does not support multi-node control plane clusters. The upgrade strategy, `InPlaceUpgrade`, is the only option available for use. | No workaround is available. | June 15, 2024 | Packs | +| Clusters using [MicroK8s](../integrations/microk8s.md) as the Kubernetes distribution, the control plane node fails to upgrade when using the `InPlaceUpgrade` strategy for sequential upgrades, such as upgrading from version 1.25.x to version 1.26.x and then to version 1.27.x. | Refer to the [Control Plane Node Fails to Upgrade in Sequential MicroK8s Upgrades](../troubleshooting/pack-issues.md) troubleshooting guide for resolution steps. | June 15, 2024 | Packs | | Deploying self-hosted Palette or VerteX to a vSphere environment fails if vCenter has standalone hosts directly under a Datacenter. Persistent Volume (PV) provisioning fails due to an upstream issue with the vSphere Container Storage Interface (CSI) for all versions before v3.2.0. Palette and VerteX use the vSphere CSI version 3.1.2 internally. The issue may also occur in workload clusters deployed on vSphere using the same vSphere CSI for storage volume provisioning. | If you encounter the following error message when deploying self-hosted Palette or VerteX: `'ProvisioningFailed failed to provision volume with StorageClass "spectro-storage-class". Error: failed to fetch hosts from entity ComputeResource:domain-xyz` then use the following workaround. Remove standalone hosts directly under the Datacenter from vCenter and allow the volume provisioning to complete. After the volume is provisioned, you can add the standalone hosts back. You can also use a service account that does not have access to the standalone hosts as the user that deployed Palette. | May 21, 2024 | Self-Hosted | | Conducting cluster node scaling operations on a cluster undergoing a backup can lead to issues and potential unresponsiveness. | To avoid this, ensure no backup operations are in progress before scaling nodes or performing other cluster operations that change the cluster state | April 14, 2024 | Clusters | | Palette automatically creates an AWS security group for worker nodes using the format `-node`. If a security group with the same name already exists in the VPC, the cluster creation process fails. | To avoid this, ensure that no security group with the same name exists in the VPC before creating a cluster. | April 14, 2024 | Clusters | diff --git a/docs/docs-content/release-notes/release-notes.md b/docs/docs-content/release-notes/release-notes.md index 12595ff273..9110ee27bd 100644 --- a/docs/docs-content/release-notes/release-notes.md +++ b/docs/docs-content/release-notes/release-notes.md @@ -13,12 +13,13 @@ tags: ["release-notes"] ## Jun 1, 2024 - Release 4.4.0 - 4.4.X -This release contains various new features and improvements. One new feature is the introduction of Trusted Boot for -Edge. Trusted Boot is a hardware-based security feature that ensures that the system boots securely and that the boot -process has not been tampered with. We also improved the MicroK8s experience by exposing lifecycle commands. Other -improvements include enhancements to the Cluster Profile Variables user experience, automatic SSL certificate updates -Edge clusters in airgap environments, and new network troubleshooting tools in LocalUI. Check out the full release notes -to learn more about this release's new features and improvements. +This release contains various new features and improvements. One new feature is the introduction of +[Trusted Boot](../clusters/edge/trusted-boot/trusted-boot.md) for Edge. Trusted Boot is a hardware-based security +feature that ensures that the system boots securely and that the boot process has not been tampered with. We also +improved the MicroK8s experience by exposing lifecycle commands. Other improvements include enhancements to the Cluster +Profile Variables user experience, automatic SSL certificate updates Edge clusters in airgap environments, and new +network troubleshooting tools in LocalUI. Check out the full release notes to learn more about this release's new +features and improvements. ### Security Notices @@ -39,6 +40,11 @@ to learn more about this release's new features and improvements. point to the new repository. Refer to the [Validator](../automation/palette-cli/commands/validator.md) CLI page documentation for more details. +- Due to the removal of GKE Kubernetes patch versions, it's critical you update existing cluster profiles to use the new + GKE Kubernetes packs to avoid issues. Active clusters using old GKE Kubernetes pack versions may encounter problems + like pods failing to start and scaling issues. We recommend deploying new clusters with the updated GKE cluster + profile and migrating workloads. + #### Features - The MicroK8s pack layer now expose `bootCommands`, `preRunCommands` and `postRunCommands`. You can use @@ -95,7 +101,7 @@ to learn more about this release's new features and improvements. #### Features -- Trusted Boot is an exciting new Edge capability part of the [SENA +- [Trusted Boot](../clusters/edge/trusted-boot/trusted-boot.md) is an exciting new Edge capability part of the [SENA framework](https://www.spectrocloud.com/product/sena). Trusted Boot is a hardware-based security feature that ensures that the system boots securely and that the boot process has not been tampered with. Trusted Boot does several significant things, all working in concert, to enhance security: - Ensures that only trusted software can boot on the system. Any modification to any part of the hard disk will be detected. @@ -104,7 +110,7 @@ to learn more about this release's new features and improvements. Unlike similar solutions, Trusted Boot utilizes a secure boot, measured boot, and encryption to protect the booting system far more than other solutions. To learn more about Edge Trusted Boot, check out the - [Edge Trusted Boot documentation](../clusters/edge/edge.md). + [Edge Trusted Boot documentation](../clusters/edge/trusted-boot/trusted-boot.md). #### Improvements @@ -112,13 +118,13 @@ to learn more about this release's new features and improvements. - The Cluster Profile Variables user experience has been improved. Users can now identify where a variable is used, preview the variable during creation time, and change the order of the variables displayed. An improved Day-2 management experience is also available. You can learn more about these new features in the [Cluster Profile Variables](../profiles/cluster-profiles/create-cluster-profiles/define-profile-variables.md) documentation. -- Edge clusters managed by [LocalUI](../clusters/edge/local-ui/local-ui.md) now receive automatic SSL certificate updates for Kubernetes. Users can also manually trigger the SSL certificate update process. For more information, refer to the [LocalUI](../clusters/edge/local-ui/local-ui.md) documentation. +- Edge clusters managed by [LocalUI](../clusters/edge/local-ui/local-ui.md) now receive automatic SSL certificate updates for Kubernetes. Users can also manually trigger the SSL certificate update process. For more information, refer to the [Renew Certificates for Airgap Clusters](../clusters/edge/cluster-management/certificate-renewal.md) guide. - [LocalUI](../clusters/edge/local-ui/local-ui.md) now includes tools to help users troubleshoot network issues. The tools include ping and traceroute. For more information, refer to the [LocalUI](../clusters/edge/local-ui/local-ui.md) documentation. - Clusters managed by [LocalUI](../clusters/edge/local-ui/local-ui.md) now include a new feature that allows users to download diagnostic logs from the LocalUI interface. This feature reduces the friction of troubleshooting issues on the cluster as the need to SSH into the cluster is reduced. -- Support for custom links, URLs, and static pages is now available in LocalUI. You can populate custom links in the left **Main Menu** of [LocalUI](../clusters/edge/local-ui/local-ui.md), which will either load content into in an iframe or act as en external link. You can also can host static pages from LocalUI. This is useful when you need to deploy and host custom or specific content for a site and want to avoid introducing additional services to host a static site +- Support for custom links, URLs, and static pages is now available in LocalUI. You can populate custom links in the left **Main Menu** of [LocalUI](../clusters/edge/local-ui/host-management/custom-link.md), which will either load content into in an iframe or act as en external link. You can also can host static pages from LocalUI. This is useful when you need to deploy and host custom or specific content for a site and want to avoid introducing additional services to host a static site ### Virtual Machine Orchestrator (VMO) From 0f98bdf8358e55c3076d597c4de267de8b6e0ad0 Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Fri, 7 Jun 2024 08:41:41 -0700 Subject: [PATCH 20/25] docs: DOC-1208 --- docs/docs-content/release-notes/release-notes.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/docs-content/release-notes/release-notes.md b/docs/docs-content/release-notes/release-notes.md index 56eefc534e..9f5aafc505 100644 --- a/docs/docs-content/release-notes/release-notes.md +++ b/docs/docs-content/release-notes/release-notes.md @@ -156,6 +156,13 @@ features and improvements. - Palette Crossplane provider version 0.20.0 is available. For more details, refer to the provider [release page](https://github.com/crossplane-contrib/provider-palette/releases) +- The Terraform data resources, + [`spectrocloud_pack`](https://registry.terraform.io/providers/spectrocloud/spectrocloud/latest/docs/data-sources/pack), + and + [`spectrocloud_pack_simple`](https://registry.terraform.io/providers/spectrocloud/spectrocloud/latest/docs/data-sources/pack_simple) + will both require the attribute `registry_uid` to be set the next Terraform release, 0.21.0. We recommend you start + using this attribute in your Terraform configurations to avoid issues in the future. + ### Docs and Education - [Palette's Crossplane provider](https://marketplace.upbound.io/providers/crossplane-contrib/provider-palette/latest) @@ -163,8 +170,6 @@ features and improvements. clusters using Crossplane. Check out the [Crossplane Provider](../automation/crossplane/crossplane.md) documentation for more details. -- - ### Packs #### Pack Notes From aea858e539d3013845e7f3865c913ff241c4f40e Mon Sep 17 00:00:00 2001 From: Lenny Chen <55669665+lennessyy@users.noreply.github.com> Date: Tue, 11 Jun 2024 09:37:07 -0700 Subject: [PATCH 21/25] docs: document the rhel fips known issue (#3043) * docs: document the rhel fips known issue * remove accidental commit * restore release notes * docs: remove accidental change * docs: add windows key combination * Update docs/docs-content/troubleshooting/edge.md * docs: add entry to global known issues * docs: fix crosslink --------- Co-authored-by: Lenny Chen --- .../edgeforge-workflow/palette-canvos/fips.md | 10 ++++++++ .../release-notes/known-issues.md | 1 + .../release-notes/release-notes.md | 5 ++++ docs/docs-content/troubleshooting/edge.md | 24 ++++++++++++++++++- 4 files changed, 39 insertions(+), 1 deletion(-) diff --git a/docs/docs-content/clusters/edge/edgeforge-workflow/palette-canvos/fips.md b/docs/docs-content/clusters/edge/edgeforge-workflow/palette-canvos/fips.md index dda613546a..2075c80f19 100644 --- a/docs/docs-content/clusters/edge/edgeforge-workflow/palette-canvos/fips.md +++ b/docs/docs-content/clusters/edge/edgeforge-workflow/palette-canvos/fips.md @@ -103,6 +103,16 @@ image with. +:::warning + +When you create a cluster with an Edge host that operates the FIPS-compliant RHEL Operating System (OS), you may +encounter an error where the `systemd-resolved.service` service enters the **failed** state. This prevents the +nameserver from being configured, which will result in cluster deployment failure. Refer to +[TroubleShooting](../../../../troubleshooting/edge.md#scenario---systemd-resolvedservice-enters-failed-state) for a +workaround. + +::: + 5. Change into the **rhel-fips** directory. 6. In the file **Dockerfile**, provide your RHEL subscription username and password. diff --git a/docs/docs-content/release-notes/known-issues.md b/docs/docs-content/release-notes/known-issues.md index f783c9a001..e7b52d64a2 100644 --- a/docs/docs-content/release-notes/known-issues.md +++ b/docs/docs-content/release-notes/known-issues.md @@ -17,6 +17,7 @@ The following table lists all known issues that are currently active and affecti | Description | Workaround | Publish Date | Product Component | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- | ----------------- | | The VerteX enterprise cluster is unable to complete backup operations. | No workaround is available. | June 15, 2024 | VerteX | +| Edge hosts with FIPS-compliant RHEL Operating System (OS) distribution may encounter the error where the `systemd-resolved.service` service enters the **failed** state. This prevents the nameserver from being configured, which will result in cluster deployment failure. | Refer to [TroubleShooting](../troubleshooting/edge.md#scenario---systemd-resolvedservice-enters-failed-state) for a workaround. | June 15, 2024 | Edge | | The GKE cluster's Kubernetes pods are failing to start because the Kubernetes patch version is unavailable. This is encountered during pod restarts or node scaling operations. | Deploy a new cluster and use a GKE cluster profile that does not contain a Kubernetes pack layer with a patch version. Migrate the workloads from the existing cluster to the new cluster. This is a breaking change introduced in Palette 4.4.0 | June 15, 2024 | Packs, Clusters | | An issue prevents RKE2 and Palette eXtended Kubernetes (PXK) on version 1.29.4 from operating correctly with Canonical MAAS. | A temporary workaround is using a version lower than 1.29.4 when using MAAS. | June 15, 2024 | Packs, Clusters | | [MicroK8s](../integrations/microk8s.md) does not support multi-node control plane clusters. The upgrade strategy, `InPlaceUpgrade`, is the only option available for use. | No workaround is available. | June 15, 2024 | Packs | diff --git a/docs/docs-content/release-notes/release-notes.md b/docs/docs-content/release-notes/release-notes.md index 05e01f74b8..0159773b04 100644 --- a/docs/docs-content/release-notes/release-notes.md +++ b/docs/docs-content/release-notes/release-notes.md @@ -101,6 +101,11 @@ features and improvements. successful. For more information about key enrollment, refer to [Enroll Trusted Boot Keys in Edge Host](../clusters/edge/trusted-boot/deployment-day2/install.md#enroll-secure-boot-keys-into-edge-device). +- Edge hosts with FIPS-compliant RHEL Operating System (OS) distribution may encounter the error where the + `systemd-resolved.service` service enters the **failed** state. This prevents the nameserver from being configured, + which will result in cluster deployment failure. Refer to + [TroubleShooting](../troubleshooting/edge.md#scenario---systemd-resolvedservice-enters-failed-state) for a workaround. + ### Edge #### Features diff --git a/docs/docs-content/troubleshooting/edge.md b/docs/docs-content/troubleshooting/edge.md index e7083cc62d..429d75614b 100644 --- a/docs/docs-content/troubleshooting/edge.md +++ b/docs/docs-content/troubleshooting/edge.md @@ -14,7 +14,7 @@ The following are common scenarios that you may encounter when using Edge. If you need to override or reconfigure the read-only file system, you can do so using the following steps. -## Debug Steps +### Debug Steps 1. Power on the Edge host. @@ -136,3 +136,25 @@ issues or not being available. Use the following steps to troubleshoot and resol 7. If you continue to encounter issues, contact our support team by emailing [support@spectrocloud.com](mailto:support@spectrocloud.com) so that we can provide you with further guidance. + +## Scenario - systemd-resolved.service Enters Failed State + +When you create a cluster with an Edge host that operates the FIPS-compliant RHEL Operating System (OS), you may +encounter an error where the `systemd-resolved.service` process enters the **failed** state. This prevents the +nameserver from being configured, which will result in cluster deployment failure. + +### Debug Steps + +1. Establish an SSH connection to the Edge host. + + Alternatively, press the keys **Fn + Ctrl +Cmd + F1** on a keyboard that is connected to the Edge host to log in to + the terminal. If you are on Windows, press **Fn + Ctrl + Alt + F1**. + +2. Issue the following command. + + ```shell + chmod a+rwxt /var/tmp + systemctl enable --now systemd-resolved.service + ``` + + This will start the `systemd-resolved.service` process and move the cluster creation process forward. From 5d543fa4b5543b46271edf9999a7b6803945ac59 Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Tue, 11 Jun 2024 09:41:43 -0700 Subject: [PATCH 22/25] chore: fix prettier --- docs/docs-content/troubleshooting/edge.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs-content/troubleshooting/edge.md b/docs/docs-content/troubleshooting/edge.md index 429d75614b..ce04332b4c 100644 --- a/docs/docs-content/troubleshooting/edge.md +++ b/docs/docs-content/troubleshooting/edge.md @@ -145,7 +145,7 @@ nameserver from being configured, which will result in cluster deployment failur ### Debug Steps -1. Establish an SSH connection to the Edge host. +1. Establish an SSH connection to the Edge host. Alternatively, press the keys **Fn + Ctrl +Cmd + F1** on a keyboard that is connected to the Edge host to log in to the terminal. If you are on Windows, press **Fn + Ctrl + Alt + F1**. From 08f941c774c2eb65d507d81996417efeaff3b578 Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Tue, 11 Jun 2024 10:00:23 -0700 Subject: [PATCH 23/25] Apply suggestions from code review Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com> --- .../release-notes/known-issues.md | 2 +- .../release-notes/release-notes.md | 20 +++++++++---------- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/docs-content/release-notes/known-issues.md b/docs/docs-content/release-notes/known-issues.md index e7b52d64a2..5fd771b718 100644 --- a/docs/docs-content/release-notes/known-issues.md +++ b/docs/docs-content/release-notes/known-issues.md @@ -32,7 +32,7 @@ The following table lists all known issues that are currently active and affecti | Day-2 operations related to infrastructure changes, such as modifying the node size and count, when using MicroK8s are not taking effect. | No workaround is available. | April 14, 2024 | Packs, Clusters | | If a cluster that uses the Rook-Ceph pack experiences network issues, it's possible for the file mount to become and remain unavailable even after the network is restored. | This a known issue disclosed in the [Rook GitHub repository](https://github.com/rook/rook/issues/13818). To resolve this issue, refer to [Rook-Ceph](../integrations/rook-ceph.md#file-mount-becomes-unavailable-after-cluster-experiences-network-issues) pack documentation. | April 14, 2024 | Packs, Edge | | Edge clusters on Edge hosts with ARM64 processors may experience instability issues that cause cluster failures. | ARM64 support is limited to a specific set of Edge devices. Currently, Nvidia Jetson devices are supported. | April 14, 2024 | Edge | -| During the cluster provisioning process of new edge clusters, the palette webhook pods may not always deploy successfully, causing the cluster to be stuck in the provisioning phase. This issue does not impact deployed clusters. | Review the [Palette Webhook Pods Fail to Start](../troubleshooting/edge.md#scenario---palette-webhook-pods-fail-to-start) troubleshooting guide for resolution steps. | April 14, 2024 | Edge | +| During the cluster provisioning process of new edge clusters, the Palette webhook pods may not always deploy successfully, causing the cluster to be stuck in the provisioning phase. This issue does not impact deployed clusters. | Review the [Palette Webhook Pods Fail to Start](../troubleshooting/edge.md#scenario---palette-webhook-pods-fail-to-start) troubleshooting guide for resolution steps. | April 14, 2024 | Edge | ## Resolved Known Issues diff --git a/docs/docs-content/release-notes/release-notes.md b/docs/docs-content/release-notes/release-notes.md index 0159773b04..164512e1cf 100644 --- a/docs/docs-content/release-notes/release-notes.md +++ b/docs/docs-content/release-notes/release-notes.md @@ -18,8 +18,8 @@ This release contains various new features and improvements. One new feature is [Trusted Boot](../clusters/edge/trusted-boot/trusted-boot.md) for Edge. Trusted Boot is a hardware-based security feature that ensures that the system boots securely and that the boot process has not been tampered with. We also improved the MicroK8s experience by exposing lifecycle commands. Other improvements include enhancements to the Cluster -Profile Variables user experience, automatic SSL certificate updates Edge clusters in airgap environments, and new -network troubleshooting tools in LocalUI. Check out the full release notes to learn more about this release's new +Profile Variables user experience, automatic SSL certificate updates for Edge clusters in airgap environments, and new +network troubleshooting tools in local UI. Check out the full release notes to learn more about this release's new features and improvements. ### Security Notices @@ -48,7 +48,7 @@ features and improvements. #### Features -- The MicroK8s pack layer now expose `bootCommands`, `preRunCommands` and `postRunCommands`. You can use +- The MicroK8s pack layer now exposes `bootCommands`, `preRunCommands` and `postRunCommands`. You can use these commands to customize and configure MicroK8s as needed. MicroK8s is delivered as a Technical Preview for AWS and Canonical MAAS in this release. To learn more, refer to the MicroK8s pack [documentation](../integrations/microk8s.md). @@ -111,7 +111,7 @@ features and improvements. #### Features -- [Trusted Boot](../clusters/edge/trusted-boot/trusted-boot.md) is an exciting new Edge capability part of the [SENA +- [Trusted Boot](../clusters/edge/trusted-boot/trusted-boot.md) is an exciting new Edge capability developed as part of the [SENA framework](https://www.spectrocloud.com/product/sena). Trusted Boot is a hardware-based security feature that ensures that the system boots securely and that the boot process has not been tampered with. Trusted Boot does several significant things, all working in concert, to enhance security: - Ensures that only trusted software can boot on the system. Any modification to any part of the hard disk will be detected. @@ -130,11 +130,11 @@ features and improvements. - Edge clusters managed by [LocalUI](../clusters/edge/local-ui/local-ui.md) now receive automatic SSL certificate updates for Kubernetes. Users can also manually trigger the SSL certificate update process. For more information, refer to the [Renew Certificates for Airgap Clusters](../clusters/edge/cluster-management/certificate-renewal.md) guide. -- [LocalUI](../clusters/edge/local-ui/local-ui.md) now includes tools to help users troubleshoot network issues. The tools include ping and traceroute. For more information, refer to the [LocalUI](../clusters/edge/local-ui/local-ui.md) documentation. +- [Local UI](../clusters/edge/local-ui/local-ui.md) now includes tools to help users troubleshoot network issues. The tools include ping and traceroute. For more information, refer to the [local UI](../clusters/edge/local-ui/local-ui.md) documentation. -- Clusters managed by [LocalUI](../clusters/edge/local-ui/local-ui.md) now include a new feature that allows users to download diagnostic logs from the LocalUI interface. This feature reduces the friction of troubleshooting issues on the cluster as the need to SSH into the cluster is reduced. +- Clusters managed by [local UI](../clusters/edge/local-ui/local-ui.md) now include a new feature that allows users to download diagnostic logs from the local UI. This feature reduces the friction of troubleshooting issues on the cluster as the need to SSH into the cluster is reduced. -- Support for custom links, URLs, and static pages is now available in LocalUI. You can populate custom links in the left **Main Menu** of [LocalUI](../clusters/edge/local-ui/host-management/custom-link.md), which will either load content into in an iframe or act as en external link. You can also can host static pages from LocalUI. This is useful when you need to deploy and host custom or specific content for a site and want to avoid introducing additional services to host a static site +- Support for custom links, URLs, and static pages is now available in local UI. You can populate custom links in the left **Main Menu** of [local UI](../clusters/edge/local-ui/host-management/custom-link.md), which will either load content into in an iframe or act as en external link. You can also can host static pages in local UI. This is useful when you need to deploy and host custom or specific content for a site and want to avoid introducing additional services to host a static site. ### Virtual Machine Orchestrator (VMO) @@ -160,12 +160,12 @@ features and improvements. [release page](https://github.com/spectrocloud/terraform-provider-spectrocloud/releases). - Palette Crossplane provider version 0.20.0 is available. For more details, refer to the provider - [release page](https://github.com/crossplane-contrib/provider-palette/releases) + [release page](https://github.com/crossplane-contrib/provider-palette/releases). - The Terraform data resources, - [`spectrocloud_pack`](https://registry.terraform.io/providers/spectrocloud/spectrocloud/latest/docs/data-sources/pack), + [`spectrocloud_pack`](https://registry.terraform.io/providers/spectrocloud/spectrocloud/latest/docs/data-sources/pack) and - [`spectrocloud_pack_simple`](https://registry.terraform.io/providers/spectrocloud/spectrocloud/latest/docs/data-sources/pack_simple) + [`spectrocloud_pack_simple`](https://registry.terraform.io/providers/spectrocloud/spectrocloud/latest/docs/data-sources/pack_simple), will both require the attribute `registry_uid` to be set the next Terraform release, 0.21.0. We recommend you start using this attribute in your Terraform configurations to avoid issues in the future. From 86f6f2e64562ccd463063a162571b954c9e8340a Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Tue, 11 Jun 2024 10:00:40 -0700 Subject: [PATCH 24/25] docs: feedback inline --- .../release-notes/release-notes.md | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/docs/docs-content/release-notes/release-notes.md b/docs/docs-content/release-notes/release-notes.md index 0159773b04..6f3eaa521a 100644 --- a/docs/docs-content/release-notes/release-notes.md +++ b/docs/docs-content/release-notes/release-notes.md @@ -80,16 +80,20 @@ features and improvements. - GET `/v1/metrics/{resourceKind}/{resourceUid}/values` - GET `/v1/metrics/{resourceKind}/values` + :::warning + After six months, the `includeMasterMachines` object will be removed from the API. Use the `includeControlPlaneMachines` object moving forward. + ::: + #### Known Issues - An issue prevents RKE2 and Palette eXtended Kubernetes (PXK) on version 1.29.4 from operating correctly with Canonical MAAS. A temporary workaround is using a version lower than 1.29.4 when using MAAS.. - [MicroK8s](../integrations/microk8s.md) does not support a multi-node cluster deployment and is limited to a - single-node cluster. As a result, the only supported upgrade strategy is InPlaceUpgrade. + single-node cluster. As a result, the only supported upgrade strategy is `InPlaceUpgrade`. - Clusters using [MicroK8s](../integrations/microk8s.md) as the Kubernetes distribution, the control plane node fails to upgrade when using the `InPlaceUpgrade` strategy for sequential upgrades, such as upgrading from version 1.25.x to @@ -116,7 +120,7 @@ features and improvements. not been tampered with. Trusted Boot does several significant things, all working in concert, to enhance security: - Ensures that only trusted software can boot on the system. Any modification to any part of the hard disk will be detected. - Encrypts all sensitive data on disk using hardware security Trusted Platform Module (TPM). - - Ensures that the TPM will only decrypt sensitive data if the boot process is clean and untampered.. + - Ensures that the TPM will only decrypt sensitive data if the boot process is clean and untampered. Unlike similar solutions, Trusted Boot utilizes a secure boot, measured boot, and encryption to protect the booting system far more than other solutions. To learn more about Edge Trusted Boot, check out the @@ -181,14 +185,14 @@ features and improvements. #### Pack Notes - Cluster Autoscaler version 1.29.2 is a Helm-based pack. Previous versions of the pack were manifest-based. Upgrades to - the new version requires you to select the new Helm-based pack. + the new version require you to select the new Helm-based pack. -- The BYOOS pack is now available for Palette VerteX deployments. This allows users to bring their own operating system +- The BYOOS pack is now available for Palette VerteX deployments. This allows users to bring their own Operating System (OS) image to deploy VerteX instances. RHEL is the only custom OS supported for VerteX deployments at this time. -- MicroK8s now supports boot, preRun and postRun commands on cloud-init. This allows users to execute custom commands - before and after their MicroK8s deployment processes, providing enhanced flexibility and control over deployment - environments. +- MicroK8s now supports boot, `preRun` and `postRun` commands on cloud-init. This allows users to execute custom + commands before and after their MicroK8s deployment processes, providing enhanced flexibility and control over + deployment environments. - The Kubernetes pack parameter `k8sHardening` is removed and no longer used as the method for hardening images during the image creation process. This change does not impact users. From 76348dbf6e2e912e8321a6b0fb39cafacc787173 Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Tue, 11 Jun 2024 10:21:35 -0700 Subject: [PATCH 25/25] chore: added spacing to warning box --- docs/docs-content/release-notes/release-notes.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/docs-content/release-notes/release-notes.md b/docs/docs-content/release-notes/release-notes.md index 54778415ab..82dc0949f1 100644 --- a/docs/docs-content/release-notes/release-notes.md +++ b/docs/docs-content/release-notes/release-notes.md @@ -80,6 +80,8 @@ features and improvements. - GET `/v1/metrics/{resourceKind}/{resourceUid}/values` - GET `/v1/metrics/{resourceKind}/values` +
+ :::warning After six months, the `includeMasterMachines` object will be removed from the API. Use the