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: DOC-1385 #4047

Merged
merged 8 commits into from
Sep 25, 2024
Merged

docs: DOC-1385 #4047

merged 8 commits into from
Sep 25, 2024

Conversation

karl-cardenas-coding
Copy link
Contributor

@karl-cardenas-coding karl-cardenas-coding commented Sep 23, 2024

Describe the Change

This PR adds release notes for an upcoming patch.

Changed Pages

💻 Preview URL for Page

Jira Tickets

🎫 DOC-1385

Backports

Can this PR be backported?

  • Yes. Remember to add the relevant backport labels to your PR.
  • No. Please leave a short comment below about why this PR cannot be backported.

@karl-cardenas-coding karl-cardenas-coding added auto-backport Enable backport backport-version-4-4 Backport change to version 4.4 labels Sep 23, 2024
@karl-cardenas-coding karl-cardenas-coding requested a review from a team as a code owner September 23, 2024 16:53
Copy link

netlify bot commented Sep 23, 2024

Deploy Preview for docs-spectrocloud ready!

Name Link
🔨 Latest commit 5dff8c9
🔍 Latest deploy log https://app.netlify.com/sites/docs-spectrocloud/deploys/66f38ee24fce6200088ee292
😎 Deploy Preview https://deploy-preview-4047--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.

docs/docs-content/release-notes/release-notes.md Outdated Show resolved Hide resolved
docs/docs-content/release-notes/release-notes.md Outdated Show resolved Hide resolved
docs/docs-content/release-notes/release-notes.md Outdated Show resolved Hide resolved
* docs: 9-23-24 cve updates (#4046)

* 9-23-24 cve updates

* ci: auto-formatting prettier issues

---------

Co-authored-by: frederickjoi <[email protected]>

* docs: PEM-5725

* docs: review feedback

* docs: vale feedback

* docs: apply suggestions from code review

Co-authored-by: caroldelwing <[email protected]>

* ci: auto-formatting prettier issues

* docs: feedback updates

---------

Co-authored-by: frederickjoi <[email protected]>
Co-authored-by: frederickjoi <[email protected]>
Co-authored-by: caroldelwing <[email protected]>
Co-authored-by: karl-cardenas-coding <[email protected]>
@@ -43,3 +43,4 @@ Ongoing

- 1.0 08/16/2024 Initial Publication
- 2.0 08/17/2024 Added palette VerteX 4.4.14 to Affected Products
- 3.0 9/23/2024 Changed CVE status to Resolved
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 🐶
[Google.DateFormat] Use 'July 31, 2016' format, not '9/23/2024'.

@@ -41,3 +41,4 @@ Ongoing

- 1.0 08/16/2024 Initial Publication
- 2.0 08/17/2024 Added Palette VerteX 4.4.14 to Affected Products
- 3.0 09/23/2024 Changed CVE status to Resolved
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 🐶
[Google.DateFormat] Use 'July 31, 2016' format, not '09/23/2024'.

@@ -41,3 +41,4 @@ Ongoing

- 1.0 07/16/2024 Initial Publication
- 2.0 08/17/2024 Remediated in Palette VerteX 4.4.14
- 3.0 09/23/2024 Changed CVE status to Resolved
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 🐶
[Google.DateFormat] Use 'July 31, 2016' format, not '09/23/2024'.

@@ -41,3 +41,4 @@ Ongoing

- 1.0 08/16/2024 Initial Publication
- 2.0 08/17/2024 Added palette VerteX 4.4.14 to Affected Products
- 3.0 09/23/2024 Changed CVE status to Resolved
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 🐶
[Google.DateFormat] Use 'July 31, 2016' format, not '09/23/2024'.

@@ -44,3 +44,4 @@ Ongoing

- 1.0 08/16/2024 Initial Publication
- 2.0 08/17/2024 Added palette VerteX 4.4.14 to Affected Products
- 3.0 09/23/2024 Changed CVE status to Resolved
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 🐶
[Google.DateFormat] Use 'July 31, 2016' format, not '09/23/2024'.

service.
2. The agent's in-memory proxy creates a WebSocket connection with the management plane servers.
3. The management plane server accepts the WebSocket connection
4. The agent in-memory proxy transcodes the gRPC request on-demand and sends it via the WebSocket connection.
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 'transcodes'?

handler.
6. The gRPC handler processes the request and responds via the same connection. The WebSocket handler sends the response
from the gRPC handler back to the agent.
7. The agent's in-memory proxy reads the response off the WebSocket connection and transcodes it back to HTTP/2 and
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 'transcodes'?

7. The agent's in-memory proxy reads the response off the WebSocket connection and transcodes it back to HTTP/2 and
passes it to the agent.

A more straightforward way to think about the WebSocket transcoding architecture is that network traffic between 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.Spelling] Did you really mean 'transcoding'?


A more straightforward way to think about the WebSocket transcoding architecture is that network traffic between the
Palette agent and the management plane uses the WebSocket connection and the HTTP/1.1 protocol. The agent and server are
still communicating using gRPC, but the messages are transcoded to the HTTP/1.1 protocol between the two entities. Using
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 'transcoded'?

The following sections provide information about using gRPC with network proxies. These issues are addressed by using
WebSocket and the HTTP/1.1 protocol as a fallback mechanism. However, if you want to better understand the reasons for
falling back to a WebSocket connection, the following sections provide more information about challenges with gRPC and
network proxies. If you want to learn more about gRPC and transcoding, check out the Red Hat article
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 'transcoding'?

over WebSocket. Palette agents will automatically fall back to a WebSocket connection if the gRPC connection cannot be
established with the management plane using the default HTTP/2 protocol. This change improves the reliability of the
communication channel between the agent and the management plane. Environments with network proxies that reject HTTP/2
connections can now connect as the connection is transcoded to the HTTP/1.1 protocol. Refer to 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.Spelling] Did you really mean 'transcoded'?

@caroldelwing caroldelwing merged commit 8af9796 into master Sep 25, 2024
16 of 17 checks passed
@caroldelwing caroldelwing deleted the 4-4-20-notes branch September 25, 2024 12:39
@vault-token-factory-spectrocloud
Copy link
Contributor

💔 All backports failed

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

You might need to backport the following PRs to version-4-4:
- docs: modify calico instructions for multi-nic case (#4050)

Manual backport

To create the backport manually run:

backport --pr 4047

Questions ?

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

@vault-token-factory-spectrocloud
Copy link
Contributor

🎉 This issue has been resolved in version 4.5.0 🎉

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-4 Backport change to version 4.4 released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants