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.

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

docs: add new vsphere known issue #3896

Merged
merged 11 commits into from
Sep 13, 2024
Merged

docs: add new vsphere known issue #3896

merged 11 commits into from
Sep 13, 2024

Conversation

lennessyy
Copy link
Contributor

@lennessyy lennessyy commented Sep 13, 2024

Describe the Change

This PR adds a new known issue with regarding self-hosted instances in vsphere.

Changed Pages

💻 Troubleshooting
Known Issues
Upgrade notes

Jira Tickets

🎫 DOC-1376
🎫 DOC-1377
🎫 DOC-1378

Backports

Can this PR be backported?

  • Yes.

Copy link

netlify bot commented Sep 13, 2024

Deploy Preview for docs-spectrocloud ready!

Name Link
🔨 Latest commit b31f0a8
🔍 Latest deploy log https://app.netlify.com/sites/docs-spectrocloud/deploys/66e47e991732450008a41731
😎 Deploy Preview https://deploy-preview-3896--docs-spectrocloud.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

@karl-cardenas-coding karl-cardenas-coding left a comment

Choose a reason for hiding this comment

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

Some quick comments

docs/docs-content/troubleshooting/enterprise-install.md Outdated Show resolved Hide resolved
docs/docs-content/troubleshooting/enterprise-install.md Outdated Show resolved Hide resolved
docs/docs-content/troubleshooting/enterprise-install.md Outdated Show resolved Hide resolved
docs/docs-content/troubleshooting/enterprise-install.md Outdated Show resolved Hide resolved
docs/docs-content/troubleshooting/palette-upgrade.md Outdated Show resolved Hide resolved
@@ -16,6 +16,7 @@ The following table lists all known issues that are currently active and affecti

| Description | Workaround | Publish Date | Product Component |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ---------------------------- |
| Self-hosted instances of Palette in VMware vCenter do not have unique cluster IDs for their persistetn volumes. This can lead to issues if there are multiple self-hosted instances of Palette or during an upgrade. | Refer to the Troubleshooting section for guidance. | Sep 13, 2024 | Self-hosted |
Copy link
Contributor

Choose a reason for hiding this comment

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

Double checking on Sumit with the issue because I don't think clusters not having unique IDs was the case, but rather the PVC all looked the same, regardless of what EC cluster it belonged to.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I am just going to use the language from Romain in the slack channel

@lennessyy lennessyy added auto-backport Enable backport backport-version-4-2 Backport change to version 4.2 backport-version-4-3 Backport change to version 4.3 backport-version-4-4 Backport change to version 4.4 labels Sep 13, 2024
@lennessyy lennessyy marked this pull request as ready for review September 13, 2024 16:44
@lennessyy lennessyy requested a review from a team as a code owner September 13, 2024 16:44
@@ -77,3 +77,83 @@ following steps to restart the management pod.
```shell hideClipboard
pod "mgmt-f7f97f4fd-lds69" deleted
```

## Non-unique vSphere CNS Mapping
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 🐶
[spectrocloud-docs-internal.headings-title] Avoid using a noun that starts with an -ing in headings. Your heading starts with a word ending in 'ing'.


## Non-unique vSphere CNS Mapping

In Palette releases 4.4.8 and earlier, Persistent Volume Claims (PVCs) metadata do not use a unique identifier for
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.Spelling] Did you really mean 'PVCs'?

## Non-unique vSphere CNS Mapping

In Palette releases 4.4.8 and earlier, Persistent Volume Claims (PVCs) metadata do not use a unique identifier for
self-hosted Palette clusters. This causes incorrect Cloud Native Storage (CNS) mappings in vSphere, potentially leading
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 'cloud' instead of 'Cloud'.


This issue is resolved in Palette releases starting with 4.4.14. However, upgrading to 4.4.14 will not automatically
resolve this issue. If you have self-hosted instances of Palette in your vSphere environment older than 4.4.14, you
should execute the following utility script manually to make the Cloud Native Storage (CNS) mapping unique for the
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 'cloud' instead of 'Cloud'.

@@ -16,6 +16,7 @@ The following table lists all known issues that are currently active and affecti

| Description | Workaround | Publish Date | Product Component |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ---------------------------- |
| Persistent Volume Claims (PVCs) metadata do not use a unique identifier for self-hosted Palette clusters. This causes incorrect Cloud Native Storage (CNS) mappings in vSphere, potentially leading to issues during node operations and cluster upgrades. | Refer to the Troubleshooting section for guidance. | Sep 13, 2024 | Self-hosted |
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.Spelling] Did you really mean 'PVCs'?

@@ -16,6 +16,7 @@ The following table lists all known issues that are currently active and affecti

| Description | Workaround | Publish Date | Product Component |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ---------------------------- |
| Persistent Volume Claims (PVCs) metadata do not use a unique identifier for self-hosted Palette clusters. This causes incorrect Cloud Native Storage (CNS) mappings in vSphere, potentially leading to issues during node operations and cluster upgrades. | Refer to the Troubleshooting section for guidance. | Sep 13, 2024 | Self-hosted |
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 'cloud' instead of 'Cloud'.

@@ -61,6 +61,7 @@ for information on the fix version and the date the issue was resolved.

| Description | Publish Date | Product Component | Fix Version |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | ------------------- | ----------- |
| In a VMware environment, self-hosted Palette instances do not receive a unique cluster ID when deployed, which can cause issues during a node repave event, such as a Kubernetes version upgrade. Specifically, Persistent Volumes (PVs) and Persistent Volume Claims (PVCs) will experience start problems due to the lack of a unique cluster ID. | April 14, 2024 | Self-Hosted | 4.4.14 |
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.Spelling] Did you really mean 'PVs'?

@@ -61,6 +61,7 @@ for information on the fix version and the date the issue was resolved.

| Description | Publish Date | Product Component | Fix Version |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | ------------------- | ----------- |
| In a VMware environment, self-hosted Palette instances do not receive a unique cluster ID when deployed, which can cause issues during a node repave event, such as a Kubernetes version upgrade. Specifically, Persistent Volumes (PVs) and Persistent Volume Claims (PVCs) will experience start problems due to the lack of a unique cluster ID. | April 14, 2024 | Self-Hosted | 4.4.14 |
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.Spelling] Did you really mean 'PVCs'?

kubectl delete pvc mongo-data-mongo-2 --namespace=hubble-system
```

8. Delete the PV associated with the MongoDB pod. Use the following command to list all PVs and find the PV associated
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.Spelling] Did you really mean 'PVs'?

@@ -16,6 +16,7 @@ The following table lists all known issues that are currently active and affecti

| Description | Workaround | Publish Date | Product Component |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ---------------------------- |
| Persistent Volume Claims (PVCs) metadata do not use a unique identifier for self-hosted Palette clusters. This causes incorrect Cloud Native Storage (CNS) mappings in vSphere, potentially leading to issues during node operations and cluster upgrades. | Refer to the [Troubleshooting section](../troubleshooting/enterprise-install.md#non-unique-vsphere-cns-mapping) for guidance. | Sep 13, 2024 | Self-hosted |
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.Spelling] Did you really mean 'PVCs'?

@@ -16,6 +16,7 @@ The following table lists all known issues that are currently active and affecti

| Description | Workaround | Publish Date | Product Component |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ---------------------------- |
| Persistent Volume Claims (PVCs) metadata do not use a unique identifier for self-hosted Palette clusters. This causes incorrect Cloud Native Storage (CNS) mappings in vSphere, potentially leading to issues during node operations and cluster upgrades. | Refer to the [Troubleshooting section](../troubleshooting/enterprise-install.md#non-unique-vsphere-cns-mapping) for guidance. | Sep 13, 2024 | Self-hosted |
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 'cloud' instead of 'Cloud'.

Copy link
Contributor

@karl-cardenas-coding karl-cardenas-coding left a comment

Choose a reason for hiding this comment

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

Just some minor suggestions. The only other item worth noting is that we need the same in the VerteX section. I called it out where needed. Thanks for tackling this @lennessyy

@karl-cardenas-coding karl-cardenas-coding added backport-version-4-0 Backport change to version 4.0 backport-version-4-1 Backport change to version 4.1 labels Sep 13, 2024
@karl-cardenas-coding
Copy link
Contributor

@lennessyy I added the version backports for 4.0 and 4.1 as they were missing.

Lenny Chen and others added 2 commits September 13, 2024 11:00
Co-authored-by: Karl Cardenas <29551334+karl-cardenas-coding@users.noreply.github.com>

## Non-unique vSphere CNS Mapping

In Palette and VerteX releases 4.4.8 and earlier, Persistent Volume Claims (PVCs) metadata do not use a unique
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.Spelling] Did you really mean 'PVCs'?

## Non-unique vSphere CNS Mapping

In Palette and VerteX releases 4.4.8 and earlier, Persistent Volume Claims (PVCs) metadata do not use a unique
identifier for self-hosted Palette clusters. This causes incorrect Cloud Native Storage (CNS) mappings in vSphere,
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 'cloud' instead of 'Cloud'.

@lennessyy lennessyy merged commit b46a973 into master Sep 13, 2024
15 checks passed
@lennessyy lennessyy deleted the vsphere-cluster-id-issue branch September 13, 2024 18:26
vault-token-factory-spectrocloud bot pushed a commit that referenced this pull request Sep 13, 2024
* docs: first draft

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <29551334+karl-cardenas-coding@users.noreply.github.com>

* docs: add clarifying details

* docs: move old content to deprecated

* docs: clarify known issue not automatically resolved

* docs: add warning to more obvious places

* docs: add link to warning and xlinks

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <29551334+karl-cardenas-coding@users.noreply.github.com>

* ci: auto-formatting prettier issues

---------

Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>
Co-authored-by: Karl Cardenas <29551334+karl-cardenas-coding@users.noreply.github.com>
Co-authored-by: lennessyy <lennessyy@users.noreply.github.com>
(cherry picked from commit b46a973)
vault-token-factory-spectrocloud bot pushed a commit that referenced this pull request Sep 13, 2024
* docs: first draft

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <29551334+karl-cardenas-coding@users.noreply.github.com>

* docs: add clarifying details

* docs: move old content to deprecated

* docs: clarify known issue not automatically resolved

* docs: add warning to more obvious places

* docs: add link to warning and xlinks

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <29551334+karl-cardenas-coding@users.noreply.github.com>

* ci: auto-formatting prettier issues

---------

Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>
Co-authored-by: Karl Cardenas <29551334+karl-cardenas-coding@users.noreply.github.com>
Co-authored-by: lennessyy <lennessyy@users.noreply.github.com>
(cherry picked from commit b46a973)
@vault-token-factory-spectrocloud
Copy link
Contributor

💔 Some backports could not be created

Status Branch Result
version-4-0 Backport failed because of merge conflicts

You might need to backport the following PRs to version-4-0:
- Self-hosted Palette upgrade guides (#2303)
- docs: DOC-1118 Image Conversion to webp (#2439)
- docs: updated URLs to use file path context
version-4-1 Backport failed because of merge conflicts

You might need to backport the following PRs to version-4-1:
- Self-hosted Palette upgrade guides (#2303)
- docs: DOC-1118 Image Conversion to webp (#2439)
version-4-2 Backport failed because of merge conflicts

You might need to backport the following PRs to version-4-2:
- docs: PE-4831 (#3809)
- chore: PAC-938-packs data initial fetch and component development for readme (#3178)
- docs: add new known issue (#3340)
- docs: add video card known issue (#3294)
- docs: DOC-1118 Image Conversion to webp (#2439)
version-4-3
version-4-4

Note: Successful backport PRs will be merged automatically after passing CI.

Manual backport

To create the backport manually run:

backport --pr 3896

Questions ?

Please refer to the Backport tool documentation and see the Github Action logs for details

vault-token-factory-spectrocloud bot added a commit that referenced this pull request Sep 13, 2024
* docs: first draft

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <29551334+karl-cardenas-coding@users.noreply.github.com>

* docs: add clarifying details

* docs: move old content to deprecated

* docs: clarify known issue not automatically resolved

* docs: add warning to more obvious places

* docs: add link to warning and xlinks

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <29551334+karl-cardenas-coding@users.noreply.github.com>

* ci: auto-formatting prettier issues

---------

Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>
Co-authored-by: Karl Cardenas <29551334+karl-cardenas-coding@users.noreply.github.com>
Co-authored-by: lennessyy <lennessyy@users.noreply.github.com>
(cherry picked from commit b46a973)

Co-authored-by: Lenny Chen <55669665+lennessyy@users.noreply.github.com>
@vault-token-factory-spectrocloud vault-token-factory-spectrocloud bot mentioned this pull request Sep 13, 2024
2 tasks
karl-cardenas-coding pushed a commit that referenced this pull request Sep 13, 2024
* docs: add new vsphere known issue  (#3896)

* docs: first draft

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <29551334+karl-cardenas-coding@users.noreply.github.com>

* docs: add clarifying details

* docs: move old content to deprecated

* docs: clarify known issue not automatically resolved

* docs: add warning to more obvious places

* docs: add link to warning and xlinks

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <29551334+karl-cardenas-coding@users.noreply.github.com>

* ci: auto-formatting prettier issues

---------

Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>
Co-authored-by: Karl Cardenas <29551334+karl-cardenas-coding@users.noreply.github.com>
Co-authored-by: lennessyy <lennessyy@users.noreply.github.com>
(cherry picked from commit b46a973)

* docs: fix broken link

---------

Co-authored-by: Lenny Chen <55669665+lennessyy@users.noreply.github.com>
Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>
@vault-token-factory-spectrocloud
Copy link
Contributor

🎉 This issue has been resolved in version 4.4.13 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport Enable backport backport-version-4-0 Backport change to version 4.0 backport-version-4-1 Backport change to version 4.1 backport-version-4-2 Backport change to version 4.2 backport-version-4-3 Backport change to version 4.3 backport-version-4-4 Backport change to version 4.4 released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants