Skip to content

Docs for StashCache ready to publish#62

Merged
djw8605 merged 59 commits intoopensciencegrid:masterfrom
zvada:master
May 11, 2017
Merged

Docs for StashCache ready to publish#62
djw8605 merged 59 commits intoopensciencegrid:masterfrom
zvada:master

Conversation

@zvada
Copy link
Copy Markdown

@zvada zvada commented May 11, 2017

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.

Copy link
Copy Markdown
Member

@djw8605 djw8605 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:
```
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought you were going to use the include features for this?

Comment thread docs/admin/configure-cache.md Outdated

### RHEL7
On RHEL7 system, you need to run following systemd unit:
* `xrootd@stashcache-cache-server.service`
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not give the full command, systemctl start xrootd@stashcache-cache-server.service

Comment thread docs/admin/configure.md
### Enabling authenticated cache
#### Add AuthFile for non-authenticated cache
```
[root@client ~]$ cat /etc/xrootd/Authfile-noauth
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't this already in the configure-cache-auth file?

Comment thread docs/admin/install.md Outdated
# 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.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you describe the role of the Origin and Cache? When would you need to install which?

Comment thread docs/index.md Outdated
# 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.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This documentation is for Side Admins and OSG Operations team who manage...

Comment thread docs/index.md Outdated
* [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.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should reorder this list. Caches at top (most common). Then origins, redirectors, and upgrades.

Comment thread docs/ops/start.md
| Fetch CRL | `fetch-crl-cron` | RHEL7 |

### Validating Cache server
To verify that your cache is being monitored properly, run the following command:
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@bbockelm
Copy link
Copy Markdown
Contributor

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.

Copy link
Copy Markdown
Author

@zvada zvada left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've incorporated changes we've discussed.

@djw8605 djw8605 merged commit fdcd077 into opensciencegrid:master May 11, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants