Create manifest of files that get changed

[justbennet]

The tutorial instructions are very clear for all the yum installations, but for beginners, keeping track of which files, and exactly what names they use, and where they are located may be challenging for some beginners (like me, even though I've done this a couple of times).

I was thinking it might be nice to have a summary of the files that need manual editing and their location for each machine type for people to use as a checklist, might help prevent some of the errors that I and some others made.

One other thing that might help would be to move the Warning in section 2.1.4 before the instruction to

sudo cvmfs_server mkfs -o $USER repo.organization.tld

so that the naming scheme is explained before its first use in a command.

Since a variable is set with the repo name subsequently, perhaps establishing the variable name at the beginning of the section would be a help? So, 2.1.4 would start with

2.1.4 Creating the repository¶

Now that all required packages have been installed, we can create a CernVM-FS repository.

You need to choose a repository name, for example, repo.${USER}.org. You may find it
easier to set a variable
MY_REPO_NAME=repo.${USER}.org
for use in what follows.
In the simplest way, this can be done by running the following command, which will
make the current user the owner of the repository:

sudo cvmfs_server mkfs -o $USER $MY_REPO_NAME

etc.

[justbennet]

Perhaps something like this?

When you are finished with the stratum0 server, you should have these files created, of which only the first you will have manually edited.

# section 2.1.7
/etc/cron.d/cvmfs_resign

# section 2.1.5, created by `cvmfs_server mkfs ...`
/etc/cvmfs/keys/${MY_REPO_NAME}.crt
/etc/cvmfs/keys/${MY_REPO_NAME}.key
/etc/cvmfs/keys/${MY_REPO_NAME}.masterkey
/etc/cvmfs/keys/${MY_REPO_NAME}.pub

[justbennet]

The above was meant as just a checklist of files that people need, not the commands, but I think Bob and Kenneth were interested in having both.

If all the commands and files are listed together, then I think this encapsulates the stratum0/client setup.

For the purposes of the tutorial, would it be helpful to have them create a file they can source to get the IP addresses for each machine at the very beginning and assign them to variables on each machine?
cvmfs_vars.setup

#----- cvmfs_vars.setup:  Helpful variables for tutorial; put on all four machines
export MY_DOMAIN=organization.tld
export MY_REPO_NAME=repo
export STRATUM0_IP=1.2.3.4
export STRATUM1_IP=5.6.7.8
export PROXY_IP=9.8.7.6
export CLIENT_IP=5.4.3.2
#-----

$ source ~/cvmfs_vars.setup

I am of two minds whether that would clarify or confuse.

# Stratum 0 server

# Section 2.1.2
sudo yum install -y epel-release  # not needed on CentOS 8
sudo yum install -y https://ecsft.cern.ch/dist/cvmfs/cvmfs-release/cvmfs-release-latest.noarch.rpm
sudo yum install -y cvmfs cvmfs-server

# Section 2.1.3
sudo systemctl enable httpd
sudo systemctl start httpd

# Section 2.1.4
# We will use repo.organization.tld in the examples.
# 'repo' is the repository name
# 'organization.tld' is the domain, but may not be a DNS domain
sudo cvmfs_server mkfs -o $USER repo.organization.tld

MY_DOMAIN=organization.tld
MY_REPO_NAME=repo.${MY_DOMAIN}

# That should create these files see section 2.1.5
/etc/cvmfs/keys/${MY_REPO_NAME}.crt
/etc/cvmfs/keys/${MY_REPO_NAME}.key
/etc/cvmfs/keys/${MY_REPO_NAME}.masterkey
/etc/cvmfs/keys/${MY_REPO_NAME}.pub

# Section 2.1.6
cvmfs_server transaction ${MY_REPO_NAME}

echo '#!/bin/bash' > /cvmfs/${MY_REPO_NAME}/hello.sh
echo 'echo hello' >> /cvmfs/${MY_REPO_NAME}/hello.sh
chmod a+x /cvmfs/${MY_REPO_NAME}/hello.sh

cvmfs_server publish ${MY_REPO_NAME}

# Section 2.1.7
# Create crontab to periodically re-sign the repo
# /etc/cron.d/cvmfs_resign
echo "0 11 * * 1 root /usr/bin/cvmfs_server resign ${MY_REPO_NAME}" \
    > /etc/cron.d/cvmfs_resign

# Section 2.1.8
# DO NOT RUN
# sudo cvmfs_server rmfs ${MY_REPO_NAME}

# CVMFS client

# Section 2.2.1
sudo yum install -y https://ecsft.cern.ch/dist/cvmfs/cvmfs-release/cvmfs-release-latest.noarch.rpm
sudo yum install -y cvmfs

export MY_DOMAIN==organization.tld
export MY_REPO_NAME=repo.${MY_DOMAIN}

# Section 2.2.2
# Copy stratum0:/etc/cvmfs/keys/${MY_REPO_NAME}.pub to
# client:/etc/cvmfs/keys/${MY_DOMAIN}/${MY_REPO_NAME}.pub


# /etc/cvmfs/config.d/{MY_REPO_NAME}.conf
#----
CVMFS_SERVER_URL="http://<STRATUM0_IP>/cvmfs/@fqrn@"
CVMFS_KEYS_DIR="/etc/cvmfs/keys/${MY_DOMAIN}"
#----

# /etc/cvmfs/default.local
#----
CVMFS_HTTP_PROXY=DIRECT
CVMFS_QUOTA_LIMIT=5000
#----

# Section 2.2.3
sudo cvmfs_config setup
# I am not remembering whether chksetup requires the repo be mounted...?
ls /cvmfs/${MY_REPO_NAME}
sudo cvmfs_config chksetup