You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/reference/embedded-cluster-install.mdx
+14-9Lines changed: 14 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Embedded Cluster Install Command Options
2
2
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).
<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>
25
24
<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>
26
25
</td>
27
26
</tr>
28
27
<tr>
29
28
<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>
31
30
</tr>
32
31
<tr>
33
32
<td>`--data-dir`</td>
34
33
<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>
36
35
<p>**Limitations:**</p>
37
36
<ul>
38
37
<li>The data directory for Embedded Cluster cannot be changed after the cluster is installed.</li>
<p>**Requirement**: Proxy installations require Embedded Cluster 1.5.1 or later with Kubernetes 1.29 or later.</p>
48
+
</td>
47
49
</tr>
48
50
<tr>
49
51
<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>
51
56
</tr>
52
57
<tr>
53
58
<td>`--local-artifact-mirror-port`</td>
54
59
<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>
<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>
68
72
</ul>
69
73
<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>
0 commit comments