diff --git a/docs/docs-content/architecture/networking-ports.md b/docs/docs-content/architecture/networking-ports.md index 06e9080f46..1564ad0a5c 100644 --- a/docs/docs-content/architecture/networking-ports.md +++ b/docs/docs-content/architecture/networking-ports.md @@ -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 --- @@ -12,38 +14,67 @@ Depending on what version of Palette you are using, the internal architecture an - - - ## SaaS Network Communications and Ports + + 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") + -#### SaaS Managed + +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") + + -:::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 + + + + + + +![SaaS network diagram displaying the network paths for edge](/architecture_networking-ports_saas-network-diagram-edge-grpc.png) + + + + + + + + + + + +![SaaS network diagram displaying the network paths for edge](/architecture_networking-ports_saas-network-diagram-edge-nats.png) + + + + -::: +## Network Ports The following ports must be reachable from a network perspective for Palette to operate properly. -## Management Platform + + + + +### Management Platform |Port |Direction|Purpose | |:---------------|:---------|:-----------------------| @@ -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| @@ -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") + -:::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. -::: +### Management Platform -## Management Platform - -|Port |Direction|Purpose | +|**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| + + + + :::info @@ -110,62 +128,62 @@ You can expose inbound port 22 for SSH if you would like to access your cluster ::: +## Self-Hosted Network Communications and Ports - - + + -## 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_network-diagram_nats.png "title=SaaS Network Diagram with ports") + +![On-prem network diagram](/architecture_networking-ports_on_prem_network-diagram-nats.png "#title="network diagram") -#### SaaS Managed + + +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) + + -The following ports must be reachable from a network perspective for Palette to operate properly. -## Management Platform +### Management Platform -|Port |Direction|Purpose | +|**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 + -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.png "#title="network diagram") -## Management Platform +### Management Platform -|Port |Direction|Purpose | +|**Port** |**Direction**|**Purpose** | |:---------------|:---------|:-----------------------| |HTTPS (tcp/443) |INBOUND |Browser/API access to management platform| |NATS (tcp/4222) |INBOUND |Message Bus for workload clusters| @@ -173,14 +191,19 @@ 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| +|**Port** |**Direction** | **Purpose**| |:---------------|:---------|:--------------| |HTTPS (tcp/443) |OUTBOUND | API access to management platform| |NATS (tcp/4222) |OUTBOUND |Agent communication via message bus | -|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 + + + + + :::info @@ -188,6 +211,11 @@ You can expose inbound port 22 for SSH if you would like to access your cluster ::: - - + + + + + + + diff --git a/docs/docs-content/release-notes.md b/docs/docs-content/release-notes.md index 300b74aba8..44d3d70a8a 100644 --- a/docs/docs-content/release-notes.md +++ b/docs/docs-content/release-notes.md @@ -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. Check out the following sections to learn about all the new features and improvements introduced in this release. diff --git a/static/assets/docs/images/architecture_networking-ports_on_prem_network-diagram-grpc.png b/static/assets/docs/images/architecture_networking-ports_on_prem_network-diagram-grpc.png new file mode 100644 index 0000000000..3e76a1dc78 Binary files /dev/null and b/static/assets/docs/images/architecture_networking-ports_on_prem_network-diagram-grpc.png differ diff --git a/static/assets/docs/images/architecture_networking-ports_on_prem_network-diagram.png b/static/assets/docs/images/architecture_networking-ports_on_prem_network-diagram-nats.png similarity index 100% rename from static/assets/docs/images/architecture_networking-ports_on_prem_network-diagram.png rename to static/assets/docs/images/architecture_networking-ports_on_prem_network-diagram-nats.png diff --git a/static/assets/docs/images/architecture_networking-ports_saas-network-diagram-edge-grpc.png b/static/assets/docs/images/architecture_networking-ports_saas-network-diagram-edge-grpc.png new file mode 100644 index 0000000000..0f17d6940b Binary files /dev/null and b/static/assets/docs/images/architecture_networking-ports_saas-network-diagram-edge-grpc.png differ diff --git a/static/assets/docs/images/architecture_networking-ports_saas-network-diagram-edge.png b/static/assets/docs/images/architecture_networking-ports_saas-network-diagram-edge-nats.png similarity index 100% rename from static/assets/docs/images/architecture_networking-ports_saas-network-diagram-edge.png rename to static/assets/docs/images/architecture_networking-ports_saas-network-diagram-edge-nats.png diff --git a/static/assets/docs/images/architecture_networking-ports_saas-network-diagram-edge_nats.png b/static/assets/docs/images/architecture_networking-ports_saas-network-diagram-edge_nats.png deleted file mode 100644 index bded5e747e..0000000000 Binary files a/static/assets/docs/images/architecture_networking-ports_saas-network-diagram-edge_nats.png and /dev/null differ diff --git a/static/assets/docs/images/architecture_networking-ports_saas-network-diagram-grpc.png b/static/assets/docs/images/architecture_networking-ports_saas-network-diagram-grpc.png new file mode 100644 index 0000000000..05143c73bf Binary files /dev/null and b/static/assets/docs/images/architecture_networking-ports_saas-network-diagram-grpc.png differ diff --git a/static/assets/docs/images/architecture_networking-ports_saas-network-diagram.png b/static/assets/docs/images/architecture_networking-ports_saas-network-diagram-nats.png similarity index 100% rename from static/assets/docs/images/architecture_networking-ports_saas-network-diagram.png rename to static/assets/docs/images/architecture_networking-ports_saas-network-diagram-nats.png