Skip to content

Commit f2d9f10

Browse files
paigecalvertajp-io
andauthored
Add EC port requirements (#2680)
* Add EC port requirements * add dr limitations * edits * Apply suggestions from code review Co-authored-by: Alex Parker <[email protected]> * edits * edits * edit more relocate language --------- Co-authored-by: Alex Parker <[email protected]>
1 parent 4b60a27 commit f2d9f10

File tree

5 files changed

+65
-5
lines changed

5 files changed

+65
-5
lines changed

docs/enterprise/installing-embedded.mdx

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -188,4 +188,22 @@ sudo ./my-app install --license license.yaml --pod-cidr 172.16.136.0/16
188188

189189
#### Limitation
190190

191-
The `--pod-cidr` and `--service-cidr` flags are not supported on Red Hat Enterprise Linux (RHEL) 9 operating systems.
191+
The `--pod-cidr` and `--service-cidr` flags are not supported on Red Hat Enterprise Linux (RHEL) 9 operating systems.
192+
193+
## Change Admin Console and LAM Ports {#adm-lam-ports}
194+
195+
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.
196+
197+
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.
198+
199+
For example:
200+
201+
```bash
202+
install --admin-console-port=20000 --local-artifact-mirror-port=40000
203+
```
204+
205+
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).
206+
207+
### Limitation
208+
209+
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).

docs/enterprise/installing-general-requirements.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import DockerCompatibility from "../partials/image-registry/_docker-compatibilit
22
import KubernetesCompatibility from "../partials/install/_kubernetes-compatibility.mdx"
33
import EmbeddedClusterRequirements from "../partials/embedded-cluster/_requirements.mdx"
44
import EmbeddedClusterStorageReqs from "../partials/embedded-cluster/_storage-reqs.mdx"
5+
import EmbeddedClusterPortRequirements from "../partials/embedded-cluster/_port-reqs.mdx"
56

67
# Installation Requirements
78

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

263264
<EmbeddedClusterStorageReqs/>
264265

266+
### Port Requirements
267+
268+
<EmbeddedClusterPortRequirements/>
269+
265270
## kURL Requirements {#kurl-requirements}
266271

267272
To install with kURL, your environment must meet the following requirements.
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
Embedded Cluster requires that the following ports are open and available:
2+
3+
* 2379/TCP &#42;
4+
* 2380/TCP
5+
* 4789/UDP
6+
* 6443/TCP
7+
* 7443/TCP
8+
* 9091/TCP
9+
* 9099/TCP &#42;
10+
* 9443/TCP
11+
* 10248/TCP &#42;
12+
* 10249/TCP
13+
* 10250/TCP
14+
* 10256/TCP
15+
* 10257/TCP &#42;
16+
* 10259/TCP &#42;
17+
* 30000/TCP &#42;&#42;&#42;
18+
* 50000/TCP &#42; &#42;&#42; &#42;&#42;&#42;
19+
20+
&#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.
21+
22+
&#42;&#42; Required for air gap installations only.
23+
24+
&#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).

docs/vendor/embedded-disaster-recovery.mdx

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,7 @@ Embedded Cluster disaster recovery has the following limitations and known issue
3838

3939
* 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.
4040

41-
* The same proxy settings provided during install must be provided to the restore command using `--http-proxy`, `--https-proxy`, and `--no-proxy`.
42-
43-
* 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.
41+
* 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).
4442

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

@@ -142,7 +140,17 @@ To restore from a backup:
142140
```
143141
Where `APP_SLUG` is the unique application slug.
144142

145-
You will be guided through the process of restoring from a backup. When prompted, enter the information for the backup storage location.
143+
Note the following requirements and guidance for the `restore` command:
144+
145+
* 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).
146+
147+
* 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).
148+
149+
* 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).
150+
151+
You will be guided through the process of restoring from a backup.
152+
153+
1. When prompted, enter the information for the backup storage location.
146154

147155
![Restore prompts on the command line](/images/dr-restore.png)
148156
[View a larger version of this image](/images/dr-restore.png)

docs/vendor/embedded-overview.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ import UpdateOverview from "../partials/embedded-cluster/_update-overview.mdx"
55
import EmbeddedClusterStorageReqs from "../partials/embedded-cluster/_storage-reqs.mdx"
66
import EmbeddedClusterSupportBundle from "../partials/support-bundles/_generate-bundle-ec.mdx"
77
import EcConfig from "../partials/embedded-cluster/_ec-config.mdx"
8+
import EmbeddedClusterPortRequirements from "../partials/embedded-cluster/_port-reqs.mdx"
89

910
# Using Embedded Cluster
1011

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

4142
<EmbeddedClusterStorageReqs/>
4243

44+
#### Port Requirements
45+
46+
<EmbeddedClusterPortRequirements/>
47+
4348
### Limitations
4449

4550
Embedded Cluster has the following limitations:

0 commit comments

Comments
 (0)