Add EC port requirements #2680

paigecalvert · 2024-09-24T21:44:58Z

No description provided.

netlify · 2024-09-24T21:45:14Z

✅ Deploy Preview for replicated-docs ready!

Name	Link
🔨 Latest commit	`79beb8f`
🔍 Latest deploy log	https://app.netlify.com/sites/replicated-docs/deploys/66f45880e4c536000897ce7e
😎 Deploy Preview	https://deploy-preview-2680--replicated-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify · 2024-09-24T21:45:14Z

✅ Deploy Preview for replicated-docs-upgrade ready!

Name	Link
🔨 Latest commit	`79beb8f`
🔍 Latest deploy log	https://app.netlify.com/sites/replicated-docs-upgrade/deploys/66f4588065d5360007e5c795
😎 Deploy Preview	https://deploy-preview-2680--replicated-docs-upgrade.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

paigecalvert · 2024-09-25T15:47:46Z

docs/enterprise/installing-embedded.mdx

-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.
+
+## Relocate Admin Console and LAM Ports


^ Added a new section to the Install topic. Probably gonna need more of a reference topic for all these flags soon

paigecalvert · 2024-09-25T15:49:55Z

docs/enterprise/installing-general-requirements.mdx


+### Port Requirements
+
+Embedded Cluster requires that the following ports are available:


^ Wasn't sure if it would be necessary to spell this out, but we could add something like: "Ensure that no other processes are using them and add firewall openings for these ports, unless otherwise indicated."

We could say "open and available" so that it covers something else already being bound there and the port being inaccessible due to a firewall.

Should this go on the EC requirements page too?

Ah yeah meant to add a note/link to this section in the requirements partial

paigecalvert · 2024-09-25T15:50:17Z

docs/vendor/embedded-disaster-recovery.mdx

-* 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 relocate the Admin Console port, note that during a restore the Admin Console port will be used from the backup and cannot be changed. For more information, see [Relocate Admin Console and LAM Ports](/enterprise/installing-embedded#relocate-admin-console-and-lam-ports).


^ Added to limitations in the DR topic

same relocate wording change here

paigecalvert · 2024-09-25T15:51:08Z

docs/vendor/embedded-disaster-recovery.mdx

     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 for the `restore` command:


I noticed that we had some of this listed under "Limitations", but it felt like it would be more useful as a heads up when you are about to run the restore command (and they felt more like reqs than limitations anyway)

docs/enterprise/installing-embedded.mdx

ajp-io · 2024-09-25T16:08:00Z

docs/enterprise/installing-embedded.mdx

+
+By default, the Admin Console and Local Artifact Mirror (LAM) run on ports 30000 and 50000, respectively. If these ports are occupied, you can relocate them.
+
+To relocate the Admin Console and LAM ports during installation with Embedded Cluster, use the `--admin-console-port` and `--local-artifact-mirror` flags with the Embedded Cluster `install` command.


And then maybe something like, "To choose different ports" or whatever.

docs/enterprise/installing-embedded.mdx

ajp-io · 2024-09-25T16:09:35Z

docs/enterprise/installing-embedded.mdx

+
+### Limitation
+
+It is not possible to relocate the Admin Console port during a restore with Embedded Cluster. For more information, see [Disaster Recovery for Embedded Cluster (Alpha)](/vendor/embedded-disaster-recovery).


same relocate wording change here

ajp-io · 2024-09-25T16:09:44Z

docs/vendor/embedded-disaster-recovery.mdx

-* 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 relocate the Admin Console port, note that during a restore the Admin Console port will be used from the backup and cannot be changed. For more information, see [Relocate Admin Console and LAM Ports](/enterprise/installing-embedded#relocate-admin-console-and-lam-ports).


same relocate wording change here

docs/vendor/embedded-disaster-recovery.mdx

ajp-io · 2024-09-25T16:14:07Z

docs/enterprise/installing-general-requirements.mdx


+### Port Requirements
+
+Embedded Cluster requires that the following ports are available:


We could say "open and available" so that it covers something else already being bound there and the port being inaccessible due to a firewall.

ajp-io · 2024-09-25T16:16:00Z

docs/enterprise/installing-general-requirements.mdx

+* 30000/TCP
+* 50000/TCP &#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. 


I trust @chris-sanders knowledge and wording here, so wouldn't mind him taking a look at this one paragraph about the ports that are only bound on localhost.

ajp-io · 2024-09-25T16:16:21Z

docs/enterprise/installing-general-requirements.mdx


+### Port Requirements
+
+Embedded Cluster requires that the following ports are available:


Should this go on the EC requirements page too?

Co-authored-by: Alex Parker <7272359+ajp-io@users.noreply.github.com>

paigecalvert · 2024-09-25T18:38:18Z

docs/partials/embedded-cluster/_port-reqs.mdx

+
+&#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).


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

paigecalvert · 2024-09-25T18:39:08Z

docs/partials/embedded-cluster/_port-reqs.mdx

+* 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. 


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

ajp-io · 2024-09-26T14:30:00Z

docs/partials/embedded-cluster/_port-reqs.mdx

@@ -0,0 +1,24 @@
+Embedded Cluster requires that the following ports are open and available:
+
+* 2379/TCP &#42;


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.

Yeah that would be worth a shot!

Add EC port requirements

0f118a0

replicated-ci added type::docs Improvements or additions to documentation type::feature labels Sep 24, 2024

paigecalvert added 2 commits September 24, 2024 16:29

add dr limitations

02b5a59

edits

d8ea08e

paigecalvert marked this pull request as ready for review September 25, 2024 15:47

paigecalvert requested a review from a team as a code owner September 25, 2024 15:47

paigecalvert commented Sep 25, 2024

View reviewed changes

paigecalvert requested a review from ajp-io September 25, 2024 15:51

ajp-io reviewed Sep 25, 2024

View reviewed changes

paigecalvert and others added 4 commits September 25, 2024 10:32

Apply suggestions from code review

9e95818

Co-authored-by: Alex Parker <7272359+ajp-io@users.noreply.github.com>

edits

fcf9028

edits

f3575d0

edit more relocate language

79beb8f

paigecalvert commented Sep 25, 2024

View reviewed changes

ajp-io reviewed Sep 26, 2024

View reviewed changes

ajp-io merged commit f2d9f10 into main Sep 26, 2024
5 checks passed

ajp-io deleted the 112535 branch September 26, 2024 16:53


		### Port Requirements

		Embedded Cluster requires that the following ports are available:


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

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


		### Limitation

		It is not possible to relocate the Admin Console port during a restore with Embedded Cluster. For more information, see [Disaster Recovery for Embedded Cluster (Alpha)](/vendor/embedded-disaster-recovery).


		** Required for air gap installations only.

		*** 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). No newline at end of file

		@@ -0,0 +1,24 @@
		Embedded Cluster requires that the following ports are open and available:

		* 2379/TCP *

Add EC port requirements #2680

Add EC port requirements #2680

Uh oh!

Conversation

paigecalvert commented Sep 24, 2024

Uh oh!

netlify bot commented Sep 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for replicated-docs ready!

Uh oh!

netlify bot commented Sep 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for replicated-docs-upgrade ready!

Uh oh!

paigecalvert Sep 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

paigecalvert Sep 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

netlify bot commented Sep 24, 2024 •

edited

Loading

netlify bot commented Sep 24, 2024 •

edited

Loading

paigecalvert Sep 25, 2024 •

edited

Loading

paigecalvert Sep 25, 2024 •

edited

Loading