Merge pull request #63 from djw8605/master

Fixing formatting on a bunch of pages

Author: Marian Zvada

docs/admin/configure-cache-auth.md

@@ -2,25 +2,26 @@
 
 Before you continue, make sure [default Cache Server](configure-cache.md) is configured on first place. Enabling authenticated cache is optionali and additional do default cache instance. This chapter describes all the steps needed. 
 
-Packages installed: `stashcache-daemon fetch-crl stashcache-cache-server xrootd-lcmaps globus-proxy-utils`
+Packages installed: 
+    stashcache-daemon fetch-crl stashcache-cache-server xrootd-lcmaps globus-proxy-utils
 
 ## Authenticated Cache server
 
-:heavy_exclamation_mark: Make sure you've in place following pre-requisities from [install step here](install.md):
+Make sure you've in place following pre-requisities from [install step here](install.md):
+
 * __Service certificate:__ create copy of the certificate to `/etc/grid-security/xrd/xrd{cert,key}.pem`
-   * set owner of the directory `/etc/grid-security/xrd/` to `xrootd:xrootd` user:
-      ```
-      $ chown -R xrootd:xrootd /etc/grid-security/xrd/
-      ```
+    * Set owner of the directory `/etc/grid-security/xrd/` to `xrootd:xrootd` user:
+    
+            $ chown -R xrootd:xrootd /etc/grid-security/xrd/
+      
 * __Network ports__: allow connections on port `8443 (TCP)` 
 
-:heavy_exclamation_mark: Beware, authenticated cache requires presence of the [config file](../configs/xrootd-stashcache-cache-server.cfg) `/etc/xrootd/xrootd-stashcache-cache-server.cfg`. 
+Beware, authenticated cache requires presence of the [config file](../configs/xrootd-stashcache-cache-server.cfg) `/etc/xrootd/xrootd-stashcache-cache-server.cfg`. 
 
 Now, create symbolic link to existing configuration file with `-auth` postfix:
-```
-   [root@client ~]$ cd /etc/xrootd/
-   [root@client ~]$ ln -s xrootd-stashcache-cache-server.cfg xrootd-stashcache-cache-server-auth.cfg
-```
+
+    [root@client ~]$ cd /etc/xrootd/
+    [root@client ~]$ ln -s xrootd-stashcache-cache-server.cfg xrootd-stashcache-cache-server-auth.cfg
 
 ### RHEL7
 
@@ -32,89 +33,91 @@ On RHEL7 system, you need to configure and run following systemd units:
 
 #### Auth.service
 1. Enable `xrootd@stashcache-cache-server-auth.service` instance:
-```
-   [root@client ~]$ systemctl enable xrootd@stashcache-cache-server-auth
-```
+
+        [root@client ~]$ systemctl enable xrootd@stashcache-cache-server-auth
+
 
 2. Reload daemons:
-```
-   [root@client ~]$ systemctl daemon-reload
-```
+
+        [root@client ~]$ systemctl daemon-reload
+
 
 #### Proxy.service
 1. Create the file with following content:
+
 ```
-   [root@client ~]$ cat /usr/lib/systemd/system/xrootd-renew-proxy.service
-   [Unit]
-   Description=Renew xrootd proxy
-
-   [Service]
-   User=xrootd
-   Group=xrootd
-   Type = oneshot
-   ExecStart = /bin/grid-proxy-init -cert /etc/grid-security/xrd/xrdcert.pem -key /etc/grid-security/xrd/xrdkey.pem -out /tmp/x509up_xrootd -valid 48:00
-
-   [Install]
-   WantedBy=multi-user.target
+[root@client ~]$ cat /usr/lib/systemd/system/xrootd-renew-proxy.service
+[Unit]
+Description=Renew xrootd proxy
+
+[Service]
+User=xrootd
+Group=xrootd
+Type = oneshot
+ExecStart = /bin/grid-proxy-init -cert /etc/grid-security/xrd/xrdcert.pem -key /etc/grid-security/xrd/xrdkey.pem -out /tmp/x509up_xrootd -valid 48:00
+
+[Install]
+WantedBy=multi-user.target
 ```
 
 2. Reload daemons:
-```
-   [root@client ~]$ systemctl daemon-reload
-```
+
+        [root@client ~]$ systemctl daemon-reload
+
 
 #### Proxy.timer
 1. Create the file with following content:
 ```
-   [root@client ~]$ cat /usr/lib/systemd/system/xrootd-renew-proxy.timer
-   [Unit]
-   Description=Renew proxy every day at midnight
-   
-   [Timer]
-   OnCalendar=*-*-* 00:00:00
-   Unit=xrootd-renew-proxy.service
-   
-   [Install]
-   WantedBy=multi-user.target
+[root@client ~]$ cat /usr/lib/systemd/system/xrootd-renew-proxy.timer
+[Unit]
+Description=Renew proxy every day at midnight
+
+[Timer]
+OnCalendar=*-*-* 00:00:00
+Unit=xrootd-renew-proxy.service
+
+[Install]
+WantedBy=multi-user.target
 ```
 
 2. Enable timer:
-```
-   [root@client ~]$ systemctl enable xrootd-renew-proxy.timer
-```
+
+        [root@client ~]$ systemctl enable xrootd-renew-proxy.timer
+
 
 3. Start and check if timer is active and working:
-```
-   [root@client ~]$ systemctl start xrootd-renew-proxy.timer
-   ...
-   [root@client ~]$ systemctl is-active xrootd-renew-proxy.timer
-   active
-   [root@client ~]$ systemctl list-timers xrootd-renew-proxy*
-   NEXT                         LEFT       LAST                         PASSED  UNIT                     ACTIVATES
-   Thu 2017-05-11 00:00:00 CDT  54min left Wed 2017-05-10 00:00:01 CDT  23h ago xrootd-renew-proxy.timer xrootd-renew-proxy.service
-```
+
+
+        [root@client ~]$ systemctl start xrootd-renew-proxy.timer
+        ...
+        [root@client ~]$ systemctl is-active xrootd-renew-proxy.timer
+        active
+        [root@client ~]$ systemctl list-timers xrootd-renew-proxy*
+        NEXT                         LEFT       LAST                         PASSED  UNIT                     ACTIVATES
+        Thu 2017-05-11 00:00:00 CDT  54min left Wed 2017-05-10 00:00:01 CDT  23h ago xrootd-renew-proxy.timer xrootd-renew-proxy.service
+
 
 4. Reload daemons:
-```
-   [root@client ~]$ systemctl daemon-reload
-```
+
+        [root@client ~]$ systemctl daemon-reload
+
 
 #### CRLs updates
 It is very important to keep CRL list updated from cron:
 1. Enable fetch-crl-cron
 ```
-   [root@client ~]$ systemctl enable fetch-crl-cron
+[root@client ~]$ systemctl enable fetch-crl-cron
 ```
 
 2. Start fetch-crl-cron
-```
-   [root@client ~]$ systemctl start fetch-crl-cron
-```
+
+        [root@client ~]$ systemctl start fetch-crl-cron
+
 
 3. Reload daemons:
-```
-   [root@client ~]$ systemctl daemon-reload
-```
+
+        [root@client ~]$ systemctl daemon-reload
+
 
 ### RHEL6
 ...to be added

docs/admin/configure-cache.md

@@ -5,7 +5,8 @@ Packages installed: `stashcache-daemon fetch-crl stashcache-cache-server`
 The following section describes required configuration to have a functional non-authenticated StashCache Cache (not origin server!). StashCache Cache package `stashcache-cache-server` needs to be manually configured from pre-existing XRootD configuration.
 
 ## Cache server
-!!! Note: While example of the configuration file below provides combination of _authenticated_ and _non-authenticated_ _Cache_, the non-authenticated cache is considered to be default and authenticated cache just optional (additional) service. If you're about to configure in addition _authenticated cache_ read to the end of this document and then follow post-installation of [authenticated part here](configure-cache-auth.md).
+!!! Note: 
+    While example of the configuration file below provides combination of _authenticated_ and _non-authenticated_ _Cache_, the non-authenticated cache is considered to be default and authenticated cache just optional (additional) service. If you're about to configure in addition _authenticated cache_ read to the end of this document and then follow post-installation of [authenticated part here](configure-cache-auth.md).
 
 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:

docs/admin/configure.md

@@ -28,8 +28,8 @@ xrootd.monitor all auth flush 30s window 5s fstat 60 lfn ops xfr 5 dest redir fs
 ```
 
 ## Cache server
-!!! Note: 
-:bangbang: While example of the configuration file below provides combination of _authenticated_ and _non-authenticated_ _Cache_, the non-authenticated cache config is considered to load by system as default.
+!!! Note 
+    While example of the configuration file below provides combination of _authenticated_ and _non-authenticated_ _Cache_, the non-authenticated cache config is considered to load by system as default.
 
 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**). 
 `StashCache-daemon` package provides default configuration file `/etc/xrootd/xrootd-stashcache-cache-server.cfg`. Example of the configuration of cache server is as follows:

docs/admin/install.md

@@ -13,19 +13,20 @@ Before starting the installation process, consider the following mandatory point
 
 * __User IDs:__ If they do not exist already, the installation will create the Linux user IDs condor and xrootd
 * __Service certificate:__ The StashCache service uses a host certificate at `/etc/grid-security/host*.pem`
-* __Network ports:__ The StashCache service must talk to:
-   * the central collector on port `9619 (TCP)` 
-   * XRootD service on port `1094 (TCP)`
-   * and allow XRootD service over HTTP on port `8000 (TCP)`
+* __Network ports:__ The StashCache service must listen on ports:
+    * the central collector on port `9619 (TCP)` 
+    * XRootD service on port `1094 (TCP)`
+    * and allow XRootD service over HTTP on port `8000 (TCP)`
 * __Hardware requirements:__ We recommend that a StashCache server has at least 10Gbps connectivity, 1TB of disk space, and 8GB of RAM. 
-   * More information about hardware and system configuration of existing caches you can find at [Upgrade status page](../ops/upgrades.md).
+    * More information about hardware and system configuration of existing caches you can find at [Upgrade status page](../ops/upgrades.md).
+
+If installing the (optional) authenticated StashCache, you need to do in addition the following:
 
-If installing authenticated StashCache, you need to do in addition following:
 * __Service certificate:__ create copy of the certificate to `/etc/grid-security/xrd/xrd{cert,key}.pem`
-   * set owner of the directory `/etc/grid-security/xrd/` to `xrootd:xrootd` user:
-      ```
-      $ chown -R xrootd:xrootd /etc/grid-security/xrd/
-      ```
+    * set owner of the directory `/etc/grid-security/xrd/` to `xrootd:xrootd` user:
+    
+            $ chown -R xrootd:xrootd /etc/grid-security/xrd/
+
 * __Network ports__: allow connections on port `8443 (TCP)` 
 
 As with all OSG software installations, there are some one-time steps to prepare in advance:
@@ -40,29 +41,30 @@ As with all OSG software installations, there are some one-time steps to prepare
 The StashCache daemon consists of an XRootD server and an HTCondor-based service for collecting and reporting statistics about the cache. To simplify installation, OSG provides convenience RPMs that install all required software with a single command:
 
 1. Clean yum cache:
-```
-   [root@client ~]$ yum clean all --enablerepo=*
-```
+
+        [root@client ~]$ yum clean all --enablerepo=*
+
 
 2. Update software, this command will update all packages on your system:
-```
-   [root@client ~]$ yum update
-```
+
+        [root@client ~]$ yum update
+
 
 3. Install the StashCache metapackage from OSG repository:
 
-   * if you are installing __Origin server__:
-   ```
-      [root@client ~]$ yum install stashcache-daemon fetch-crl stashcache-cache-origin
-   ```
-   * if you are installing __Cache server__:
-   ```
-      [root@client ~]$ yum install stashcache-daemon fetch-crl stashcache-cache-server
-   ```
-
-!!! Note: If installing authenticated StashCache Cache server, you need additional packages to be installed:
-```
-   [root@client ~]$ yum install xrootd-lcmaps globus-proxy-utils
-```
+    * if you are installing __Origin server__:
+   
+            [root@client ~]$ yum install stashcache-daemon fetch-crl stashcache-cache-origin
+   
+    * if you are installing __Cache server__:
+   
+            [root@client ~]$ yum install stashcache-daemon fetch-crl stashcache-cache-server
+   
+
+    !!! Note: 
+        If installing authenticated StashCache Cache server, you need additional packages to be installed:
+    
+            [root@client ~]$ yum install xrootd-lcmaps globus-proxy-utils
+
 
 4. Mount the disk that will be used for the cache to */stash* and set owner of the directory to `xrootd:xrootd` user.

docs/ops/register.md

@@ -11,26 +11,27 @@ You can see the current state of affairs here:
 To register a cache instance go [here](https://oim.grid.iu.edu/oim/resourceedit) (with a cert in your browser). Fill in the required fields, example is displayed below:
 
 ### Registering StashCache resource information: 
-* the site __must be__ _OSG-GOC_ 
-* the resource group __must be__ _Monitored Caches_
+* The site __must be__ _OSG-GOC_ 
+* The resource group __must be__ _Monitored Caches_
 ![ResourceInfo](../images/resource-info.png)
 
 ### Registering StashCache resource services: 
-* the service __must be__ XRootD component
+* The service __must be__ XRootD component
 ![ResourceServices](../images/resource-services.png)
 
-!!! Note: Contact Information (will be pre-filled, add or modify as you see fit) - there are several types of contact, administrative and security are the most important to the GOC - __DO NOT__ check the WLCG resource box; Add a Update comment if you'd like.
+!!! Note: 
+    Contact Information (will be pre-filled, add or modify as you see fit) - there are several types of contact, administrative and security are the most important to the GOC - __DO NOT__ check the WLCG resource box; Add a Update comment if you'd like.
 
 ### Confirming and submitting StashCache resource registration: 
-* you must click the __"Acceptable Use Policy"__ checkbox
+* Tou must click the __"Acceptable Use Policy"__ checkbox
 ![FormConfirm](../images/resource-confirm.png)
 Hit the __blue__ submit button.
 
 ## Configuring resource monitoring for RSV
 E.g. for the Nebraska instance the status of the following command is checked: 
-```
-[user@client ~]$ xrdcp root://hcc-stash.unl.edu//stash/user/test.1M /tmp/dump
-```
+
+    [user@client ~]$ xrdcp root://hcc-stash.unl.edu//stash/user/test.1M /tmp/dump
+
 If the return status is zero, the cache is working, otherwise it is not. What we need from you is:
 * the equivalent `//stash/user/test.1M` a file you select that will always be there.