Skip to content

Commit

Permalink
docs: document api breaking change/known issue (#3951) (#3953)
Browse files Browse the repository at this point in the history 
* docs: document api breaking change/known issue

* docs: address review suggestions

(cherry picked from commit d531907)

Co-authored-by: caroldelwing <[email protected]>
  • Loading branch information
@vault-token-factory-spectrocloud @caroldelwing
vault-token-factory-spectrocloud[bot] and caroldelwing authored Sep 17, 2024
1 parent ba3420a commit 20b0772
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
1 change: 1 addition & 0 deletions docs/docs-content/release-notes/known-issues.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ The following table lists all known issues that are currently active and affecti

| Description | Workaround | Publish Date | Product Component |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ---------------------------- |
| A change in the [Edge Native Cluster](https://docs.spectrocloud.com/api/v1/v-1-spectro-clusters-edge-native-create/) API endpoint affects Terraform and API workflows for Edge cluster creation or modification. The `type` parameter in the `controlPlaneEndpoint` no longer accepts IP addresses; the accepted values are now `VIP`, `External`, and `DDNS`. As a result, API and Terraform workflows for Edge cluster creation or modification that use the IP address are currently unavailable. | For the Terraform workflow, upgrade the Terraform provider to version `0.21.4`. This new version supports the use of IP addresses and sends the `VIP` value to the API. No workaround is available for the API workflow. | September 17, 2024 | Edge |
| If an Edge host operating a cluster in connected mode loses connection to Palette, the cluster will not auto-renew its Public Key Infrastructure (PKI) certificates. When it re-establishes the connection to Palette, the Edge host will renew the certificates if the existing certificates have less than 30 days before expiry. | No workaround available. | Sep 14, 2024 | Edge |
| Using the Flannel Container Network Interface (CSI) pack together with a Red Hat Enterprise Linux (RHEL)-based provider image may lead to a pod becoming stuck during deployment. This is caused by an upstream issue with Flannel that was discovered in a K3s GitHub issue. Refer to [the K3s issue page](https://github.com/k3s-io/k3s/issues/5013) for more information. | No workaround is available | Sep 14, 2024 | Edge |
| Palette OVA import operations fail if the VMO cluster is using a storageClass with the volume bind method `WaitForFirstConsumer`. | Refer to the [OVA Imports Fail Due To Storage Class Attribute](../troubleshooting/vmo-issues.md#scenario---ova-imports-fail-due-to-storage-class-attribute) troubleshooting guide for workaround steps. | September 13, 2024 | Palette CLI, VMO |
Expand Down
11 changes: 7 additions & 4 deletions docs/docs-content/release-notes/release-notes.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -61,10 +61,6 @@ tags: ["release-notes"]
to the [Edge Installer User Data Configuration](../clusters/edge/edge-configuration/edge-configuration.md) reference
page for more information.

- A change in the Palette API affects Edge clusters deployed with Terraform or the Palette API. The `type` parameter in
the `controlPlaneEndpoint` for Edge clusters no longer accepts IP addresses. The accepted values are now `VIP`,
`External`, and `DDNS`.

#### Features

- You can now configure the Maximum Transmission Unit (MTU) for network interface configured for discovery though
Expand All @@ -86,6 +82,13 @@ tags: ["release-notes"]
(TUI) to enhance the user experience. These improvements include more visible options menus, automatic configuration
save upon exit, improved color scheme, and more.

#### Known Issues

- A change in the [Edge Native Cluster](https://docs.spectrocloud.com/api/v1/v-1-spectro-clusters-edge-native-create/)
API endpoint affects Terraform and API workflows for Edge cluster creation or modification. The `type` parameter in
the `controlPlaneEndpoint` no longer accepts IP addresses. The accepted values are now `VIP`, `External`, and `DDNS`.
Refer to the [Known Issues](./known-issues.md) page for more information.

### Virtual Machine Orchestrator

#### Features
Expand Down

0 comments on commit 20b0772

Please sign in to comment.