Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Oct 10, 2024
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2c7ea39
feat(ec): new data directory location and configuration
emosbaugh Oct 4, 2024
e64ec2c
docs edits
paigecalvert Oct 8, 2024
ff80bf4
docs edits
paigecalvert Oct 8, 2024
212a304
Update docs/enterprise/installing-embedded.mdx
paigecalvert Oct 8, 2024
ba3820f
undo rn change
paigecalvert Oct 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion docs/enterprise/installing-embedded.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Copy link
Contributor

@paigecalvert paigecalvert Oct 8, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

^ Added "Change the Default Data Directory" section in the Embedded Cluster online install topic next just below the existing section of the changing the default kotsadm/LAM ports


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
Copy link
Contributor

@paigecalvert paigecalvert Oct 8, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

^ Added limitations related to changing the default dir, including that you have to use the same dir during a restore


* 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`.
5 changes: 0 additions & 5 deletions docs/enterprise/installing-general-requirements.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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/>
Expand Down
16 changes: 11 additions & 5 deletions docs/partials/embedded-cluster/_requirements.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Copy link
Contributor

@paigecalvert paigecalvert Oct 8, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

^ Updated the disk space requirements to clarify that you just need the embedded-cluster dir with 40gi+ of space and 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.
69 changes: 0 additions & 69 deletions docs/partials/embedded-cluster/_storage-reqs.mdx
View file
Open in desktop
Copy link
Contributor

@paigecalvert paigecalvert Oct 8, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With the change that all data is stored in the /var/lib/embedded-cluster dir, it seemed like this whole storage requirements partial could be removed. I'm thinking that if there's anything from this that we want to tell people (like some examples of what's stored in /var/lib/embedded-cluster), I could add that to the disk storage requirement

This file was deleted.

2 changes: 1 addition & 1 deletion docs/partials/support-bundles/_generate-bundle-ec.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
7 changes: 1 addition & 6 deletions docs/vendor/embedded-overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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/>
Expand Down Expand Up @@ -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
Expand Down