Add proper templating to esg documentation

This commit is contained in:
dmh 2013-10-17 11:43:53 -06:00
parent 29867a5b03
commit 9b0f0a9da4
2 changed files with 30 additions and 53 deletions

2
cf
View File

@ -152,7 +152,7 @@ FLAGS="$FLAGS --disable-examples"
#FLAGS="$FLAGS --enable-extra-tests"
#FLAGS="$FLAGS --enable-large-file-tests"
#FLAGS="$FLAGS --disable-testsets"
#FLAGS="$FLAGS --disable-dap-remote-tests"
FLAGS="$FLAGS --disable-dap-remote-tests"
#FLAGS="$FLAGS --enable-doxygen"
FLAGS="$FLAGS --enable-logging"
#FLAGS="$FLAGS --disable-diskless"

View File

@ -1,48 +1,21 @@
<html><!-- InstanceBegin template="/Templates/MyUnidata.dwt" codeOutsideHTMLIsLocked="true" -->
<!-- This document is kept in netcdf-c/man4;
it is not normally included in the distribution.
-->
<html>
<style>
.break { page-break-before: always; }
body { counter-reset: H2; font-size: 12pt; }
h1 { counter-reset: H2; font-size: 18pt; }
h2:before {
content: counter(H2) " ";
counter-increment: H2;
}
h2 { counter-reset: H3; }
h3:before {
content: counter(H2) "." counter(H3) " ";
counter-increment:H3;
}
h3 { counter-reset: H4; }
h4:before {
content: counter(H2) "." counter(H3) "." counter(H4) " ";
counter-increment:H4;
}
h4 { counter-reset: H5; }
h5:before {
content: counter(H2) "." counter(H3) "." counter(H4) "." counter(H5) " ";
counter-increment:H5;
}
h6 {font-size: 16pt; margin-bottom: 0pt; padding: 0pt; } /* For TOC */
</style>
<head>
<!-- InstanceBeginEditable name="Title" -->
<TITLE>Accessing ESG Datasets</TITLE>
<META NAME="UIINDEX" CONTENT="0">
<META NAME="BOOKMARK" CONTENT="ESG Access">
<META NAME="AUTHOR" CONTENT="Heimbigner">
<META NAME="KEYWORDS" CONTENT="netcdf, authorization, ESG, truststore keystore">
<META NAME="DESCRIPTION" CONTENT="Describe in detail how to establish access to ESG servers">
<!-- InstanceEndEditable -->
</head>
<body>
<center>
<h1>Accessing ESG Data Through netCDF</h1>
<table>
<tr><td>Created:<td>10/17/2013
<tr><td>Last Revised:<td>10/17/2013<br>
<tr><td>Version:<td>1.0
<tr><td>Author:<td>Dennis Heimbigner
<tr><td>Affiliation:<td>Unidata/UCAR
<tr><td>email:<td>dmh&#064;unida.ucar.edu
</table>
</center>
<p>
<h2 class="break"><a name="Introduction"><u>Introduction</u></a></h2>
<h2><a name="Introduction"><u>Introduction</u></a></h2>
It is possible to access Earth Systems Grid (ESG) datasets
from ESG servers through the netCDF API.
This requires building the netCDF library with DAP2 protocol support
@ -66,7 +39,7 @@ somewhat complicated. The DAP2 support in netCDF
uses the <i>curl</i> library and it is that underlying library
that must be properly configured.
<h2 class="break"><a name="terms"><u>Terminology</u></a></h2>
<h2><a name="terms"><u>Terminology</u></a></h2>
The key elements for client-side keys requires the constructions of
two "stores" on the client side.
<ul>
@ -78,7 +51,7 @@ two "stores" on the client side.
The server actually has a similar set of stores, but the client
need not be concerned with those.
<h2 class="break"><a name="steps1"><u>Initial Steps</u></a></h2>
<h2><a name="steps1"><u>Initial Steps</u></a></h2>
The first step is to obtain authorization from ESG.
Note that this information may evolve over time, and
@ -106,7 +79,7 @@ to substitute the ESG site for BADC in the following.
(read the whole page, it will help you understand the remaining steps).
</ol>
<h2 class="break"><a name="steps2"><u>Building the KeyStore</u></a></h2>
<h2><a name="steps2"><u>Building the KeyStore</u></a></h2>
You will have to modify the keyfile in the previous step
and then create a keystore and install the key and a certificate.
The commands are these:
@ -120,7 +93,7 @@ The commands are these:
Note, the file names "key.der" and "cert.der" can be whatever you choose.
It is probably best to leave the .der extension, though.
<h2 class="break"><a name="steps2"><u>Building the TrustStore</u></a></h2>
<h2><a name="steps2"><u>Building the TrustStore</u></a></h2>
Building the truststore is a bit tricky because as provided, the
certificates in "globus" need some massaging. See the script below
for the details. The primary command is this, which is executed for every
@ -130,7 +103,7 @@ named "truststore"
keytool -trustcacerts -storepass "password" -v -keystore "truststore" -importcert -file "${c}"
</pre>
<h2 class="break"><a name="steps2"><u>Running the C Client</u></a></h2>
<h2><a name="steps2"><u>Running the C Client</u></a></h2>
The file ".dodsrc" is used to configure curl. This file must
reside either in the current directory or in your home directory.
@ -158,7 +131,7 @@ certificate produced by MyProxyLogon. The HTTP.SSL.CAPATH entry
should be the path to the "certificates" directory produced by
MyProxyLogon.
<h2 class="break"><a name="steps2"><u>Running the Java Client</u></a></h2>
<h2><a name="steps2"><u>Running the Java Client</u></a></h2>
If you are using the Java netCDF client, then you need to add
some parameters to the "java" command. Specifically, add the following
flags.
@ -166,7 +139,7 @@ flags.
-Dkeystore="path to keystore file" -Dkeystorepassword="keystore password"
</pre>
<h2 class="break"><a name="script"><u>Script for creating Stores</u></a></h2>
<h2><a name="script"><u>Script for creating Stores</u></a></h2>
The following script shows in detail how to actually construct the key
and trust stores. It is specific to the format of the globus file
as it was when ESG support was first added. It may have changed
@ -233,12 +206,16 @@ exit
<li>10/17/2013 &ndash; Initial Release
</ul>
<h2><a name="docinfo"><u>Document Information</u></a></h2>
<table>
<tr><td>Created:<td>10/17/2013
<tr><td>Last Revised:<td>10/17/2013<br>
<tr><td>Version:<td>1.0
<tr><td>Author:<td>Dennis Heimbigner
<tr><td>Affiliation:<td>Unidata/UCAR
<tr><td>email:<td>dmh&#064;unida.ucar.edu
</table>
</body>
</html>