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: fuse-overlayfs configuration #2685

Merged
merged 30 commits into from
Feb 22, 2024
Merged

feat: fuse-overlayfs configuration #2685

merged 30 commits into from
Feb 22, 2024

Conversation

dkwon17
Copy link
Contributor

@dkwon17 dkwon17 commented Feb 15, 2024

What does this pull request change?

Adds documentation for enabling fuse-overlayfs for Podman in workspaces, based on @cgruver 's blog post: https://upstreamwithoutapaddle.com/blog%20post/2023/08/10/Podman-In-Dev-Spaces-With-Fuse-Overlay.html

What issues does this pull request fix or reference?

https://issues.redhat.com/browse/CRW-3397

Specify the version of the product this pull request applies to

Any supported version

Pull Request checklist

The author and the reviewers validate the content of this pull request with the following checklist, in addition to the automated tests.

  • Any procedure:
    • Successfully tested.
  • Any page or link rename:
    • The page contains a redirection for the previous URL.
    • Propagate the URL change in:
  • Builds on Eclipse Che hosted by Red Hat.
  • the Validate language on files added or modified step reports no vale warnings.

Copy link

github-actions bot commented Feb 15, 2024

Click here to review and test in web IDE: Contribute

Copy link

github-actions bot commented Feb 15, 2024

🎊 Navigate the preview: https://65d76eb95f14be008569f48b--eclipse-che-docs-pr.netlify.app 🎊

Signed-off-by: dkwon17 <[email protected]>
Signed-off-by: dkwon17 <[email protected]>
<6> List of devices on the host that a user can specify with the `io.kubernetes.cri-o.Devices` annotation.

. After applying the `MachineConfig` resource, scheduling will be temporarily disabled for each node with the `worker` role as changes are applied. View the nodes' statuses.
+
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm having trouble with the indentation for this section, as the numbering for the next step resets to 1 (red circle):
Screenshot from 2024-02-15 10-43-23-edit

Any ideas on how I can fix it @deerskindoll ?

Copy link
Contributor

Choose a reason for hiding this comment

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

let's see how the formatting looks with added + in the empty lines

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've applied the changes, however it is still having issues:
Screenshot from 2024-02-16 11-21-23

Copy link
Contributor

Choose a reason for hiding this comment

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

got it, I'll look into it

@dkwon17 dkwon17 marked this pull request as ready for review February 15, 2024 15:56
@dkwon17 dkwon17 requested review from deerskindoll and a team as code owners February 15, 2024 15:56
@dkwon17 dkwon17 requested a review from tolusha February 15, 2024 15:56
Signed-off-by: dkwon17 <[email protected]>
Copy link
Contributor

@deerskindoll deerskindoll left a comment

Choose a reason for hiding this comment

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

formatting fix (I hope)

<6> List of devices on the host that a user can specify with the `io.kubernetes.cri-o.Devices` annotation.

. After applying the `MachineConfig` resource, scheduling will be temporarily disabled for each node with the `worker` role as changes are applied. View the nodes' statuses.
+
Copy link
Contributor

Choose a reason for hiding this comment

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

let's see how the formatting looks with added + in the empty lines

----
cat << EOF | butane | oc apply -f -
variant: openshift
version: 4.12.0
Copy link
Contributor

Choose a reason for hiding this comment

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

Is it OpenShift version?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is the OpenShift butane config version: https://coreos.github.io/butane/upgrading-openshift/

Since version 4.12.0 is compatible with 4.13.0 and 4.14.0, I kept the version to 4.12.0

Copy link
Contributor Author

Choose a reason for hiding this comment

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

For OpenShift >= 4.15, we do not need the MachineConfig to enable fuse overlay. I plan to provide a new PR to update the docs and merge it when OpenShift 4.15 is available

Copy link
Contributor

@tolusha tolusha left a comment

Choose a reason for hiding this comment

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

Tested

Copy link
Contributor

@deerskindoll deerskindoll left a comment

Choose a reason for hiding this comment

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

I changed the passive voice to active in many places. please check out the edits.

dkwon17 and others added 13 commits February 20, 2024 14:46
Signed-off-by: dkwon17 <[email protected]>
@dkwon17
Copy link
Contributor Author

dkwon17 commented Feb 21, 2024

Thank you @deerskindoll , I've applied the changes, although I do still see some formatting issues for the bullet points and numbered list in the administration page:

Example 1

Screenshot from 2024-02-20 18-11-33

Example 2

Screenshot from 2024-02-20 18-12-32

@deerskindoll
Copy link
Contributor

Thank you @deerskindoll , I've applied the changes, although I do still see some formatting issues for the bullet points and numbered list in the administration page:

I set those aside for a moment. I'll get back to the formatting issues now.

@dkwon17
Copy link
Contributor Author

dkwon17 commented Feb 21, 2024

Thank you @deerskindoll, the indentation fix you suggested works well.

I've also added a new commit to mention Buildah alongside Podman

Copy link
Contributor

@deerskindoll deerskindoll left a comment

Choose a reason for hiding this comment

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

lgtm

Signed-off-by: dkwon17 <[email protected]>
@dkwon17 dkwon17 merged commit 1f9ecf7 into eclipse-che:main Feb 22, 2024
6 checks passed
deerskindoll added a commit that referenced this pull request Mar 1, 2024
* feat: fuse-overlayfs configuration

Signed-off-by: dkwon17 <[email protected]>

* Update

Signed-off-by: dkwon17 <[email protected]>

* Indentation

Signed-off-by: dkwon17 <[email protected]>

* Update

Signed-off-by: dkwon17 <[email protected]>

* Update modules/administration-guide/pages/configuring-fuse.adoc

Co-authored-by: Jana Vrbkova <[email protected]>

* Update modules/administration-guide/pages/configuring-fuse.adoc

Co-authored-by: Jana Vrbkova <[email protected]>

* Update butane version

Signed-off-by: dkwon17 <[email protected]>

* Update modules/administration-guide/pages/configuring-fuse.adoc

Co-authored-by: Jana Vrbkova <[email protected]>

* Update modules/administration-guide/pages/configuring-fuse.adoc

Co-authored-by: Jana Vrbkova <[email protected]>

* Update modules/administration-guide/pages/configuring-fuse.adoc

Co-authored-by: Jana Vrbkova <[email protected]>

* Update modules/administration-guide/pages/configuring-fuse.adoc

Co-authored-by: Jana Vrbkova <[email protected]>

* Update modules/administration-guide/pages/configuring-fuse.adoc

Co-authored-by: Jana Vrbkova <[email protected]>

* Update modules/administration-guide/pages/configuring-fuse.adoc

Co-authored-by: Jana Vrbkova <[email protected]>

* Update modules/administration-guide/pages/configuring-fuse.adoc

Co-authored-by: Jana Vrbkova <[email protected]>

* Update modules/administration-guide/pages/configuring-fuse.adoc

Co-authored-by: Jana Vrbkova <[email protected]>

* Update modules/administration-guide/pages/configuring-fuse.adoc

Co-authored-by: Jana Vrbkova <[email protected]>

* Update modules/administration-guide/pages/configuring-fuse.adoc

Co-authored-by: Jana Vrbkova <[email protected]>

* Update modules/end-user-guide/pages/accessing-fuse.adoc

Co-authored-by: Jana Vrbkova <[email protected]>

* Update modules/end-user-guide/pages/accessing-fuse.adoc

Co-authored-by: Jana Vrbkova <[email protected]>

* Update modules/end-user-guide/pages/enabling-overlay-with-a-configmap.adoc

Co-authored-by: Jana Vrbkova <[email protected]>

* Update modules/end-user-guide/pages/using-the-fuse-overlay-storage-driver.adoc

Co-authored-by: Jana Vrbkova <[email protected]>

* Update modules/end-user-guide/pages/enabling-overlay-with-a-configmap.adoc

Co-authored-by: Jana Vrbkova <[email protected]>

* Update modules/end-user-guide/pages/enabling-overlay-with-a-configmap.adoc

Co-authored-by: Jana Vrbkova <[email protected]>

* Update modules/end-user-guide/pages/using-the-fuse-overlay-storage-driver.adoc

Co-authored-by: Jana Vrbkova <[email protected]>

* Update modules/end-user-guide/pages/enabling-overlay-with-a-configmap.adoc

Co-authored-by: Jana Vrbkova <[email protected]>

* Update modules/end-user-guide/pages/enabling-overlay-with-a-configmap.adoc

Co-authored-by: Jana Vrbkova <[email protected]>

* Update prerequisites

Signed-off-by: dkwon17 <[email protected]>

* Fix indentation formatting

Signed-off-by: dkwon17 <[email protected]>

* Mention Buildah

Signed-off-by: dkwon17 <[email protected]>

* Fix build

Signed-off-by: dkwon17 <[email protected]>

---------

Signed-off-by: dkwon17 <[email protected]>
Co-authored-by: Jana Vrbkova <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

5 participants