feat(ec): new data directory location and configuration (#2723)

* feat(ec): new data directory location and configuration

* docs edits

* docs edits

* Update docs/enterprise/installing-embedded.mdx

Co-authored-by: Alex Parker <[email protected]>

* undo rn change

---------

Co-authored-by: Paige Calvert <[email protected]>
Co-authored-by: Alex Parker <[email protected]>

Author: 3 people

docs/enterprise/installing-embedded.mdx

@@ -208,4 +208,25 @@ The Embedded Cluster host preflight checks verify the default ports or the user-
 
 ### 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).
+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 symlinked directories for the Embedded Cluster data directory. Use the `--data-dir` flag instead of symlinking `/var/lib/embedded-cluster`.

docs/enterprise/installing-general-requirements.mdx

@@ -1,7 +1,6 @@
 import DockerCompatibility from "../partials/image-registry/_docker-compatibility.mdx"
 import KubernetesCompatibility from "../partials/install/_kubernetes-compatibility.mdx"
 import EmbeddedClusterRequirements from "../partials/embedded-cluster/_requirements.mdx"
-import EmbeddedClusterStorageReqs from "../partials/embedded-cluster/_storage-reqs.mdx"
 import EmbeddedClusterPortRequirements from "../partials/embedded-cluster/_port-reqs.mdx"
 
 # Installation Requirements
@@ -259,10 +258,6 @@ To install with the Embedded Cluster installer, your environment must meet the f
 
 <EmbeddedClusterRequirements/>
 
-### Host Storage Requirements
-
-<EmbeddedClusterStorageReqs/>
-
 ### Port Requirements
 
 <EmbeddedClusterPortRequirements/>

docs/partials/embedded-cluster/_requirements.mdx

@@ -1,11 +1,17 @@
 * Linux operating system
+
 * x86-64 architecture
+
 * systemd
+
 * At least 2GB of memory and 2 CPU cores
-* Disk space requirements:
-  * The filesystem at `/var/lib/embedded-cluster` has 40Gi or more of total space
-  * The filesystem at `/var/lib/k0s` has 40Gi or more of total space and must be no more than 80% full
-  * The filesystem at `/var/openebs` has 5Gi or more of total space
-  * The filesystem at `/tmp` has 5Gi or more of total space
+
+* 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_.
+   :::
+
 * (Online installations only) Access to replicated.app and proxy.replicated.com or your custom domain for each
+
 * Embedded Cluster is based on k0s, so all k0s system requirements and external runtime dependencies apply. See [System requirements](https://docs.k0sproject.io/stable/system-requirements/) and [External runtime dependencies](https://docs.k0sproject.io/stable/external-runtime-deps/) in the k0s documentation.

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

@@ -18,7 +18,7 @@ To generate a support bundle:
     ((____!___/) Type 'exit' (or CTRL+d) to exit.
     \0\0\0\0\/  Happy hacking.
     ~~~~~~~~~~~
-    root@alex-ec-2:/home/alex# export KUBECONFIG="/var/lib/k0s/pki/admin.conf"
+    root@alex-ec-2:/home/alex# export KUBECONFIG="/var/lib/embedded-cluster/k0s/pki/admin.conf"
     root@alex-ec-2:/home/alex# export PATH="$PATH:/var/lib/embedded-cluster/bin"
     root@alex-ec-2:/home/alex# source <(kubectl completion bash)
     root@alex-ec-2:/home/alex# source /etc/bash_completion

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

@@ -2,7 +2,6 @@ import EmbeddedCluster from "../partials/embedded-cluster/_definition.mdx"
 import KurlComparison from "../partials/embedded-cluster/_kurl-comparison.mdx"
 import Requirements from "../partials/embedded-cluster/_requirements.mdx"
 import UpdateOverview from "../partials/embedded-cluster/_update-overview.mdx"
-import EmbeddedClusterStorageReqs from "../partials/embedded-cluster/_storage-reqs.mdx"
 import EmbeddedClusterSupportBundle from "../partials/support-bundles/_generate-bundle-ec.mdx"
 import EcConfig from "../partials/embedded-cluster/_ec-config.mdx"
 import EmbeddedClusterPortRequirements from "../partials/embedded-cluster/_port-reqs.mdx"
@@ -37,10 +36,6 @@ As shown in the diagram above, the Embedded Cluster Config is included in the ap
 
 <Requirements/>
 
-#### Host Storage Requirements
-
-<EmbeddedClusterStorageReqs/>
-
 #### Port Requirements
 
 <EmbeddedClusterPortRequirements/>
@@ -215,7 +210,7 @@ To access the cluster and use other included binaries:
     ((____!___/) Type 'exit' (or CTRL+d) to exit.
     \0\0\0\0\/  Happy hacking.
     ~~~~~~~~~~~
-    root@alex-ec-2:/home/alex# export KUBECONFIG="/var/lib/k0s/pki/admin.conf"
+    root@alex-ec-2:/home/alex# export KUBECONFIG="/var/lib/embedded-cluster/k0s/pki/admin.conf"
     root@alex-ec-2:/home/alex# export PATH="$PATH:/var/lib/embedded-cluster/bin"
     root@alex-ec-2:/home/alex# source <(kubectl completion bash)
     root@alex-ec-2:/home/alex# source /etc/bash_completion