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 known issue #3400

Merged
merged 6 commits into from
Jul 17, 2024
Merged

docs: add known issue #3400

merged 6 commits into from
Jul 17, 2024

Conversation

lennessyy
Copy link
Contributor

@lennessyy lennessyy commented Jul 17, 2024

Describe the Change

This PR adds a known issue about Edge stages overwriting each other and losing user information.

Changed Pages

💻 Add Preview URL for Page

Jira Tickets

🎫 PE-4708

Backports

Can this PR be backported?

  • Yes.

@lennessyy lennessyy added backport-version-4-0 Backport change to version 4.0 auto-backport Enable backport backport-version-3-4 Backport change to version 3.4 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 labels Jul 17, 2024
Copy link

netlify bot commented Jul 17, 2024

Deploy Preview for docs-spectrocloud ready!

Name Link
🔨 Latest commit dca281c
🔍 Latest deploy log https://app.netlify.com/sites/docs-spectrocloud/deploys/66982be738bee40008409232
😎 Deploy Preview https://deploy-preview-3400--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.

@lennessyy lennessyy marked this pull request as ready for review July 17, 2024 20:09
@lennessyy lennessyy requested a review from a team as a code owner July 17, 2024 20:09
@@ -16,6 +16,7 @@ The following table lists all known issues that are currently active and affecti

| Description | Workaround | Publish Date | Product Component |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- | --------------------- |
| When provisioning an Edge cluster, it's possible that some Operating System (OS) user credentials will be lost once the cluster is active. This is because the cloud-init stages from different sources merge during the deployment process and sometimes the same stages without distinct names overwrite each other. | Give each of your cloud-init stages in the OS pack and in the Edge installer **user-data** file a unique name. For more information about cloud-init stages and examples of cloud-init stages with names, refer to [Cloud-init Stages](../clusters/edge/edge-configuration/cloud-init#erase-partitions.md). | July 17 2024 | Edge |
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

@caroldelwing caroldelwing left a comment

Choose a reason for hiding this comment

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

Approved with 1 comment :)

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

| Description | Workaround | Publish Date | Product Component |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- | --------------------- |
| When provisioning an Edge cluster, it's possible that some Operating System (OS) user credentials will be lost once the cluster is active. This is because the cloud-init stages from different sources merge during the deployment process and sometimes the same stages without distinct names overwrite each other. | Give each of your cloud-init stages in the OS pack and in the Edge installer **user-data** file a unique name. For more information about cloud-init stages and examples of cloud-init stages with names, refer to [Cloud-init Stages](../clusters/edge/edge-configuration/cloud-init#erase-partitions.md). | July 17 2024 | Edge |
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
| When provisioning an Edge cluster, it's possible that some Operating System (OS) user credentials will be lost once the cluster is active. This is because the cloud-init stages from different sources merge during the deployment process and sometimes the same stages without distinct names overwrite each other. | Give each of your cloud-init stages in the OS pack and in the Edge installer **user-data** file a unique name. For more information about cloud-init stages and examples of cloud-init stages with names, refer to [Cloud-init Stages](../clusters/edge/edge-configuration/cloud-init#erase-partitions.md). | July 17 2024 | Edge |
| When provisioning an Edge cluster, it's possible that some Operating System (OS) user credentials will be lost once the cluster is active. This is because the cloud-init stages from different sources merge during the deployment process, and sometimes, stages with the same names overwrite each other. | Give each of your cloud-init stages in the OS pack and in the Edge installer **user-data** file a unique name. For more information about cloud-init stages and examples of cloud-init stages with names, refer to [Cloud-init Stages](../clusters/edge/edge-configuration/cloud-init#erase-partitions.md). | July 17 2024 | Edge |

Maybe? :)
Also, I think the cloud-init stages link is broken

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

| Description | Workaround | Publish Date | Product Component |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- | --------------------- |
| When provisioning an Edge cluster, it's possible that some Operating System (OS) user credentials will be lost once the cluster is active. This is because the cloud-init stages from different sources merge during the deployment process and sometimes the same stages without distinct names overwrite each other. | Give each of your cloud-init stages in the OS pack and in the Edge installer **user-data** file a unique name. For more information about cloud-init stages and examples of cloud-init stages with names, refer to [Cloud-init Stages](../clusters/edge/edge-configuration/cloud-init.md). | July 17 2024 | Edge |
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 ac245ed into master Jul 17, 2024
15 checks passed
@lennessyy lennessyy deleted the PE-4708 branch July 17, 2024 21:01
vault-token-factory-spectrocloud bot pushed a commit that referenced this pull request Jul 17, 2024
* docs: add known issue

* docs: clarify issue

* docs: add example

* docs: fix broken link

* docs: implement suggestion

---------

Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>
(cherry picked from commit ac245ed)
vault-token-factory-spectrocloud bot pushed a commit that referenced this pull request Jul 17, 2024
* docs: add known issue

* docs: clarify issue

* docs: add example

* docs: fix broken link

* docs: implement suggestion

---------

Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>
(cherry picked from commit ac245ed)
vault-token-factory-spectrocloud bot pushed a commit that referenced this pull request Jul 17, 2024
* docs: add known issue

* docs: clarify issue

* docs: add example

* docs: fix broken link

* docs: implement suggestion

---------

Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>
(cherry picked from commit ac245ed)
@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:
- docs: update ghsa-m425-mq94-257g.md (#3399)
- Security Bulletin Changes (#3120)
- docs: add video card known issue (#3294)
- Create, style, and populate the Tutorials section (#2689)
version-3-4 Backport failed because of merge conflicts

You might need to backport the following PRs to version-3-4:
- docs: update ghsa-m425-mq94-257g.md (#3399)
- Security Bulletin Changes (#3120)
version-4-1 Backport failed because of merge conflicts

You might need to backport the following PRs to version-4-1:
- docs: update ghsa-m425-mq94-257g.md (#3399)
- Security Bulletin Changes (#3120)
- docs: add video card known issue (#3294)
- Create, style, and populate the Tutorials section (#2689)
version-4-2
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 3400

Questions ?

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

@lennessyy lennessyy removed backport-version-4-0 Backport change to version 4.0 backport-version-3-4 Backport change to version 3.4 backport-version-4-1 Backport change to version 4.1 labels Jul 17, 2024
vault-token-factory-spectrocloud bot added a commit that referenced this pull request Jul 17, 2024
* docs: add known issue

* docs: clarify issue

* docs: add example

* docs: fix broken link

* docs: implement suggestion

---------

Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>
(cherry picked from commit ac245ed)

Co-authored-by: Lenny Chen <55669665+lennessyy@users.noreply.github.com>
vault-token-factory-spectrocloud bot added a commit that referenced this pull request Jul 17, 2024
* docs: add known issue

* docs: clarify issue

* docs: add example

* docs: fix broken link

* docs: implement suggestion

---------

Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>
(cherry picked from commit ac245ed)

Co-authored-by: Lenny Chen <55669665+lennessyy@users.noreply.github.com>
vault-token-factory-spectrocloud bot added a commit that referenced this pull request Jul 17, 2024
* docs: add known issue

* docs: clarify issue

* docs: add example

* docs: fix broken link

* docs: implement suggestion

---------

Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>
(cherry picked from commit ac245ed)

Co-authored-by: Lenny Chen <55669665+lennessyy@users.noreply.github.com>
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-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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants