Skip to content

Add EC port requirements #2680

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

Merged
merged 7 commits into from
Sep 26, 2024
Merged

Add EC port requirements #2680

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
0f118a0
Add EC port requirements
paigecalvert Sep 24, 2024
02b5a59
add dr limitations
paigecalvert Sep 24, 2024
d8ea08e
edits
paigecalvert Sep 25, 2024
9e95818
Apply suggestions from code review
paigecalvert Sep 25, 2024
fcf9028
edits
paigecalvert Sep 25, 2024
f3575d0
edits
paigecalvert Sep 25, 2024
79beb8f
edit more relocate language
paigecalvert Sep 25, 2024
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
20 changes: 19 additions & 1 deletion docs/enterprise/installing-embedded.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,4 +188,22 @@ sudo ./my-app install --license license.yaml --pod-cidr 172.16.136.0/16

#### Limitation

The `--pod-cidr` and `--service-cidr` flags are not supported on Red Hat Enterprise Linux (RHEL) 9 operating systems.
The `--pod-cidr` and `--service-cidr` flags are not supported on Red Hat Enterprise Linux (RHEL) 9 operating systems.

## Change Admin Console and LAM Ports {#adm-lam-ports}

By default, the Admin Console and Local Artifact Mirror (LAM) run on ports 30000 and 50000, respectively. If these ports are occupied, you can select different ports.

To choose different ports for the Admin Console and LAM during installation with Embedded Cluster, use the `--admin-console-port` and `--local-artifact-mirror-port` flags with the Embedded Cluster `install` command.

For example:

```bash
install --admin-console-port=20000 --local-artifact-mirror-port=40000
```

The Embedded Cluster host preflight checks verify the default ports or the user-supplied ports, so users will be alerted before installation if they need to choose new port(s). For more information about the host preflight checks for Embedded Cluster, see [About Host Preflight Checks](/vendor/embedded-overview#about-host-preflight-checks).

### Limitation

It is not possible to change the port for the Admin Console during a restore with Embedded Cluster. For more information, see [Disaster Recovery for Embedded Cluster (Alpha)](/vendor/embedded-disaster-recovery).
5 changes: 5 additions & 0 deletions docs/enterprise/installing-general-requirements.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import DockerCompatibility from "../partials/image-registry/_docker-compatibilit
import KubernetesCompatibility from "../partials/install/_kubernetes-compatibility.mdx"
import EmbeddedClusterRequirements from "../partials/embedded-cluster/_requirements.mdx"
import EmbeddedClusterStorageReqs from "../partials/embedded-cluster/_storage-reqs.mdx"
import EmbeddedClusterPortRequirements from "../partials/embedded-cluster/_port-reqs.mdx"

# Installation Requirements

Expand Down Expand Up @@ -262,6 +263,10 @@ To install with the Embedded Cluster installer, your environment must meet the f

<EmbeddedClusterStorageReqs/>

### Port Requirements

<EmbeddedClusterPortRequirements/>

## kURL Requirements {#kurl-requirements}

To install with kURL, your environment must meet the following requirements.
Expand Down
24 changes: 24 additions & 0 deletions docs/partials/embedded-cluster/_port-reqs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
Embedded Cluster requires that the following ports are open and available:

* 2379/TCP &#42;
Copy link
Member

@ajp-io ajp-io Sep 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's merge this first, but just thinking out loud, I wonder if a table view here could be easier to parse. Columns like port number, protocol (tcp vs udp), local or not, air gap/online/both, etc. This might be perfectly fine too, just a thought.

Copy link
Contributor Author

@paigecalvert paigecalvert Sep 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah that would be worth a shot!

* 2380/TCP
* 4789/UDP
* 6443/TCP
* 7443/TCP
* 9091/TCP
* 9099/TCP &#42;
* 9443/TCP
* 10248/TCP &#42;
* 10249/TCP
* 10250/TCP
* 10256/TCP
* 10257/TCP &#42;
* 10259/TCP &#42;
* 30000/TCP &#42;&#42;&#42;
* 50000/TCP &#42; &#42;&#42; &#42;&#42;&#42;

&#42; These ports are used only by processes running on the same node. Ensure that there are no other processes using them. It is not necessary to create firewall openings for these ports.
Copy link
Contributor Author

@paigecalvert paigecalvert Sep 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

^ @chris-sanders could you confirm that this language about the ports that need to be listening on localhost makes sense?


&#42;&#42; Required for air gap installations only.

&#42;&#42;&#42; By default, the Admin Console and Local Artifact Mirror (LAM) run on ports 30000 and 50000, respectively. If these ports are occupied, you can select different ports during installation. For more information, see [Change the Admin Console and LAM Ports](/enterprise/installing-embedded#adm-lam-ports).
Copy link
Contributor Author

@paigecalvert paigecalvert Sep 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

^ also noticed that we weren't calling out how these change be changed

16 changes: 12 additions & 4 deletions docs/vendor/embedded-disaster-recovery.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,7 @@ Embedded Cluster disaster recovery has the following limitations and known issue

* Velero is only installed during the installation process. Enabling the disaster recovery license field for customers after they have already installed will not do anything.

* The same proxy settings provided during install must be provided to the restore command using `--http-proxy`, `--https-proxy`, and `--no-proxy`.

* If the `--pod-cidr` and `--service-cidr` flags were used during install to the set IP address ranges for Pods and Services, these flags must be provided with the same CIDRs during the restore. If these flags are not provided or are provided with different CIDRs, the restore will fail with an error message telling you to rerun with the appropriate flags and values. However, it will take some time before that error occurs.
* If the `--admin-console-port` flag was used during install to change the port for the Admin Console, note that during a restore the Admin Console port will be used from the backup and cannot be changed. For more information, see [Change the Admin Console and LAM Ports](/enterprise/installing-embedded#adm-lam-ports).

* Restores do not work if a prefix is specified for the S3 bucket in the backup settings.

Expand Down Expand Up @@ -142,7 +140,17 @@ To restore from a backup:
```
Where `APP_SLUG` is the unique application slug.

You will be guided through the process of restoring from a backup. When prompted, enter the information for the backup storage location.
Note the following requirements and guidance for the `restore` command:

* If the installation is behind a proxy, the same proxy settings provided during install must be provided to the restore command using `--http-proxy`, `--https-proxy`, and `--no-proxy`. For more information, see [Install Behind a Proxy](/enterprise/installing-embedded#proxy).

* If the `--pod-cidr` and `--service-cidr` flags were used during install to the set IP address ranges for Pods and Services, these flags must be provided with the same CIDRs during the restore. If these flags are not provided or are provided with different CIDRs, the restore will fail with an error message telling you to rerun with the appropriate flags and values. However, it will take some time before that error occurs. For more information, see [Set IP Address Ranges for Pods and Services](/enterprise/installing-embedded#set-ip-address-ranges-for-pods-and-services).

* If the `--local-artifact-mirror-port` flag was used during install to change the port for the Local Artifact Mirror (LAM), you can optionally use the `--local-artifact-mirror-port` flag to choose a different LAM port during restore. For example, `restore --local-artifact-mirror-port=50000`. If no LAM port is provided during restore, the LAM port that was supplied during installation will be used. For more information, see [Change Admin Console and LAM Ports](/enterprise/installing-embedded#adm-lam-ports).

You will be guided through the process of restoring from a backup.

1. When prompted, enter the information for the backup storage location.

![Restore prompts on the command line](/images/dr-restore.png)
[View a larger version of this image](/images/dr-restore.png)
Expand Down
5 changes: 5 additions & 0 deletions docs/vendor/embedded-overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import UpdateOverview from "../partials/embedded-cluster/_update-overview.mdx"
import EmbeddedClusterStorageReqs from "../partials/embedded-cluster/_storage-reqs.mdx"
import EmbeddedClusterSupportBundle from "../partials/support-bundles/_generate-bundle-ec.mdx"
import EcConfig from "../partials/embedded-cluster/_ec-config.mdx"
import EmbeddedClusterPortRequirements from "../partials/embedded-cluster/_port-reqs.mdx"

# Using Embedded Cluster (Beta)

Expand Down Expand Up @@ -40,6 +41,10 @@ As shown in the diagram above, the Embedded Cluster Config is included in the ap

<EmbeddedClusterStorageReqs/>

#### Port Requirements

<EmbeddedClusterPortRequirements/>

### Limitations

Embedded Cluster has the following limitations:
Expand Down