Skip to content

Commit 78db71e

Browse files
vvolklvvolkl
authored
use tabsets in quickstart instructions (#222)
* use tabsets in quickstart instructions * use tabsets in quickstart instructions
1 parent 848a245 commit 78db71e

File tree

3 files changed

+75
-61
lines changed

3 files changed

+75
-61
lines changed

‎conf.py

+1
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@
3434
'sphinxcontrib.mermaid',
3535
'sphinx_rtd_theme',
3636
'sphinxcontrib.cairosvgconverter',
37+
'sphinx_design',
3738
]
3839

3940
# Add any paths that contain templates here, relative to this directory.

‎cpt-quickstart.rst

+71-61
Original file line numberDiff line numberDiff line change
@@ -21,103 +21,113 @@ Getting the Software
2121
The CernVM-FS source code and binary packages are available from the `CernVM website <https://cernvm.cern.ch/portal/filesystem/downloads>`_.
2222
However, it is recommended to use the available package repositories that are also provided for the supported operating systems.
2323

24-
Scientific Linux/CentOS
25-
~~~~~~~~~~~~~~~~~~~~~~~
26-
To add the CVMFS repository and install CVMFS run
24+
Linux
25+
~~~~~~~~~~~~~~~~
2726

28-
::
27+
To add the CVMFS repository (available for Debian and RHEL flavors) and install CVMFS, run:
2928

30-
sudo yum install https://ecsft.cern.ch/dist/cvmfs/cvmfs-release/cvmfs-release-latest.noarch.rpm
31-
sudo yum install -y cvmfs
3229

33-
Debian/Ubuntu
34-
~~~~~~~~~~~~~
35-
To add the CVMFS repository and install CVMFS run
30+
.. tab-set::
3631

37-
::
32+
.. tab-item:: Scientific Linux / RHEL / Alma
3833

39-
wget https://ecsft.cern.ch/dist/cvmfs/cvmfs-release/cvmfs-release-latest_all.deb
40-
sudo dpkg -i cvmfs-release-latest_all.deb
41-
rm -f cvmfs-release-latest_all.deb
42-
sudo apt-get update
43-
sudo apt-get install cvmfs
34+
.. code-block:: console
4435
45-
Fedora
46-
~~~~~~
47-
To install the CVMFS package run
36+
sudo yum install https://ecsft.cern.ch/dist/cvmfs/cvmfs-release/cvmfs-release-latest.noarch.rpm
37+
sudo yum install -y cvmfs
4838
49-
::
39+
.. tab-item:: Debian/Ubuntu
40+
41+
.. code-block:: console
42+
43+
wget https://ecsft.cern.ch/dist/cvmfs/cvmfs-release/cvmfs-release-latest_all.deb
44+
sudo dpkg -i cvmfs-release-latest_all.deb
45+
rm -f cvmfs-release-latest_all.deb
46+
sudo apt-get update
47+
sudo apt-get install cvmfs
5048
51-
sudo dnf install https://ecsft.cern.ch/dist/cvmfs/cvmfs-2.11.0/cvmfs-2.11.0-1.fc34.x86_64.rpm https://ecsft.cern.ch/dist/cvmfs/cvmfs-config/cvmfs-config-default-latest.noarch.rpm http://ecsft.cern.ch/dist/cvmfs/cvmfs-2.11.0/cvmfs-libs-2.11.0-1.fc34.x86_64.rpm
5249
50+
.. tab-item:: Fedora
5351

54-
Docker Container
52+
.. code-block:: console
53+
54+
sudo dnf install https://ecsft.cern.ch/dist/cvmfs/cvmfs-2.11.0/cvmfs-2.11.0-1.fc34.x86_64.rpm \
55+
https://ecsft.cern.ch/dist/cvmfs/cvmfs-config/cvmfs-config-default-latest.noarch.rpm \
56+
http://ecsft.cern.ch/dist/cvmfs/cvmfs-2.11.0/cvmfs-libs-2.11.0-1.fc34.x86_64.rpm
57+
58+
59+
Other Platforms
5560
~~~~~~~~~~~~~~~~
5661

57-
The CernVM-FS service container can expose the ``/cvmfs`` directory tree to the host.
58-
Import the container with
62+
.. tab-set::
5963

60-
::
64+
.. tab-item:: Service Container
6165

62-
docker pull registry.cern.ch/cvmfs/service:latest
66+
The CernVM-FS service container can expose the ``/cvmfs`` directory tree to the host.
67+
Import the container with
6368

64-
or with
69+
.. code-block:: console
6570
66-
::
71+
docker pull registry.cern.ch/cvmfs/service:latest
6772
68-
curl https://ecsft.cern.ch/dist/cvmfs/cvmfs-2.11.0/cvmfs-service-2.11.0-1.x86_64.docker.tar.gz | docker load
73+
or with
6974

70-
Run the container as a system service with
75+
.. code-block:: console
7176
72-
::
77+
curl https://ecsft.cern.ch/dist/cvmfs/cvmfs-2.11.0/cvmfs-service-2.11.0-1.x86_64.docker.tar.gz | docker load
7378
74-
docker run -d --rm \
75-
-e CVMFS_CLIENT_PROFILE=single \
76-
-e CVMFS_REPOSITORIES=sft.cern.ch,... \
77-
--cap-add SYS_ADMIN \
78-
--device /dev/fuse \
79-
--volume /cvmfs:/cvmfs:shared \
80-
cvmfs/service:2.8.0-1
79+
Run the container as a system service with
8180

82-
Use ``docker stop`` to unmount the ``/cvmfs`` tree.
81+
.. code-block:: console
8382
84-
.. note::
85-
If you run multiple nodes (a cluster), use ``-e CVMFS_HTTP_PROXY`` to set a proper site proxy as described further down.
83+
docker run -d --rm \
84+
-e CVMFS_CLIENT_PROFILE=single \
85+
-e CVMFS_REPOSITORIES=sft.cern.ch,... \
86+
--cap-add SYS_ADMIN \
87+
--device /dev/fuse \
88+
--volume /cvmfs:/cvmfs:shared \
89+
cvmfs/service:2.8.0-1
8690
87-
Mac OS X
88-
~~~~~~~~
91+
Use ``docker stop`` to unmount the ``/cvmfs`` tree.
8992

90-
On Mac OS X, CernVM-FS is based on `macFUSE <http://osxfuse.github.io>`_.
91-
Note that as of macOS 11 Big Sur, `kernel extensions need to be enabled <https://support.apple.com/guide/mac-help/change-startup-disk-security-settings-a-mac-mchl768f7291/mac>`_
92-
to install macFUSE.
93-
Verify that fuse is available with
93+
.. note::
94+
If you run multiple nodes (a cluster), use ``-e CVMFS_HTTP_PROXY`` to set a proper site proxy as described further down.
9495

95-
::
9696

97-
kextstat | grep -i fuse
97+
.. tab-item:: Mac OS X
9898

99-
Download the CernVM-FS client package in the terminal in order to avoid signature warnings
99+
On Mac OS X, CernVM-FS is based on `macFUSE <http://osxfuse.github.io>`_.
100+
Note that as of macOS 11 Big Sur, `kernel extensions need to be enabled <https://support.apple.com/guide/mac-help/change-startup-disk-security-settings-a-mac-mchl768f7291/mac>`_
101+
to install macFUSE.
102+
Verify that fuse is available with
100103

101-
::
104+
.. code-block:: console
102105
103-
curl -o ~/Downloads/cvmfs-2.11.0.pkg https://ecsft.cern.ch/dist/cvmfs/cvmfs-2.11.0/cvmfs-2.11.0.pkg
106+
kextstat | grep -i fuse
104107
105-
Install the CernVM-FS package by opening the .pkg file and reboot.
106-
Future releases will provide a signed and notarized package.
108+
Download the CernVM-FS client package in the terminal in order to avoid signature warnings
107109

110+
.. code-block:: console
108111
109-
Windows / WSL2
110-
~~~~~~~~~~~~~~
112+
curl -o ~/Downloads/cvmfs-2.11.0.pkg https://ecsft.cern.ch/dist/cvmfs/cvmfs-2.11.0/cvmfs-2.11.0.pkg
111113
112-
Follow the `Windows instructions <https://docs.microsoft.com/en-us/windows/wsl/install-win10>`_ to install the Windows Subsystem for Linux (WSL2).
113-
Install any of the Linux distributions and follow the instructions for the distribution in this guide.
114-
Whenever you open the Linux distribution, run
114+
Install the CernVM-FS package by opening the .pkg file and reboot.
115+
Future releases will provide a signed and notarized package.
115116

116-
::
117117

118-
sudo cvmfs_config wsl2_start
118+
.. tab-item:: Windows / WSL2
119+
120+
Follow the `Windows instructions <https://docs.microsoft.com/en-us/windows/wsl/install-win10>`_ to install the Windows Subsystem for Linux (WSL2).
121+
Install any of the Linux distributions and follow the instructions for the distribution in this guide.
122+
Whenever you open the Linux distribution, run
123+
124+
.. code-block:: console
125+
126+
sudo cvmfs_config wsl2_start
127+
128+
to start the CernVM-FS service.
129+
119130

120-
to start the CernVM-FS service.
121131

122132

123133
Setting up the Software

‎requirements.txt

+3
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,10 @@ recommonmark
99
sphinx-rtd-theme
1010
readthedocs-sphinx-ext
1111
jinja2
12+
sphinx_design
13+
1214
# for conversion of svgs to use in latex
1315
cairosvg
1416
sphinxcontrib-svg2pdfconverter
1517

18+

0 commit comments

Comments
 (0)