Skip to content

Commit

Permalink
Getting Started - Phase 2 (#3159) (#4075)
Browse files Browse the repository at this point in the history
* docs: create cloud-centric Getting Started DOC-1068 (#2389)

* docs: add navigation card components

* chore: Add a few more grid styles

* docs: add Jest test and adjust Getting Started landing page

* docs: fix formatting

* docs: fix lint errors in SimpleCard

* docs: refactor grid test DOC-1067

* docs: reduce duplication in SimpleCard test

* docs: reduce duplication in SimpleCard test

* docs: fix formatting DOC-1067

* docs: update SimpleCardGrid naming DOC-1067

* docs: create cloud-centric Getting Started prototype DOC-1068

* docs: fix formatting

* docs: adjust nav cards and rebase

* docs: update prototype DOC-1068

* docs: move dashboard to introduction DOC-1068

* docs: update AWS section DOC-1068

* docs: update Azure section DOC-1068

* docs: update GCP section DOC-1068

* docs: add tags to getting started DOC-1068

* docs: update formatting DOC-1068

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: update GCP landing page DOC-1068

* Apply suggestions from code review



* docs: adjust setup fro getting started DOC-1068

* docs: remove video from deploy cluster DOC-1068

* docs: update imports in AWS DOC-1068

* docs: fix formatting DOC-1068

* docs: fix broken links DOC-1068

* docs: fix broken links DOC-1068

* docs: adjust partials usage DOC-1068

* docs: use partials in getting started DOC-1068

* docs: use hello-universe pack in cluster profile DOC-1068

* Optimised images with calibre/image-actions

* docs: fix registries link DOC-1068

* docs: update aws cluster profile updates page DOC-1068

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: update azure tutorial with hello-uni pack DOC-1068

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: update gcp tutorial DOC-1068

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: update azure guide with correct assets DOC-1068

---------





* docs: add VMware Getting Started DOC-1126 (#3173)

* docs: add VMware Getting Started DOC-1126

* docs: update AWS flow

* docs: adjust Azure flow DOC-116

* docs: adjust GCP flow DOC-1126

* docs: adjust VMware flow DOC-1126

* docs: add Cluster Observability section DOC-1126

* docs: fix landing DOC-1126

* docs: fix landing DOC-1126

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: add PCG page card to VMware landing

* docs: remove spaces from around VersionedLink

* Apply suggestions from code review



* docs: add missing VMware card & fix PR comments DOC-1126

---------




* docs: revert adding of old accept file

* Manage AWS Clusters with Terraform tutorial - Getting Started (#3276)

* docs: create cloud-centric Getting Started DOC-1068 (#2389)

* docs: add navigation card components

* chore: Add a few more grid styles

* docs: add Jest test and adjust Getting Started landing page

* docs: fix formatting

* docs: fix lint errors in SimpleCard

* docs: refactor grid test DOC-1067

* docs: reduce duplication in SimpleCard test

* docs: reduce duplication in SimpleCard test

* docs: fix formatting DOC-1067

* docs: update SimpleCardGrid naming DOC-1067

* docs: create cloud-centric Getting Started prototype DOC-1068

* docs: fix formatting

* docs: adjust nav cards and rebase

* docs: update prototype DOC-1068

* docs: move dashboard to introduction DOC-1068

* docs: update AWS section DOC-1068

* docs: update Azure section DOC-1068

* docs: update GCP section DOC-1068

* docs: add tags to getting started DOC-1068

* docs: update formatting DOC-1068

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: update GCP landing page DOC-1068

* Apply suggestions from code review



* docs: adjust setup fro getting started DOC-1068

* docs: remove video from deploy cluster DOC-1068

* docs: update imports in AWS DOC-1068

* docs: fix formatting DOC-1068

* docs: fix broken links DOC-1068

* docs: fix broken links DOC-1068

* docs: adjust partials usage DOC-1068

* docs: use partials in getting started DOC-1068

* docs: use hello-universe pack in cluster profile DOC-1068

* Optimised images with calibre/image-actions

* docs: fix registries link DOC-1068

* docs: update aws cluster profile updates page DOC-1068

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: update azure tutorial with hello-uni pack DOC-1068

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: update gcp tutorial DOC-1068

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: update azure guide with correct assets DOC-1068

---------





* docs: add aws terraform tutorial

* docs: fix broken link, remove duplicated partials

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: fix card component

* docs: fix images conflicts

* docs: fix more images conflicts

* docs: fix last image conflicts

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: final review

* Apply suggestions from code review



* docs: apply suggestions from review

---------






* docs: add azure terraform tutorial, clean up gs section (#3330)

* docs: add azure terraform tutorial, clean up gs section

* docs: add gcp tutorial

* docs: add vmware terraform tutorial

* docs: vale suggestions

* Optimised images with calibre/image-actions

* docs: vale suggestions

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: style guide fixes

* docs: apply suggestions from review

---------



* docs: combine cluster profiles with introduction page Getting Started DOC-1125 (#3473)

* docs: combine cluster profiles with introduction page Getting Started DOC-1125

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

---------



* docs: remove duplicate partial entry in prettierignore

* docs: add AWS "Scale, Upgrade, and Secure Clusters" tutorial DOC-1306 (#3463)

* docs: create cloud-centric Getting Started DOC-1068 (#2389)

* docs: add navigation card components

* chore: Add a few more grid styles

* docs: add Jest test and adjust Getting Started landing page

* docs: fix formatting

* docs: fix lint errors in SimpleCard

* docs: refactor grid test DOC-1067

* docs: reduce duplication in SimpleCard test

* docs: reduce duplication in SimpleCard test

* docs: fix formatting DOC-1067

* docs: update SimpleCardGrid naming DOC-1067

* docs: create cloud-centric Getting Started prototype DOC-1068

* docs: fix formatting

* docs: adjust nav cards and rebase

* docs: update prototype DOC-1068

* docs: move dashboard to introduction DOC-1068

* docs: update AWS section DOC-1068

* docs: update Azure section DOC-1068

* docs: update GCP section DOC-1068

* docs: add tags to getting started DOC-1068

* docs: update formatting DOC-1068

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: update GCP landing page DOC-1068

* Apply suggestions from code review



* docs: adjust setup fro getting started DOC-1068

* docs: remove video from deploy cluster DOC-1068

* docs: update imports in AWS DOC-1068

* docs: fix formatting DOC-1068

* docs: fix broken links DOC-1068

* docs: fix broken links DOC-1068

* docs: adjust partials usage DOC-1068

* docs: use partials in getting started DOC-1068

* docs: use hello-universe pack in cluster profile DOC-1068

* Optimised images with calibre/image-actions

* docs: fix registries link DOC-1068

* docs: update aws cluster profile updates page DOC-1068

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: update azure tutorial with hello-uni pack DOC-1068

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: update gcp tutorial DOC-1068

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: update azure guide with correct assets DOC-1068

---------





* docs: add aws tutorial DOC-1306

* docs: update tutorial wording DOC-1306

* docs: fix vale DOC-1306

* docs: fix vale DOC-1306

* docs: fix vale DOC-1306

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: add gif and details DOC-1306

* docs: adjust files on rebase

* Apply suggestions from code review



* docs: address further review comments DOC-1306

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

---------






* docs: add Azure/GCP/VMware Scale and Secure tutorial DOC-1307 DOC-1308 DOC-1309 (#3517)

* docs: add Azure Scale and Secure tutorial DOC-1308

* docs: add GCP Scale and Secure tutorial DOC-1308

* docs: add VMware Scale and Secure tutorial DOC-1309

* docs: fix vale DOC-1307

* docs: fix formatting

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: rephrase upgrades description DOC-1308

---------



* docs: additional capabilities pages DOC-1144 (#3550)

* docs: additional capabilities pages DOC-1144

* docs: fix formatting

* docs: change landing

* Apply suggestions from code review



* docs: fix up review comments

* docs: fix links additional capabilities DOC-1144

* docs: move trusted boot mention

* docs: revise wording doc-1144

---------



* docs: fix broken link to pack

* docs: fix broken link to dashboard

* docs: bump tutorials container image version

* docs: add spacetastic story to AWS Getting Started DOC-1332 (#4019)

* docs: add spacetastic story DOC-1332

* docs: adjust conversation punctuation DOC-1332

* docs: remove gendered language DOC-1332

* docs: remove repeated spacetastic

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: fix formatting

* docs: adjust systems diagram

* Optimised images with calibre/image-actions

* docs: add story to setup page DOC-1332

* Optimised images with calibre/image-actions

* docs: add story to create cluster profile page DOC-1332

* docs: add spacetastic story to rest of getting started DOC-1332

* Optimised images with calibre/image-actions

* docs: fix vale

* docs: fix vale

* docs: fix vale

* Apply suggestions from code review




* Update docs/docs-content/getting-started/aws/scale-secure-cluster.md



* docs: fix formatting

* docs: add call reference to additional capabilities on scale secure DOC-1332

* docs: fix vale

* Optimised images with calibre/image-actions

---------





* docs: add Spacetastic to all clouds DOC-1332 (#4048)

* docs: add Spacetastic to all clouds DOC-1332

* docs: fix formatting

* docs: update Getting Started AWS and GCP screenshots DOC-1394 (#4054)

* docs: update aws screenshots DOC-1394

* docs: fix formatting

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: update GCP screenshots & pack DOC-1394

* docs: fix formatting

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

---------



* docs: update GS Azure tutorials (#4055)

* docs: update cluster profile, cluster, update tutorials

* docs: update terraform tutorial

* docs: bump terraform container version

* docs: update scale secure tutorial DOC-1395

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: update table DOC-395

---------




* docs: update profile tutorial, container version (#4058)

* docs: update profile tutorial, container version

* docs: update hellouni

* docs: update profile tutorial, container version

* docs: update hellouni

* Optimised images with calibre/image-actions

* docs: bump hellouni version

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

---------



* docs: fix up landing page buttons DOC-855

---------

Co-authored-by: Karl Cardenas <[email protected]>
Co-authored-by: yuliiiah <[email protected]>
Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
Co-authored-by: Karl Cardenas <[email protected]>
  • Loading branch information
5 people authored Sep 25, 2024
1 parent 8e34d46 commit 2654f55
Show file tree
Hide file tree
Showing 4 changed files with 146 additions and 41 deletions.
72 changes: 65 additions & 7 deletions docs/docs-content/architecture/grps-proxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,77 @@ sidebar_custom_props:

Palette uses [gRPC](https://grpc.io) to communicate between the management platform and the workload cluster. gRPC is a
high-performance, open-source universal Remote Procedure Call (RPC) framework. It is used to build distributed
applications and services. gRPC is based on HTTP/2 and uses protocol buffers ([protobuf](https://protobuf.dev/)) as the
underlying data serialization framework.
applications and services. gRPC is based on HTTP/2 protocol and uses protocol buffers
([protobuf](https://protobuf.dev/)) as the underlying data serialization framework.

:::info
:::tip

Refer to the [Network Ports](networking-ports.md) documentation for a detailed network architecture diagram with gRPC
and to learn more about the ports used for communication.

:::

## gRPC and WebSocket

The Palette agent will automatically attempt to connect to the management plane using gRPC through HTTPS using the
HTTP/2 protocol. In some environments, the network configuration may not allow gRPC traffic to pass through. A common
scenario is when the network is behind a proxy server that does not support HTTP/2. In this scenario, the Palette agent
will first attempt to connect to the management plane using HTTP/2. After several failed attempts, the agent will fall
back to using WebSocket over HTTPS with HTTP/1.1.

The fallback to WebSocket with transcoding occurs automatically and does not require any additional configuration.

### gRPC Transcode

Behind the scenes, when the Palette agent fails to connect with the management plane after a maximum of ten connection
attempts, the agent initiates the failover to a WebSocket connection and transcodes the gRPC messages with the HTTP/1.1
protocol.

The Palette agent directs gRPC messages to a freshly started in-memory proxy service, which takes the original gRPC
request, transcodes it to HTTP/1.1 protocol, and sends it over the WebSocket connection to the management plane. The
management plane's WebSocket handler will then accept the WebSocket message and transcode it back to the HTTP/2 protocol
before forwarding it to the gRPC handler. The server will then respond with a gRPC message, which will be transcoded to
HTTP/1.1 and sent back to the agent over the WebSocket. The agent's in-memory proxy will read the message and transcode
it back to HTTP/2 and pass it to the agent.

![An architecture diagram of the gRPC over WebSocket flow from a network perspective. Agent to agent proxy, to WebSocket handler, who then forwards the message to the server gRPC handler.](/architecture_grps-proxy_grpc-websocket.webp)

Below is a high-level overview of the order of operations when the Palette agent falls back to using WebSocket:

1. The agent initiates a new gRPC request to the management plane servers that is picked up by the in-memory proxy
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.
5. The server's WebSocker handler reads the request off the WebSocket connection and forwards it to the server's gRPC
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
passes it to the agent.

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
WebSocket and HTTP/1.1 removes issues due to application firewalls or network proxies not supporting the HTTP/2
protocol. Once the gRPC message is internal to the agent or the server, the HTTP/2 protocol is used for communication.

## gRPC and Proxies

:::info

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
[gRPC Anywhere](https://www.redhat.com/en/blog/grpc-anywhere).

:::

When gRPC is used with network proxies, the proxy servers may or may not support gRPC or require additional
configuration to allow gRPC traffic to pass through. The following table summarizes the different scenarios and whether
or not the proxy server supports gRPC.
or not the proxy server supports gRPC. Keep in mind that should the gRPC connection fail, the agent will automatically
fall back to using WebSocket.

| **Scenario** | **Description** | **Proxy Supported** |
| :---------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------- | :------------------ |
Expand All @@ -33,7 +91,7 @@ or not the proxy server supports gRPC.

The following sections provide more information about gRPC and proxies.

## Proxy Without SSL Bump
### Proxy Without SSL Bump

Because gRPC is based on HTTP/2, any proxy server that supports the
[HTTP CONNECT](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/CONNECT) method can be used to forward gRPC
Expand All @@ -48,7 +106,7 @@ scenario, the proxy server must support gRPC and may require additional configur

:::

## Proxy With SSL Bump
### Proxy With SSL Bump

Several vendors provide proxy servers that support gRPC. Some of the vendors may require additional configurations or
the use of a specific version of the proxy server. We encourage you to review your proxy server documentation for more
Expand All @@ -65,7 +123,7 @@ to some vendors' documentation that addresses HTTP/2 and gRPC support.

- [Check Point](https://support.checkpoint.com/results/sk/sk116022)

## Squid Proxy With SSL Bump
### Squid Proxy With SSL Bump

A common open-source proxy server is [Squid](https://wiki.squid-cache.org). Squid is a caching proxy for the Web
supporting HTTP, HTTPS, FTP, and more. Squid supports gRPC but requires additional configuration. gRPC with SSL bump
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -120,53 +120,56 @@ cluster:
   vip_interface: "ens32"
```
In the CNI layer, depending on which CNI pack you choose for your cluster profile, you need to make changes in the
following locations.
In the CNI layer, depending on which CNI pack you choose for your cluster profile, you need to make changes in the
following locations.
<Tabs>
<TabItem value="calico" label="Calico">
In the Calico pack YAML file default template, uncomment `manifests.calico.env.calicoNode.IP_AUTODETECTION_METHOD` and set its value to `interface=INTERFACE_NAME`. Replace `INTERFACE_NAME` with the name of the NIC in your control plane node pool. For example, set `IP_AUTODETECTION_METHOD` to `"interface=eno32"` if the NIC name of the nodes in your control plane pool is `eno32`.

```yaml {11}
manifests:
calico:
...
env:
# Additional env variables for calico-node
calicoNode:
#IPV6: "autodetect"
#FELIX_IPV6SUPPORT: "true"
#CALICO_IPV6POOL_NAT_OUTGOING: "true"
#CALICO_IPV4POOL_CIDR: "192.168.0.0/16"
IP_AUTODETECTION_METHOD: "interface=eno32"
```
In the Calico pack YAML file default template, uncomment `manifests.calico.env.calicoNode.IP_AUTODETECTION_METHOD` and
set its value to `kubernetes-internal-ip`. This tells Calico to use the address assigned to the Kubernetes node.

```yaml {11}
manifests:
calico:
...
env:
# Additional env variables for calico-node
calicoNode:
#IPV6: "autodetect"
#FELIX_IPV6SUPPORT: "true"
#CALICO_IPV6POOL_NAT_OUTGOING: "true"
#CALICO_IPV4POOL_CIDR: "192.168.0.0/16"
IP_AUTODETECTION_METHOD: "kubernetes-internal-ip"
```

</TabItem>
<TabItem value="flannel" label="Flannel">

In the Flannel pack YAML file, add a line `- "--iface=INTERFACE_NAME"` in the default template under
`charts.flannel.args`. Replace `INTERFACE_NAME` with the name of the NIC. For example, add the line `- "--iface=eno32`
if the NIC name of your control plane nodes is `eno32`.

```yaml {8}
charts:
flannel:
...
# flannel command arguments
args:
- "--ip-masq"
- "--kube-subnet-mgr"
- "--iface=eno32"
```
In the Flannel pack YAML file, add a line `- "--iface=INTERFACE_NAME"` in the default template under
`charts.flannel.args`. Replace `INTERFACE_NAME` with the name of the NIC. For example, add the line `- "--iface=eno32`
if the NIC name of your control plane nodes is `eno32`.

```yaml {8}
charts:
flannel:
...
# flannel command arguments
args:
- "--ip-masq"
- "--kube-subnet-mgr"
- "--iface=eno32"
```

</TabItem>

<TabItem value="cilium" label="Cilium">
You do not need to make any adjustments to the Cilium pack.
You do not need to make any adjustments to the Cilium pack.
</TabItem>

<TabItem value="other" label="Other">
If you are using other CNIs, refer to the documentation of your selected CNI and configure it to make sure that it picks the right NIC on your Edge hosts.
If you are using other CNIs, refer to the documentation of your selected CNI and configure it to make sure that it picks the right NIC on your Edge hosts.
</TabItem>
</Tabs>

Expand Down
44 changes: 44 additions & 0 deletions docs/docs-content/release-notes/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,50 @@ tags: ["release-notes"]

<ReleaseNotesVersions />

## Sept 25, 2024 - Release 4.4.20

### Improvements

- Palette's message communication channel between clusters and the management plane has been updated to support gRPC
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
[gRPC and WebSocket](../architecture/grps-proxy.md#grpc-and-websocket) section of the Architecture documentation to
learn more.

- Local UI now supports selecting network interfaces by name.

- Local UI has improved validation when assigning static IP addresses to network interfaces.

- The heartbeat mechanism for Palette deployed clusters has been improved for better performance and reliability.

### Bug Fixes

- Fixed an issue where imported cluster profiles defaulted to incorrect registry type.

- Fixed an issue where Palette TUI was not displaying network interfaces that had no IP addresses assigned.

- Resolved an issue where the Local UI took a long time to load after application deployment.

- Fixed an issue where the Edge CLI could not download Helm charts from private registries.

- Fix an issue with the Edge CLI that was silently failing when unable to create the build artifact. The Edge CLI now
provides a clear error message when the build artifact creation fails.

- Fixed a Palette UI message incorrectly stating to check the new issue date for SSL certificate renewal. The message
now correctly states to check the new expiration date.

- Resolved an issue where the Palette UI was erroring out when reviewing pack layers during a PCG upgrade.

- Resolved an issue where the Local UI username and password field validation was not working as expected.

- Fixed an issue with updating the node port for the Edge Harbor pack. The node port is now correctly updated when
changing the value in the Harbor pack.

- Resolved an issue where kubeadm based Kubernetes distributions were unable to initialize on clusters with multiple
Network Interface Cards (NIC).

## Sept 18, 2024 - Release 4.4.19

#### Bug Fixes
Expand Down
Binary file not shown.

0 comments on commit 2654f55

Please sign in to comment.