Skip to content

Commit e9ce37f

Browse files
author
Ben Cotton
committed
Add installation instructions, tidy some links and wording.
1 parent 44bc539 commit e9ce37f

File tree

1 file changed

+16
-7
lines changed

1 file changed

+16
-7
lines changed

README.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,19 @@ It supports expiring, local file caching to reduce the number of calls triggered
66

77
Support for multiple URLs provides a simple mechanism to ensure high-availability for configuration information. The cache_config tool will attempt to pull configuration from each URL, stopping after the first successful pull happens.
88

9+
## Installation
10+
11+
On Windows, put the cache_config.exe file in the HTCondor bin directory.
12+
13+
On other OSes, put the cache_config.py file in the HTCondor bin directory.
14+
915
## Options
1016

1117
cache_config.[exe|py] CacheFile CacheTTL LockTTL URL1 [URL2 ...]
1218

13-
* CacheFile - The file name for the cached config on local disk
14-
* CacheTTL - The time-to-live for the cache file
15-
* LockTTL - The time-to-live for the file lock
19+
* CacheFile - The file name for the cached config on local disk (in seconds)
20+
* CacheTTL - The time-to-live for the cache file (in seconds)
21+
* LockTTL - The time-to-live for the file lock (in seconds)
1622
* URL1 - The first URL to check
1723
* URL2, URL3, ... - Additional, optional failover URLs to check
1824

@@ -23,6 +29,9 @@ cache_config checks for an existing, local, cache file to determine whether the
2329
acquired, with its own TTL to avoid deadlock cases. cache_config then gets the configuration file by attempting to read from the list of URLs for the configuration data. If any error occurs in reading from the first URL, the second is attempted, then the third, and so on, until configuration is successfully fetched and cached. Should all URLs fail, cache_config returns the existing, stale, configuration with additional configuration settings embedded in the output that publish the details of the failures.
2430

2531

32+
## Installation
33+
34+
2635
## HTCondor Configuration
2736

2837
In using cache_config with HTCondor it is recommended you copy it to your condor\bin directory (the BIN directory in your current HTCondor configuration). When configuring HTCondor, it is recommended you have a local configuration file that will get HTCondor up and running, then use the following line within that file to fetch the detailed configuration for the machine:
@@ -31,7 +40,7 @@ In using cache_config with HTCondor it is recommended you copy it to your condor
3140

3241
The above line should appear last in your local configuration file to ensure that any configuration sent to HTCondor via the fetch URL overrides any of the local bootstrap configuration.
3342

34-
Note: If using CacheConfig for Windows replace `$(BIN)\cache_config.py` with `$(BIN)\cache_config.exe` in the configuration line above.
43+
Note: If using cache_config for Windows replace `$(BIN)\cache_config.py` with `$(BIN)\cache_config.exe` in the configuration line above.
3544

3645

3746
## Using `cache_config` with CycleServer
@@ -46,11 +55,11 @@ To fetch your configuration from a CycleServer instance, make your configuration
4655
## See Also
4756

4857
* [HTCondor][htcondor] - high throughput computing from the University of Wisconsin
49-
* For more information on "Configuration with Pipes" in HTCondor, please see the HTCondor manual. In the 7.6 manual the appropriate section is [3.3.1.4][configwithpipes]
58+
* For more information on "Configuration with Pipes" in HTCondor, please see the HTCondor manual. In the 8.0 manual the appropriate section is [3.3.1.4][configwithpipes]
5059

5160
## Copyright
5261

53-
Copyright (C) 2007-2012, Cycle Computing, LLC.
62+
Copyright (C) 2007-2013, Cycle Computing, LLC.
5463

5564
## License
5665

@@ -63,4 +72,4 @@ Unless required by applicable law or agreed to in writing, software distributed
6372
[cycleserver]:http://www.cyclecomputing.com/cycleserver/overview
6473
[htcondor]:http://research.cs.wisc.edu/htcondor
6574
[curl]:http://curl.haxx.se/
66-
[configwithpipes]:http://research.cs.wisc.edu/htcondor/manual/v7.8/3_3Configuration.html#SECTION00431400000000000000
75+
[configwithpipes]:http://research.cs.wisc.edu/htcondor/manual/v8.0/3_3Configuration.html#SECTION00431400000000000000

0 commit comments

Comments
 (0)