Skip to content

Commit 01f915b

Browse files
committed
Update README for client packages
1 parent bc70d89 commit 01f915b

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,8 @@ ansible-playbook -b -K -e @inventory/local_site_specific_vars.yml localproxy.yml
135135
```
136136

137137
### Clients
138+
139+
#### Method 1: Ansible
138140
Make sure that your hosts file contains the list of hosts where the CVMFS client should be installed.
139141
Furthermore, you can define a list of (local) proxy servers
140142
that your clients should use in `inventory/local_site_specific_vars.yml` using the parameter `local_cvmfs_http_proxies`.
@@ -146,6 +148,30 @@ Finally, run the playbook:
146148
ansible-playbook -b -K -e @inventory/local_site_specific_vars.yml client.yml
147149
```
148150

151+
#### Method 2: Packages
152+
On many operating systems the CVMFS client can be installed through your package manager.
153+
For details, see the [Getting Started page](https://cvmfs.readthedocs.io/en/stable/cpt-quickstart.html)
154+
in the documentation.
155+
156+
After installing the client, you will have to configure it.
157+
For this you can use the CVMFS configuration packages that we provide for clients.
158+
These packages can be found on the [Releases](https://github.com/eessi/filesystem-layer/releases) page.
159+
Download the package for your operating system, and install it, e.g.:
160+
```
161+
rpm -i cvmfs-config-eessi-*.rpm
162+
dpkg -i cvmfs-config-eessi-*.rpm
163+
```
164+
165+
Finally, you need to make a file `/etc/cvmfs/default.local` manually; this file is used for local settings and
166+
contains, for instance, the URL to your local proxy and the size of the local cache. As an example, you can put
167+
the following in this file, which corresponds to not using a proxy and setting the local quota limit to 40000MB:
168+
```
169+
CVMFS_HTTP_PROXY=DIRECT
170+
CVMFS_QUOTA_LIMIT=40000
171+
```
172+
173+
Admin note: for building the client configuration packages, see
174+
149175
## Verification and usage
150176

151177
### Client
@@ -198,3 +224,12 @@ touch /cvmfs/pilot.eessi-hpc.org/testdir/testfile
198224
sudo cvmfs_server publish pilot.eessi-hpc.org
199225
```
200226
It might take a few minutes, but then the new file should show up at the clients.
227+
228+
229+
## Building the CVMFS configuration packages
230+
231+
For each push and pull request to the master branch, packages are automatically built by a Github Action.
232+
The resulting (unversioned) packages can be found as build artifacts on the page of each run of this action.
233+
When a new tag is created to mark a versioned release of the repository (e.g. `v1.2.3`, where the `v` is required!),
234+
the action builds a package with the same version number, creates a release, and stores the packages
235+
as release assets.

0 commit comments

Comments
 (0)