Author: buildbot
Date: Thu Jul 23 18:41:27 2015
New Revision: 959338
Log:
Staging update by buildbot for vcl
Modified:
websites/staging/vcl/trunk/content/ (props changed)
websites/staging/vcl/trunk/content/docs/vclPostScripts.html
Propchange: websites/staging/vcl/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Thu Jul 23 18:41:27 2015
@@ -1 +1 @@
-1687808
+1692427
Modified: websites/staging/vcl/trunk/content/docs/vclPostScripts.html
==============================================================================
--- websites/staging/vcl/trunk/content/docs/vclPostScripts.html (original)
+++ websites/staging/vcl/trunk/content/docs/vclPostScripts.html Thu Jul 23
18:41:27 2015
@@ -21,7 +21,7 @@
<link href="/css/vcl.css" rel="stylesheet" type="text/css">
<link href="/css/code.css" rel="stylesheet" type="text/css">
- <title>Apache VCL - VCL Post Load & Reserve scripts</title>
+ <title>Apache VCL - VCL Image Scripts: Post-Load, Post-Reserve, &
Post-Reservation</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
</head>
@@ -36,7 +36,18 @@
</div>
<div id="navigation">
- <ul>
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink,
h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink,
dt:hover > .elementid-permalink { visibility: visible }</style>
+<ul>
<li><a href="/index.html">Information</a><ul>
<li><a href="/info/features.html">Features</a></li>
<li><a href="/info/architecture.html">Architecture</a></li>
@@ -71,31 +82,107 @@
</div>
<div id="content">
- <h1 class="title">VCL Post Load & Reserve scripts</h1>
- <p>VCL post scripts allow for customization after a node is loaded or
reserved. If these scripts exists in the default location they will be excuted
at their designated times. These scripts are often used for Cluster on demand
or for handling custom tasks that are local to the node.</p>
-<p>The scripts are:</p>
-<ol>
-<li>
-<p>vcl_post_load</p>
-<ul>
-<li>File location in Linux /etc/init.d/vcl_post_load</li>
-<li>File location in Windows is SYSTEMROOT, usually
C:\Windows\vcl_post_load.cmd</li>
-<li>Executed after a node is loaded during the post_load process during a new
reservation or reload</li>
-<li>Created by the image owner</li>
-<li>Ideal for editing configuration files or registering OS</li>
+ <h1 class="title">VCL Image Scripts: Post-Load, Post-Reserve, &
Post-Reservation</h1>
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink,
h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink,
dt:hover > .elementid-permalink { visibility: visible }</style>
+<p>Scripts may be saved within VCL images which are automatically executed at
specific stages of the
+VCL
+reservation process. The scripts are added by the image creator prior to
saving the image. They
+must be
+located and named exactly as specified below.</p>
+<p>For Windows image scripts, the output is saved in
C:\Cygwin\root\VCL\Scripts\Logs. The name of
+the log file name corresponds to the name of the script. Example:
+C:\Cygwin\root\VCL\Scripts\Logs\vcl_post_load.log</p>
+<h2 id="post-load">Post-Load<a class="headerlink" href="#post-load"
title="Permanent link">¶</a></h2>
+<p>Location:</p>
+<ul>
+<li>Linux: /usr/local/vcl/vcl_post_load</li>
+<li>Windows: C:\Windows\vcl_post_load.cmd</li>
</ul>
-</li>
-<li>
-<p>vcl_post_reserve</p>
+<p>The post-load script will be executed every time a compute node is loaded,
meaning:</p>
+<ul>
+<li>Whether or not the compute node is assigned to a user's reservation</li>
+<li>After a user's reservation ends and the compute node is automatically
reloaded with another
+image</li>
+<li>After a compute node is reloaded with a specific image via the Manage
Computers utility</li>
+</ul>
+<p>The post-load script is executed after all of the standard
<em>post-load</em> steps are performed via
+SSH by the
+management node's vcld process. For Linux images, these steps include:</p>
<ul>
-<li>Linux File location /etc/init.d/vcl_post_reserve</li>
-<li>Windows File location is SYSTEMROOT, usually
C:\Windows\vcl_post_reserve.cmd</li>
-<li>Executed during an active reservation, when user hits "Connect" button</li>
-<li>Created by the image owner</li>
-<li>Ideal for making custom changes to configuration files, such as Cluster on
Demand or starting services </li>
+<li>Secure the firewall to only allow access from the management node</li>
+<li>Configure the SSH service so access is only permitted from the management
node</li>
+<li>Randomize the root password</li>
+<li>Set the node's hostname</li>
+</ul>
+<p>It is <strong>important</strong> to recognize that the steps listed above
to not include any steps related to
+the creation
+or configuration of user accounts intended for end user connections. The user
accounts have not
+been created
+prior to the stage when the post-load script is executed.</p>
+<p>The post-load script is useful for:</p>
+<ul>
+<li>Making changes to configuration files which require the IP address of the
compute node to be
+known</li>
+<li>Registering the compute node with an external service such as for OS
activation or software
+licensing</li>
+<li>Mounting external storage intended for system files or logs</li>
+</ul>
+<h2 id="post-reserve">Post-Reserve<a class="headerlink" href="#post-reserve"
title="Permanent link">¶</a></h2>
+<p>Location:</p>
+<ul>
+<li>Linux: /usr/local/vcl/vcl_post_reserve</li>
+<li>Windows: C:\Windows\vcl_post_reserve.cmd</li>
+</ul>
+<p>The post-reserve script is only executed when a user makes a reservation
for an image and
+acknowledges the
+reservation by clicking the Connect button. It is executed after the standard
<em>reserve</em> steps
+are performed
+via SSH by the management node's vcld process. These steps include:</p>
+<ul>
+<li>Add user account(s) and set passwords if applicable</li>
+<li>Grant access via SSH and other connect methods</li>
+<li>For cluster reservations, the /etc/cluster_info file is created</li>
+</ul>
+<p>The post-reserve script is useful for:</p>
+<ul>
+<li>Making changes to configuration files which require the username(s) to be
known</li>
+<li>Starting services which should only run when the compute node is available
to an end user</li>
+<li>Configuring the firewall to allow access to a particular service</li>
+<li>Configuring interaction with other compute nodes assigned to a cluster by
parsing the
+cluster_info file and
+modifying configuration files with information about the other cluster
nodes</li>
+<li>Mounting external storage intended for user files</li>
+</ul>
+<h2 id="post-reservation">Post-Reservation<a class="headerlink"
href="#post-reservation" title="Permanent link">¶</a></h2>
+<p>Location:</p>
+<ul>
+<li>Linux: /usr/local/vcl/vcl_post_reservation</li>
+<li>Windows: C:\Windows\vcl_post_reservation.cmd</li>
+</ul>
+<p>The post-reservation script is executed prior to a compute node being
reloaded. It does not
+matter if the
+compute node is reloaded with the same or a different image, nor does it
matter if the compute
+node was
+assigned to an end user reservation or simply is being reloaded via the
<em>Manage Computers</em>
+utility.</p>
+<p>The post-reservation script is useful for:</p>
+<ul>
+<li>Stopping services</li>
+<li>Unregistering the compute node from external services such as a license
server in order to free
+up a license
+for other users</li>
+<li>Removing/unregistering the node from an external shared filesystem</li>
</ul>
-</li>
-</ol>
</div>
<div id="footer">
