Skip to content

Commit 6b3009d

Browse files
authored
Merge pull request #61 from bedroge/adv_improvements
Improvements for advanced section
2 parents 8e38fac + fd3f232 commit 6b3009d

File tree

1 file changed

+24
-12
lines changed

1 file changed

+24
-12
lines changed

docs/05_advanced.md

Lines changed: 24 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@ If you are experiencing issues with your CernVM-FS setup, there are various ways
1717
Most issues are caused by wrongly configured clients (either a configuration issue, or a wrong public key)
1818
and connection or firewall issues.
1919

20-
### 5.2.1 Debugging with `cvmfs_config`
20+
### 5.2.1 Debugging with `cvmfs_config` on the client machine
2121

2222
In order to find the cause of the issue, you should first find out *where* the issue is being caused.
23-
You can start by checking the client configuration:
23+
You can start by checking the configuration on your client machine by running:
2424

2525
```bash
2626
sudo cvmfs_config chksetup
@@ -47,7 +47,7 @@ Probing /cvmfs/repo.organization.tld... OK
4747

4848
However, since you are debugging a problem, it probably returns an error...
4949

50-
So, let's enable some debugging output by adding the following line to your `/etc/cvmfs/default.local`:
50+
So, let's enable some debugging output by adding the following line to your client's `/etc/cvmfs/default.local`:
5151
```
5252
CVMFS_DEBUGLOG=/path/to/cvmfs.log
5353
```
@@ -74,7 +74,7 @@ If the problem turns out to be some kind of connection issue, you can trace it d
7474
by manually checking the connections from your client to the proxy and/or Stratum 1 server.
7575

7676
First, let's rule out that it is some kind of firewall issue by verifying that you can actually
77-
connect to the appropriate ports on those servers:
77+
connect from your client to the appropriate ports on those servers:
7878

7979
```bash
8080
telnet <PROXY_IP> 3128
@@ -83,8 +83,8 @@ telnet <STRATUM1_IP> 80
8383

8484
If this does work, probably something is wrong with the services running on these machines.
8585

86-
Every CernVM-FS repository has a file named `.cvmfspublished`, and you can try to fetch it manually
87-
using `curl`, both directly from the Stratum 1 and via your proxy:
86+
Every CernVM-FS repository has a file named `.cvmfspublished`, and you can use `curl` on your client
87+
to fetch it manually, both directly from the Stratum 1 and via your proxy:
8888

8989
```bash
9090
# Without your own proxy, so directly to the Stratum 1:
@@ -249,8 +249,10 @@ To start the gateway service, use:
249249
systemctl start cvmfs-gateway
250250
```
251251

252-
Note that once this service is running you should *not* open transactions on this Stratum 0 server anymore,
253-
or you may corrupt the repository. If you do want to open a transaction, stop the gateway service first!
252+
!!! warning
253+
If you do run the gateway service on a different machine than the Stratum 0,
254+
make sure to *not* open transactions on your Stratum 0 server anymore, unless you stop the gateway service first.
255+
Otherwise, you may corrupt the repository.
254256

255257
### 5.4.2 Publisher
256258

@@ -260,10 +262,11 @@ There a no special requirements for a publisher system with respect to resources
260262

261263
***Installation***
262264

263-
The publisher only needs to have the `cvmfs-server` package installed:
265+
The publisher needs to have the `cvmfs` and `cvmfs-server` packages installed:
264266
```
267+
sudo yum install -y epel-release # not needed on CentOS 8
265268
sudo yum install -y https://ecsft.cern.ch/dist/cvmfs/cvmfs-release/cvmfs-release-latest.noarch.rpm
266-
sudo yum install -y cvmfs-server
269+
sudo yum install -y cvmfs-server cvmfs
267270
```
268271

269272
***Configuration***
@@ -275,7 +278,11 @@ The publisher machine only needs three files with keys:
275278
- the gateway API key stored in a file named `repo.organization.tld.gw`.
276279

277280
The first two files can be taken from `/etc/cvmfs/keys` on your Stratum 0 server.
278-
The latter can be created manually and should just contain the secret that was used in the gateway configuration.
281+
The latter can be created manually and should just contain the following:
282+
```
283+
plain_text <KEY_ID> <SECRET>
284+
```
285+
Make sure that `<KEY_ID>` and `<SECRET>` correspond to the values you have entered in the gateway configuration.
279286

280287
All these files should be placed in some (temporary) directory on the publisher system.
281288

@@ -300,7 +307,12 @@ You should now be able to make changes to the repository by starting a transacti
300307
cvmfs_server transaction repo.organization.tld
301308
```
302309

303-
making some changes to the repository at `/cvmfs/repo.organization.tld`, and then publishing the changes:
310+
You can also request a lock on only a subtree of the repository, so that other publishers can still change different parts of the repository:
311+
```bash
312+
cvmfs_server transaction repo.organization.tld/some/subdir
313+
```
314+
315+
When you are done, publish the changes:
304316

305317
```bash
306318
cvmfs_server publish repo.organization.tld

0 commit comments

Comments
 (0)