Skip to content

Commit

Permalink
docs: updated proxy domain table (#2966) (#2976)
Browse files Browse the repository at this point in the history 
* docs: updated proxy domain table

* chore: fix prettier check not using package.json definition

* Apply suggestions from code review



---------

Co-authored-by: caroldelwing <[email protected]>
  • Loading branch information
@karl-cardenas-coding @caroldelwing
karl-cardenas-coding and caroldelwing authored Jun 3, 2024
1 parent 96a1d0b commit 2e3ef71
Show file tree
Hide file tree
Showing 5 changed files with 48 additions and 29 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/pull_request.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,8 @@ jobs:
node-version: "20"
cache: "npm"

- run: npm ci

- name: Prettier Check
run: npx prettier . --check

Expand Down
57 changes: 34 additions & 23 deletions docs/docs-content/architecture/palette-public-ips.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,26 +34,37 @@ Palette uses the following domains for communication between the management plat

<br />

| Domain | Ports |
| :-------------------------------------------- | :---- |
| api.spectrocloud.com | 443 |
| api1.spectrocloud.com | 443 |
| api2.spectrocloud.com | 443 |
| api3.spectrocloud.com | 443 |
| message.spectrocloud.com | 4222 |
| message1.spectrocloud.com | 4222 |
| message2.spectrocloud.com | 4222 |
| message3.spectrocloud.com | 4222 |
| console.spectrocloud.com | 443 |
| proxy.console.spectrocloud.com | 443 |
| registry.spectrocloud.com | 443 |
| saas-repo.console.spectrocloud.com | 443 |
| maasgoldenimage-console.s3.amazonaws.com | 443 |
| openstackgoldenimage-console.s3.amazonaws.com | 443 |
| edgegoldenimage-console.s3.amazonaws.com | 443 |
| vmwaregoldenimage-console.s3.amazonaws.com | 443 |
| registry1.spectrocloud.com | 443 |
| registry2.spectrocloud.com | 443 |
| registry3.spectrocloud.com | 443 |
| 415789037893.dkr.ecr.us-east-1.amazonaws.com | 443 |
| 415789037893.dkr.ecr.us-west-2.amazonaws.com | 443 |
:::warning

NATS and the associated port, 4222, are 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.

:::

| Domain | Ports |
| :-------------------------------------------- | :-------- |
| api.spectrocloud.com | 443 |
| api1.spectrocloud.com | 443 |
| api2.spectrocloud.com | 443 |
| api3.spectrocloud.com | 443 |
| message.spectrocloud.com | 443, 4222 |
| message1.spectrocloud.com | 443, 4222 |
| message2.spectrocloud.com | 443, 4222 |
| message3.spectrocloud.com | 443, 4222 |
| msg.spectrocloud.com | 443 |
| msg1.spectrocloud.com | 443 |
| msg2.spectrocloud.com | 443 |
| msg3.spectrocloud.com | 443 |
| console.spectrocloud.com | 443 |
| proxy.console.spectrocloud.com | 443 |
| registry.spectrocloud.com | 443 |
| saas-repo.console.spectrocloud.com | 443 |
| maasgoldenimage-console.s3.amazonaws.com | 443 |
| openstackgoldenimage-console.s3.amazonaws.com | 443 |
| edgegoldenimage-console.s3.amazonaws.com | 443 |
| vmwaregoldenimage-console.s3.amazonaws.com | 443 |
| registry1.spectrocloud.com | 443 |
| registry2.spectrocloud.com | 443 |
| registry3.spectrocloud.com | 443 |
| 415789037893.dkr.ecr.us-east-1.amazonaws.com | 443 |
| 415789037893.dkr.ecr.us-west-2.amazonaws.com | 443 |
10 changes: 7 additions & 3 deletions docs/docs-content/enterprise-version/install-palette/install-palette.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,12 +53,13 @@ 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.

<br />

| **Top-Level Domain** | **Port** | **Description** |
| ------------------------- | -------- | ----------------------------------------------------- |
| spectrocloud.com | 443 | Spectro Cloud content repository and pack registry |
Expand All @@ -70,9 +71,12 @@ active nodes and pods at any given time.
| 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 |
| 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

Expand Down
6 changes: 4 additions & 2 deletions package-lock.json
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@
"jest-fetch-mock": "^3.0.3",
"lint-staged": "^13.2.3",
"netlify-cli": "^17.17.1",
"prettier": "3.2.5",
"prettier": "3.3.0",
"semantic-release": "^20.1.0",
"test-links": "^0.0.1",
"ts-jest": "^29.1.2",
Expand Down

0 comments on commit 2e3ef71

Please sign in to comment.