Skip to content

Commit

Permalink
docs: updated tabs order
Browse files Browse the repository at this point in the history
  • Loading branch information
karl-cardenas-coding committed Oct 26, 2023
1 parent b01c9d2 commit ae37172
Showing 1 changed file with 91 additions and 62 deletions.
153 changes: 91 additions & 62 deletions docs/docs-content/architecture/networking-ports.md
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,11 +14,10 @@ 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">



Expand All @@ -25,25 +26,55 @@ The following ports must be reachable from a network perspective for Palette Saa
![SaaS Network Diagram with ports](/architecture_networking-ports_saas-network-diagram-grpc.png "title=SaaS Network Diagram with ports")


</TabItem>

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

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-nats.png "title=SaaS Network Diagram with ports")


</TabItem>

</Tabs>


### SaaS Managed With Edge

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

#### SaaS Managed


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




:::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>

:::
<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_on_prem_network-diagram-grpc.png "#title="network diagram")




:::caution
</TabItem>

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 |
|:---------------|:---------|:-----------------------|
|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|
|:---------------|:---------|:--------------|
|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,59 +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")

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

<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>

![SaaS network diagram displaying the network paths for edge](/architecture_networking-ports_saas-network-diagram-edge-nats.png)
The following ports must be reachable from a network perspective for Palette self-hosted to function correctly.


The following ports must be reachable from a network perspective for Palette to operate properly.
<Tabs groupId="architecture">
<TabItem label="gRPC" value="gRPC">


## Management Platform
### Management Platform

|Port |Direction|Purpose |
|:---------------|:---------|:-----------------------|
|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|
|:---------------|:---------|:--------------|
|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

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.
|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|

:::


## Self-Hosted Network Communications and Ports
</TabItem>

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-nats.png "#title="network diagram")

## Management Platform
### Management Platform

|Port |Direction|Purpose |
|:---------------|:---------|:-----------------------|
Expand All @@ -172,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|
Expand All @@ -181,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.


</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>








0 comments on commit ae37172

Please sign in to comment.