Docs for StashCache ready to publish#62
Conversation
djw8605
left a comment
There was a problem hiding this comment.
Throughout this document, it makes it sound like you can have either a authenticated stashcache, or an non-authenticated. It should be structured such that by default, you always have an un-authenticated cache. But, you can always add on a authenticated cache. That way, if you have an authenticated cache, then you always have non-authenticated as well.
|
|
||
| For configuring **cache** one needs to define directive `pss.origin redirector.osgstorage.org:1024` (not `all.manager redirector.osgstorage.org+ 1213` directive as it is in case of [configuring origin](configure-origin.md)). | ||
| `StashCache-daemon` package provides default configuration file `/etc/xrootd/xrootd-stashcache-cache-server.cfg`. Example of the configuration of cache server is as follows: | ||
| ``` |
There was a problem hiding this comment.
I thought you were going to use the include features for this?
|
|
||
| ### RHEL7 | ||
| On RHEL7 system, you need to run following systemd unit: | ||
| * `xrootd@stashcache-cache-server.service` |
There was a problem hiding this comment.
Why not give the full command, systemctl start xrootd@stashcache-cache-server.service
| ### Enabling authenticated cache | ||
| #### Add AuthFile for non-authenticated cache | ||
| ``` | ||
| [root@client ~]$ cat /etc/xrootd/Authfile-noauth |
There was a problem hiding this comment.
Isn't this already in the configure-cache-auth file?
| # Installation Guide | ||
|
|
||
| This document describes how to install a StashCache cache, a server that caches files locally rather than serving files to the StashCache federation. The installation utilizes XRootD and HTCondor for file storage and monitoring, respectively. | ||
| This document describes how to install a StashCache service (Origin or Cache). The installation utilizes XRootD and HTCondor for file storage and monitoring, respectively. |
There was a problem hiding this comment.
Can you describe the role of the Origin and Cache? When would you need to install which?
| # StashCache | ||
|
|
||
| This documenation serve to Operations team and Site Admins who manage StashCache nodes (origin or cache server; or redirectors). Main functionality of StashCache is based on [XRootD](http://xrootd.org) technology, there are other components involved to function StashCache properly, though. E.g. if you are a user of **"stashcp"** you want to follow [this](https://support.opensciencegrid.org/support/solutions/articles/12000002775-transferring-data-with-stashcache) document instead. | ||
| This documenation serves to Operations team and Site Admins who manage StashCache nodes (origin or cache server; or redirectors). Main functionality of StashCache is based on [XRootD](http://xrootd.org) technology, there are other components involved to function StashCache properly, though. E.g. if you are a user of **"stashcp"** you want to follow [this](https://support.opensciencegrid.org/support/solutions/articles/12000002775-transferring-data-with-stashcache) document instead. |
There was a problem hiding this comment.
This documentation is for Side Admins and OSG Operations team who manage...
| * [StashCache origins](https://github.com/opensciencegrid/StashCache/docs/admin): Managed by an organization, **"origin"** is data server to host files locally and serve them to users upon transfer request (via [stashcp](https://support.opensciencegrid.org/support/solutions/articles/12000002775-transferring-data-with-stashcach)) unless data are already cached. | ||
| * [StashCache caches](https://github.com/opensciencegrid/StashCache/docs/admin): Managed by an organization, **"cache"** server to keep data cached and immediately available (via [stashcp](https://support.opensciencegrid.org/support/solutions/articles/12000002775-transferring-data-with-stashcach))within Stash federation (without re-transfering from "origin"). | ||
| * [StashCache upgrades](https://twiki.grid.iu.edu/bin/view/Documentation/Release3/StashCacheUpgrades): Keeps track of versions deployed at sites as well as other information about OS, system resources, connectivity, etc. | ||
| * [StashCache origins](admin/install.md): Managed by an organization, **"origin"** is data server to host files locally and serve them to users upon transfer request (via [stashcp](https://support.opensciencegrid.org/support/solutions/articles/12000002775-transferring-data-with-stashcach)) unless data are already cached. |
There was a problem hiding this comment.
You should reorder this list. Caches at top (most common). Then origins, redirectors, and upgrades.
| | Fetch CRL | `fetch-crl-cron` | RHEL7 | | ||
|
|
||
| ### Validating Cache server | ||
| To verify that your cache is being monitored properly, run the following command: |
There was a problem hiding this comment.
There has to be more of a test than just this. You should include a wget command to test the CVMFS accessibility.
curl -O http://cache_host:8000/user/dweitzel/public/blast/queries/query1
Or something like that. I'm sure there is a curl command that doesn't produce output.
|
There are lots of commits to this branch with no useful commit messages. Accordingly, when this is merged, please rebase + squash with a useful commit message. |
zvada
left a comment
There was a problem hiding this comment.
I've incorporated changes we've discussed.
Quite substantial edits to merge. Included table of content in mkdocs.yml. I think is in fair condition to publish for someone to install stuff on RHEL7. For RHEL6 it needs few more edits, but easy to figure even without it for experienced admin.