Skip to content

Commit

Permalink
docs: PPD-1446 new known issue (#3103)
Browse files Browse the repository at this point in the history 
* docs: new known issue

* chore: PPD-1446 added know issue entry

* docs: feedback

* chore: added troubleshooting steps

* docs: feedback

* docs: feedback

---------

Co-authored-by: Karl Cardenas <>
  • Loading branch information
@karl-cardenas-coding
karl-cardenas-coding authored Jun 14, 2024
1 parent d5a61bd commit 4fbf17e
Show file tree
Hide file tree
Showing 3 changed files with 97 additions and 0 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 |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- | ----------------- |
| During the platform upgrade from Palette 4.3 to 4.4, Virtual Clusters may encounter a scenario where the pod `palette-controller-manager` is not upgraded to the newer version of Palette. The virtual cluster will continue to be operational, and this does not impact its functionality. | Refer to the [Controller Manager Pod Not Upgraded](../troubleshooting/palette-dev-engine.md#scenario---controller-manager-pod-not-upgraded) troubleshooting guide. | June 15, 2024 | Virtual Clusters |
| The VerteX enterprise cluster is unable to complete backup operations. | No workaround is available. | June 15, 2024 | VerteX |
| Edge hosts with FIPS-compliant RHEL Operating System (OS) distribution may encounter the error where the `systemd-resolved.service` service enters the **failed** state. This prevents the nameserver from being configured, which will result in cluster deployment failure. | Refer to [TroubleShooting](../troubleshooting/edge.md#scenario---systemd-resolvedservice-enters-failed-state) for a workaround. | June 15, 2024 | Edge |
| The GKE cluster's Kubernetes pods are failing to start because the Kubernetes patch version is unavailable. This is encountered during pod restarts or node scaling operations. | Deploy a new cluster and use a GKE cluster profile that does not contain a Kubernetes pack layer with a patch version. Migrate the workloads from the existing cluster to the new cluster. This is a breaking change introduced in Palette 4.4.0 | June 15, 2024 | Packs, Clusters |
Expand Down
11 changes: 11 additions & 0 deletions docs/docs-content/release-notes/release-notes.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,17 @@ features and improvements.

- Support for custom links, URLs, and static pages is now available in local UI. You can populate custom links in the left **Main Menu** of [local UI](../clusters/edge/local-ui/host-management/custom-link.md), which will either load content into in an iframe or act as en external link. You can also can host static pages in local UI. This is useful when you need to deploy and host custom or specific content for a site and want to avoid introducing additional services to host a static site.

### Palette Dev Engine (PDE)

#### Known Issues

- During the platform upgrade from Palette 4.3 to 4.4,
[Virtual Clusters](../clusters/palette-virtual-clusters/palette-virtual-clusters.md) may encounter a scenario where
the pod `palette-controller-manager` is not upgraded to the newer version of Palette. The virtual cluster will
continue to be operational, and this does not impact its functionality. Refer to the
[Controller Manager Pod Not Upgraded](../troubleshooting/palette-dev-engine.md#scenario---controller-manager-pod-not-upgraded)
troubleshooting guide for resolution steps.

### Virtual Machine Orchestrator (VMO)

#### Improvements
Expand Down
85 changes: 85 additions & 0 deletions docs/docs-content/troubleshooting/palette-dev-engine.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,88 @@ Invalid value: "300m": must be less than or equal to CPU limit spec.containers[0
The workaround is to define both the `requests` and `limits`.

<br />

## Scenario - Controller Manager Pod Not Upgraded

If the `palette-controller-manager` pod for a virtual cluster is not upgraded after a Palette platform upgrade, use the
following steps to resolve the issue.

### Debug Steps

1. Ensure you can connect to the host cluster using the cluster's kubeconfig file. Refer to the
[Access Cluster with CLI](../clusters/cluster-management/palette-webctl.md) guide for additional guidance.

2. Identify the namespace where the virtual cluster is active. Use the virtual cluster's ID to identify the correct
namespace. Use the following to extract the namespace. Make sure you get the correct namespace for the virtual
cluster and not the main host cluster namespace.

```shell
kubectl get pods --all-namespaces | grep cluster-management-agent
```

In this example, the virtual cluster ID is `666c92d18b802543a124513d`.

```shell hideClipboard {2}
cluster-666c89f28b802503dc8542d3 cluster-management-agent-f766467f4-8prd6 1/1 Running 1 (29m ago) 30m
cluster-666c92d18b802543a124513d cluster-management-agent-f766467f4-8v577 1/1 Running 0 4m13s
```

:::tip

You can find the virtual cluster ID in the URL when you access the virtual cluster in the Palette UI. From the left
**Main Menu**, click on **Cluster Groups** and select the cluster group hosting your virtual cluster. Click on the
virtual cluster name to access the virtual cluster. The URL will contain the virtual cluster ID.

:::

3. Scale down the `cluster-management-agent` deployment to 0. Replace `<namespace>` with the namespace of the virtual
cluster.

```shell
kubectl scale deployment cluster-management-agent --replicas=0 --namespace <namespace>
```

```shell hideClipboard
deployment.apps/cluster-management-agent scaled
```

4. Edit the `palette-controller-manager` deployment and under the resources section for the `manager` and `atop` add the
`ephemeral-storage` field and the `1Gi` value.

```yaml {4}
name: manager
resources:
limits:
ephemeral-storage: 1Gi
```
```yaml {4}
name: atop-manager
resources:
limits:
ephemeral-storage: 1Gi
```
You can use the following command to edit the deployment. Press `i` to enter insert mode, make the necessary changes,
and then press `Esc` followed by `:wq` to save and exit.

```shell
kubectl edit deployment palette-controller-manager --namespace <namespace>
```

```shell hideClipboard
deployment.apps/palette-controller-manager edited
```

5. Wait for the new `palette-manager` pod to become healthy and active.

6. Scale up the `cluster-management-agent` deployment to 1. Replace `<namespace>` with the namespace of the virtual
cluster.

```shell
kubectl scale deployment cluster-management-agent --replicas=1 --namespace <namespace>
```

```shell hideClipboard
deployment.apps/cluster-management-agent scaled
```

0 comments on commit 4fbf17e

Please sign in to comment.