diff --git a/_partials/self-hosted/_required-domains.mdx b/_partials/self-hosted/_required-domains.mdx new file mode 100644 index 0000000000..9a24ceca4e --- /dev/null +++ b/_partials/self-hosted/_required-domains.mdx @@ -0,0 +1,45 @@ +--- +partial_category: self-hosted +partial_name: required-domains +--- + + +By default, {props.edition} connects to the internet to download images and packages. If your environment uses a proxy server, ensure the +following domains and ports are accessible. The proxy server should meet the following requirements: + +- A proxy used for outgoing connections should support both HTTP and HTTPS traffic. + +- If you are deploying {props.edition} to a vSphere environment. Ensure the instance Palette is installed through network has + access to vCenter. + +- Allow connectivity to domains and ports in the table. + + + +- Review the page to learn more about Palette's support for gRPC in a proxy environment. + +:::info + +The statements above are not applicable to air-gapped installations. For air-gapped installations, you must download the required images and packages and make them available to the system. + +::: + + + | **Top-Level Domain** | **Port** | **Description** | + | ------------------------- | -------- | ----------------------------------------------------- | + | ecr.*.amazonaws.com | 443 | AWS ECR Registry | + | spectrocloud.com | 443 | Spectro Cloud content repository and pack registry | + | s3.amazonaws.com | 443 | Spectro Cloud VMware OVA files | + | gcr.io | 443 | Spectro Cloud and common third party container images | + | ghcr.io | 443 | Kubernetes VIP images | + | docker.io | 443 | Common third party content | + | googleapis.com | 443 | For pulling Spectro Cloud images | + | docker.com | 443 | Common third party container images | + | raw.githubusercontent.com | 443 | Common third party content | + | projectcalico.org | 443 | Calico container images | + | quay.io | 443 | Common third party container images | + | grafana.com | 443 | Grafana container images and manifests | + | github.com | 443 | Common third party content | + | k8s.gcr.io | 443 | Kubernetes images [deprecated] | + | registry.k8s.io | 443 | Kubernetes images | + | docker.pkg.dev | 443 | Common third party content | diff --git a/docs/docs-content/enterprise-version/install-palette/install-on-kubernetes/install.md b/docs/docs-content/enterprise-version/install-palette/install-on-kubernetes/install.md index c93b896d98..e93901b702 100644 --- a/docs/docs-content/enterprise-version/install-palette/install-on-kubernetes/install.md +++ b/docs/docs-content/enterprise-version/install-palette/install-on-kubernetes/install.md @@ -70,6 +70,9 @@ You can use the Palette Helm Chart to install Palette in a multi-node Kubernetes certificate file in the base64 format. You will need this to enable Palette to communicate with the network proxy server. +- Ensure Palette has access to the required domains and ports. Refer to the + [Required Domains](../install-palette.md#proxy-requirements) section for more information. + - Access to the Palette Helm Charts. Refer to the [Access Palette](../../enterprise-version.md#access-palette) for instructions on how to request access to the Helm Chart diff --git a/docs/docs-content/enterprise-version/install-palette/install-on-vmware/install.md b/docs/docs-content/enterprise-version/install-palette/install-on-vmware/install.md index bd53535403..c3de9d3e64 100644 --- a/docs/docs-content/enterprise-version/install-palette/install-on-vmware/install.md +++ b/docs/docs-content/enterprise-version/install-palette/install-on-vmware/install.md @@ -67,6 +67,9 @@ for more information. - Assigned IP addresses for application workload services, such as Load Balancer services. +- Ensure Palette has access to the required domains and ports. Refer to the + [Required Domains](../install-palette.md#proxy-requirements) section for more information. + - Shared Storage between VMware vSphere hosts. :::info diff --git a/docs/docs-content/enterprise-version/install-palette/install-palette.md b/docs/docs-content/enterprise-version/install-palette/install-palette.md index 7530f374d2..9eb7de1032 100644 --- a/docs/docs-content/enterprise-version/install-palette/install-palette.md +++ b/docs/docs-content/enterprise-version/install-palette/install-palette.md @@ -64,33 +64,7 @@ active nodes and pods at any given time. ## Proxy Requirements -Palette connects to the internet to download images and packages. If your environment uses a proxy server, ensure the -following domains and ports are accessible. The proxy server should meet the following requirements: - -- A proxy used for outgoing connections should support both HTTP and HTTPS traffic. - -- Allow connectivity to domains and ports in the table. - -- Review the [gRPC and Proxies](../../architecture/grps-proxy.md) page to learn more about Palette's support for gRPC in - a proxy environment. - - | **Top-Level Domain** | **Port** | **Description** | - | ------------------------- | -------- | ----------------------------------------------------- | - | spectrocloud.com | 443 | Spectro Cloud content repository and pack registry | - | s3.amazonaws.com | 443 | Spectro Cloud VMware OVA files | - | gcr.io | 443 | Spectro Cloud and common third party container images | - | ghcr.io | 443 | Kubernetes VIP images | - | docker.io | 443 | Common third party content | - | googleapis.com | 443 | For pulling Spectro Cloud images | - | docker.com | 443 | Common third party container images | - | raw.githubusercontent.com | 443 | Common third party content | - | projectcalico.org | 443 | Calico container images | - | quay.io | 443 | Common third party container images | - | grafana.com | 443 | Grafana container images and manifests | - | github.com | 443 | Common third party content | - | k8s.gcr.io | 443 | Kubernetes images [deprecated] | - | registry.k8s.io | 443 | Kubernetes images | - | docker.pkg.dev | 443 | Common third party content | + ## Resources diff --git a/docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/install.md b/docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/install.md index 0e7a1da4e1..a799f00881 100644 --- a/docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/install.md +++ b/docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/install.md @@ -74,6 +74,9 @@ has the necessary network connectivity for VerteX to operate successfully. - A custom domain and the ability to update Domain Name System (DNS) records. You will need this to enable HTTPS encryption for VerteX. +- Ensure VerteX has access to the required domains and ports. Refer to the + [Required Domains](../install-palette-vertex.md#proxy-requirements) section for more information. + - If you are installing VerteX behind a network proxy server, ensure you have the Certificate Authority (CA) certificate file in the base64 format. You will need this to enable VerteX to communicate with the network proxy server. diff --git a/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/install.md b/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/install.md index d329266844..29968d3edc 100644 --- a/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/install.md +++ b/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/install.md @@ -91,6 +91,9 @@ for more information. - Assigned IP addresses for application workload services, such as Load Balancer services. +- Ensure Palette has access to the required domains and ports. Refer to the + [Required Domains](../install-palette-vertex.md#proxy-requirements) section for more information. + - Shared Storage between VMware vSphere hosts. :::info diff --git a/docs/docs-content/vertex/install-palette-vertex/install-palette-vertex.md b/docs/docs-content/vertex/install-palette-vertex/install-palette-vertex.md index fba6b34f06..e37319fc6e 100644 --- a/docs/docs-content/vertex/install-palette-vertex/install-palette-vertex.md +++ b/docs/docs-content/vertex/install-palette-vertex/install-palette-vertex.md @@ -66,33 +66,7 @@ number of active nodes and pods at any given time. ## Proxy Requirements -VerteX connects to the internet to download images and packages. If your environment uses a proxy server, ensure the -following domains and ports are accessible. The proxy server should meet the following requirements: - -- A proxy used for outgoing connections should support both HTTP and HTTPS traffic. - -- Allow connectivity to domains and ports in the table. - -- Review the [gRPC and Proxies](../../architecture/grps-proxy.md) page to learn more about VerteX's support for gRPC in - a proxy environment. - - | **Top-Level Domain** | **Port** | **Description** | - | ------------------------- | -------- | ----------------------------------------------------- | - | spectrocloud.com | 443 | Spectro Cloud content repository and pack registry | - | s3.amazonaws.com | 443 | Spectro Cloud VMware OVA files | - | gcr.io | 443 | Spectro Cloud and common third party container images | - | ghcr.io | 443 | Kubernetes VIP images | - | docker.io | 443 | Common third party content | - | googleapis.com | 443 | For pulling Spectro Cloud images | - | docker.com | 443 | Common third party container images | - | raw.githubusercontent.com | 443 | Common third party content | - | projectcalico.org | 443 | Calico container images | - | quay.io | 443 | Common third party container images | - | grafana.com | 443 | Grafana container images and manifests | - | github.com | 443 | Common third party content | - | k8s.gcr.io | 443 | Kubernetes images [deprecated] | - | registry.k8s.io | 443 | Kubernetes images | - | docker.pkg.dev | 443 | Common third party content | + ## Resources