Docker-in-Docker (DinD) capabilities of public runners deactivated. More info

Commit f80cb89d authored by Fabio Hernandez's avatar Fabio Hernandez
Browse files

Simplify configuration instructions and document current available versions

parent 95126901
......@@ -14,10 +14,10 @@ With this method, you need to install and configure CernVM FS only once. Once th
This method of distributing the software is particularly useful for individuals: you don't need to install each official LSST software release by hand on your personal computer, but rather to automatically mount and use the binary distributions prepared for your convenience.
Please note that you don't need special privileges to use the LSST software stack distributed in this way: any user on a pre-configured computer can use the software. However, in order to install and configure CernVM FS, a one-time process, you need super-user privileges on the target machine.
Please note that you don't need special privileges to *use* the LSST software stack distributed in this way: any user on a pre-configured computer can use the software. However, in order to *install* and configure CernVM FS, a one-time process, you need super-user privileges on the client machine.
# Installation
So far we have tested this installation on Scientific Linux 6, Scientific Linux 7, CentOS 7 and Ubuntu 14.04. It may work on other platforms but we haven't verified that.
So far we have tested this installation on Scientific Linux 6, Scientific Linux 7, CentOS 7 and Ubuntu 14.04. It may work on other Linux platforms.
### Installing on Scientific Linux 6 and 7, CentOS 7 (64 bits)
To download the software from CERN's repository and install it, as `root` do:
......@@ -43,70 +43,18 @@ Download and install CernVM FS (as `root`):
# Configuration
The configuration of CernVM FS client to use the binary distribution of LSST software served by CC-IN2P3 is a *one-time operation*. It needs to be performed by user `root`.
* Run the utility:
* Clone this repository and run the provided configuration script. The configuration script needs super-user privileges for creating or modifying some configuration files under `/etc/cvmfs`. You must run it as `root`:
# cvmfs_config setup
$ cd /tmp
$ git clone https://github.com/airnandez/lsst-cvmfs.git
$ cd lsst-cvmfs
$ sudo sh ./configure.sh
After this step, among other things, an unprivileged user `cvmfs` is created in your computer and several configuration files with sensible default values are located under `/etc/cvmfs`.
The next steps modify the default configuration to the specifics of LSST repository hosted by CC-IN2P3.
* Create file `/etc/cvmfs/keys/lsst.in2p3.fr.pub`:
# cat > /etc/cvmfs/keys/lsst.in2p3.fr.pub <<-EOF
-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAxpOBi4YSHya9NLFyjwko
1QGO0cEbcN6JKMht8bfqUOsH/gdov8sUIlZ3XOzAqwHmb/F76QbtaftDXrJqwCXF
91YHUI2XvaOMlQmYamfxslUkvwgImCmEoMb6Q2bLYJFGQXcin0kV6Va2jFa9UyVW
mqQzRtYQDoM1rKwt0Nj+DblUddFS8GevSB/caZs/HhzJF6IO+et8H+KFiXptUC8L
hcvSNJUKV5T7topF2TF1J3/D03BbSJBMwu2PKffobvj6A/8cTNg0aNE0ZOIgg4c6
kPIRNLPW8ZkMHFct8IvUUPNFgcEYflqBtB6HmWJcVVZDTE600pgdir+Pdlqd17XF
AwIDAQAB
-----END PUBLIC KEY-----
EOF
This text file contains the public key of CC-IN2P3's software repository for LSST. The CernVM FS client running on your machine needs this key to verify that it is talking to the expected server.
* Create the file `/etc/cvmfs/default.local`:
# cat > /etc/cvmfs/default.local <<-EOF
CVMFS_REPOSITORIES=lsst.in2p3.fr
CVMFS_QUOTA_LIMIT=20000
# Default cache directory is '/var/lib/cvmfs' but you can change it by uncommenting
# and customizing the line below
# CVMFS_CACHE_BASE=/cvmfscache
EOF
This file tells the CernVM FS client to mount the repository named `lsst.in2p3.fr` and to use a local disk cache of up to 20.000 MB. By default, the local cache is located at `/var/lib/cvmfs` but you can use another directory on your local disk. For instance, if you wish CernVM FS cache to be located under `/cvmfscache` uncomment the line below:
CVMFS_CACHE_BASE=/cvmfscache
You can also modify the size of the disk cache CernVM FS should use. Please bear in mind that the current LSST stack (v9.2) requires about 7GB of disk space. As you may want to use a few releases simultaneously we think 20.000MB is a reasonable starting point but feel free to adapt it as you consider suitable for your particular needs.
* Create file `/etc/cvmfs/config.d/lsst.in2p3.fr.conf`:
# cat > /etc/cvmfs/config.d/lsst.in2p3.fr.conf <<-EOF
CVMFS_SERVER_URL="http://cccrnvmfs01.in2p3.fr/cvmfs/lsst.in2p3.fr"
CVMFS_HTTP_PROXY="http://cctbcrnvmfsli01.in2p3.fr:3128"
CVMFS_PUBLIC_KEY="/etc/cvmfs/keys/lsst.in2p3.fr.pub"
EOF
* Set the permissions of the files created in the previous steps:
# chmod 0444 /etc/cvmfs/keys/lsst.in2p3.fr.pub
# chmod 0644 /etc/cvmfs/default.local /etc/cvmfs/config.d/lsst.in2p3.fr.conf
* Check your configuration by running
# cvmfs_config chksetup
If everything is correct, this utility will print an explicit `OK` in which case you are ready to use LSST software stack. Otherwise, you will be presented with the relevant error message which will hopefully help you finding what's is wrong with your configuration.
* Restart `autofs` service so that it takes into account the modified configuration:
# service autofs restart
You can tell the configuration process was successful if you won't see any error message.
* Configure `autofs` to start at boot time. On Scientific Linux and CentOS do (as `root`):
* **[Recommended]** The CernVM FS client uses `autofs` for atuomatically mounting and unmounting the file system exposing the LSST software repository when needed. We suggest you to configure `autofs` to start at boot time. On Scientific Linux and CentOS do (as `root`):
# chkconfig autofs on
......@@ -114,17 +62,32 @@ The configuration of CernVM FS client to use the binary distribution of LSST sof
# sysv-rc-conf autofs on
This is necessary to automatically mount the remote repository under `/cvmfs/lsst.in2p3.fr` any time you access a file or directory under that namespace.
Now you are ready to use the stack.
Now you are ready to use the stack. See next section.
# Usage
In order to use the LSST software stack, you need to setup your environment for a specific version for which there is a binary distribution available. For instance, to use LSST v9.2 do:
$ cd /cvmfs/lsst.in2p3.fr/software/x86_64-slc6/lsst-v9.2
$ cd /cvmfs/lsst.in2p3.fr/software/linux-x86_64/lsst-v9.2
$ source loadLSST.sh
Note that you don't need super-user privileges to use this distribution of the LSST software. For testing your installation you can run the LSST demo, as documented [here](https://confluence.lsstcorp.org/display/LSWUG/Testing+the+Installation).
Note that you don't need super-user privileges to use this distribution of the LSST software. For testing your installation you can [run the LSST demo](https://confluence.lsstcorp.org/display/LSWUG/Testing+the+Installation).
# Available releases
At any moment, you can see what released are available for Linux-based machines by visiting the directory:
/cvmfs/lsst.in2p3.fr/software/linux-x86_64
The releases for MacOS X will be availabe under:
/cvmfs/lsst.in2p3.fr/software/darwin-x86_64
Currently you will find the releases presented in the table below:
| Platform | Available versions of LSST software |
| --------------------- | ------------ |
| Linux, x86_64, 64bits | v9.2, v10.1-rc3 |
| Darwin, x86_64, 64bits | v10.1-rc3 *(in preparation)* |
# Advanced usage
Details on how to use this distribution mechanism for more advanced use cases are provided in the [Advanced Usage](AdvancedUsage.md) document. There you will find details on how you can develop your own software package which depends on other packages already present in the binary distribution.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment