Merge branch 'main' into 122803

Author: paigecalvert

docs/enterprise/embedded-manage-nodes.mdx

@@ -16,6 +16,10 @@ Multi-node clusters with Embedded Cluster have the following limitations:
 
 * The `join print-command` command always returns the commands for joining a node with the controller role. It does not support printing the join command for any custom node roles defined in the Embedded Cluster Config `roles` key. See [Automate Controller Node Joins](#automate-node-joins) below.
 
+## Requirement
+
+To deploy multi-node clusters with Embedded Cluster, the **Multi-node Cluster (Embedded Cluster only)** license field must be enabled for the customer. For more information about managing customer licenses, see [Create and Manage Customers](/vendor/releases-creating-customer).
+
 ## Add Nodes to a Cluster {#add-nodes}
 
 This section describes how to add nodes to a cluster with Embedded Cluster.

docs/intro.md

@@ -12,11 +12,11 @@ pagination_next: null
         <p>What's New?</p>
     </li>
     <li>
-        <h3>Embedded Cluster Fully Supports Custom Domains</h3>
-        <p>Update the Embedded Cluster Config to alias the `replicated.app` and `proxy.replicated.com` endpoints with your custom domains.</p>
+        <h3>Configure the Kubelet with Embedded Cluster</h3>
+        <p>Use the Embedded Cluster Config to change the Kubelet configuration based on your application's needs.</p>
     </li>
     <li>
-      <a href="/vendor/custom-domains-using#ec">Learn more</a>
+      <a href="/reference/embedded-config#configure-the-kubelet">Learn more</a>
     </li>
   </ul>
   <ul id="did-you-know">
@@ -25,11 +25,11 @@ pagination_next: null
         <p>Did You Know?</p>
     </li>
     <li>
-        <h3>View Embedded Cluster Logs</h3>
-        <p>To help troubleshoot Embedded Cluster deployments, you can view logs for both Embedded Cluster and the k0s systemd service.</p>
+        <h3>Customize the SDK with Helm Values</h3>
+        <p>The Replicated SDK's Helm values support various configuration options, like adding custom annotations across all resources, defining container resource requirements, and more.</p>
     </li>
     <li>
-      <a href="/vendor/embedded-troubleshooting">Learn more</a>
+      <a href="/vendor/replicated-sdk-customizing">Learn more</a>
     </li>
   </ul>
 </section>

docs/partials/embedded-cluster/_proxy-env-vars.mdx

@@ -0,0 +1 @@
+Embedded Cluster 2.4.0 and later also respects the `http_proxy`, `https_proxy`, and `no_proxy` environment variables for installing behind a proxy. When set, the `--http-proxy`, `--https-proxy`, `--no-proxy` flags take precedence over environment variables. Additionally, lowercase environment variables (`http_proxy`) take precedence over uppercase (`HTTP_PROXY`).

docs/reference/embedded-cluster-install.mdx

@@ -1,6 +1,6 @@
 import ProxyLimitations from "../partials/embedded-cluster/_proxy-install-limitations.mdx"
 import ProxyRequirements from "../partials/embedded-cluster/_proxy-install-reqs.mdx"
-
+import ProxyEnvVars from "../partials/embedded-cluster/_proxy-env-vars.mdx"
 
 # Embedded Cluster Install Command Options
 
@@ -70,6 +70,7 @@ sudo ./APP_SLUG install --license PATH_TO_LICENSE [flags]
      <td>`--http-proxy`</td>
      <td>
         <p>Proxy server to use for HTTP.</p>
+        <ProxyEnvVars/>
         <ProxyRequirements/>
         <ProxyLimitations/>   
      </td>
@@ -78,6 +79,7 @@ sudo ./APP_SLUG install --license PATH_TO_LICENSE [flags]
      <td>`--https-proxy`</td>
      <td>
         <p>Proxy server to use for HTTPS.</p>
+        <ProxyEnvVars/>
         <ProxyRequirements/>
         <ProxyLimitations/>
      </td>
@@ -118,6 +120,7 @@ sudo ./APP_SLUG install --license PATH_TO_LICENSE [flags]
          <li>The CIDR block used for assigning IPs to Kubernetes Pods and Services. By default, the CIDR block is `10.244.0.0/16`. For information about how to change this default, see [Set IP Address Range for Pods and Services](#set-ip-address-range-for-pods-and-services).</li>
        </ul>
        <p>To ensure your application'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>
+       <ProxyEnvVars/>
        <ProxyRequirements/>
        <ProxyLimitations/>
      </td>

docs/reference/replicated-cli-cluster-addon-create-object-store.mdx

@@ -7,26 +7,26 @@ Create an object store bucket for a cluster.
 Creates an object store bucket for a cluster, requiring a bucket name prefix. The bucket name will be auto-generated using the format "[BUCKET_PREFIX]-[ADDON_ID]-cmx". This feature provisions an object storage bucket that can be used for storage in your cluster environment.
 
 ```
-replicated cluster addon create object-store CLUSTER_ID --bucket-prefix BUCKET_PREFIX [flags]
+replicated cluster addon create object-store CLUSTER_ID_OR_NAME --bucket-prefix BUCKET_PREFIX [flags]
 ```
 
 ### Examples
 
 ```
 # Create an object store bucket with a specified prefix
-replicated cluster addon create object-store 05929b24 --bucket-prefix mybucket
+replicated cluster addon create object-store CLUSTER_ID_OR_NAME --bucket-prefix mybucket
 
 # Create an object store bucket and wait for it to be ready (up to 5 minutes)
-replicated cluster addon create object-store 05929b24 --bucket-prefix mybucket --wait 5m
+replicated cluster addon create object-store CLUSTER_ID_OR_NAME --bucket-prefix mybucket --wait 5m
 
 # Perform a dry run to validate inputs without creating the bucket
-replicated cluster addon create object-store 05929b24 --bucket-prefix mybucket --dry-run
+replicated cluster addon create object-store CLUSTER_ID_OR_NAME --bucket-prefix mybucket --dry-run
 
 # Create an object store bucket and output the result in JSON format
-replicated cluster addon create object-store 05929b24 --bucket-prefix mybucket --output json
+replicated cluster addon create object-store CLUSTER_ID_OR_NAME --bucket-prefix mybucket --output json
 
 # Create an object store bucket with a custom prefix and wait for 10 minutes
-replicated cluster addon create object-store 05929b24 --bucket-prefix custom-prefix --wait 10m
+replicated cluster addon create object-store CLUSTER_ID_OR_NAME --bucket-prefix custom-prefix --wait 10m
 ```
 
 ### Options

docs/reference/replicated-cli-cluster-addon-create.mdx

@@ -10,10 +10,10 @@ Create new add-ons for a cluster. This command allows you to add functionality o
 
 ```
 # Create an object store bucket add-on for a cluster
-replicated cluster addon create object-store CLUSTER_ID --bucket-prefix mybucket
+replicated cluster addon create object-store CLUSTER_ID_OR_NAME --bucket-prefix mybucket
 
 # Perform a dry run for creating an object store add-on
-replicated cluster addon create object-store CLUSTER_ID --bucket-prefix mybucket --dry-run
+replicated cluster addon create object-store CLUSTER_ID_OR_NAME --bucket-prefix mybucket --dry-run
 ```
 
 ### Options

docs/reference/replicated-cli-cluster-addon-ls.mdx

@@ -9,7 +9,7 @@ The 'cluster addon ls' command allows you to list all add-ons for a specific clu
 This can be useful for monitoring the health and configuration of add-ons or performing troubleshooting tasks.
 
 ```
-replicated cluster addon ls CLUSTER_ID [flags]
+replicated cluster addon ls CLUSTER_ID_OR_NAME [flags]
 ```
 
 ### Aliases
@@ -22,13 +22,13 @@ ls, list
 
 ```
 # List add-ons for a cluster with default table output
-replicated cluster addon ls CLUSTER_ID
+replicated cluster addon ls CLUSTER_ID_OR_NAME
 
 # List add-ons for a cluster with JSON output
-replicated cluster addon ls CLUSTER_ID --output json
+replicated cluster addon ls CLUSTER_ID_OR_NAME --output json
 
 # List add-ons for a cluster with wide table output
-replicated cluster addon ls CLUSTER_ID --output wide
+replicated cluster addon ls CLUSTER_ID_OR_NAME --output wide
 ```
 
 ### Options

docs/reference/replicated-cli-cluster-addon-rm.mdx

@@ -4,12 +4,12 @@ Remove cluster add-on by ID.
 
 ### Synopsis
 
-The 'cluster addon rm' command allows you to remove a specific add-on from a cluster by specifying the cluster ID and the add-on ID.
+The 'cluster addon rm' command allows you to remove a specific add-on from a cluster by specifying the cluster ID or name and the add-on ID.
 
 This command is useful when you want to deprovision an add-on that is no longer needed or when troubleshooting issues related to specific add-ons. The add-on will be removed immediately, and you will receive confirmation upon successful removal.
 
 ```
-replicated cluster addon rm CLUSTER_ID --id ADDON_ID [flags]
+replicated cluster addon rm CLUSTER_ID_OR_NAME --id ADDON_ID [flags]
 ```
 
 ### Aliases

docs/reference/replicated-cli-cluster-addon.mdx

@@ -12,16 +12,16 @@ You can use various subcommands to create, list, remove, or check the status of
 
 ```
 # List all add-ons installed on a cluster
-replicated cluster addon ls CLUSTER_ID
+replicated cluster addon ls CLUSTER_ID_OR_NAME
 
 # Remove an add-on from a cluster
-replicated cluster addon rm CLUSTER_ID --id ADDON_ID
+replicated cluster addon rm CLUSTER_ID_OR_NAME --id ADDON_ID
 
 # Create an object store bucket add-on for a cluster
-replicated cluster addon create object-store CLUSTER_ID --bucket-prefix mybucket
+replicated cluster addon create object-store CLUSTER_ID_OR_NAME --bucket-prefix mybucket
 
 # List add-ons with JSON output
-replicated cluster addon ls CLUSTER_ID --output json
+replicated cluster addon ls CLUSTER_ID_OR_NAME --output json
 ```
 
 ### Options

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

@@ -6,7 +6,7 @@ Create test clusters.
 
 The 'cluster create' command provisions a new test cluster with the specified Kubernetes distribution and configuration. You can customize the cluster's size, version, node groups, disk space, IP family, and other parameters.
 
-This command supports creating clusters on multiple Kubernetes distributions, including setting up node groups with different instance types and counts. You can also specify a TTL (Time-To-Live) to automatically terminate the cluster after a set duration.
+This command supports creating clusters on multiple Kubernetes distributions, including setting up node groups with different instance types and counts. You can also specify a TTL (Time-To-Live) to automatically terminate the cluster after a set duration. If no TTL is specified, the default TTL is 1 hour.
 
 Use the '--dry-run' flag to simulate the creation process and get an estimated cost without actually provisioning the cluster.