Skip to content

some small fixes to the client #459

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

some small fixes to the client #459

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 13 additions & 4 deletions docs/tutorial/access/client.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ which should contain something like:

``` { .ini .copy }
CVMFS_CLIENT_PROFILE="single" # a single node setup, not a cluster
CVMFS_QUOTA_LIMIT=10000
CVMFS_QUOTA_LIMIT=10000 # 10 GB of local client cache, shared
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
CVMFS_QUOTA_LIMIT=10000 # 10 GB of local client cache, shared
CVMFS_QUOTA_LIMIT=10000 # 10 GB of local client cache, shared across repos

```

More information on the structure of `/etc/cvmfs` and supported configuration settings is available
Expand Down Expand Up @@ -124,10 +124,15 @@ More information on the structure of `/etc/cvmfs` and supported configuration se
can be considered if enough memory is available in the client system, which would
help reduce latency and start-up performance of software.

**IMPORTANT**: CernVM-FS is only aware about its own space-usage of the cache. It does not reserve it on the partition.
If another program uses more space on the partition, the CernVM-FS Cache Manager will eventually run out of space and crash.
As such, it is the system administrator responsibility of making sure that CernVM-FS will always have enough caching space available (if in doubt: put it on its own partition).

For more information on cache-related configuration settings,
[see the CernVM-FS documentation](https://cvmfs.readthedocs.io/en/stable/cpt-configure.html#cache-settings).

### Hierarchy of configuration files {: #configuration_hierarchy }
!!! danger "never heard anyone call them parameter files? maybe not needed?"

CernVM-FS can be configured through a *hierarchy* of configuration files (sometimes also referred to as
parameter files), which can be located under either `/etc/cvmfs`, or the [CernVM-FS configuration repository](
Comment on lines +135 to 138
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
!!! danger "never heard anyone call them parameter files? maybe not needed?"
CernVM-FS can be configured through a *hierarchy* of configuration files (sometimes also referred to as
parameter files), which can be located under either `/etc/cvmfs`, or the [CernVM-FS configuration repository](
CernVM-FS can be configured through a *hierarchy* of configuration files,
which can be located under either `/etc/cvmfs`, or the [CernVM-FS configuration repository](

Expand All @@ -146,7 +151,7 @@ it specifies, in the order outlined below:

* By level: first general, then domain-specific, finally repository-specific;
* Within each level:
* `.conf` before `.local`;
* `.local` has priority over `.conf`;
* CernVM-FS configuration repository before `/etc/cvmfs` (except for general level);

As a result, a configuration file that is picked up later can override configuration settings
Expand Down Expand Up @@ -226,6 +231,8 @@ update the `autofs` configuration.

### Recommendations for `autofs` {: #autofs }

!!! danger "is this still recommended?"
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
!!! danger "is this still recommended?"

I think there are still situations where autofs unmounting repos can cause trouble.

Maybe @vvolkl or @jblomer can pitch in?

Copy link

Choose a reason for hiding this comment

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

No, the linked issue does no longer apply, I think. There may be circumstances with bind-mounts into containers, let me double-check that


It is recommended to configure `autofs` to *never unmount* repositories due to inactivity,
since that [can cause problems in specific situations](https://github.com/cvmfs/cvmfs/issues/3402).

Expand Down Expand Up @@ -337,10 +344,10 @@ Seems like CernVM-FS is not running in /var/lib/cvmfs/shared (not found: /var/li

## Accessing a repository

To access the contents of the repository, just use the corresponding subdirectory as if it were a local filesystem.
To access the contents of the repository, just use the corresponding subdirectory as if it were a local file system.

While the contents of the files you are accessing are not actually available on the client system the first time
they are being accessed, CernVM-FS will automatically downloaded them in the background, providing the illusion
they are being accessed, CernVM-FS will automatically download them in the background, providing the illusion
that the whole repository is already there.

We like to refer to this as "streaming" of software installations, much like streaming music or video services.
Expand All @@ -351,6 +358,8 @@ To start using EESSI just [source the initialisation script](../eessi/using-eess
source /cvmfs/software.eessi.io/versions/2023.06/init/bash
```

!!! danger "update link to latest version? maybe add to eessi a symlink /cvmfs/software.eessi.io/versions/latest/init/bash"
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
!!! danger "update link to latest version? maybe add to eessi a symlink /cvmfs/software.eessi.io/versions/latest/init/bash"

For now this is still the only version we had. We actually used to have a latest symlink, but we stopped doing that because figuring out when to update the target of that is ... challenging.

Copy link

Choose a reason for hiding this comment

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

Sounds reasonable. And for the tutorial even an old version would work.



You may notice some "lag" when files are being accessed, or not, depending on the network latency.

Expand Down