diff --git a/docs/api-content/api-docs/1-introduction.md b/docs/api-content/api-docs/1-introduction.md index 5888444907..f6be668e1b 100644 --- a/docs/api-content/api-docs/1-introduction.md +++ b/docs/api-content/api-docs/1-introduction.md @@ -268,7 +268,7 @@ information about Edge clusters, retrieve the list of available images on your E using embedded cluster definitions. You can find the Open API Swagger specification for the Edge Management API at the following location: -https://raw.githubusercontent.com/spectrocloud/librarium/version-4-3/docs/api-content/api-docs/edge-v1/emc-api.json +https://raw.githubusercontent.com/spectrocloud/librarium/version-4-4/docs/api-content/api-docs/edge-v1/emc-api.json :::preview diff --git a/docs/docs-content/release-notes/known-issues.md b/docs/docs-content/release-notes/known-issues.md index 1586c8ee83..85d70e6f2e 100644 --- a/docs/docs-content/release-notes/known-issues.md +++ b/docs/docs-content/release-notes/known-issues.md @@ -16,6 +16,7 @@ The following table lists all known issues that are currently active and affecti | Description | Workaround | Publish Date | Product Component | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- | --------------------- | +| Single-node Private Cloud Gateway (PCG) clusters are experiencing an issue upgrading to 4.4.a. The vSphere CSI controller pod fails to start because there are no matching affinity rules. | Check out the [vSphere Controller Pod Fails to Start in Single Node PCG Cluster](../troubleshooting/pcg.md#scenario---vsphere-controller-pod-fails-to-start-in-single-node-pcg-cluster) guide for workaround steps. | July 13, 2024 | PCG | | When you add a new VMware vSphere Edge host to an Edge cluster, the IP address may fail to be assigned to the Edge host after a reboot. | Review the [Edge Troubleshooting](../troubleshooting/edge.md) section for workarounds. | July 9, 2024 | Edge | | When you install Palette Edge using an Edge Installer ISO with a RHEL 8 operating system on a Virtual Machine (VM) with insufficient video memory, the QR code in the registration screen does not display correctly. | Increase the video memory of your VM to 8 MB or higher. The steps to do this vary depending on the platform you use to deploy your VM. In vSphere, you can right click on the VM, click **Edit Settings** and adjust the video card memory in the **Video card** tab. | July 9, 2024 | Edge | | Custom Certificate Authority (CA) is not supported for accessing Azure AKS clusters. Using a custom CA prevents the `spectro-proxy` pack from working correctly with Azure AKS clusters. | No workaround is available. | July 9, 2024 | Packs, Clusters | @@ -50,10 +51,11 @@ The following table lists all known issues that are currently active and affecti 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 | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | ------------------- | ----------- | -| When you upgrade VerteX from version 4.3.x to 4.4.x, a few system pods may remain unhealthy and experience _CrashLoopBackOff_ errors. This issue only impacts VMware vSphere-based installations and occurs because the internal Mongo DNS is incorrectly configured in the configserver ConfigMap. | June 29, 2024 | Self-Hosted, VerteX | 4.4.7 | -| 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 | +| Description | Publish Date | Product Component | Fix Version | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | ------------------- | ----------- | +| 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. | May 21, 2024 | Self-Hosted | 4.4.8 | +| When you upgrade VerteX from version 4.3.x to 4.4.x, a few system pods may remain unhealthy and experience _CrashLoopBackOff_ errors. This issue only impacts VMware vSphere-based installations and occurs because the internal Mongo DNS is incorrectly configured in the configserver ConfigMap. | June 29, 2024 | Self-Hosted, VerteX | 4.4.7 | +| 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/release-notes.md b/docs/docs-content/release-notes/release-notes.md index 852cb63d6a..c809262ca7 100644 --- a/docs/docs-content/release-notes/release-notes.md +++ b/docs/docs-content/release-notes/release-notes.md @@ -11,6 +11,178 @@ tags: ["release-notes"] +## Jul 13, 2024 - Release 4.4.X + + + +### Palette {#release-4-4-a} + +#### Features + +- This release introduces a system-wide control User Interface (UI) for feature flags. System administrators can now + turn features on or off through the system console. Once a feature flag is enabled, all tenants will have access to + the feature. Check out the [Feature Flags](../enterprise-version/system-management/feature-flags.md) documentation to + learn more. + +- Palette now supports specifying a custom Certificate Authority (CA) when enabling OIDC integration. You now use + self-signed root certificates from internal identity providers when configuring OIDC integration. To learn more, refer + to the [Enable SSO with Custom CA](../user-management/saml-sso/saml-sso.md) guide. + +- You can now deploy a cluster on Azure and only use private IP addresses for the control plane and worker nodes. When + deploying the cluster, this new behavior requires using a Private Cloud Gateway (PCG) and static placement selection. + To learn more about deploying a cluster with private IP addresses, refer to the + [Deploy a Cluster with Private IP Addresses](../clusters/public-cloud/azure/create-azure-cluster.md) guide. + +#### Improvements + +- The Palette UI has been updated to improve the user experience for the project and tenant settings pages. The new + **Settings Menu** enhances usability and reduces visual clutter. You can now collapse and expand categories within the + **Settings Menu**. + +- Self-hosted Palette and PCG instances deployed to Azure through a Helm Chart now accept proxy configurations for + outbound traffic. The proxy configuration is set in the **values.yaml** file during the deployment process. Refer to + the + [Self-Hosted Helm Chart Configuration Reference](../enterprise-version/install-palette/install-on-kubernetes/palette-helm-ref.md#reach-system) + or the [Deploy a PCG to an Existing Kubernetes Cluster](../clusters/pcg/deploy-pcg-k8s.md) guide to learn more. + +- Improvements to the Palette agent has reduced the frequency and bandwidth of agent communication with the Palette + management platform. This change reduces the resource consumption by the Palette agent in a cluster and the bandwidth + usage between the agent and the Palette management platform. + +- Palette API responses now include the header `Cache-Control`. This header provides information on how long the + response can be cached and helps improve the performance of the Palette UI. + +- Self-Hosted Palette and Private Cloud Gateway (PCG) instances deployed on VMware vSphere now use the vSphere CSI + driver version 3.2.0. The new version will automatically get picked up during an upgrade. + +### Edge + +#### Breaking Changes + +- A change in the EdgeForge process affects the Local UI customization process when using the CanvOS utility. In the + past, placing a folder named **ui** at the root level of the CanvOS project was required. Moving forward, the **ui** + folder will be placed in the **local-ui/** folder. This change is to align with the new CanvOS project structure. If + you are using the EdgeForge process to create Edge artifacts, ensure you update the location of the **ui** folder in + your CanvOS project. Refer to the Local UI [Custom Links](../clusters/edge/local-ui/host-management/custom-link.md) + and [Customize Local UI Theme](../clusters/edge/local-ui/host-management/theming.md) to learn more about the changes. + +#### Features + +- A new Palette API endpoint, `v1/edgehosts/tags`, is available to retrieve all tags associated with Edge clusters. + +- [The Edge Management API](/api/category/edge-management-api-v1/) now supports some operations on connected Edge hosts + (non-airgap). In the past, the Edge Management API only supported airgap Edge hosts and clusters. The new + functionality now allows you to perform some actions using the Edge Management API on connected Edge hosts. Refer to + [List of Endpoints Unavailable to Connected Edge Hosts](/api/introduction/#list-of-endpoints-unavailable-to-connected-edge-hosts) + section to learn more about the limitations of connected Edge hosts. + +- Local UI now supports signed content bundles and cluster definitions. You can embed a public key in your Edge + Installer ISO or provider image. Local UI can use the key to verify the content bundle and cluster definition + cryptographically during uploads to ensure you are fulfilling compliance requirements. Refer to the + [Build Content Bundles](../clusters/edge/edgeforge-workflow/palette-canvos/build-content-bundle.md) guide to learn + more. + +#### Improvements + +- You can now disable password changes of Operating System (OS) users from Local UI. When password updates from Local UI + are disabled, you can still update the OS user password from the OS or the Edge Management API. Check out the + [Access Local UI](../clusters/edge/local-ui/host-management/access-console.md) page to learn more. + +- Several enhancements have been made to the UI for Edge host management in the context of cluster creation and updates. + These changes ensure a consistent and user-friendly experience, including new designs for the Edge host selection + screen and a customizable, powerful grid view. This redesign provides a better user experience for managing many edge + hosts in large-scale environments. Check out the + [Edge Host Grid View](../clusters/edge/site-deployment/edge-host-view.md) page to learn more. + +- EdgeForge now supports creating base images for Edge hosts using Ubuntu 24.04 UKI. To learn more about creating base + images, refer to the [Build Edge Artifacts](../clusters/edge/edgeforge-workflow/palette-canvos/palette-canvos.md) + guide. + +### VerteX + +#### Features + +- Includes all Palette features and improvements in this release. Refer to the [Palette](#jul-13-2024---release-44x) + section for more details. + +### Automation + +- Terraform version 0.20.7 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.7 is available. For more details, refer to the provider + [release page](https://github.com/crossplane-contrib/provider-palette/releases). + +- The Palette CLI now supports automatic validation when deploying a self-hosted VerteX or Palette instance. Use the + `--validate` flag to validate the deployment configuration before deploying the instance. Refer to the + [Validate Environment](../automation/palette-cli/commands/ec.md#validate-environment) section of the Palette EC + command documentation to learn more. + +### Docs and Education + +- Palette tutorials now have a dedicated view in the documentation. The [Tutorials](../tutorials/tutorials.md) page + provides a list of tutorials to help you get started with Palette and its features, and other advanced topics. + +### Packs + +#### Kubernetes + +| Pack | New Version | +| ------------------------------------------ | ----------- | +| K3s | 1.27.15 | +| K3s | 1.28.11 | +| K3s | 1.29.6 | +| Palette eXtended Kubernetes (PXK) | 1.27.15 | +| Palette eXtended Kubernetes (PXK) | 1.28.11 | +| Palette eXtended Kubernetes (PXK) | 1.29.6 | +| Palette eXtended Kubernetes - Edge (PXK-E) | 1.27.15 | +| Palette eXtended Kubernetes - Edge (PXK-E) | 1.28.11 | +| Palette eXtended Kubernetes - Edge (PXK-E) | 1.29.6 | +| RKE2 | 1.27.14 | +| RKE2 | 1.28.10 | +| RKE2 | 1.29.5 | +| RKE2 - Edge | 1.27.14 | +| RKE2 - Edge | 1.28.10 | +| RKE2 - Edge | 1.29.5 | + +#### CNI + +| Pack | New Version | +| ------ | ----------- | +| Calico | 3.28.0 | + +#### CSI + +| Pack | New Version | +| ----------- | ----------- | +| AWS EFS | 2.0.4 | +| Rook Ceph | 1.14.0 | +| vSphere CSI | 3.2.0 | + +#### Add-on Packs + +| Pack | New Version | +| ------------------------- | ----------- | +| External Secrets Operator | 0.9.16 | +| Kong | 2.38.0 | +| Reloader | 1.0.74 | +| Reloader | 1.0.107 | + +#### FIPS + +| Pack | New Version | +| ----------- | ----------- | +| Calico | 3.28.0 | +| Flannel | 0.24.3 | +| RKE2 | 1.27.14 | +| RKE2 | 1.28.10 | +| RKE2 | 1.29.5 | +| RKE2 - Edge | 1.27.14 | +| RKE2 - Edge | 1.28.10 | +| RKE2 - Edge | 1.29.5 | + ## Jul 7, 2024 - Release 4.4.7 #### Bug Fixes diff --git a/docs/docs-content/troubleshooting/pcg.md b/docs/docs-content/troubleshooting/pcg.md index 08741110c4..b84bde37e1 100644 --- a/docs/docs-content/troubleshooting/pcg.md +++ b/docs/docs-content/troubleshooting/pcg.md @@ -215,3 +215,44 @@ self-hosted Palette or VerteX cluster. Reach out to your Palette system administ ```bash kubectl delete VSphereFailureDomain ``` + +## Scenario - vSphere Controller Pod Fails to Start in Single Node PCG Cluster + +In a single-node PCG cluster, the vSphere controller pod may fail to start due to no matching node affinity rules. If +you encounter this issue, follow the steps below to resolve it. + +### Debug Steps + +1. Connect to the PCG cluster using the `kubectl` command-line tool. You can find the kubeconfig file in the PCG + cluster's details page in Palette. Log in to Palette and navigate to the left **Main Menu** and select **Tenant + Settings**. From the **Tenant settings Menu**, select **Private Cloud Gateways**. Select the PCG cluster that is + deployed in the VMware vSphere environment to access the details page. For additional guidance on how to setup + kubectl, check out the [Access Cluster with CLI](../clusters/cluster-management/palette-webctl.md) page. + +2. Issue the following command to get the vSphere controller pod's status. Take note of the pod's name. + + ```bash + kubectl get pods --namespace kube-system + ``` + +3. If the vSphere controller pod is in a `Pending` state, issue the following command to delete the existing pod and + force a restart. + + ```bash + kubectl delete pod --namespace kube-system + ``` + +4. After deleting the pod, issue the following command to check the pod's status. + + ```bash + kubectl get pods --namespace kube-system + ``` + +5. If the pod is still in a `Pending` state, check the pod's events to investigate the issue. + + ```bash + kubectl describe pod --namespace kube-system + ``` + +6. If the problem persists, reach out to our support team at + [support@spectrocloud.com](mailto:support@spectrocloud.com).