docs: DOC-1408 #4159
Merged
docs: DOC-1408 #4159
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
🤖 Netlify configured to enable preview build for branch: rl-notes-4-5 . Subsequent commits will automatically trigger a Netlify build preview. |
✅ Deploy Preview for docs-spectrocloud ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
|
||
| This release of Palette features a new deployment model, Agent Mode, and contains several new improvements and | ||
| enhancements. Take a moment and review the breaking changes and deprecation messages to ensure you stay informed of | ||
| upcoming changes. We also have a new and improved [Getting Started](../getting-started/getting-started.md) series worth |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'we' instead of 'We'.
| #### Improvements | ||
|
|
||
| ### Palette Dev Engine (PDE) | ||
| - You can now disable the webhook Edge hosts use to redirect image pulls to the appropriate locations depending on your |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'Disable' instead of 'disable'.
| ### Packs | ||
|
|
||
| #### Pack Notes | ||
| #### OS |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[spectrocloud-docs-internal.heading-all-caps] Headings should not be entirely in uppercase.
| | Pack Name | New Version | | ||
| | ------------------------- | ----------- | | ||
| | AWS ALB | 2.8.3 | | ||
| | Cillium Tetragon | 1.2.0 | |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Cillium'?
| | Manifests attached to an Infrastructure Pack, such as OS, Kubernetes, Network, or Storage, are not applied to the Edge cluster. This issue does not impact the infrastructure pack's YAML definition, which is applied to the cluster. | Specify custom configurations through an add-on pack or a custom manifest pack applied after the infrastructure packs. | Jul 9, 2024 | Edge, Packs | | ||
| | Clusters using Cilium and deployed to VMware environments with the VXLAN tunnel protocol may encounter an I/O timeout error. This issue is caused by the VXMNET3 adapter, which is dropping network traffic and resulting in VXLAN traffic being dropped. You can learn more about this issue in the [Cilium's GitHub issue #21801](https://github.com/cilium/cilium/issues/21801). | Review the <VersionedLink text="Cilium Troubleshooting" url="/integrations/packs/?pack=cni-cilium-oss"/> section for workarounds. | June 27, 2024 | Packs, Clusters, Edge | | ||
| | [Sonobuoy](../clusters/cluster-management/compliance-scan.md#conformance-testing) scans fail to generate reports on airgapped Palette Edge clusters. | No workaround is available. | June 24, 2024 | Edge | | ||
| | Clusters configured with OpenID Connect (OIDC) at the Kubernetes layer encounter issues when authenticating with the [non-admin Kubeconfig file](../clusters/cluster-management/kubeconfig.md#cluster-admin). Kubeconfig files using OIDC to authenticate will not work if the SSL certificate is set at the OIDC provider level. | Use the admin Kubeconfig file to authenticate with the cluster, as it does not use OIDC to authenticate. | June 21, 2024 | Clusters | |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'kubeconfig' instead of 'Kubeconfig'.
| | Manifests attached to an Infrastructure Pack, such as OS, Kubernetes, Network, or Storage, are not applied to the Edge cluster. This issue does not impact the infrastructure pack's YAML definition, which is applied to the cluster. | Specify custom configurations through an add-on pack or a custom manifest pack applied after the infrastructure packs. | Jul 9, 2024 | Edge, Packs | | ||
| | Clusters using Cilium and deployed to VMware environments with the VXLAN tunnel protocol may encounter an I/O timeout error. This issue is caused by the VXMNET3 adapter, which is dropping network traffic and resulting in VXLAN traffic being dropped. You can learn more about this issue in the [Cilium's GitHub issue #21801](https://github.com/cilium/cilium/issues/21801). | Review the <VersionedLink text="Cilium Troubleshooting" url="/integrations/packs/?pack=cni-cilium-oss"/> section for workarounds. | June 27, 2024 | Packs, Clusters, Edge | | ||
| | [Sonobuoy](../clusters/cluster-management/compliance-scan.md#conformance-testing) scans fail to generate reports on airgapped Palette Edge clusters. | No workaround is available. | June 24, 2024 | Edge | | ||
| | Clusters configured with OpenID Connect (OIDC) at the Kubernetes layer encounter issues when authenticating with the [non-admin Kubeconfig file](../clusters/cluster-management/kubeconfig.md#cluster-admin). Kubeconfig files using OIDC to authenticate will not work if the SSL certificate is set at the OIDC provider level. | Use the admin Kubeconfig file to authenticate with the cluster, as it does not use OIDC to authenticate. | June 21, 2024 | Clusters | |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'kubeconfig' instead of 'Kubeconfig'.
| | Clusters using <VersionedLink text="Microk8s" url="/integrations/packs/?pack=kubernetes-microk8s" /> 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 | | ||
| | Azure IaaS clusters are having issues with deployed load balancers and ingress deployments when using Kubernetes versions 1.29.0 and 1.29.4. Incoming connections time out as a result due to a lack of network path inside the cluster. Azure AKS clusters are not impacted. | Use a Kubernetes version lower than 1.29.0 | June 12, 2024 | Clusters | | ||
| | OIDC integration with Virtual Clusters is not functional. All other operations related to Virtual Clusters are operational. | No workaround is available. | Jun 11, 2024 | Virtual Clusters | | ||
| | 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 | |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Datacenter'?
caroldelwing
approved these changes
Oct 10, 2024
Co-authored-by: caroldelwing <[email protected]>
lennessyy
added a commit
that referenced
this pull request
Oct 13, 2024
* feat: release 4.5 * docs: DOC-1410 (#4121) * docs: PLT-1407 (#4112) * docs: PEM-5698 OIDC userinfo (#4119) * docs: PEM-5698 * docs: vale feedback * docs: missing commit * docs: PCP-3569 Microk8s and Backup Failures (#4138) * docs: PCP-3568 * docs: PCP-3569 * docs: fixed heading * docs: Apply suggestions from code review Co-authored-by: caroldelwing <[email protected]> * ci: auto-formatting prettier issues --------- Co-authored-by: caroldelwing <[email protected]> Co-authored-by: karl-cardenas-coding <[email protected]> * docs: PEM-5472 (#4181) * docs: PEM-5472 * docs: trigger build * docs: added limiation * docs: apply suggestions from code review * docs: capitalization fix * docs: palette API docs - 4.5 (#4219) * docs: update API * chore: fix API labeler * docs: PEM-6014 (#4216) * docs: PEM-6014 * docs: more changes * docs: added tooltip infobox * docs: vale feedback * Optimised images with calibre/image-actions * Optimised images with calibre/image-actions * docs: Apply suggestions from code review Co-authored-by: caroldelwing <[email protected]> * ci: auto-formatting prettier issues --------- Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com> Co-authored-by: caroldelwing <[email protected]> Co-authored-by: karl-cardenas-coding <[email protected]> * docs: add Edge api 4.5.0 (#4233) * docs: add edge mgmt api 450 * ci: auto-formatting API changes --------- Co-authored-by: Lenny Chen <[email protected]> Co-authored-by: Karl Cardenas <[email protected]> Co-authored-by: karl-cardenas-coding <[email protected]> * docs: add workaround for RKE2 Cilium known issue (#4217) * docs: add workaround * docs:git statusgit status * docs: add troubleshooting steps * docs: vale * docs: link upstream issue * docs: add crosslink --------- Co-authored-by: Lenny Chen <[email protected]> * docs: add 4.5 palette oss licenses (#4251) * docs: add 4.5 palette oss licenses * docs: trigger netlify * docs: disable webhook (#4098) * docs: start page * docs: missing validate steps * docs: add draft for webhook feature * docs: add registry redirect instructions * docs: copy edits * docs: adjust verify steps * docs: vale kubelet * docs: address review comments * docs: Update docs/docs-content/clusters/edge/edge-configuration/installer-reference.md * chore: prettier --------- Co-authored-by: Lenny Chen <[email protected]> Co-authored-by: Karl Cardenas <[email protected]> Co-authored-by: Karl Cardenas <[email protected]> * docs: share local UI login (#4140) * docs: add title description * docs: add some steps" * docs: add content to page * docs: add note about getting edge host ID * docs: add prereqs * docs: add env variable tip * docs: small copy edit * docs: fix broken links * docs: vale comments * Apply suggestions from code review Co-authored-by: Karl Cardenas <[email protected]> * ci: auto-formatting prettier issues * docs: address review comments --------- Co-authored-by: Lenny Chen <[email protected]> Co-authored-by: Karl Cardenas <[email protected]> Co-authored-by: lennessyy <[email protected]> * docs: DOC-1408 DOC-1472 PCP-3520 PE-5257 (#4159) * docs: DOC-1408 * docs: more content * docs: save * chore: update content * docs: more content * docs: more content * docs: update * docs: PPD-1472 * docs: more changes * docs: PCP-3567 * docs: updated terraform version * docs: updates * docs: PE-5257 * docs: PE-5257 * save * docs: updated release notes * docs: ready for review * docs: apply suggestions from code review Co-authored-by: caroldelwing <[email protected]> * ci: auto-formatting prettier issues --------- Co-authored-by: caroldelwing <[email protected]> Co-authored-by: karl-cardenas-coding <[email protected]> * docs: agent mode / deployment modes (#4099) * docs: start first page * docs: add category.json * docs: rough outline * docs: add more disposition and place holder text * docs: add more placeholders * docs: brief descriptions * docs: add diagrams * docs: convert to webp * docs: index page draft * docs: add agent mode content * docs: add agent mode info * docs: Agent Mode installation guide (#4198) * docs: add agent installation guide * docs: remove config ref paragraph * docs: add agent mgmt page * docs: add new controller mode page and diagram * docs: add limitations, tech preview banner, fix command * docs: vale feedback * Optimised images with calibre/image-actions * Apply suggestions from code review * Optimised images with calibre/image-actions --------- Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com> Co-authored-by: Lenny Chen <[email protected]> * docs: add appliance mode info * docs: fix broken link * docs: remove image from index page * docs: add diagrams * docs: add link to github repo, review prereqs * docs: add local ui theming guide * docs: update BYOS pack * Optimised images with calibre/image-actions * Optimised images with calibre/image-actions * docs: add deployment modes icon * docs: review grammar * docs: add instructions for airgap * docs: fix broken tab, add main diagram * docs: replace gif bc it was not looping * docs: comment out airgap * docs: minor copy edit * docs: add supported k8s distros * docs: remove CPU model restrictions * docs: add airgap steps * Apply suggestions from code review Co-authored-by: Karl Cardenas <[email protected]> * docs: address review comments * docs: add local ui link * docs: address vale comments * docs: fix grouptab, replace download script command * docs: modify version number * docs: change docker to crane * docs: add warning for docker * docs: add flannel limitation --------- Co-authored-by: Lenny Chen <[email protected]> Co-authored-by: Carolina Delwing Rosa <[email protected]> Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com> Co-authored-by: Karl Cardenas <[email protected]> * chore: changes * chore: added agent mode link * chore: vale feedback * docs: version.sh change (#4267) * docs: version script * docs: remove redundant changes * docs: add robot.txt * docs: rename robots.txt --------- Co-authored-by: Lenny Chen <[email protected]> * chore: version update * chore: version changes * docs: updated URLs * chore: fix docs --------- Co-authored-by: caroldelwing <[email protected]> Co-authored-by: karl-cardenas-coding <[email protected]> Co-authored-by: Ravikumar Kondepati <[email protected]> Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com> Co-authored-by: Lenny Chen <[email protected]> Co-authored-by: Lenny Chen <[email protected]> Co-authored-by: lennessyy <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Describe the Change
This PR adds release notes for 4.5
Changed Pages
💻 Preview URL for Page
Jira Tickets
🎫 DOC-1408
🎫 DOC-1472
🎫 PCP-3520
🎫 PE-5257
Backports
Can this PR be backported?