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

Add FAQ page to docs #1390

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

Add FAQ page to docs #1390

wants to merge 3 commits into from

Conversation

tsalo
Copy link
Member

@tsalo tsalo commented Feb 7, 2025

Changes proposed in this pull request

Documentation that should be reviewed

@tsalo tsalo added the documentation Improvements or additions to documentation label Feb 7, 2025
Copy link

codecov bot commented Feb 7, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.14%. Comparing base (91afe6a) to head (e0130d7).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1390   +/-   ##
=======================================
  Coverage   78.14%   78.14%           
=======================================
  Files          58       58           
  Lines        7249     7249           
  Branches      957      957           
=======================================
  Hits         5665     5665           
  Misses       1307     1307           
  Partials      277      277           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@singlesp
Copy link
Contributor

singlesp commented Feb 7, 2025

@tsalo I want to probably move this rare edge case to faq rather than have it be the second thing a user sees after getting to the section on how to run xcp-d with apptainer:

Home Directory Handling in Apptainer

When running XCP-D through Apptainer, the handling of home directories requires special attention. Here's what you need to know:

Default Behavior

By default, Apptainer will:

  1. Mount your host system's home directory into the container at /home/$USER
  2. Set the container's $HOME environment variable to this location

Potential Issues

This default behavior can cause problems on some systems, particularly in HPC environments where home directory permissions or configurations may be restricted.

Workaround

If you encounter home directory-related issues, you can explicitly control the home directory handling with these Apptainer arguments:

.. code-block:: bash

apptainer run
-B $HOME \ # Mount host's home directory to your $HOME in container
--home $HOME \ # Set container's $HOME to your $HOME directory
--cleanenv xcp_d-.simg
<xcp_d arguments>

.. note::
Check with your system administrator if you're unsure about your system's Apptainer configuration or if you encounter permission issues.

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

Successfully merging this pull request may close these issues.

2 participants