Skip to content

Commit d1b64dc

Browse files
committed
Update the JDK being used in the docs.
1 parent 7b4ffcf commit d1b64dc

File tree

3 files changed

+33
-37
lines changed

3 files changed

+33
-37
lines changed

docs/details.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ <h3>System requirements</h3>
8686
These are the prerequisites for the EPICS archiver appliance.
8787
<ul>
8888
<li>A recent version of Linux, definitely 64 bit Linux for production systems. If using RedHat, we should aim for RedHat 6.1.</li>
89-
<li>JDK 1.12+ - definitely the 64 bit version for production systems. We need the JDK, <b>not</b> the JRE.</li>
89+
<li>JDK 1.16+ - definitely the 64 bit version for production systems. We need the JDK, <b>not</b> the JRE.</li>
9090
<li>A recent version of Tomcat 9.x; preferably <code>apache-tomcat-9.0.20</code> or later.</li>
9191
<li>The management UI works best with a recent version of Firefox or Chrome.</li>
9292
<li>By default, the EPICS archiver appliance uses a bundled versions of the Java CA and PVA libraries from <a href="https://github.com/epics-base/epicsCoreJava">EPICS base</a>.</li>

docs/quickstart.html

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="utf-8">
55
<meta name="viewport" content="width=device-width, initial-scale=1">
66
<link href="js/bootstrap-3.3.5/css/bootstrap.min.css" rel="stylesheet">
7-
<link type="text/css" href="docs.css" rel="Stylesheet" />
7+
<link type="text/css" href="docs.css" rel="Stylesheet" />
88
<title>EPICS Archiver Appliance -- Quickstart</title>
99

1010
</head>
@@ -43,27 +43,26 @@
4343

4444
<h3>Quickstart Guide</h3>
4545
<div id="intro">
46-
The steps outlined here should get you started quickly with evaluating and testing a new archiver appliance.
46+
The steps outlined here should get you started quickly with evaluating and testing a new archiver appliance.
4747
Note, <b>these steps are not meant for production deployments</b>, but are meant for evaluating and getting to know the system.
4848
For more details on how to deploy in a cluster or in a production environment, please see the <a href="installguide.html">Installation</a> guide.
49-
</div>
49+
</div>
5050

5151
<section>
5252
For folks familiar with deployment of WAR files, the archiver appliance consists of 4 WAR files.
5353
These steps deploy these WAR files on a single Tomcat JVM, set the log levels to ERROR and start the VM.
54-
To simplify matters, we are not persisting configuration and therefore there are no steps to define a connection pool for the configuration database.
54+
To simplify matters, we are not persisting configuration and therefore there are no steps to define a connection pool for the configuration database.
5555
</section>
5656

5757

5858
<section>
5959
Here are the steps to get started quickly.
6060
<ol>
61-
<li>Make sure you have a recent version of JDK 1.12 by running <code>java -version</code>. You should see something like so
62-
<pre class="bash_output"><code>[ quickstart_test ]$ java -version
63-
openjdk version "12.0.1" 2019-04-16
64-
OpenJDK Runtime Environment (build 12.0.1+12)
65-
OpenJDK 64-Bit Server VM (build 12.0.1+12, mixed mode, sharing)
66-
[ quickstart_test ]$ </code></pre>
61+
<li>Make sure you have a recent version of JDK by running <code>java -version</code>. You should see something like so
62+
<pre class="bash_output"><code>[ quickstart_test ]$ java -version
63+
openjdk version "16" 2021-03-16
64+
OpenJDK Runtime Environment (build 16+36-2231)
65+
OpenJDK 64-Bit Server VM (build 16+36-2231, mixed mode, sharing)[ quickstart_test ]$ </code></pre>
6766
</li>
6867
<li>Download the installation package to a Linux machine into a brand new folder. This should give you a tar.gz file like <code>archappl_vx.x.x.tar.gz</code>.</li>
6968
<li>Download a recent version of Tomcat 9.x. into the same folder. You should now have two files in this folder like so
@@ -74,7 +73,7 @@ <h3>Quickstart Guide</h3>
7473
[ quickstart_test ]$ </code></pre>
7574
</li>
7675
<li>Untar the <code>archappl_vx.x.x.tar.gz</code>. This should untar into 4 WAR files and a bash script like so
77-
<pre class="bash_output"><code>[ quickstart_test ]$ tar zxf archappl_v0.0.1_SNAPSHOT_12-November-2019T21-10-12.tar.gz
76+
<pre class="bash_output"><code>[ quickstart_test ]$ tar zxf archappl_v0.0.1_SNAPSHOT_12-November-2019T21-10-12.tar.gz
7877
[ quickstart_test ]$ ls -l
7978
total 312440
8079
-rw-r--r-- 1 mshankar cd 11358 Sep 9 16:03 Apache_2.0_License.txt
@@ -93,7 +92,7 @@ <h3>Quickstart Guide</h3>
9392
[ quickstart_test ]$ </code></pre>
9493
</li>
9594
<li>Run the script like so
96-
<pre class="bash_output"><code>[ quickstart_test ]$ ./quickstart.sh apache-tomcat-9.0.20.tar.gz
95+
<pre class="bash_output"><code>[ quickstart_test ]$ ./quickstart.sh apache-tomcat-9.0.20.tar.gz
9796

9897
</code></pre>
9998
</li>
@@ -105,7 +104,7 @@ <h3>Quickstart Guide</h3>
105104
</code></pre>
106105
</li>
107106
<li>Open a browser to <code>http://&lt;&lt;<i>machinename</i>&gt;&gt;:17665/mgmt/ui/index.html</code> and you should see the home screen for your archiver appliance.</li>
108-
<li>If your EPICS environment variables are set up correctly, you should be able to start archiving PV's right away.
107+
<li>If your EPICS environment variables are set up correctly, you should be able to start archiving PV's right away.
109108
Note it takes about 5 minutes for the archiver appliance to measure the event rate, storage rate etc and to transition PVs from the <code>Initial sampling</code> state to the <code>Being archived</code> state.
110109
</li>
111110
<li>To stop the appliance, use a <code>CTRL-C</code> in the console.</li>
@@ -123,7 +122,7 @@ <h3>Quickstart Guide</h3>
123122

124123
<section>
125124
<h4>Quickstart using predefined VMs</h4>
126-
An alternate way to quickly get started and test the system is to use the predefined VM's provided by Martin.
125+
An alternate way to quickly get started and test the system is to use the predefined VM's provided by Martin.
127126
These consists of three repos needed to set up an EPICS Archiver Appliance test environment:
128127
<ol>
129128
<li><a href="https://stash.nscl.msu.edu/projects/DEPLOY/repos/vagrant_archiver_appliance">vagrant_archiver_appliance</a></li>

docs/samples/single_machine_install.sh

Lines changed: 19 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,13 @@ fi
2020

2121
if [[ -z ${JAVA_HOME} ]]
2222
then
23-
echo "Please set JAVA_HOME to point to a 1.8 JDK"
23+
echo "Please set JAVA_HOME to point to a 1.16+ JDK"
2424
exit 1
2525
fi
2626

2727
if [[ ! -f ${JAVA_HOME}/include/linux/jni_md.h ]]
2828
then
29-
echo "Missing the include/jni.md.h file in ${JAVA_HOME}. Please set JAVA_HOME to point to a 1.8 JDK (not a JRE)"
29+
echo "Missing the include/jni.md.h file in ${JAVA_HOME}. Please set JAVA_HOME to point to a 1.16+ JDK (not a JRE)"
3030
exit 1
3131
fi
3232

@@ -36,7 +36,7 @@ java -version 2>&1 | grep --regexp 'version \"[1-9][2-9]'; echo $?
3636
if (( ( $? != 0 ) ))
3737
then
3838
java -version
39-
echo "This seems to be a older JDK. Please point your JAVA_HOME to a 1.12+ JDK for best results."
39+
echo "This seems to be a older JDK. Please point your JAVA_HOME to a 1.16+ JDK for best results."
4040
exit 1
4141
fi
4242

@@ -193,7 +193,7 @@ then
193193
MSG="After calling deployMultipleTomcats.py to create the tomcats for the components, we did not find the mgmt ui. One reason for this is a mismatch between the appliance identity ${ARCHAPPL_MYIDENTITY} and your appliances file at ${ARCHAPPL_APPLIANCES}. Please make that the appliance information for ${ARCHAPPL_MYIDENTITY} in ${ARCHAPPL_APPLIANCES} is correct."
194194
echo ${MSG}
195195
zenity --text="${MSG}" --error
196-
exit 1
196+
exit 1
197197
fi
198198

199199

@@ -214,7 +214,7 @@ echo "Setting MYSQL_CONNECTION_STRING to ${MYSQL_CONNECTION_STRING}"
214214

215215
# Use a SHOW DATABASES command to see if the connection string is valid
216216
let numtries=5
217-
mysql ${MYSQL_CONNECTION_STRING} -e "SHOW DATABASES" | grep information_schema
217+
mysql ${MYSQL_CONNECTION_STRING} -e "SHOW DATABASES" | grep information_schema
218218
while (( $? && ( ${numtries} > 1) ))
219219
do
220220
let numtries=numtries-1
@@ -226,13 +226,13 @@ do
226226
# We've tried a few times; must be a bug in the script.
227227
exit 1
228228
fi
229-
229+
230230
MSG="Please enter a MySQL Connection string like so"
231231
DEFAULT_MYSQL_CONNECTION_STRING = ${MYSQL_CONNECTION_STRING}
232232
echo $MSG
233233
export MYSQL_CONNECTION_STRING=$(zenity --entry --width=800 --text="$MSG" --entry-text="${DEFAULT_MYSQL_CONNECTION_STRING}")
234234
echo "Setting MYSQL_CONNECTION_STRING to ${MYSQL_CONNECTION_STRING}"
235-
235+
236236
mysql ${MYSQL_CONNECTION_STRING} -e "SHOW DATABASES" | grep information_schema
237237
done
238238

@@ -247,7 +247,7 @@ then
247247
if [[ $? == 0 ]] ; then
248248
echo "Creating tables in ${MYSQL_CONNECTION_STRING}"
249249
mysql ${MYSQL_CONNECTION_STRING} < ${SCRIPTS_DIR}/archappl_mysql.sql
250-
250+
251251
mysql ${MYSQL_CONNECTION_STRING} -e "SHOW TABLES" | grep PVTypeInfo
252252
if (( ( $? != 0 ) ))
253253
then
@@ -259,10 +259,10 @@ then
259259
else
260260
echo "Skipping creating MySQL tables."
261261
fi
262-
else
262+
else
263263
MSG="The EPICS archiver appliance tables already exist in the schema accessed by using ${MYSQL_CONNECTION_STRING}"
264264
echo ${MSG}
265-
zenity --text="${MSG}" --info
265+
zenity --text="${MSG}" --info
266266
fi
267267

268268

@@ -305,9 +305,9 @@ then
305305
fi
306306
307307
echo "Deploying a new release from \${WARSRC_DIR} onto \${DEPLOY_DIR}"
308-
pushd \${DEPLOY_DIR}/mgmt/webapps && rm -rf mgmt*; cp \${WARSRC_DIR}/mgmt.war .; mkdir mgmt; cd mgmt; jar xf ../mgmt.war; popd;
309-
pushd \${DEPLOY_DIR}/engine/webapps && rm -rf engine*; cp \${WARSRC_DIR}/engine.war .; mkdir engine; cd engine; jar xf ../engine.war; popd;
310-
pushd \${DEPLOY_DIR}/etl/webapps && rm -rf etl*; cp \${WARSRC_DIR}/etl.war .; mkdir etl; cd etl; jar xf ../etl.war; popd;
308+
pushd \${DEPLOY_DIR}/mgmt/webapps && rm -rf mgmt*; cp \${WARSRC_DIR}/mgmt.war .; mkdir mgmt; cd mgmt; jar xf ../mgmt.war; popd;
309+
pushd \${DEPLOY_DIR}/engine/webapps && rm -rf engine*; cp \${WARSRC_DIR}/engine.war .; mkdir engine; cd engine; jar xf ../engine.war; popd;
310+
pushd \${DEPLOY_DIR}/etl/webapps && rm -rf etl*; cp \${WARSRC_DIR}/etl.war .; mkdir etl; cd etl; jar xf ../etl.war; popd;
311311
pushd \${DEPLOY_DIR}/retrieval/webapps && rm -rf retrieval*; cp \${WARSRC_DIR}/retrieval.war .; mkdir retrieval; cd retrieval; jar xf ../retrieval.war; popd;
312312
echo "Done deploying a new release from \${WARSRC_DIR} onto \${DEPLOY_DIR}"
313313
@@ -339,7 +339,7 @@ then
339339
MSG="After deploying the release, cannot find a required file. The deployment did not succeed."
340340
echo ${MSG}
341341
zenity --text="${MSG}" --error
342-
exit 1
342+
exit 1
343343
fi
344344

345345
cat ${SCRIPTS_DIR}/sampleStartup.sh \
@@ -349,7 +349,7 @@ cat ${SCRIPTS_DIR}/sampleStartup.sh \
349349
| sed -e "s;export ARCHAPPL_APPLIANCES=/nfs/archiver/appliances.xml;export ARCHAPPL_APPLIANCES=${ARCHAPPL_APPLIANCES};g" \
350350
| sed -e "s;export ARCHAPPL_MYIDENTITY=\"appliance0\";export ARCHAPPL_MYIDENTITY=\"${ARCHAPPL_MYIDENTITY}\";g" \
351351
> ${DEPLOY_DIR}/sampleStartup.sh
352-
352+
353353
MSG="Do you have a site specific policies.py file?"
354354
echo ${MSG}
355355
zenity --text="${MSG}" --question
@@ -371,15 +371,12 @@ then
371371
cat ${DEPLOY_DIR}/sampleStartup.sh \
372372
| sed -e "s;# export ARCHAPPL_POLICIES=/nfs/epics/archiver/production_policies.py;export ARCHAPPL_POLICIES=${SITE_SPECIFIC_POLICIES_FILE};g" \
373373
> ${DEPLOY_DIR}/sampleStartup.sh.withpolicies
374-
374+
375375
mv -f ${DEPLOY_DIR}/sampleStartup.sh.withpolicies ${DEPLOY_DIR}/sampleStartup.sh
376376
fi
377-
377+
378378
chmod +x ${DEPLOY_DIR}/sampleStartup.sh
379379

380-
MSG="Done with the installation. Please use ${DEPLOY_DIR}/sampleStartup.sh to start and stop the appliance and ${DEPLOY_DIR}/deployRelease.sh to deploy a new release."
380+
MSG="Done with the installation. Please use ${DEPLOY_DIR}/sampleStartup.sh to start and stop the appliance and ${DEPLOY_DIR}/deployRelease.sh to deploy a new release."
381381
echo ${MSG}
382-
zenity --text="${MSG}" --info
383-
384-
385-
382+
zenity --text="${MSG}" --info

0 commit comments

Comments
 (0)