Skip to content
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.

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

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

emosbaugh
Copy link
Member

No description provided.

@emosbaugh emosbaugh requested a review from a team as a code owner October 4, 2024 21:30
Copy link

netlify bot commented Oct 4, 2024

Deploy Preview for replicated-docs ready!

Name Link
🔨 Latest commit ff80bf4
🔍 Latest deploy log https://app.netlify.com/sites/replicated-docs/deploys/67055f8cc3022900081feed5
😎 Deploy Preview https://deploy-preview-2723--replicated-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

netlify bot commented Oct 4, 2024

Deploy Preview for replicated-docs-upgrade ready!

Name Link
🔨 Latest commit ff80bf4
🔍 Latest deploy log https://app.netlify.com/sites/replicated-docs-upgrade/deploys/67055f8caa85c60008cd6145
😎 Deploy Preview https://deploy-preview-2723--replicated-docs-upgrade.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@replicated-ci replicated-ci added the type::docs Improvements or additions to documentation label Oct 4, 2024
@emosbaugh emosbaugh requested a review from ajp-io October 4, 2024 22:28
paigecalvert
paigecalvert previously approved these changes Oct 4, 2024
@ajp-io
Copy link
Member

ajp-io commented Oct 7, 2024

@paigecalvert We can talk tomorrow, but we can make a few changes here:

  • We moved all of our main data to /var/lib/embedded-cluster, so we don't really need to document /var/lib/embedded-cluster/k0s, /var/lib/embedded-cluster/openebs-local, or /tmp anymore. We can just mention /var/lib/embedded-cluster, which needs to be at least 40 Gi and less than 80% full.
  • I wonder if the --data-dir flag should be documented outside of the requirements section. Maybe requirements just say a 40 Gi installation directory, and mention that we use /var/lib/embedded-cluster by default, but the user can choose an alternative with --data-dir. Like what we do for the ports.

@emosbaugh
Copy link
Member Author

Additionally, we could add a limitation that if you use an alternate data-dir, you must use the same location when restoring.

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

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

Where `APP_SLUG` is the unique application slug.

### Limtiations
Copy link
Contributor

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 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

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type::docs Improvements or additions to documentation type::feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants