Skip to content

Commit 624c6dc

Browse files
committed
add link to new topic
1 parent 516ea6d commit 624c6dc

File tree

5 files changed

+25
-19
lines changed

5 files changed

+25
-19
lines changed

docs/enterprise/installing-embedded-air-gap.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,10 @@ To install with Embedded Cluster in an air gap environment:
8181
sudo ./APP_SLUG install --license license.yaml --airgap-bundle APP_SLUG.airgap
8282
```
8383
Where `APP_SLUG` is the unique application slug.
84+
85+
:::note
86+
Embedded Cluster supports installation options such as installing behind proxy and changing the data directory used by Embedded Cluster. For the list of flags supported with the Embedded Cluster `install` command, see [Embedded Cluster Install Command Options](/reference/embedded-cluster-install).
87+
:::
8488

8589
1. When prompted, enter a password for accessing the KOTS Admin Console.
8690

docs/enterprise/installing-embedded.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,10 @@ To install an application with Embedded Cluster:
4747
Where:
4848
* `APP_SLUG` is the unique slug for the application.
4949
* `LICENSE_FILE` is the customer license.
50+
<br/>
51+
:::note
52+
Embedded Cluster supports installation options such as installing behind proxy and changing the data directory used by Embedded Cluster. For the list of flags supported with the Embedded Cluster `install` command, see [Embedded Cluster Install Command Options](/reference/embedded-cluster-install).
53+
:::
5054

5155
1. When prompted, enter a password for accessing the KOTS Admin Console.
5256

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
**Limitations:**
2+
3+
* If any of your [Helm extensions](/reference/embedded-config#extensions) make requests to the internet, the given charts need to be manually configured so that those requests are made to the user-supplied proxy server instead. Typically, this requires updating the Helm values to set HTTP proxy, HTTPS proxy, and no proxy. Note that this limitation applies only to network requests made by your Helm extensions. The proxy settings supplied to the install command are used to pull the containers required to run your Helm extensions.
4+
5+
* Proxy settings cannot be changed after installation or during upgrade.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
**Requirement:** Proxy installations require Embedded Cluster 1.5.1 or later with Kubernetes 1.29 or later.

docs/reference/embedded-cluster-install.mdx

Lines changed: 11 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
import ProxyLimitations from "../partials/embedded-cluster/_proxy-install-limitations.mdx"
2+
import ProxyRequirements from "../partials/embedded-cluster/_proxy-install-reqs.mdx"
3+
4+
15
# Embedded Cluster Install Command Options
26

37
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,30 +48,22 @@ sudo ./APP_SLUG install --license LICENSE_FILE [flags]
4448
<td>`--http-proxy`</td>
4549
<td>
4650
<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-
<p>**Limitations:**</p>
49-
<ul>
50-
<li>If any of your [Helm extensions](/reference/embedded-config#extensions) make requests to the internet, the given charts need to be manually configured so that those requests are made to the user-supplied proxy server instead. Typically, this requires updating the Helm values to set HTTP proxy, HTTPS proxy, and no proxy. Note that this limitation applies only to network requests made by your Helm extensions. The proxy settings supplied to the install command are used to pull the containers required to run your Helm extensions.</li>
51-
<li>Proxy settings cannot be changed after installation or during upgrade.</li>
52-
</ul>
51+
<ProxyRequirements/>
52+
<ProxyLimitations/>
5353
</td>
5454
</tr>
5555
<tr>
5656
<td>`--https-proxy`</td>
5757
<td>
5858
<p>Proxy server to use for HTTPS.</p>
59-
<p>**Requirement**: Proxy installations require Embedded Cluster 1.5.1 or later with Kubernetes 1.29 or later.</p>
60-
<p>**Limitations:**</p>
61-
<ul>
62-
<li>If any of your [Helm extensions](/reference/embedded-config#extensions) make requests to the internet, the given charts need to be manually configured so that those requests are made to the user-supplied proxy server instead. Typically, this requires updating the Helm values to set HTTP proxy, HTTPS proxy, and no proxy. Note that this limitation applies only to network requests made by your Helm extensions. The proxy settings supplied to the install command are used to pull the containers required to run your Helm extensions.</li>
63-
<li>Proxy settings cannot be changed after installation or during upgrade.</li>
64-
</ul>
59+
<ProxyRequirements/>
60+
<ProxyLimitations/>
6561
</td>
6662
</tr>
6763
<tr>
6864
<td>`--license`</td>
6965
<td>
70-
<p>License file.</p>
66+
<p>The license file to use for installation. Must have the **Embedded Cluster Enabled** license field enabled. See [Creating and Managing Customers](/vendor/releases-creating-customer).</p>
7167
</td>
7268
</tr>
7369
<tr>
@@ -87,12 +83,8 @@ sudo ./APP_SLUG install --license LICENSE_FILE [flags]
8783
<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>
8884
</ul>
8985
<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>
90-
<p>**Requirement**: Proxy installations require Embedded Cluster 1.5.1 or later with Kubernetes 1.29 or later.</p>
91-
<p>**Limitations:**</p>
92-
<ul>
93-
<li>If any of your [Helm extensions](/reference/embedded-config#extensions) make requests to the internet, the given charts need to be manually configured so that those requests are made to the user-supplied proxy server instead. Typically, this requires updating the Helm values to set HTTP proxy, HTTPS proxy, and no proxy. Note that this limitation applies only to network requests made by your Helm extensions. The proxy settings supplied to the install command are used to pull the containers required to run your Helm extensions.</li>
94-
<li>Proxy settings cannot be changed after installation or during upgrade.</li>
95-
</ul>
86+
<ProxyRequirements/>
87+
<ProxyLimitations/>
9688
</td>
9789
</tr>
9890
<tr>

0 commit comments

Comments
 (0)