Skip to content

Commit 9e97d4f

Browse files
committed
remove note, rearrange the sections, add section for larger systems
1 parent 020139c commit 9e97d4f

File tree

1 file changed

+16
-12
lines changed

1 file changed

+16
-12
lines changed

docs/getting_access/native_installation.md

+16-12
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Native installation
22

3+
## Installation for single clients
4+
35
Setting up native access to EESSI, that is a system-wide deployment that does not require workarounds like
46
[using a container](eessi_container.md), requires the installation and configuration of [CernVM-FS](https://cernvm.cern.ch/fs).
57

@@ -62,19 +64,21 @@ The good news is that all of this only requires a handful commands :astonished:
6264
sudo cvmfs_config setup
6365
```
6466

65-
!!! note
66-
67-
:point_up: The commands above only cover the basic installation of EESSI.
68-
69-
This is good enough for an individual client, or for testing purposes,
70-
but for a production-quality setup you should also set up a Squid proxy cache.
67+
## Installation for larger systems (e.g. clusters)
7168

72-
For large-scale systems, like an HPC cluster, you should also consider [setting up your own CernVM-FS Stratum 1 mirror server](../filesystem_layer/stratum1.md).
69+
When using CernVM-FS on a larger number of local clients, e.g. on a HPC cluster or set of workstations,
70+
it is very strongly recommended to at least set up some Squid proxies close to your clients.
71+
These Squid proxies will be used to cache content that was recently accessed by your clients,
72+
which reduces the load on the Stratum 1 servers and reduces the latency for your clients.
73+
As a rule of thumb, you should use about one proxy per 500 clients, and have a minimum of two.
74+
Instructions for setting up a Squid proxy can be found in the [CernVM-FS documentation](https://cvmfs.readthedocs.io/en/stable/cpt-squid.html) and
75+
in the [CernVM-FS tutorial](https://cvmfs-contrib.github.io/cvmfs-tutorial-2021/03_stratum1_proxies/#32-setting-up-a-proxy).
7376

74-
For more details on this, please refer to the
75-
[*Stratum 1 and proxies section* of the CernVM-FS tutorial](https://cvmfs-contrib.github.io/cvmfs-tutorial-2021/03_stratum1_proxies/).
77+
Additionally, setting up a private Stratum 1, which will make a full copy of the repository,
78+
can be beneficial to improve the latency and bandwidth even further, and to be better protected against network outages.
79+
Instructions for setting up your own EESSI Stratum 1 can be found in [setting up your own CernVM-FS Stratum 1 mirror server](../filesystem_layer/stratum1.md).
7680

77-
## Configuring your client to use a Squid proxy
81+
### Configuring your client to use a Squid proxy
7882

7983
If you have set up one or more Squid proxies, you will have to add them to your CernVM-FS client configuration.
8084
This can be done by removing `CVMFS_CLIENT_PROFILE="single"` from `/etc/cvmfs/default.local`, and add the following line:
@@ -86,7 +90,7 @@ CVMFS_HTTP_PROXY="http://ip-of-your-1st-proxy:port|http://ip-of-your-2nd-proxy:p
8690
In this case, both proxies are equally preferable.
8791
More advanced use cases can be found in [the CernVM-FS documentation](https://cvmfs.readthedocs.io/en/stable/cpt-configure.html#proxy-list-examples).
8892

89-
## Configuring your client to use a private Stratum 1 mirror server
93+
### Configuring your client to use a private Stratum 1 mirror server
9094

9195
If you have set up your own Stratum 1 mirror server that replicates the EESSI CernVM-FS repositories,
9296
you can instruct your CernVM-FS client(s) to use it by prepending your newly created Stratum 1 to the existing list of EESSI Stratum 1 servers by creating a local CVMFS configuration file for the EESSI domain:
@@ -100,7 +104,7 @@ echo 'CVMFS_SERVER_URL="http://<url-or-ip-to-your-stratum1>/cvmfs/@fqrn@;$CVMFS_
100104
In case of downtime of your private Stratum 1, they will also still be able to make use of the public EESSI Stratum 1 servers.
101105

102106

103-
## Applying changes in the CernVM-FS client configuration files
107+
### Applying changes in the CernVM-FS client configuration files
104108

105109
After you have made any changes to the CernVM-FS client configuration, you will have to apply them.
106110
If this is the first time you set up the client, you can simply run:

0 commit comments

Comments
 (0)