Merge branch 'main' into 114155

Author: paigecalvert

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

@@ -50,13 +50,17 @@ To install with Embedded Cluster in an air gap environment:
     Errors in building either the application air gap bundle or the Embedded Cluster infrastructure will be shown if present.
     :::
 
-1. Go to **Customers** and click on the target customer. Click **Install instructions > Embedded Cluster**.
+1. Go to **Customers** and click on the target customer. 
+
+1. On the **Manage customer** tab, under **License options**, enable the **Airgap Download Enabled** license field.
+
+1. At the top of the page, click **Install instructions > Embedded Cluster**.
 
      ![Customer install instructions drop down button](/images/customer-install-instructions-dropdown.png)
 
      [View a larger version of this image](/images/customer-install-instructions-dropdown.png)
-
-1. In the **Embedded Cluster install instructions** dialog, enable the **Install in an air gap environment** checkbox.
+    
+1. In the **Embedded Cluster install instructions** dialog, verify that the **Install in an air gap environment** checkbox is enabled.
 
     <img alt="Embedded cluster install instruction dialog" src="/images/embedded-cluster-install-dialog-airgap.png" width="500px"/>
 
@@ -68,19 +72,23 @@ To install with Embedded Cluster in an air gap environment:
 
 1. On a machine with internet access, run the curl command to download the air gap installation assets as a `.tgz`.
 
-1. Move the downloaded `.tgz` to the air gapped machine where you will install. 
+1. Move the downloaded `.tgz` to the air-gapped machine where you will install. 
 
-1. On your air gapped machine, untar the `.tgz` following the instructions provided in the **Embedded Cluster installation instructions** dialog. This will produce three files:
+1. On your air-gapped machine, untar the `.tgz` following the instructions provided in the **Embedded Cluster installation instructions** dialog. This will produce three files:
     * The installer
     * The license
     * The air gap bundle (`APP_SLUG.airgap`)
 
-1. Install the application with the installation command copied from the **Embedded Cluster installation instructions** dialog, adding `--airgap-bundle` flag to pass the `.airgap` bundle that you downloaded to the installation:
+1. Install the application with the installation command copied from the **Embedded Cluster installation instructions** dialog:
 
     ```bash
     sudo ./APP_SLUG install --license license.yaml --airgap-bundle APP_SLUG.airgap
     ```
     Where `APP_SLUG` is the unique application slug.
+    
+    :::note
+    Embedded Cluster supports installation options such as installing behind a 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).
+    :::
 
 1. When prompted, enter a password for accessing the KOTS Admin Console.
 

docs/enterprise/installing-embedded.mdx

@@ -47,6 +47,10 @@ To install an application with Embedded Cluster:
     Where:
     * `APP_SLUG` is the unique slug for the application.
     * `LICENSE_FILE` is the customer license.
+    <br/>
+    :::note
+    Embedded Cluster supports installation options such as installing behind a 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).
+    :::
 
 1. When prompted, enter a password for accessing the KOTS Admin Console.
 
@@ -101,132 +105,4 @@ On the Admin Console dashboard, the application status changes from Missing to U
 
 ![Admin console dashboard showing ready status](/images/gitea-ec-ready.png)
 
-[View a larger version of this image](/images/gitea-ec-ready.png)
-
-## Install Behind a Proxy Server {#proxy}
-
-The following flags can be used with the Embedded Cluster `install` command to install behind a proxy server:
-
-<table>
-  <tr>
-    <th width="35%">Flag</th>
-    <th width="65%">Description</th>
-  </tr>
-  <tr>
-     <td>`--http-proxy`</td>
-     <td>Proxy server to use for HTTP</td>
-  </tr>
-  <tr>
-     <td>`--https-proxy`</td>
-     <td>Proxy server to use for HTTPS</td>
-  </tr>
-  <tr>
-     <td>`--no-proxy`</td>
-     <td>
-       <p>Comma-separated list of hosts for which not to use a proxy.</p>
-       <p>For single-node installations, pass the IP address of the node where you are installing. For multi-node installations, when deploying the first node, pass the list of IP addresses for all nodes in the cluster (typically in CIDR notation).</p>
-       <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>
-       </ul>
-       <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>
-     </td>
-  </tr>
-</table>
-
-#### Example
-
-```bash
-sudo ./APP_SLUG install --license LICENSE_FILE \
-  --http-proxy=HOST:PORT \
-  --https-proxy=HOST:PORT \
-  --no-proxy=LIST_OF_HOSTS
-```
-
-Where:
-
-* `LICENSE_FILE` is the customer's license
-* `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.
-
-#### Requirement
-
-Proxy installations require Embedded Cluster 1.5.1 or later with Kubernetes 1.29 or later. For example, Embedded Cluster 1.6.0+k8s-1.29 supports installing behind a proxy, and 1.6.0+k8s-1.28 does not. For the latest version information, see [Embedded Cluster Release Notes](/release-notes/rn-embedded-cluster).
-
-#### Limitations
-
-* If any of your Helm 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.
-
-* Proxy settings cannot be changed after installation or during upgrade.
-
-### Set IP Address Ranges for Pods and Services
-
-The following flags can be used with the Embedded Cluster `install` command to allocate IP address ranges for Pods and Services:
-
-<table>
-  <tr>
-    <th width="35%">Flag</th>
-    <th width="65%">Description</th>
-  </tr>
-  <tr>
-     <td>`--pod-cidr`</td>
-     <td>The range of IP addresses that can be assigned to Pods, in CIDR notation. By default, the Pod CIDR is `10.244.0.0/16`.</td>
-  </tr>
-  <tr>
-     <td>`--service-cidr`</td>
-     <td>The range of IP addresses that can be assigned to Services, in CIDR notation. By default, the Service CIDR is `10.96.0.0/12`.</td>
-  </tr>
-</table>
-
-
-#### Example
-
-```bash
-sudo ./my-app install --license license.yaml --pod-cidr 172.16.136.0/16
-```
-
-#### Limitation
-
-The `--pod-cidr` and `--service-cidr` flags are not supported on Red Hat Enterprise Linux (RHEL) 9 operating systems.
-
-## Change Admin Console and LAM Ports {#adm-lam-ports}
-
-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.
-
-To choose different ports for the Admin Console and LAM during installation with Embedded Cluster, use the `--admin-console-port` and `--local-artifact-mirror-port` flags with the Embedded Cluster `install` command.
-
-For example:
-
-```bash
-install --admin-console-port=20000 --local-artifact-mirror-port=40000
-```
-
-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).
-
-### 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).
-
-## Change the Default Data Directory {#data-dir}
-
-The default location of the data directory for Embedded Cluster is `/var/lib/embedded-cluster`.
-
-This directory can be modified by the user by passing the `--data-dir` flag to the `install` command.
-
-For example:
-
-```bash
-sudo ./APP_SLUG install --data-dir /data/embedded-cluster --license license.yaml --airgap-bundle APP_SLUG.airgap
-```
-Where `APP_SLUG` is the unique application slug.
-
-### Limtiations
-
-* The data directory for Embedded Cluster cannot be changed after the cluster is installed.
-
-* If you use the `--data-dir` flag to change the data directory during installation, then you must use the same location when restoring in a disaster recovery scenario. For more information about disaster recovery with Embedded Cluster, see [Disaster Recovery for Embedded Cluster](/vendor/embedded-disaster-recovery).
-
-* Replicated does not support using symlinks for the Embedded Cluster data directory. Use the `--data-dir` flag instead of symlinking `/var/lib/embedded-cluster`.
+[View a larger version of this image](/images/gitea-ec-ready.png)

docs/intro.md

@@ -49,13 +49,10 @@ pagination_next: null
       <a href="/vendor/kots-faq">Replicated FAQs</a>
     </li>
     <li>
-      <a href="/vendor/replicated-onboarding">Replicated Quick Start</a>
+      <a href="/vendor/replicated-onboarding">Replicated Onboarding</a>
     </li>
     <li>
-      <a href="/vendor/tutorial-kots-helm-setup">Tutorials</a>
-    </li>
-    <li>
-      <a href="https://play.instruqt.com/embed/replicated/tracks/distributing-with-replicated?token=em_VHOEfNnBgU3auAnN">Getting Started Lab in Instruqt</a>
+      <a href="/vendor/tutorial-embedded-cluster-setup">Tutorials</a>
     </li>
   </ul>
 </section>
@@ -141,29 +138,26 @@ pagination_next: null
     <li>
       <a href="intro-kots">Introduction to KOTS</a>
     </li>
-    <li>
-      <a href="/vendor/distributing-workflow">Onboarding with KOTS</a>
-    </li>
     <li>
       <a href="/vendor/helm-native-about">About Distributing Helm Charts with KOTS</a>
     </li>
   </ul>
   <ul>
     <li class="tile__header">
         <img src="images/icons/k8s_installer.png" alt="installer icon"></img>
-        <p>Embedded Kubernetes</p>
+        <p>Embedded Cluster (Beta)</p>
     </li>
     <li>
         <p>Embed Kubernetes with your application to support installations on VMs or bare metal servers.</p>
     </li>
     <li>
-      <a href="/vendor/embedded-kubernetes-overview">About Embedded Kubernetes</a>
+      <a href="/vendor/embedded-overview">Using Embedded Cluster (Beta)</a>
     </li>
     <li>
-      <a href="/vendor/kurl-about">Introduction to kURL</a>
+      <a href="/enterprise/installing-embedded">Installing with Embedded Cluster (Beta)</a>
     </li>
     <li>
-      <a href="/vendor/embedded-overview">Using Embedded Cluster (Beta)</a>
+      <a href="/vendor/tutorial-embedded-cluster-setup">Tutorial: Deploy a Helm Chart on a VM with Embedded Cluster (Beta)</a>
     </li>
   </ul>
 </section>

docs/partials/embedded-cluster/_ec-config.mdx

@@ -2,5 +2,5 @@
 apiVersion: embeddedcluster.replicated.com/v1beta1
 kind: Config
 spec:
-  version: 1.14.2+k8s-1.29
+  version: 1.16.0+k8s-1.30
 ```

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

@@ -21,4 +21,4 @@ Embedded Cluster requires that the following ports are open and available:
 
 ** 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).
+*** 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 [Embedded Cluster Install Command Options](/reference/embedded-cluster-install).

docs/partials/embedded-cluster/_proxy-install-limitations.mdx

@@ -0,0 +1,5 @@
+**Limitations:**
+
+* 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.
+
+* Proxy settings cannot be changed after installation or during upgrade.

docs/partials/embedded-cluster/_proxy-install-reqs.mdx

@@ -0,0 +1 @@
+**Requirement:** Proxy installations require Embedded Cluster 1.5.1 or later with Kubernetes 1.29 or later.

docs/partials/embedded-cluster/_requirements.mdx

@@ -9,7 +9,7 @@
 * The filesystem at `/var/lib/embedded-cluster` has 40Gi or more of total space and must be less than 80% full
 
    :::note
-   The directory used for data storage can be changed by passing the `--data-dir` flag with the Embedded Cluster install command. For more information, see [Change the Default Data Directory](/enterprise/installing-embedded#data-dir) in _Installing with Embedded Cluster_.
+   The directory used for data storage can be changed by passing the `--data-dir` flag with the Embedded Cluster install command. For more information, see [Embedded Cluster Install Command Options](/reference/embedded-cluster-install).
    :::
 
    Note that in addition to the primary `/var/lib/embedded-cluster` directory, Embedded Cluster creates directories and files in the following locations:

docs/partials/getting-started/_create-promote-release.mdx

@@ -0,0 +1 @@
+Create a new release and promote it to the Unstable channel. For more information, see [Managing Releases with the Vendor Portal](releases-creating-releases) or [Managing Releases with the CLI](releases-creating-cli).

docs/partials/getting-started/_gitea-ec-config.mdx

@@ -2,5 +2,5 @@
 apiVersion: embeddedcluster.replicated.com/v1beta1
 kind: Config
 spec:
-  version: 1.14.2+k8s-1.29
+  version: 1.16.0+k8s-1.30
 ```