Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Release Notes 4.4.a #3320

Merged
merged 15 commits into from
Jul 11, 2024
Merged

Release Notes 4.4.a #3320

Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
8465ce8
docs: DOC-1269
karl-cardenas-coding Jul 9, 2024
a0e5b9d
docs: more notes
karl-cardenas-coding Jul 9, 2024
07afc8a
docs: more content
karl-cardenas-coding Jul 9, 2024
3dfa367
Merge branch 'release-4-4-a' into notes-4-4-a
karl-cardenas-coding Jul 10, 2024
91053f7
docs: added more content
karl-cardenas-coding Jul 10, 2024
6c4f0a4
Merge branch 'release-4-4-a' of github.com:spectrocloud/librarium int…
karl-cardenas-coding Jul 10, 2024
23ffe8e
docs: updated release notes
karl-cardenas-coding Jul 10, 2024
2d32c2d
docs: update release notes
karl-cardenas-coding Jul 10, 2024
0717e80
docs: vale feedback
karl-cardenas-coding Jul 10, 2024
088ff91
docs: added VerteX section
karl-cardenas-coding Jul 10, 2024
7a0e365
docs: update edge section
Jul 10, 2024
9fff722
docs: minor updates
Jul 10, 2024
75e3f7f
docs: apply suggestions from code review
karl-cardenas-coding Jul 11, 2024
6c10c03
docs: updated release notes
karl-cardenas-coding Jul 11, 2024
449e563
doc: PLT-1298
karl-cardenas-coding Jul 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/api-content/api-docs/1-introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
15 changes: 8 additions & 7 deletions docs/docs-content/release-notes/known-issues.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,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 |
karl-cardenas-coding marked this conversation as resolved.
Show resolved Hide resolved
karl-cardenas-coding marked this conversation as resolved.
Show resolved Hide resolved
| 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 |
172 changes: 172 additions & 0 deletions docs/docs-content/release-notes/release-notes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,178 @@ tags: ["release-notes"]

<ReleaseNotesVersions />

## Jul 13, 2024 - Release 4.4.X

<!-- Custom heading applied due to linking of the Palette section in the VerteX section -->

### 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.
karl-cardenas-coding marked this conversation as resolved.
Show resolved Hide resolved
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
karl-cardenas-coding marked this conversation as resolved.
Show resolved Hide resolved
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
karl-cardenas-coding marked this conversation as resolved.
Show resolved Hide resolved
driver version 3.2.0. The new version will automatically get picked up during an upgrade.

### Edge

#### Breaking Changes
karl-cardenas-coding marked this conversation as resolved.
Show resolved Hide resolved

- 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 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. You can still update the OS user
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'Disable' instead of 'disable'.

password from the OS or the Edge Management API. Check out the
[Access Local U](../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.
The new changes ensure a consistent and user-friendly experience that involves new designs for the edge host selection
karl-cardenas-coding marked this conversation as resolved.
Show resolved Hide resolved
screen during cluster creation and updates and a redesign that incorporates a customizable, powerful grid view and
provides a better user experience for large-scale environments with many edge hosts. 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 |
karl-cardenas-coding marked this conversation as resolved.
Show resolved Hide resolved
| Reloader | 1.0.107 |
karl-cardenas-coding marked this conversation as resolved.
Show resolved Hide resolved

#### 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
Expand Down
Loading