Skip to content

Commit 2c7ea39

Browse files
committed
feat(ec): new data directory location and configuration
1 parent 15be48e commit 2c7ea39

File tree

5 files changed

+18
-9
lines changed

5 files changed

+18
-9
lines changed

docs/partials/embedded-cluster/_requirements.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@
44
* At least 2GB of memory and 2 CPU cores
55
* Disk space requirements:
66
* The filesystem at `/var/lib/embedded-cluster` has 40Gi or more of total space
7-
* The filesystem at `/var/lib/k0s` has 40Gi or more of total space and must be no more than 80% full
8-
* The filesystem at `/var/openebs` has 5Gi or more of total space
9-
* The filesystem at `/tmp` has 5Gi or more of total space
7+
* The filesystem at `/var/lib/embedded-cluster/k0s` has 40Gi or more of total space and must be no more than 80% full
8+
* The filesystem at `/var/lib/embedded-cluster/openebs-local` has 5Gi or more of total space
109
* (Online installations only) Access to replicated.app and proxy.replicated.com or your custom domain for each
1110
* 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

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
Embedded Cluster stores data in the following primary locations, all of which must be writable:
22

3+
The default location of the data directory can be modified by the user at install time by passing the `--data-dir` flag to the `install` command.
4+
This directory cannot be changed after the cluster is installed.
5+
6+
For example:
7+
8+
```bash
9+
sudo ./APP_SLUG install --data-dir /data/embedded-cluster --license license.yaml --airgap-bundle APP_SLUG.airgap
10+
```
11+
Where `APP_SLUG` is the unique application slug.
12+
313
:::note
414
Replicated does not support using symlinked directories for these locations. Instead, Replicated recommends bind mounts, which provide greater consistency across different applications, preserve the original directory permissions and ownership, and have less overhead compared to symlinks. For more information, see [Relocating data directories with bind mounts](https://community.replicated.com/t/relocating-data-directories-with-bind-mounts/1435) in Replicated Community.
515
:::
@@ -8,12 +18,11 @@ Replicated does not support using symlinked directories for these locations. Ins
818

919
- Used to store your installer
1020
- Includes:
11-
* Logs
1221
* Temporary files
1322
* Supporting binaries (for example, kubectl and Replicated’s preflight and support-bundle plugins)
1423
- Should be large enough to fit at least 2 installer binaries
1524

16-
#### `/var/lib/k0s`
25+
#### `/var/lib/embedded-cluster/k0s`
1726

1827
- Where the Kubernetes cluster runs
1928
- Includes:
@@ -29,7 +38,7 @@ Replicated does not support using symlinked directories for these locations. Ins
2938
- Calculation example:
3039
If the sum of required storage for logs, images, and components is X GB, the total allocated space should be at least X / 0.85 GB to ensure it remains below 85% utilization.
3140

32-
#### `/var/openebs`
41+
#### `/var/lib/embedded-cluster/openebs-local`
3342

3443
- Where PVC data is stored
3544
- Needs enough storage to support all volumes used in your application
@@ -65,5 +74,6 @@ In addition to the primary directories above, Embedded Cluster creates directori
6574
- /var/lib/kubelet
6675
- /var/log/calico
6776
- /var/log/containers
77+
- /var/log/embedded-cluster
6878
- /var/log/pods
6979
- /usr/local/bin/k0s

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ To generate a support bundle:
1818
((____!___/) Type 'exit' (or CTRL+d) to exit.
1919
\0\0\0\0\/ Happy hacking.
2020
~~~~~~~~~~~
21-
root@alex-ec-2:/home/alex# export KUBECONFIG="/var/lib/k0s/pki/admin.conf"
21+
root@alex-ec-2:/home/alex# export KUBECONFIG="/var/lib/embedded-cluster/k0s/pki/admin.conf"
2222
root@alex-ec-2:/home/alex# export PATH="$PATH:/var/lib/embedded-cluster/bin"
2323
root@alex-ec-2:/home/alex# source <(kubectl completion bash)
2424
root@alex-ec-2:/home/alex# source /etc/bash_completion

docs/release-notes/rn-embedded-cluster.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -277,7 +277,7 @@ Released on August 23, 2024
277277

278278
### Bug Fixes {#bug-fixes-1-11-0}
279279

280-
* Fixes several issues that caused node resets to fail. Single-node clusters are no longer drained before being reset. Resets will no longer fail with the error `unable to get installation` if the installation failed early on. And node resets will now work if bind mounts are used for `/var/lib/embedded-cluster`, `/var/lib/k0s`, and `/var/openebs`.
280+
* Fixes several issues that caused node resets to fail. Single-node clusters are no longer drained before being reset. Resets will no longer fail with the error `unable to get installation` if the installation failed early on. And node resets will now work if bind mounts are used for `/var/lib/embedded-cluster`, `/var/lib/embedded-cluster/k0s`, and `/var/lib/embedded-cluster/openebs-local`.
281281
* Fixes an issue where preflight checks for `modprobe`, `mount`, and `unmount` in `PATH` did not use absolute paths.
282282
* Fixes an issue where restoring did not work with S3-compatible object stores other than AWS S3.
283283

docs/vendor/embedded-overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ To access the cluster and use other included binaries:
215215
((____!___/) Type 'exit' (or CTRL+d) to exit.
216216
\0\0\0\0\/ Happy hacking.
217217
~~~~~~~~~~~
218-
root@alex-ec-2:/home/alex# export KUBECONFIG="/var/lib/k0s/pki/admin.conf"
218+
root@alex-ec-2:/home/alex# export KUBECONFIG="/var/lib/embedded-cluster/k0s/pki/admin.conf"
219219
root@alex-ec-2:/home/alex# export PATH="$PATH:/var/lib/embedded-cluster/bin"
220220
root@alex-ec-2:/home/alex# source <(kubectl completion bash)
221221
root@alex-ec-2:/home/alex# source /etc/bash_completion

0 commit comments

Comments
 (0)