Skip to content

Commit caa2d43

Browse files
committed
add minimal 'Creating a CernVM-FS repository' section
1 parent afc2480 commit caa2d43

File tree

4 files changed

+54
-8
lines changed

4 files changed

+54
-8
lines changed

docs/containers.md

+4
Original file line numberDiff line numberDiff line change
@@ -62,3 +62,7 @@ For Apptainer, the same can be done by setting the `$SINGULARITY_BIND` (or `$APP
6262
```{ .bash .copy }
6363
export SINGULARITY_BIND="/cvmfs"
6464
```
65+
66+
---
67+
68+
*(next: [Creating a CernVM-FS repository](creating-repo.md))*

docs/creating-repo.md

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Creating a CernVM-FS repository
2+
3+
Although creating a new CernVM-FS repository and making it available to the world is not in scope for this
4+
tutorial, we do want to give a (very) brief overview of what that entails.
5+
6+
For more information on starting with CernVM-FS from scratch to create your own CernVM-FS repository,
7+
see the [introductory tutorial to the CernVM-FS](https://cvmfs-contrib.github.io/cvmfs-tutorial-2021)
8+
was organised at the [6th EasyBuild User Meeting](https://easybuild.io/eum21) (Jan'21).
9+
10+
## Stratum 0 + creating repository
11+
12+
To create a new CernVM-FS repository, you will need to **set up a [Stratum 0 server](appendix/terminology.md#stratum0)**,
13+
or find an existing one that is willing to host your repository.
14+
15+
On a Stratum 0 server, a new repository can be created with:
16+
17+
```{ .bash .copy }
18+
cvmfs_server mkfs example.domain.tld
19+
```
20+
21+
For more information on this, see [the CernVM-FS documentation](
22+
https://cvmfs.readthedocs.io/en/stable/cpt-repo.html),
23+
or the [second section of the CernVM-FS introductory tutorial](https://cvmfs-contrib.github.io/cvmfs-tutorial-2021/02_stratum0_client/).
24+
25+
## Publshing content
26+
27+
After creating the repository, you should add some content to it via the update procedure
28+
that is documented [here](https://cvmfs.readthedocs.io/en/stable/cpt-repo.html#repository-update),
29+
which involves starting a *transaction*, making changes, and then *publishing* those changes.
30+
31+
## Managing repository
32+
33+
To optimize metadata access for client systems, you may need to look into creating [nested catalogs](
34+
https://cvmfs.readthedocs.io/en/stable/cpt-repo.html#managing-nested-catalogs).
35+
36+
If files are frequent removed from the repository, you should consider enabling [garbage
37+
collection](https://cvmfs.readthedocs.io/en/stable/cpt-repo.html#repository-garbage-collection).
38+
39+
## Public Stratum 1 replica servers
40+
41+
To distribute your repository, you should set up one or more public [Stratum 1 replicate
42+
servers](appendix/terminology.md#stratum1), much like we also did in this tutorial (see the
43+
[Accessing repositories - Private Stratum 1 replica server](access/stratum1.md) section).
44+
45+
For information on this is available [in the CernVM-FS documentation](https://cvmfs.readthedocs.io/en/stable/cpt-replica.html) as well.
46+
47+
---
48+
49+
*(next: [Appendix: Terminology](appendix/terminology.md))*

docs/getting-started.md

-7
This file was deleted.

mkdocs.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ nav:
3131
- Troubleshooting: troubleshooting.md
3232
- Performance aspects: performance.md
3333
- Containers: containers.md
34-
- Creating a CernVM-FS repository: getting-started.md
34+
- Creating a CernVM-FS repository: creating-repo.md
3535
- "Appendix: Terminology": appendix/terminology.md
3636
plugins:
3737
# show revision date at bottom of each page

0 commit comments

Comments
 (0)