Merge branch 'main' into automation/vendor-portal-release-notes-v2025.03.13-5

Author: paigecalvert

docs/enterprise/embedded-manage-nodes.mdx

@@ -10,10 +10,12 @@ Multi-node clusters with Embedded Cluster have the following limitations:
 
 * Support for multi-node clusters with Embedded Cluster is Beta. Only single-node embedded clusters are Generally Available (GA).
 
-* High availability for Embedded Cluster in an Alpha feature. This feature is subject to change, including breaking changes. To get access to this feature, reach out to Alex Parker at [[email protected]](mailto:[email protected]).
+* High availability for Embedded Cluster in an Alpha feature. This feature is subject to change, including breaking changes. For more information about this feature, reach out to Alex Parker at [[email protected]](mailto:[email protected]).
 
 * The same Embedded Cluster data directory used at installation is used for all nodes joined to the cluster. This is either the default `/var/lib/embedded-cluster` directory or the directory set with the [`--data-dir`](/reference/embedded-cluster-install#flags) flag. You cannot choose a different data directory for Embedded Cluster when joining nodes.
 
+* More than one controller node should not be joined at the same time. When joining a controller node, a warning is printed that explains that the user should not attempt to join another node until the controller node joins successfully.
+
 ## Add Nodes to a Cluster (Beta) {#add-nodes}
 
 You can add nodes to create a multi-node cluster in online (internet-connected) and air-gapped (limited or no outbound internet access) environments. The Admin Console provides the join command that you use to join nodes to the cluster.
@@ -86,7 +88,7 @@ To add nodes to a cluster:
 Multi-node clusters are not highly available by default. The first node of the cluster is special and holds important data for Kubernetes and KOTS, such that the loss of this node would be catastrophic for the cluster. Enabling high availability (HA) requires that at least three controller nodes are present in the cluster. Users can enable HA when joining the third node.
 
 :::important
-High availability for Embedded Cluster in an Alpha feature. This feature is subject to change, including breaking changes. To get access to this feature, reach out to Alex Parker at [[email protected]](mailto:[email protected]).
+High availability for Embedded Cluster in an Alpha feature. This feature is subject to change, including breaking changes. For more information about this feature, reach out to Alex Parker at [[email protected]](mailto:[email protected]).
 :::
 
 ### HA Architecture
@@ -107,7 +109,7 @@ Enabling high availability has the following requirements:
 
 Enabling high availability has the following limitations:
 
-* High availability for Embedded Cluster in an Alpha feature. This feature is subject to change, including breaking changes. To get access to this feature, reach out to Alex Parker at [[email protected]](mailto:[email protected]).
+* High availability for Embedded Cluster in an Alpha feature. This feature is subject to change, including breaking changes. For more information about this feature, reach out to Alex Parker at [[email protected]](mailto:[email protected]).
 
 * The `--enable-ha` flag serves as a feature flag during the Alpha phase. In the future, the prompt about migrating to high availability will display automatically if the cluster is not yet HA and you are adding the third or more controller node. 
 
@@ -142,4 +144,4 @@ To create a multi-node HA cluster:
     ![high availability command line prompt](/images/embedded-cluster-ha-prompt.png)
     [View a larger version of this image](/images/embedded-cluster-ha-prompt.png)
 
-1. Wait for the migration to complete.
+1. Wait for the migration to complete.

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

@@ -5,6 +5,7 @@ This section lists the ports used by Embedded Cluster. These ports must be open
 The following ports must be open and available for use by local processes running on the same node. It is not necessary to create firewall openings for these ports.
 
 * 2379/TCP
+* 7443/TCP
 * 9099/TCP
 * 10248/TCP
 * 10257/TCP
@@ -21,7 +22,6 @@ For single-node installations, ensure that there are no other processes using th
 * 2380/TCP
 * 4789/UDP
 * 6443/TCP
-* 7443/TCP
 * 9091/TCP
 * 9443/TCP
 * 10249/TCP

docs/partials/embedded-cluster/_shell-command.mdx

@@ -0,0 +1,46 @@
+To access the cluster and use other included binaries:
+
+1. SSH onto a controller node.
+
+     :::note
+     You cannot run the `shell` command on worker nodes.
+     :::
+
+1. Use the Embedded Cluster shell command to start a shell with access to the cluster:
+
+     ```
+     sudo ./APP_SLUG shell
+     ```
+     Where `APP_SLUG` is the unique slug for the application.
+
+     The output looks similar to the following:
+     ```
+        __4___
+     _  \ \ \ \   Welcome to APP_SLUG debug shell.
+    <'\ /_/_/_/   This terminal is now configured to access your cluster.
+     ((____!___/) Type 'exit' (or CTRL+d) to exit.
+      \0\0\0\0\/  Happy hacking.
+     ~~~~~~~~~~~
+    root@alex-ec-1:/home/alex# export KUBECONFIG="/var/lib/embedded-cluster/k0s/pki/admin.conf"
+    root@alex-ec-1:/home/alex# export PATH="$PATH:/var/lib/embedded-cluster/bin"
+    root@alex-ec-1:/home/alex# source <(k0s completion bash)
+    root@alex-ec-1:/home/alex# source <(cat /var/lib/embedded-cluster/bin/kubectl_completion_bash.sh)
+    root@alex-ec-1:/home/alex# source /etc/bash_completion
+    ```
+
+     The appropriate kubeconfig is exported, and the location of useful binaries like kubectl and Replicated’s preflight and support-bundle plugins is added to PATH.
+
+1. Use the available binaries as needed.
+
+     **Example**:
+
+     ```bash
+     kubectl version
+     ```
+     ```
+     Client Version: v1.29.1
+     Kustomize Version: v5.0.4-0.20230601165947-6ce0bf390ce3
+     Server Version: v1.29.1+k0s
+     ```
+
+1. Type `exit` or **Ctrl + D** to exit the shell. 

docs/partials/kots/_download-portal-about.mdx

@@ -1,5 +1,6 @@
-Embedded Cluster includes a default support bundle spec that collects both host- and cluster-level information.
+Embedded Cluster includes a default support bundle spec that collects both host- and cluster-level information:
 
-The host-level information is useful for troubleshooting failures related to host configuration like DNS, networking, or storage problems. Cluster-level information includes details about the components provided by Replicated, such as the Admin Console and Embedded Cluster operator that manage install and upgrade operations. If the cluster has not installed successfully and cluster-level information is not available, then it is excluded from the bundle.
+* The host-level information is useful for troubleshooting failures related to host configuration like DNS, networking, or storage problems.
+* Cluster-level information includes details about the components provided by Replicated, such as the Admin Console and Embedded Cluster Operator that manage install and upgrade operations. If the cluster has not installed successfully and cluster-level information is not available, then it is excluded from the bundle.
 
 In addition to the host- and cluster-level details provided by the default Embedded Cluster spec, support bundles generated for Embedded Cluster installations also include app-level details provided by any custom support bundle specs that you included in the application release.

docs/partials/support-bundles/_ec-support-bundle-intro.mdx

@@ -1,6 +1,4 @@
-There are different steps to generate a support bundle depending on the version of Embedded Cluster installed.
-
-### For Versions 1.17.0 and Later
+### Generate a Bundle For Versions 1.17.0 and Later
 
 For Embedded Cluster 1.17.0 and later, you can run the Embedded Cluster `support-bundle` command to generate a support bundle.
 
@@ -22,7 +20,7 @@ To generate a support bundle:
 
    Where `APP_SLUG` is the unique slug for the application. 
 
-### For Versions Earlier Than 1.17.0
+### Generate a Bundle For Versions Earlier Than 1.17.0
 
 For Embedded Cluster versions earlier than 1.17.0, you can generate a support bundle from the shell using the kubectl support-bundle plugin.
 
@@ -42,7 +40,7 @@ To generate a bundle:
      The output looks similar to the following:
 
     ```bash
-        __4___
+       __4___
     _  \ \ \ \   Welcome to APP_SLUG debug shell.
     <'\ /_/_/_/   This terminal is now configured to access your cluster.
     ((____!___/) Type 'exit' (or CTRL+d) to exit.

docs/partials/support-bundles/_generate-bundle-ec.mdx

@@ -82,6 +82,19 @@ sudo ./APP_SLUG install --license LICENSE_FILE [flags]
         <ProxyLimitations/>
      </td>
   </tr>
+  <tr>
+     <td>`--ignore-host-preflights`</td>
+     <td>
+        <p>When `--ignore-host-preflights` is passed, the host preflight checks are still run, but the user is prompted and can choose to continue with the installation if preflight failures occur. If there are no failed preflights, no user prompt is displayed. Additionally, the Admin Console still runs any application-specific preflight checks before the application is deployed. For more information about the Embedded Cluster host preflight checks, see [About Host Preflight Checks](/vendor/embedded-using#about-host-preflight-checks) in _Using Embedded Cluster_</p>
+        <p>Ignoring host preflight checks is _not_ recommended for production installations.</p>
+     </td>
+  </tr>
+  <tr>
+     <td>`-l, --license`</td>
+     <td>
+        <p>Path to the license file</p>
+     </td>
+  </tr>
   <tr>
      <td>`--local-artifact-mirror-port`</td>
      <td>
@@ -116,6 +129,13 @@ sudo ./APP_SLUG install --license LICENSE_FILE [flags]
         <p>The KOTS [PrivateCACert](/reference/template-functions-static-context#privatecacert) template function returns the ConfigMap containing the private CA certificates supplied with the `--private-ca` flag. You can use this template function to mount the ConfigMap so your containers trust the CA too.</p>
      </td>
   </tr>
+  <tr>
+     <td>`-y, --yes`</td>
+     <td>
+        <p>In Embedded Cluster 1.21.0 and later, pass the `--yes` flag to provide an affirmative response to any user prompts for the command. For example, you can pass `--yes` with the `--ignore-host-preflights` flag to ignore host preflight checks during automated installations.</p>
+        <p>**Requirement:** Embedded Cluster 1.21.0 and later</p>
+     </td>
+  </tr>
 </table>
 
 ## Examples
@@ -184,4 +204,4 @@ sudo ./my-app install --license license.yaml --cidr 172.16.136.0/16
 
 ```bash
 sudo ./my-app install --license license.yaml --network-interface eno167777
-```
+```

docs/reference/embedded-cluster-install.mdx

@@ -2,19 +2,15 @@
 
 This topic is a reference for the Replicated Embedded Cluster Config custom resource. For more information about Embedded Cluster, see [Using Embedded Cluster](/vendor/embedded-overview).
 
-:::note
-Embedded Cluster is in beta. If you are instead looking for information about creating Kubernetes Installers with Replicated kURL, see the [Replicated kURL](/vendor/packaging-embedded-kubernetes) section.
-:::
-
 ## Overview
 
-To install your application with Embedded Cluster, an Embedded Cluster Config must be created in a release. Embedded Cluster installation artifacts are available only for releases that include an Embedded Cluster Config.
+To install your application with Embedded Cluster, an Embedded Cluster Config must be included in the release. Embedded Cluster installation artifacts are available only for releases that include an Embedded Cluster Config.
 
 The Embedded Cluster Config lets you define several aspects of the Kubernetes cluster that will be created.
 
-### Limitations
+### Limitation
 
-* The Embedded Cluster Config does not support the use of Go template functions, including [KOTS template functions](/reference/template-functions-about).
+The Embedded Cluster Config does not support the use of Go template functions, including [KOTS template functions](/reference/template-functions-about).
 
 For additional property-specific limitations, see the sections below.
 
@@ -34,6 +30,9 @@ spec:
     - name: app
       labels:
        app: "true"
+    domains:
+      proxyRegistryDomain: proxy.yourcompany.com
+      replicatedAppDomain: updates.yourcompany.com
   extensions:
     helm:
       repositories:
@@ -148,6 +147,29 @@ spec:
         gpu: "true" # Label applied to "gpu" nodes    
 ```
 
+## domains
+
+Configure the `domains` key so that Embedded Cluster uses your custom domains for the Replicated proxy registry and Replicated app service.
+
+When `domains.proxyRegistryDomain` and `domains.replicatedAppDomain` are set, Embedded Cluster uses the custom domains specified when making requests to the given service. Embedded Cluster also passes the values to KOTS to ensure that KOTS uses the same domains for these services.
+
+The custom domains that you specify in the `domains.proxyRegistryDomain` and `domains.replicatedAppDomain` fields must be added to the Vendor Portal before they can be used by Embedded Cluster. For more information, see [Add a Custom Domain in the Vendor Portal](/vendor/custom-domains-using#add-domain) in _Using Custom Domains_.
+
+If `domains.proxyRegistryDomain` and `domains.replicatedAppDomain` are not set, Embedded Cluster uses the default Replicated domains. For more information about aliasing Replicated endpoints with custom domains, see [About Custom Domains](/vendor/custom-domains).
+
+#### Example
+
+```yaml
+apiVersion: embeddedcluster.replicated.com/v1beta1
+kind: Config
+spec:
+  domains:
+    # Your proxy registry custom domain
+    proxyRegistryDomain: proxy.yourcompany.com
+    # Your app service custom domain
+    replicatedAppDomain: updates.yourcompany.com    
+```
+
 ## extensions
 
 If you need to install Helm charts before your application and as part of the Embedded Cluster itself, you can do this with Helm extensions. One situation where this is useful is if you want to ship an ingress controller, because Embedded Cluster does not yet include one.

docs/reference/embedded-config.mdx

@@ -33,7 +33,7 @@ replicated app create "Custom App" --output table
 
 ```
   -h, --help            help for create
-      --output string   The output format to use. One of: json|table (default: table) (default "table")
+  -o, --output string   The output format to use. One of: json|table (default "table")
 ```
 
 ### Options inherited from parent commands

docs/reference/replicated-cli-app-create.mdx

@@ -44,7 +44,7 @@ replicated app ls "App Name" --output table
 
 ```
   -h, --help            help for ls
-      --output string   The output format to use. One of: json|table (default: table) (default "table")
+  -o, --output string   The output format to use. One of: json|table (default "table")
 ```
 
 ### Options inherited from parent commands