You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@vcl.apache.org by bu...@apache.org on 2012/12/10 22:32:44 UTC
svn commit: r841540 - in /websites/staging/vcl/trunk/content: ./
dev/releaseprocedures.html docs/windowsbaseimagecreation.html
Author: buildbot
Date: Mon Dec 10 21:32:43 2012
New Revision: 841540
Log:
Staging update by buildbot for vcl
Added:
websites/staging/vcl/trunk/content/dev/releaseprocedures.html
Modified:
websites/staging/vcl/trunk/content/ (props changed)
websites/staging/vcl/trunk/content/docs/windowsbaseimagecreation.html
Propchange: websites/staging/vcl/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Mon Dec 10 21:32:43 2012
@@ -1 +1 @@
-1419775
+1419792
Added: websites/staging/vcl/trunk/content/dev/releaseprocedures.html
==============================================================================
--- websites/staging/vcl/trunk/content/dev/releaseprocedures.html (added)
+++ websites/staging/vcl/trunk/content/dev/releaseprocedures.html Mon Dec 10 21:32:43 2012
@@ -0,0 +1,259 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE- 2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+ <link href="/css/vcl.css" rel="stylesheet" type="text/css">
+ <link href="/css/code.css" rel="stylesheet" type="text/css">
+ <title>Apache VCL - VCL Release Procedures</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+</head>
+
+<body>
+ <div id="sitetitle">
+ <table width="100%" border="0" cellspacing="0" cellpadding="5">
+ <tr>
+ <td><a href="/index.html"><img src="/img/vcl-logo.png" height="100" align="left" alt="Apache VCL logo"></a></td>
+ <td><a href="http://www.apache.org"><img src="/img/asf-logo.png" align="right" alt="Apache Software Foundation logo"></a></td>
+ </tr>
+ </table>
+ </div>
+
+ <div id="navigation">
+ <ul>
+<li>Information<ul>
+<li><a href="/info/about.html">What is VCL?</a></li>
+<li><a href="/info/features.html">Features</a></li>
+<li><a href="/info/architecture.html">Architecture</a></li>
+<li><a href="/info/use-cases.html">Use Cases</a></li>
+<li><a href="/downloads/download.cgi">Download</a></li>
+<li><a href="http://www.apache.org/licenses/LICENSE-2.0.html">License</a></li>
+<li><a href="/info/faq.html">FAQ</a></li>
+</ul>
+</li>
+<li><a href="/docs/index.html">Documentation</a><ul>
+<li><a href="/docs/using-vcl.html">Using VCL</a></li>
+<li><a href="/docs/image-creation.html">Image Creation</a></li>
+<li><a href="/docs/administration.html">Administration</a></li>
+<li><a href="/docs/installation.html">Installation</a></li>
+<li><a href="/docs/deployment-planning.html">Deployment Planning</a></li>
+</ul>
+</li>
+<li><a href="/comm/index.html">Community</a><ul>
+<li><a href="/comm/index.html#getInvolved">Getting Involved</a></li>
+<li><a href="/comm/index.html#mail-list">Mailing Lists</a></li>
+<li><a href="/comm/index.html#how-do-i-join-the-project">How can I Join</a></li>
+<li><a href="/comm/wiki.html">Wiki</a></li>
+<li><a href="/dev/index.html">Development</a><ul>
+<li><a href="/dev/jira.html">Issue Tracking</a></li>
+<li><a href="/dev/code-documentation.html">Code Documentation</a></li>
+<li><a href="/dev/roadmap.html">Roadmap</a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li><a href="http://www.apache.org">Apache Software Foundation</a><ul>
+<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
+<li><a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a></li>
+</ul>
+</li>
+</ul>
+ </div>
+
+ <div id="content">
+ <h1 class="title">VCL Release Procedures</h1>
+ <h1 id="prerequisites-things-that-must-be-done-before-a-release">Prerequisites: Things that must be done before a release</h1>
+<ul>
+<li>all items from the JIRA roadmap for the release must be completed or
+moved to a future release</li>
+<li>ALL human readable files must contain the Apache license header<ul>
+<li>this includes style sheets, test code, and documentation - when in
+ doubt, add a header</li>
+<li>files that are part of other software packages that are bundled with
+ a release must not contain the header (unless that software is also ASF
+ software) and should be clearly documented as being bundled software</li>
+</ul>
+</li>
+<li>LICENSE and NOTICE files should be reviewed<ul>
+<li>LICENSE: This file should have the Apache License at the top of it;
+ any third party artifacts or documents included in the release should
+ have their licenses included in this file along with a clear explanation
+ of which files each license applies to.</li>
+<li>NOTICE: This file is for additional copyright and attribution
+ statements any third party licenses may require. A typical NOTICE
+ document at a minimum includes a copyright and attribution statement for
+ The Apache Software Foundation. Nothing else belongs in the NOTICE document.</li>
+<li>Make sure copyright date is correct in NOTICE file</li>
+</ul>
+</li>
+<li>Files containing the VCL version should be updated to the version being
+released<ul>
+<li>The backend Perl files contain a line defining a $VERSION variable,
+ this should be updated in every file</li>
+</ul>
+</li>
+<li>documentation on how to upgrade from a previous release must be created<ul>
+<li>if appropriate, scripts to help users upgrade should be created
+ (don't forget steps/scripts to upgrade the database schema)</li>
+</ul>
+</li>
+<li>RELEASE_NOTES file needs to be updated and should contain:<ul>
+<li>release version</li>
+<li>an intro to VCL</li>
+<li>a brief description of the aims of VCL</li>
+<li>a brief roadmap of VCL and how this release fits in to it</li>
+<li>a list of ways for users to get involved</li>
+<li>a description of how users can submit issues</li>
+</ul>
+</li>
+<li>the README file must also contain all dependencies (this includes PHP,
+Perl, MySQL versions in addition to perl and php modules, dojo, etc.) for
+running VCL, any changes in dependencies since the last release must be
+listed in the CHANGLOG file</li>
+<li>generate a CHANGELOG file<ul>
+<li>go to the <a href="https://issues.apache.org/jira/secure/ConfigureReleaseNote.jspa?projectId=12310840&version=12322740">Create Release Notes</a> page of the JIRA site</li>
+<li>select the release version</li>
+<li>select <strong>text</strong> as the style</li>
+<li>click <strong>Create</strong></li>
+<li>scroll down to <strong>Edit/Copy Release Notes</strong></li>
+<li>copy/paste the contents to a new section in the CHANGELOG file</li>
+<li>make sure to add any changes in the dependencies since the last release</li>
+</ul>
+</li>
+<li>make sure INSTALLATION file is up to date with content from Confluence on
+how to install each part</li>
+<li>ensure LICENSE, NOTICE, RELEASE_NOTES, CHANGELOG, INSTALLATION, UPGRADE,
+and README files are in top level directory of trunk (or the branch that
+will be used for the release)</li>
+<li>an export from HEAD should result in a directory tree with all files and
+directories having appropriate permissions</li>
+<li>release manager's GPG signing key must be in KEYS file in toplevel
+directory of SVN (one above trunk)</li>
+<li>a release/download page needs to be created for the specific release
+containing:<ul>
+<li>link to release artifact (link to a mirror)</li>
+<li>link to signatures and checksums (link directly to apache.org)</li>
+<li>steps explaining how to verify artifact using signatures and checksums</li>
+<li>either a link to release notes or contain them inline</li>
+<li>either a link to a change log or contain it inline</li>
+</ul>
+</li>
+<li>a decision needs to be made determining which, if any, previously released
+artifacts should be removed from the main distribution site after this
+release is completed</li>
+<li>make sure the index.php file from the web code has the correct VCL
+version at the top of it</li>
+</ul>
+<h1 id="steps-to-create-a-release-candidate-artifact">Steps to create a release candidate artifact</h1>
+<ul>
+<li>A tag for the release candidate needs to be created in subversion. It
+should be created under the <strong>tags</strong> directory of the repository and should be
+named <strong>release-W.X.Y-RCZ</strong> (with Z being the release candidate number, starting
+with 1 and with .Y only being included if Y > 0)</li>
+<li>export from this tag to get the code for the release candidate</li>
+<li>add Dojo Toolkit<ul>
+<li>download and extract most recent (and tested to work with web code)
+ version of Dojo Toolkit under 'web'</li>
+<li>rename extracted dojo directory to just 'dojo'</li>
+<li>change to themes directory and run './copydojocss.sh default'</li>
+<li>update the version listed for Dojo in the README file</li>
+</ul>
+</li>
+<li>remove any VCL perl modules that should not be part of the release</li>
+<li>create a tarball of the directory<ul>
+<li>compress it with bzip2</li>
+<li>name it apache-VCL-W.X.Y-RCZ-incubating.tar.bz2 (the .Y should only
+ be included if Y > 0)</li>
+</ul>
+</li>
+<li>create MD5 and SHA-1 sums of the tarball</li>
+<li>sign the tarball with GPG<ul>
+<li><a href="http://www.apache.org/dev/release-signing.html#sign-release">This document</a> contains information on how to sign the tarball</li>
+</ul>
+</li>
+<li>distribute the RC through the release manager's personal web space on
+people.apache.org (RC are not to be release from the main distribution area
+to cut down on archive storage and mirroring bandwidth)</li>
+</ul>
+<h1 id="community-and-pmc-voting-process">Community and PMC voting process</h1>
+<ul>
+<li>release manager should start a <a href="http://www.apache.org/foundation/voting.html#ReleaseVotes">VOTE</a> thread on the dev list; <a href="http://markmail.org/message/ysdor5uddhviawln">this is a
+good example</a></li>
+<li>the release manage's vote should be posted in a separate message from the
+one calling for the vote</li>
+<li>the VOTE thread should be ended with a reply post including [RESULT] in the
+subject; <a href="http://markmail.org/message/kanwckkfrnbcs2s7">this is a good example</a> except that it is missing the [RESULT] part from
+the subject</li>
+</ul>
+<h1 id="steps-to-make-the-rc-available-as-a-release-artifact">Steps to make the RC available as a release artifact</h1>
+<ul>
+<li>create a tag for the release from the approved RC tag (svn copy from RC
+tag to new release tag)</li>
+<li>create a copy of the approved RC artifact and name it
+apache-VCL-X.Y.Z-incubating.tar.bz2 (the .Z should only be included if Z > 0) -
+untar old one, rename director to not have RC part, create new tarball</li>
+<li>sign the file with GPG</li>
+<li>create md5 and sha1 sum files</li>
+</ul>
+<h1 id="steps-to-make-release-artifact-available-to-users">Steps to make release artifact available to users</h1>
+<ul>
+<li>place the release artifact, sums, and signature in
+/www/www.apache.org/dist/vcl on people.apache.org</li>
+<li>ensure the artifact has permissions 664 and is owned by the vcl group</li>
+<li>wait 24 hours for the artifact to propagate to the mirrors before
+announcing the release<ul>
+<li>ideally, a test download should be done from the mirror and a check
+ of the sums and signatures should be done</li>
+</ul>
+</li>
+<li>After successfully performing a test download from the mirror,
+announcements should be made<ul>
+<li>on the dev@ list</li>
+<li>on the user@ list</li>
+<li>update currently listed version and download link on <a href="http://vcl.apache.org/downloads/download.cgi">download page</a></li>
+</ul>
+</li>
+<li>Set the newly released version to the Release status in JIRA so that people
+will be able to see it as released when reporting bugs<ul>
+<li>Go to the <a href="https://issues.apache.org/jira/browse/VCL#selectedTab=com.atlassian.jira.plugin.system.project%3Aversions-panel">versions page</a> of the JIRA site</li>
+<li>click <strong>Manage Versions</strong></li>
+<li>mouse over the line of the release version</li>
+<li>click the gear menu drop down</li>
+<li>click Release and follow the instructions</li>
+</ul>
+</li>
+</ul>
+<p><strong>IMPORTANT</strong>: Once a release is copied to the dist location, it <strong>must not be
+modified</strong>. This can signal that an attack is being performed. If an error is
+found, a new .Z release should be made.</p>
+ </div>
+
+ <div id="footer">
+ <div class="copyright">
+ <p>
+ Copyright © 2012 The Apache Software Foundation, Licensed under
+ the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+ <br />
+ Apache and the Apache feather logo are trademarks of The Apache Software Foundation.
+ </p>
+ </div>
+ </div>
+
+</body>
+</html>
Modified: websites/staging/vcl/trunk/content/docs/windowsbaseimagecreation.html
==============================================================================
--- websites/staging/vcl/trunk/content/docs/windowsbaseimagecreation.html (original)
+++ websites/staging/vcl/trunk/content/docs/windowsbaseimagecreation.html Mon Dec 10 21:32:43 2012
@@ -199,6 +199,71 @@
</li>
<li>Click Next > Finish</li>
</ul>
+<h4 id="install-windows">Install Windows</h4>
+<p><strong>VMware Only: Install VMware Tools</strong></p>
+<ul>
+<li>Power on the VM if it is not already powered on</li>
+<li>Install VMWare Tools (Note: you must have a CD-ROM drive configured for the VM in order to install VMware Tools)<ul>
+<li>Click on the VM menu and select "Install VMWare Tools"</li>
+<li>Select Typical and proceed through the setup pages accepting the defaults</li>
+<li>Reboot the VM when installation is complete</li>
+</ul>
+</li>
+</ul>
+<h4 id="install-cygwin-sshd">Install Cygwin SSHD</h4>
+<p>Follow the steps: Install & Configure Cygwin SSHD</p>
+<p><strong>Run vcld -setup</strong></p>
+<ol>
+<li>
+<p>Run the following command on the management node:</p>
+<p>/usr/local/vcl/bin/vcld -setup</p>
+</li>
+<li>
+<p>Navigate the menu options</p>
+<ul>
+<li>(Note: the names and numbers of the menu items may not match your installation):</li>
+<li>Select a module to configure: VCL Image State Module</li>
+<li>Choose an operation: Capture Base Image</li>
+<li>Enter the VCL login name or ID of the user who will own the image:</li>
+<li>Enter your VCL user ID or the user ID of the user you want to own the image. Pressing Enter without entering a user login ID will cause admin to be the owner of the new base image.</li>
+<li>Enter the hostname or IP address of the computer to be captured:</li>
+<li>Enter the name or private IP address of the computer which has already added to the VCL database.</li>
+<li>Select the OS to be captured:<ol>
+<li>VMware Linux</li>
+<li>VMware Windows 2003 Server</li>
+<li>VMware Windows 7</li>
+<li>VMware Windows Server 2008</li>
+<li>VMware Windows Vista</li>
+<li>VMware Windows XP</li>
+</ol>
+</li>
+<li>Image architecture:<ol>
+<li>x86</li>
+<li>x86_64</li>
+</ol>
+</li>
+<li>Use Sysprep:<ol>
+<li>Yes</li>
+<li>No</li>
+<li>Sysprep is usually only required if the image will be loaded on bare metal computers with varying different hardware.</li>
+</ol>
+</li>
+<li>Enter the name of the image to be captured: <ul>
+<li>The name you enter is the name that will be displayed in the list of environments. It may contain spaces but including other special characters is not recommended.</li>
+</ul>
+</li>
+</ul>
+</li>
+</ol>
+<p>The following happens once you enter an image name and press enter:</p>
+<ul>
+<li>A new image is added to the VCL database</li>
+<li>An imaging request is added to the VCL database</li>
+<li>The vcld -setup automatically initiates 'tail -f /var/log/vcld.log' to monitor the vcld log file. The output should be displayed on the screen.</li>
+</ul>
+<p>Watch the vcld logfile output to determine if the image capture process is successful or terminated because a problem occurred. When the capture process terminates, there will either be a message near the end of the output saying "image capture successful" or there will be several WARNING messages, the last of which says something to the effect "image failed to be captured". Further troubleshooting is required if the image fails to be captured.</p>
+<h4 id="add-the-base-image-to-an-image-group">Add the Base Image to an Image Group</h4>
+<p>The vcld -setup utility does not add the new base image to any image groups. You must add the image to an image group using the VCL website after the image capture process is complete. Reservations for the image cannot be made until this is done. To add the image to an image group, browse to the VCL website and select Manage Images > Edit Image Grouping.</p>
</div>
<div id="footer">