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.

Sign up for GitHub

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

gRPC diagrams #1712

Merged
merged 4 commits into from
Oct 26, 2023
Merged

gRPC diagrams #1712

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b01c9d2
docs: fixed missing grpc images
karl-cardenas-coding Oct 26, 2023
ae37172
docs: updated tabs order
karl-cardenas-coding Oct 26, 2023
b97e812
Apply suggestions from code review
karl-cardenas-coding Oct 26, 2023
da0d7f4
Merge branch 'master' into image-correction
karl-cardenas-coding Oct 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
156 changes: 92 additions & 64 deletions docs/docs-content/architecture/networking-ports.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: "Network Communication and Ports"
description: "Port-Direction-Purpose Management Platform and Workload Clusters"
icon: ""
hide_table_of_contents: false
# toc_min_heading_level: 2
toc_max_heading_level: 2
sidebar_position: 20
---

Expand All @@ -12,38 +14,67 @@ Depending on what version of Palette you are using, the internal architecture an



<Tabs queryString="networking-ports">
<TabItem label="gRPC" value="gRPC" que>

## SaaS Network Communications and Ports

<Tabs groupId="architecture">
<TabItem label="gRPC" value="gRPC">



The following ports must be reachable from a network perspective for Palette SaaS to function correctly.

![SaaS Network Diagram with ports](/architecture_networking-ports_saas-network-diagram.png "title=SaaS Network Diagram with ports")
![SaaS Network Diagram with ports](/architecture_networking-ports_saas-network-diagram-grpc.png "title=SaaS Network Diagram with ports")


</TabItem>

#### SaaS Managed
<TabItem label="NATS" value="nats">

The following ports must be reachable from a network perspective for Palette SaaS to function correctly.

![SaaS network diagram displaying the network paths for edge](/architecture_networking-ports_saas-network-diagram-edge.png)
![SaaS Network Diagram with ports](/architecture_networking-ports_saas-network-diagram-nats.png "title=SaaS Network Diagram with ports")


</TabItem>

</Tabs>

:::caution

NATS is deprecated and will be removed in a future release. Starting with Palette 4.0.0, gRPC is used for all communication between the management platform and the workload cluster.
### SaaS Managed With Edge

:::
<Tabs groupId="architecture">
<TabItem label="gRPC" value="gRPC">



![SaaS network diagram displaying the network paths for edge](/architecture_networking-ports_saas-network-diagram-edge-grpc.png)





</TabItem>

<TabItem label="NATS" value="nats">



![SaaS network diagram displaying the network paths for edge](/architecture_networking-ports_saas-network-diagram-edge-nats.png)

</TabItem>
</Tabs>



## Network Ports

The following ports must be reachable from a network perspective for Palette to operate properly.

## Management Platform
<Tabs groupId="architecture">
<TabItem label="gRPC" value="gRPC">


### Management Platform

|Port |Direction|Purpose |
|:---------------|:---------|:-----------------------|
Expand All @@ -52,7 +83,7 @@ The following ports must be reachable from a network perspective for Palette to
|NATS (tcp/4222) |INBOUND |Agent running inside connecting to management platform [Deprecated]|


## Workload Cluster
### Workload Cluster


|Port |Direction | Purpose|
Expand All @@ -61,47 +92,34 @@ The following ports must be reachable from a network perspective for Palette to
|HTTPS (tcp/443) |OUTBOUND | gRPC, Registry (packs, integrations), Pack containers, Application Updates|
|NATS (tcp/4222) |OUTBOUND |Registry (packs, integrations), Pack containers, Application Updates [Deprecated]|

:::info

You can expose inbound port 22 for SSH if you would like to access your cluster nodes for troubleshooting remotely. This is entirely optional and not required for Palette to operate appropriately.

:::


## Self-Hosted Network Communications and Ports

The following ports must be reachable from a network perspective for Palette self-hosted to function correctly.


![On-prem network diagram](/architecture_networking-ports_network-diagram.png "#title="network diagram")



</TabItem>

:::caution

NATS is deprecated and will be removed in a future release. Starting with Palette 4.0.0, gRPC is used for all communication between the management platform and the workload cluster.
<TabItem label="NATS" value="nats">

:::

## Management Platform
### Management Platform

|Port |Direction|Purpose |
karl-cardenas-coding marked this conversation as resolved.
Show resolved Hide resolved
|:---------------|:---------|:-----------------------|
|HTTPS (tcp/443) |INBOUND |Browser/API access to management platform, gRPC|
|NATS (tcp/4222) |INBOUND |Message Bus for workload clusters [Deprecated]|
|HTTPS (tcp/443) |OUTBOUND |vSphere vCenter API, Registry (packs, integrations), Pack containers, app updates, gRPC|
|HTTPS (tcp/6443)|OUTBOUND |Workload K8s cluster API Server|
|HTTPS (tcp/443) |INBOUND |Browser/API access to management platform|
|NATS (tcp/4222) |INBOUND |Agent running inside connecting to management platform|


## Workload Cluster
### Workload Cluster


|Port |Direction | Purpose|
|Port |Direction | Purpose|
karl-cardenas-coding marked this conversation as resolved.
Show resolved Hide resolved
|:---------------|:---------|:--------------|
|HTTPS (tcp/443) |OUTBOUND | API access to management platform|
|NATS (tcp/4222) |OUTBOUND |Agent communication via message bus. [Deprecated] |
|HTTPS (tcp/443) |OUTBOUND |vSphere vCenter API, gRPC, Registry (packs, integrations), Pack containers, Application updates|
|NATS (tcp/4222) |OUTBOUND |Registry (packs, integrations), Pack containers, Application Updates|
|NATS (tcp/4222) |OUTBOUND |Registry (packs, integrations), Pack containers, Application Updates|


</TabItem>
</Tabs>

:::info

Expand All @@ -110,60 +128,60 @@ You can expose inbound port 22 for SSH if you would like to access your cluster
:::


## Self-Hosted Network Communications and Ports

</TabItem>

<TabItem label="NATS" value="nats">
<Tabs groupId="architecture">
<TabItem label="gRPC" value="gRPC">

## SaaS Network Communications and Ports

The following ports must be reachable from a network perspective for Palette SaaS to function correctly.
![On-prem network diagram](/architecture_networking-ports_on_prem_network-diagram-grpc.png "#title="network diagram")

</TabItem>

![SaaS Network Diagram with ports](/architecture_networking-ports_network-diagram_nats.png "title=SaaS Network Diagram with ports")
<TabItem label="NATS" value="nats">

![On-prem network diagram](/architecture_networking-ports_on_prem_network-diagram-nats.png "#title="network diagram")


#### SaaS Managed
</TabItem>
</Tabs>

The following ports must be reachable from a network perspective for Palette self-hosted to function correctly.

![SaaS network diagram displaying the network paths for edge](/architecture_networking-ports_saas-network-diagram-edge_nats.png)

<Tabs groupId="architecture">
<TabItem label="gRPC" value="gRPC">

The following ports must be reachable from a network perspective for Palette to operate properly.

## Management Platform
### Management Platform

|Port |Direction|Purpose |
karl-cardenas-coding marked this conversation as resolved.
Show resolved Hide resolved
|:---------------|:---------|:-----------------------|
|HTTPS (tcp/443) |INBOUND |Browser/API access to management platform|
|NATS (tcp/4222) |INBOUND |Agent running inside connecting to management platform|
|HTTPS (tcp/443) |INBOUND |Browser/API access to management platform, gRPC|
|NATS (tcp/4222) |INBOUND |Message Bus for workload clusters [Deprecated]|
|HTTPS (tcp/443) |OUTBOUND |vSphere vCenter API, Registry (packs, integrations), Pack containers, app updates, gRPC|
|HTTPS (tcp/6443)|OUTBOUND |Workload K8s cluster API Server|


## Workload Cluster
### Workload Cluster


|Port |Direction | Purpose|
|Port |Direction | Purpose|
karl-cardenas-coding marked this conversation as resolved.
Show resolved Hide resolved
|:---------------|:---------|:--------------|
|HTTPS (tcp/443) |OUTBOUND | API access to management platform|
|NATS (tcp/4222) |OUTBOUND |Registry (packs, integrations), Pack containers, Application Updates|
|NATS (tcp/4222) |OUTBOUND |Registry (packs, integrations), Pack containers, Application Updates|

:::info
|NATS (tcp/4222) |OUTBOUND |Agent communication via message bus. [Deprecated] |
karl-cardenas-coding marked this conversation as resolved.
Show resolved Hide resolved
|HTTPS (tcp/443) |OUTBOUND |vSphere vCenter API, gRPC, Registry (packs, integrations), Pack containers, Application updates|

You can expose inbound port 22 for SSH if you would like to access your cluster nodes for troubleshooting remotely. This is entirely optional and not required for Palette to operate appropriately.

:::

</TabItem>

## Self-Hosted Network Communications and Ports

The following ports must be reachable from a network perspective for Palette self-hosted to function correctly.
<TabItem label="NATS" value="nats">


![On-prem network diagram](/architecture_networking-ports_on_prem_network-diagram.png "#title="network diagram")

## Management Platform
### Management Platform

|Port |Direction|Purpose |
karl-cardenas-coding marked this conversation as resolved.
Show resolved Hide resolved
|:---------------|:---------|:-----------------------|
Expand All @@ -173,7 +191,7 @@ The following ports must be reachable from a network perspective for Palette sel
|HTTPS (tcp/6443)|OUTBOUND |Workload K8s cluster API Server|


## Workload Cluster
### Workload Cluster


|Port |Direction | Purpose|
karl-cardenas-coding marked this conversation as resolved.
Show resolved Hide resolved
Expand All @@ -182,12 +200,22 @@ The following ports must be reachable from a network perspective for Palette sel
|NATS (tcp/4222) |OUTBOUND |Agent communication via message bus |
|HTTPS (tcp/443) |OUTBOUND |vSphere vCenter API, Registry (packs, integrations), Pack containers, Application updates.
karl-cardenas-coding marked this conversation as resolved.
Show resolved Hide resolved
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
|HTTPS (tcp/443) |OUTBOUND |vSphere vCenter API, Registry (packs, integrations), Pack containers, Application updates.
|HTTPS (tcp/443) |OUTBOUND |vSphere vCenter API, Registry (packs, integrations), Pack containers, Application updates



</TabItem>
</Tabs>


:::info

You can expose inbound port 22 for SSH if you would like to access your cluster nodes for troubleshooting remotely. This is entirely optional and not required for Palette to operate appropriately.

:::

</TabItem>
</Tabs>








2 changes: 1 addition & 1 deletion docs/docs-content/release-notes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ tags: ["release-notes"]

## October 22, 2023 - Release 4.1.0

Palette 4.1.0 introduces several new features and enhancements to the platform. New features, such as the automatic SSL control plane certificate renewal and node repavement warnings, are designed to continue to help you manage Kubernetes clusters with confidence. The new built-in notification system for our SaaS platform is another addition designed to help you stay up-to-date with announcements and changes by bringing the news directly to you.
Palette 4.1.0 introduces several new features and enhancements to the platform. New features, such as static IP address for Edge hosts, and node repavement warnings, are designed to continue to help you manage Kubernetes clusters with confidence. The new built-in notification system for our SaaS platform is another addition designed to help you stay up-to-date with announcements and changes by bringing the news directly to you.
karl-cardenas-coding marked this conversation as resolved.
Show resolved Hide resolved

Check out the following sections to learn about all the new features and improvements introduced in this release.

Expand Down
Binary file added ...sets/docs/images/architecture_networking-ports_on_prem_network-diagram-grpc.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
0 ...working-ports_on_prem_network-diagram.png → ...ng-ports_on_prem_network-diagram-nats.png
View file
Open in desktop
File renamed without changes
Binary file added ...ts/docs/images/architecture_networking-ports_saas-network-diagram-edge-grpc.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
0 ...rking-ports_saas-network-diagram-edge.png → ...-ports_saas-network-diagram-edge-nats.png
View file
Open in desktop
File renamed without changes
Binary file removed ...ts/docs/images/architecture_networking-ports_saas-network-diagram-edge_nats.png
View file
Open in desktop
Binary file not shown.
Binary file added .../assets/docs/images/architecture_networking-ports_saas-network-diagram-grpc.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
0 ...networking-ports_saas-network-diagram.png → ...rking-ports_saas-network-diagram-nats.png
View file
Open in desktop
File renamed without changes
Loading