Skip to content

Commit 7a2fd2d

Browse files
committed
edits
1 parent acc424f commit 7a2fd2d

File tree

1 file changed

+14
-9
lines changed

1 file changed

+14
-9
lines changed

docs/reference/embedded-cluster-install.mdx

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Embedded Cluster Install Command Options
22

3-
This topic describes the options available with the Embedded Cluster install command. For more information about how to install with Embedded Cluster, see [Installing with Embedded Cluster](/enterprise/installing-embedded).
3+
This topic describes the options available with the Embedded Cluster install command. For more information about how to install with Embedded Cluster, see [Online Installation with Embedded Cluster](/enterprise/installing-embedded) or [Air Gap Installation with Embedded Cluster](/enterprise/installing-embedded).
44

55
## Usage
66

@@ -20,19 +20,18 @@ sudo ./APP_SLUG install --license LICENSE_FILE [flags]
2020
<tr>
2121
<td>`--admin-console-port`</td>
2222
<td>
23-
<p>Port to run the KOTS Admin Console on. **Default**: By default, the Admin Console runs on port 30000.</p>
24-
<p>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).</p>
23+
<p>Port on which to run the KOTS Admin Console. **Default**: By default, the Admin Console runs on port 30000.</p>
2524
<p>**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).</p>
2625
</td>
2726
</tr>
2827
<tr>
2928
<td>`--airgap-bundle`</td>
30-
<td>The Embedded Cluster air gap bundle used for installations in air-gapped environments with no outbound internet access. For information about how to install in an air-gapped environment with Embedded Cluster, see [Air Gap Installation with Embedded Cluster](/enterprise/installing-embedded-air-gap).</td>
29+
<td>The Embedded Cluster air gap bundle used for installations in air-gapped environments with no outbound internet access. For information about how to install in an air-gapped environment, see [Air Gap Installation with Embedded Cluster](/enterprise/installing-embedded-air-gap).</td>
3130
</tr>
3231
<tr>
3332
<td>`--data-dir`</td>
3433
<td>
35-
<p>The data directory used by Embedded Cluster. **Default**: `/var/lib/embedded-cluster`.</p>
34+
<p>The data directory used by Embedded Cluster. **Default**: `/var/lib/embedded-cluster`</p>
3635
<p>**Limitations:**</p>
3736
<ul>
3837
<li>The data directory for Embedded Cluster cannot be changed after the cluster is installed.</li>
@@ -43,17 +42,22 @@ sudo ./APP_SLUG install --license LICENSE_FILE [flags]
4342
</tr>
4443
<tr>
4544
<td>`--http-proxy`</td>
46-
<td>Proxy server to use for HTTP</td>
45+
<td>
46+
<p>Proxy server to use for HTTP.</p>
47+
<p>**Requirement**: Proxy installations require Embedded Cluster 1.5.1 or later with Kubernetes 1.29 or later.</p>
48+
</td>
4749
</tr>
4850
<tr>
4951
<td>`--https-proxy`</td>
50-
<td>Proxy server to use for HTTPS</td>
52+
<td>
53+
<p>Proxy server to use for HTTPS.</p>
54+
<p>**Requirement**: Proxy installations require Embedded Cluster 1.5.1 or later with Kubernetes 1.29 or later.</p>
55+
</td>
5156
</tr>
5257
<tr>
5358
<td>`--local-artifact-mirror-port`</td>
5459
<td>
55-
<p>Port to run the Local Artifact Mirror (LAM) on. **Default**: By default, the LAM runs on port 50000.</p>
56-
<p>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).</p>
60+
<p>Port on which to run the Local Artifact Mirror (LAM). **Default**: By default, the LAM runs on port 50000.</p>
5761
</td>
5862
</tr>
5963
<tr>
@@ -67,6 +71,7 @@ sudo ./APP_SLUG install --license LICENSE_FILE [flags]
6771
<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>
6872
</ul>
6973
<p>To ensure your app'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>
74+
<p>**Requirement**: Proxy installations require Embedded Cluster 1.5.1 or later with Kubernetes 1.29 or later.</p>
7075
</td>
7176
</tr>
7277
<tr>

0 commit comments

Comments
 (0)