Skip to content

WAIT FOR RELEASE: Doc new --cidr flag #2761

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 6 commits into from
Oct 24, 2024
Merged

WAIT FOR RELEASE: Doc new --cidr flag #2761

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d392ad4
Doc new --cidr flag
ajp-io Oct 22, 2024
c517ccc
App Manager v1.119.1 release notes (#2762)
replicated-ci Oct 23, 2024
45e723d
Mention that we add node IP to no-proxy
ajp-io Oct 23, 2024
df549b8
Update embedded-cluster-install.mdx
ajp-io Oct 24, 2024
4c2a158
Merge branch 'main' into cidr-flag
paigecalvert Oct 24, 2024
b8fef8b
Update embedded-cluster-install.mdx
paigecalvert Oct 24, 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
18 changes: 5 additions & 13 deletions docs/reference/embedded-cluster-install.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,25 +74,17 @@ sudo ./APP_SLUG install --license LICENSE_FILE [flags]
<p>The following are never proxied:</p>
<ul>
<li>Internal cluster communication (`localhost`, `127.0.0.1`, `.cluster.local`, `.svc`)</li>
<li>The CIDRs used for assigning IPs to Kubernetes Pods and Services. By default, the Pod CIDR is `10.244.0.0/16` and the Service CIDR `10.96.0.0/12`. For information about how to change these defaults, see [Set IP Address Ranges for Pods and Services](#set-ip-address-ranges-for-pods-and-services).</li>
<li>The CIDR used for assigning IPs to Kubernetes Pods and Services. By default, the CIDR is `10.244.0.0/16`. For information about how to change this default, see [Set IP Address Ranges for Pods and Services](#set-ip-address-ranges-for-pods-and-services).</li>
</ul>
<p>To ensure your application's internal cluster communication is not proxied, use fully qualified domain names like `my-service.my-namespace.svc` or `my-service.my-namespace.svc.cluster.local`.</p>
<ProxyRequirements/>
<ProxyLimitations/>
</td>
</tr>
<tr>
<td>`--pod-cidr`</td>
<td>`--cidr`</td>
<td>
<p>The range of IP addresses that can be assigned to Pods, in CIDR notation. **Default:** By default, the Pod CIDR is `10.244.0.0/16`.</p>
<p>**Limitation:** The `--pod-cidr` flag is not supported on Red Hat Enterprise Linux (RHEL) 9 operating systems.</p>
</td>
</tr>
<tr>
<td>`--service-cidr`</td>
<td>
<p>The range of IP addresses that can be assigned to Services, in CIDR notation. **Default:** By default, the Service CIDR is `10.96.0.0/12`.</p>
<p>**Limitation:** The `--service-cidr` flags is not supported on Red Hat Enterprise Linux (RHEL) 9 operating systems.</p>
<p>The range of IP addresses that can be assigned to Pods and Services, in CIDR notation. **Default:** By default, the CIDR is `10.244.0.0/16`.</p>
</td>
</tr>
</table>
Expand Down Expand Up @@ -130,8 +122,8 @@ Where:
* `HOST:PORT` is the host and port of the proxy server
* `LIST_OF_HOSTS` is the list of hosts to not proxy. For example, the IP address of the node where you are installing. Or, for multi-node clusters, the list of IP addresses for all nodes in the cluster, typically in CIDR notation.

### Set IP Address Range for Pods
### Set IP Address Range for Pods and Services

```bash
sudo ./my-app install --license license.yaml --pod-cidr 172.16.136.0/16
sudo ./my-app install --license license.yaml --cidr 172.16.136.0/16
```
2 changes: 1 addition & 1 deletion docs/vendor/embedded-disaster-recovery.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ To restore from a backup:

* 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 `--cidr` flag was used during install to the set IP address ranges for Pods and Services, this flag must be provided with the same CIDR during the restore. If this flag is not provided or is provided with a different CIDR, the restore will fail with an error message telling you to rerun with the appropriate value. 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).

Expand Down
Loading