From e5575cda82ee76361dbd1c37c75b063dcd9181cf Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Fri, 3 May 2024 12:50:29 -0700 Subject: [PATCH] Known Issues Global Page (#2688) * docs: DOC-1151 Known issues table * Apply suggestions from code review Co-authored-by: caroldelwing * chore: fix format --------- Co-authored-by: caroldelwing --- .../release-notes/_category_.json | 3 + .../release-notes/known-issues.md | 40 ++++++++++ .../{ => release-notes}/release-notes.md | 76 +++++++++---------- .../troubleshooting/palette-upgrade.md | 2 +- 4 files changed, 82 insertions(+), 39 deletions(-) create mode 100644 docs/docs-content/release-notes/_category_.json create mode 100644 docs/docs-content/release-notes/known-issues.md rename docs/docs-content/{ => release-notes}/release-notes.md (81%) diff --git a/docs/docs-content/release-notes/_category_.json b/docs/docs-content/release-notes/_category_.json new file mode 100644 index 0000000000..3fca6fb9f9 --- /dev/null +++ b/docs/docs-content/release-notes/_category_.json @@ -0,0 +1,3 @@ +{ + "position": 0 +} diff --git a/docs/docs-content/release-notes/known-issues.md b/docs/docs-content/release-notes/known-issues.md new file mode 100644 index 0000000000..22bf1503cb --- /dev/null +++ b/docs/docs-content/release-notes/known-issues.md @@ -0,0 +1,40 @@ +--- +sidebar_label: "Known Issues" +title: "Known Issues" +description: "Review all known issues in Palette and learn more about their status." +hide_table_of_contents: false +sidebar_position: 10 +tags: ["known-issues"] +--- + +Throughout the development lifecycle of Palette, known issues may arise that affect the user experience. Use this page +to review and stay informed about the status of known issues in Palette. As issues are resolved, this page is updated. + +## Active Known Issues + +The following table lists all known issues that are currently active and affecting users. + +| Description | Workaround | Publish Date | Product Component | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------- | ----------------- | +| 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 | +| When deploying a multi-node AWS EKS cluster with the Container Network Interface (CNI) [Calico](../integrations/calico.md), the cluster deployment fails. | A workaround is to use the AWS VPC CNI in the interim while the issue is resolved. | April 14, 2024 | Packs, Clusters | +| 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 the PCG, or the 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. | April 14, 2024 | Clusters | +| 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. | April 14, 2024 | Self-Hosted | +| 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 | + +## Resolved Known Issues + +The following table lists all known issues that have been resolved and are no longer affecting users. Refer to the table +for information on the fix version and the date the issue was resolved. + +| Description | Publish Date | Product Component | Fix Version | +| -------------------------------------------------------------------------------------------------------- | ----------------- | ----------------- | ----------- | +| Clusters are failing to start on AWS EKS when using the AWS VPC CNI pack and Kubernetes versions 1.28. | February 26, 2024 | Packs, Clusters | 4.2.13 | +| The Kubernetes Dashboard fails to load when added to a cluster profile and deployed. | February 26, 2024 | Packs | 4.2.13 | +| Clusters using MicroK8s are failing to launch pods due to a mismatch in node affinity labels. | February 26, 2024 | Packs, Clusters | 4.2.13 | +| MAAS clusters are failing to deploy when the default image endpoint is not set in an airgap environment. | February 26, 2024 | Clusters | 4.2.13 | diff --git a/docs/docs-content/release-notes.md b/docs/docs-content/release-notes/release-notes.md similarity index 81% rename from docs/docs-content/release-notes.md rename to docs/docs-content/release-notes/release-notes.md index 80b4de99fd..5cd1a378a3 100644 --- a/docs/docs-content/release-notes.md +++ b/docs/docs-content/release-notes/release-notes.md @@ -23,7 +23,7 @@ the following sections for a complete list of features, improvements, and known - 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/cve-reports.md) page for the latest security advisories. +- Review the [Security Bulletins](../security-bulletins/security-bulletins.md) page for the latest security advisories. ### Palette @@ -33,23 +33,23 @@ the following sections for a complete list of features, improvements, and known - 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 + 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) + 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 +- 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 + [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) + [System Administrators](../enterprise-version/system-management/account-management/account-management.md#system-administrators) page to learn more about system administrators. #### Improvements @@ -57,7 +57,7 @@ the following sections for a complete list of features, improvements, and known - 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. + [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 @@ -74,14 +74,14 @@ the following sections for a complete list of features, improvements, and known - 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](./palette-cli/commands/validator.md) page to learn how to use Validator with the + Refer to the Palette CLI [Validator](../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. + [maintenance policy](../integrations/maintenance-policy.md#pack-deprecations) page to learn more. -- Several enhancements have been added to the Palette CLI [Validator](./palette-cli/commands/validator.md) command that +- Several enhancements have been added to the Palette CLI [Validator](../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. @@ -91,7 +91,7 @@ the following sections for a complete list of features, improvements, and known - 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. + [Upgrade a PCG](../clusters/pcg/manage-pcg/pcg-upgrade.md) guide to learn more about updating a PCG. - 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, @@ -113,13 +113,13 @@ the following sections for a complete list of features, improvements, and known 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](https://docs.spectrocloud.com/integrations/calico), the cluster deployments fail. A workaround is to use the - AWS VPC CNI in the interim while the issue is resolved. + [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) + [VMware Resources Remain After Cluster Deletion](../troubleshooting/pcg.md#scenario---vmware-resources-remain-after-cluster-deletion) troubleshooting guide for resolution steps. @@ -128,7 +128,7 @@ the following sections for a complete list of features, improvements, and known 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) + [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 @@ -139,7 +139,7 @@ the following sections for a complete list of features, improvements, and known #### 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/architecture.md#minimum-device-requirements) page to learn more + the [Minimum Device Requirements](../clusters/edge/architecture.md#minimum-device-requirements) page to learn more about the minimum requirements for Edge hosts. #### Features @@ -148,11 +148,11 @@ the following sections for a complete list of features, improvements, and known 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 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 +- 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. @@ -161,29 +161,29 @@ the following sections for a complete list of features, improvements, and known - 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 + 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) + [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. + [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. + [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 + [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. @@ -191,7 +191,7 @@ the following sections for a complete list of features, improvements, and known - 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) + [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) @@ -206,12 +206,12 @@ 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 + [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 +- 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 + [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 @@ -220,14 +220,14 @@ the following sections for a complete list of features, improvements, and known - 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) + [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](./palette-cli/commands/fips-validate.md) guide to learn more about the command. + [FIPS Validate](../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 @@ -238,7 +238,7 @@ the following sections for a complete list of features, improvements, and known - 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) + [Password Requirements and Security](../vertex/system-management/account-management/credentials.md#password-requirements-and-security) page for more details. ### Terraform @@ -254,9 +254,9 @@ the following sections for a complete list of features, improvements, and known - 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. + [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 +- 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 @@ -264,18 +264,18 @@ the following sections for a complete list of features, improvements, and known - 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. + [Private Cloud Gateway](../clusters/pcg/pcg.md) page to learn more about PCG. ### Packs #### Pack Notes -- Several Kubernetes versions are [deprecated](./integrations/maintenance-policy.md#pack-deprecations) and removed in +- 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. -- Local Path Provisioner CSI for Edge is now a [verified pack](./integrations/verified_packs.md). +- Local Path Provisioner CSI for Edge is now a [verified pack](../integrations/verified_packs.md). #### Kubernetes @@ -372,4 +372,4 @@ the following sections for a complete list of features, improvements, and known 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. +- Check out the [Deprecated Packs](../integrations/deprecated-packs.md) page for a list of all deprecated packs. diff --git a/docs/docs-content/troubleshooting/palette-upgrade.md b/docs/docs-content/troubleshooting/palette-upgrade.md index eb7a789506..d2e8aea78f 100644 --- a/docs/docs-content/troubleshooting/palette-upgrade.md +++ b/docs/docs-content/troubleshooting/palette-upgrade.md @@ -8,7 +8,7 @@ sidebar_position: 60 tags: ["troubleshooting", "palette-upgrade"] --- -We recommend you review the [Release Notes](../release-notes.md) and the +We recommend you review the [Release Notes](../release-notes/release-notes.md) and the [Upgrade Notes](../enterprise-version/upgrade/upgrade.md) before attempting to upgrade Palette. Use this information to address common issues that may occur during an upgrade.