http://git-wip-us.apache.org/repos/asf/incubator-trafodion-site/blob/c166c834/document.html ---------------------------------------------------------------------- diff --git a/document.html b/document.html deleted file mode 100644 index f8430cd..0000000 --- a/document.html +++ /dev/null @@ -1,870 +0,0 @@ - -<!DOCTYPE html> -<!-- - Generated by Apache Maven Doxia at 2016-01-27 - Rendered using Reflow Maven Skin 1.1.1 (http://andriusvelykis.github.io/reflow-maven-skin) ---> -<html xml:lang="en" lang="en"> - - <head> - <meta charset="UTF-8" /> - <title>Apache Trafodion Modify Documentation</title> - <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <meta name="description" content="" /> - <meta http-equiv="content-language" content="en" /> - - <link href="http://netdna.bootstrapcdn.com/bootswatch/2.3.2/cerulean/bootstrap.min.css"; rel="stylesheet" /> - <link href="http://netdna.bootstrapcdn.com/twitter-bootstrap/2.3.1/css/bootstrap-responsive.min.css"; rel="stylesheet" /> - <link href="./css/bootswatch.css" rel="stylesheet" /> - <link href="./css/reflow-skin.css" rel="stylesheet" /> - - <link href="http://yandex.st/highlightjs/7.5/styles/default.min.css"; rel="stylesheet" /> - - <link href="./css/lightbox.css" rel="stylesheet" /> - - <link href="./css/site.css" rel="stylesheet" /> - <link href="./css/print.css" rel="stylesheet" media="print" /> - - <!-- Le HTML5 shim, for IE6-8 support of HTML5 elements --> - <!--[if lt IE 9]> - <script src="http://html5shim.googlecode.com/svn/trunk/html5.js";></script> - <![endif]--> - - - - <!-- Google Analytics --> - <script type="text/javascript"> - - var _gaq = _gaq || []; - _gaq.push(['_setAccount', 'UA-72491210-1']); - _gaq.push(['_trackPageview']); - - (function() { - var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; - ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); - })(); - - </script> - </head> - - <body class="page-document project-trafodion" data-spy="scroll" data-offset="60" data-target="#toc-scroll-target"> - - <div class="navbar navbar-fixed-top"> - <div class="navbar-inner"> - <div class="container"> - <a class="btn btn-navbar" data-toggle="collapse" data-target="#top-nav-collapse"> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - </a> - <a class="brand" href="index.html">Apache <span class="color-highlight">Trafodion</span></a> - <div class="nav-collapse collapse" id="top-nav-collapse"> - <ul class="nav pull-right"> - <li ><a href="download.html" title="Download">Download</a></li> - <li class="dropdown"> - <a href="#" class="dropdown-toggle" data-toggle="dropdown">About <b class="caret"></b></a> - <ul class="dropdown-menu"> - <li ><a href="index.html" title="Project Overview">Project Overview</a></li> - <li ><a href="new-features.html" title="New Features">New Features</a></li> - <li ><a href="roadmap.html" title="Roadmap">Roadmap</a></li> - <li ><a href="performance.html" title="Performance">Performance</a></li> - <li ><a href="http:divider" title=""></a></li> - <li ><a href="team-list.html" title="Team">Team</a></li> - <li ><a href="presentations.html" title="Presentations">Presentations</a></li> - <li ><a href="mail-lists.html" title="Mailing List">Mailing List</a></li> - <li ><a href="http:divider" title=""></a></li> - <li ><a href="source-repository.html" title="Source Repository">Source Repository</a></li> - <li ><a href="issue-tracking.html" title="Issue Tracking">Issue Tracking</a></li> - <li ><a href="license.html" title="License">License</a></li> - </ul> - </li> - <li class="dropdown"> - <a href="#" class="dropdown-toggle" data-toggle="dropdown">Using <b class="caret"></b></a> - <ul class="dropdown-menu"> - <li ><a href="quickstart.html" title="Quick Start">Quick Start</a></li> - <li ><a href="download.html" title="Download">Download</a></li> - <li ><a href="install.html" title="Install">Install</a></li> - <li ><a href="uninstall.html" title="Uninstall">Uninstall</a></li> - <li ><a href="management.html" title="Managing Trafodion">Managing Trafodion</a></li> - <li ><a href="http:divider" title=""></a></li> - <li ><a href="documentation.html" title="Documentation">Documentation</a></li> - <li ><a href="port-assignment.html" title="Port Assignments">Port Assignments</a></li> - <li ><a href="faq.html" title="FAQ">FAQ</a></li> - <li ><a href="release-notes.html" title="Release Notes">Release Notes</a></li> - </ul> - </li> - <li class="dropdown"> - <a href="#" class="dropdown-toggle" data-toggle="dropdown">Features <b class="caret"></b></a> - <ul class="dropdown-menu"> - <li ><a href="architecture-overview.html" title="Architecture Overview">Architecture Overview</a></li> - <li ><a href="http:divider" title=""></a></li> - <li ><a href="https://blueprints.launchpad.net/trafodion/+spec/security-ansi-schemas"; title="ANSI Schema Support" class="externalLink">ANSI Schema Support</a></li> - <li ><a href="https://blueprints.launchpad.net/trafodion/+spec/ustat-automation"; title="Automated Update Statistics" class="externalLink">Automated Update Statistics</a></li> - <li ><a href="https://blueprints.launchpad.net/trafodion/+spec/bulkunload"; title="Bulk Unload" class="externalLink">Bulk Unload</a></li> - <li ><a href="https://wiki.trafodion.org/wiki/index.php/Trafodion_Manageability#Logging_Events"; title="Event Handling" class="externalLink">Event Handling</a></li> - <li ><a href="https://blueprints.launchpad.net/trafodion/+spec/hybrid-query-cache"; title="Hybrid Query Cache" class="externalLink">Hybrid Query Cache</a></li> - <li ><a href="https://blueprints.launchpad.net/trafodion/+spec/identity-column"; title="Identity Column" class="externalLink">Identity Column</a></li> - <li ><a href="https://wiki.trafodion.org/wiki/index.php/Creating_Statistics_During_Bulk_Load"; title="Immediate Update Statistics" class="externalLink">Immediate Update Statistics</a></li> - <li ><a href="https://blueprints.launchpad.net/trafodion/+spec/lob-support"; title="Large Object (LOB)" class="externalLink">Large Object (LOB)</a></li> - <li ><a href="https://blueprints.launchpad.net/trafodion/+spec/ddl-query-invalidation"; title="Metadata Query Invalidation" class="externalLink">Metadata Query Invalidation</a></li> - <li ><a href="https://cwiki.apache.org/confluence/display/TRAFODION/Cmp-divisioning"; title="Multi-Temperature Data" class="externalLink">Multi-Temperature Data</a></li> - <li ><a href="https://blueprints.launchpad.net/trafodion/+spec/access-external-hbase-tables"; title="Native HBase Tables" class="externalLink">Native HBase Tables</a></li> - <li ><a href="docs/odb_user/index.html" title="ODB">ODB</a></li> - <li ><a href="https://blueprints.launchpad.net/trafodion/+spec/sql-query-cancel"; title="Query Cancel" class="externalLink">Query Cancel</a></li> - <li ><a href="https://blueprints.launchpad.net/trafodion/+spec/security-privilege-updates"; title="Privilege Checking" class="externalLink">Privilege Checking</a></li> - <li ><a href="https://wiki.trafodion.org/wiki/index.php/Trafodion_Manageability"; title="Repository" class="externalLink">Repository</a></li> - <li ><a href="https://blueprints.launchpad.net/trafodion/+spec/enable-get-statistics-thru-rms"; title="Runtime Management System" class="externalLink">Runtime Management System</a></li> - <li ><a href="https://blueprints.launchpad.net/trafodion/+spec/sequence-numbers"; title="Sequence Numbers" class="externalLink">Sequence Numbers</a></li> - <li ><a href="https://blueprints.launchpad.net/trafodion/+spec/skew-buster"; title="Skew Buster" class="externalLink">Skew Buster</a></li> - <li ><a href="https://wiki.trafodion.org/wiki/index.php/Tutorial:_The_object-oriented_UDF_interface"; title="Table-Oriented UDF" class="externalLink">Table-Oriented UDF</a></li> - <li ><a href="https://wiki.trafodion.org/wiki/index.php/Data_Loading#Trickle_Loading_Data_Into_Trafodion_Tables"; title="Trickle Load" class="externalLink">Trickle Load</a></li> - <li ><a href="http:divider" title=""></a></li> - <li ><a href="https://wiki.trafodion.org/wiki/index.php/Backup_and_Restore"; title="Backup/Restore Utility" class="externalLink">Backup/Restore Utility</a></li> - <li ><a href="https://wiki.trafodion.org/wiki/index.php/Metadata_Cleanup"; title="Metadata Cleanup Utility" class="externalLink">Metadata Cleanup Utility</a></li> - </ul> - </li> - <li class="dropdown active"> - <a href="#" class="dropdown-toggle" data-toggle="dropdown">Contributing <b class="caret"></b></a> - <ul class="dropdown-menu"> - <li ><a href="contribute.html" title="Contribute">Contribute</a></li> - <li ><a href="advocate.html" title="Advocate">Advocate</a></li> - <li ><a href="develop.html" title="Develop">Develop</a></li> - <li ><a href="testing.html" title="Test">Test</a></li> - <li ><a href="merge.html" title="Merge">Merge</a></li> - <li ><a href="release.html" title="Release">Release</a></li> - <li ><a href="http:divider" title=""></a></li> - <li ><a href="create-dev-environment.html" title="Create Dev Environment">Create Dev Environment</a></li> - <li ><a href="manage-dev-environment.html" title="Manage Dev Environment">Manage Dev Environment</a></li> - <li ><a href="setup-build-environment.html" title="Setup Build Environment">Setup Build Environment</a></li> - <li ><a href="build.html" title="Build Trafodion">Build Trafodion</a></li> - <li ><a href="http:divider" title=""></a></li> - <li ><a href="code.html" title="Modify Code">Modify Code</a></li> - <li ><a href="tests.html" title="Modify Tests">Modify Tests</a></li> - <li class="active"><a href="" title="Modify Documentation">Modify Documentation</a></li> - <li ><a href="website.html" title="Modify Web Site">Modify Web Site</a></li> - <li ><a href="wiki.html" title="Modify Wiki Pages">Modify Wiki Pages</a></li> - <li ><a href="http:divider" title=""></a></li> - <li ><a href="cplusplus-coding-guidelines.html" title="C++ Coding Guidelines">C++ Coding Guidelines</a></li> - </ul> - </li> - <li class="dropdown"> - <a href="#" class="dropdown-toggle" data-toggle="dropdown">Apache <b class="caret"></b></a> - <ul class="dropdown-menu"> - <li ><a href="http://incubator.apache.org/projects/trafodion.html"; title="Project Status" target="_blank" class="externalLink">Project Status</a></li> - <li ><a href="http://www.apache.org/foundation/how-it-works.html"; title="Apache Foundation" target="_blank" class="externalLink">Apache Foundation</a></li> - <li ><a href="http://www.apache.org/licenses/"; title="Apache License" target="_blank" class="externalLink">Apache License</a></li> - <li ><a href="http://www.apache.org/security/"; title="Apache Security" target="_blank" class="externalLink">Apache Security</a></li> - <li ><a href="http:divider" title=""></a></li> - <li ><a href="http://www.apache.org/foundation/sponsorship.html"; title="Sponsorship" target="_blank" class="externalLink">Sponsorship</a></li> - <li ><a href="http://www.apache.org/foundation/thanks.html"; title="Thanks" target="_blank" class="externalLink">Thanks</a></li> - </ul> - </li> - </ul> - </div><!--/.nav-collapse --> - </div> - </div> - </div> - - <div class="container"> - - <!-- Masthead - ================================================== --> - - <header> - <div class="jumbotron subhead"> - <div class="row" id="banner"> - <div class="span12"> - <div class="pull-left"> - <a href="index.html" id="bannerLeft"><h1>Apache <span class="color-highlight">Trafodion</span></h1></a> - <p class="lead">Transactional SQL-on-Hadoop Database</p> - </div> - <div class="pull-right"> - </div> - </div> - </div> - </div> - <div> - <ul class="breadcrumb"> - <li><a href="index.html" title="Trafodion">Trafodion</a></li> - <li class="divider">/</li> - <li>Modify Documentation</li> - </ul> - </div> - <hr class="toc-separator" /> - <div id="toc-bar" class="navbar" data-spy="affix" data-offset-top="250"> - <div class="navbar-inner"> - <div id="toc-scroll-target" class="container"> - <a class="btn btn-navbar" data-toggle="collapse" data-target="#toc-nav-collapse"> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - </a> - <div class="nav-collapse collapse" id="toc-nav-collapse"> - <ul id="toc" class="nav"> - <li class="dropdown"> - <a href="#source" title="Source" class="dropdown-toggle" role="button" data-toggle="dropdown" data-target="#">Source <b class="caret"></b></a> - <ul class="dropdown-menu" role="menu"> - <!-- Repeat the item, otherwise it is not clickable as the dropdown root --> - <li><a href="#source" title="Source">Source</a></li> - <li class="divider"></li> - <li><a href="#Source_Location" title="Source Location">Source Location</a></li> - <li class="dropdown-submenu"> - <a href="#Source_Tree_Organization" title="Source Tree Organization">Source Tree Organization</a> - <ul class="dropdown-menu" role="menu"> - <li><a href="#DCS_and_REST" title="DCS and REST">DCS and REST</a></li> - <li><a href="#All_Other" title="All Other">All Other</a></li> - - </ul> - </li> - - </ul> - </li> - <li class="divider-vertical"></li> - <li class="dropdown"> - <a href="#making_changes" title="Making Changes" class="dropdown-toggle" role="button" data-toggle="dropdown" data-target="#">Making Changes <b class="caret"></b></a> - <ul class="dropdown-menu" role="menu"> - <!-- Repeat the item, otherwise it is not clickable as the dropdown root --> - <li><a href="#making_changes" title="Making Changes">Making Changes</a></li> - <li class="divider"></li> - <li><a href="#Building_an_Individual_Document" title="Building an Individual Document">Building an Individual Document</a></li> - <li><a href="#Building_the_Entire_Website_including_Documents" title="Building the Entire Website, including Documents">Building the Entire Website, including Documents</a></li> - - </ul> - </li> - <li class="divider-vertical"></li> - <li class="dropdown"> - <a href="#build_trafodion_document_tree" title="Build Trafodion Document Tree" class="dropdown-toggle" role="button" data-toggle="dropdown" data-target="#">Build Trafodion Document Tree <b class="caret"></b></a> - <ul class="dropdown-menu" role="menu"> - <!-- Repeat the item, otherwise it is not clickable as the dropdown root --> - <li><a href="#build_trafodion_document_tree" title="Build Trafodion Document Tree">Build Trafodion Document Tree</a></li> - <li class="divider"></li> - <li><a href="#Version_Directories" title="Version Directories">Version Directories</a></li> - <li><a href="#Document_Directories" title="Document Directories">Document Directories</a></li> - - </ul> - </li> - <li class="divider-vertical"></li> - <li class="toplevel"><a href="#publish" title="Publish">Publish</a></li> - </ul> - </div> - </div> - </div> - </div> - </header> - - <div class="main-body"> - <div class="row"> - <div class="span12"> - <div class="body-content"> -<!-- Licensed 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 expreess or implied. - See the License for the specific language governing permissions and - limitations under the - License. --> -<p>This page describes how to modify the Trafodion documentation. Please refer to the <a href="contribute.html">Contribute</a> page for information about other ways to contribute to the Trafodion project.</p> -<div class="page-header"> - <h1 id="source">Source</h1> -</div> -<p>Documents do <b>not</b> include version information as part of the file name.</p> -<div class="section"> - <h2 id="Source_Location">Source Location</h2> - <table border="0" class="bodyTable table table-striped table-hover"> - <thead> - <tr class="a"> - <th>Document </th> - <th>Source Format </th> - <th>Source Tree </th> - <th>Output Format</th> - </tr> - </thead> - <tbody> - <tr class="b"> - <td>Client Installation Guide </td> - <td>asciidoc </td> - <td><tt>docs/client_install/</tt> </td> - <td>Web Book, PDF</td> - </tr> - <tr class="a"> - <td>Command Interface Guide </td> - <td>asciidoc </td> - <td><tt>docs/comand_interface/</tt> </td> - <td>Web Book, PDF</td> - </tr> - <tr class="b"> - <td>DCS Reference Guide </td> - <td>asciidoc </td> - <td><tt>dcs/src/main/asciidoc/</tt> </td> - <td>Web Book</td> - </tr> - <tr class="a"> - <td>DCS APIs </td> - <td>javadoc </td> - <td><tt>dcs/src/main/java/</tt> </td> - <td>Web Book</td> - </tr> - <tr class="b"> - <td>odb User Guide </td> - <td>asciidoc </td> - <td><tt>docs/odb/</tt> </td> - <td>Web Book, PDF</td> - </tr> - <tr class="a"> - <td>REST Reference Guide </td> - <td>asciidoc </td> - <td><tt>core/rest/src/main/asciidoc/</tt> </td> - <td>Web Book</td> - </tr> - <tr class="b"> - <td>REST APIs </td> - <td>javadoc </td> - <td><tt>core/rest/src/main/java/</tt> </td> - <td>Web Book</td> - </tr> - <tr class="a"> - <td>SQL Reference Manual </td> - <td>asciidoc </td> - <td><tt>/docs/sql_reference/</tt> </td> - <td>Web Book, PDF</td> - </tr> - </tbody> - </table> -</div> -<div class="section"> - <h2 id="Source_Tree_Organization">Source Tree Organization</h2> - <div class="section"> - <h3 id="DCS_and_REST">DCS and REST</h3> - </div> - <div class="section"> - <h3 id="All_Other">All Other</h3> - <p>All other documents share a common web-book stylesheet definition, which is located in <b><tt>docs/css/trafodion-manuals.css</tt></b>.</p> - <p>The source tree for each manual is organized as follows:</p> - <table border="0" class="bodyTable table table-striped table-hover"> - <thead> - <tr class="a"> - <th>File/Directory </th> - <th>Content</th> - </tr> - </thead> - <tbody> - <tr class="b"> - <td><b><tt>pom.xml</tt></b> </td> - <td>Maven Project Object Model (POM) used to build the document.</td> - </tr> - <tr class="a"> - <td><b><tt>src/</tt></b> </td> - <td>The source files used to define the document.</td> - </tr> - <tr class="b"> - <td><b><tt>src/asciidoc</tt></b> </td> - <td>Asciidoc files for the document.</td> - </tr> - <tr class="a"> - <td><b><tt>src/asciidoc/index.adoc</tt></b> </td> - <td>Main asciidoc defining the document. Includes the different chapters from the <b><tt>_chapters</tt></b> directory.</td> - </tr> - <tr class="b"> - <td><b><tt>src/asciidoc/_chapters/</tt></b> </td> - <td>Source files for the different chapters in the document.</td> - </tr> - <tr class="a"> - <td><b><tt>images/</tt></b> </td> - <td>Images used in the document.</td> - </tr> - <tr class="b"> - <td><b><tt>resources/</tt></b> </td> - <td>Other include materials; for example, source examples that are included with the document.</td> - </tr> - <tr class="a"> - <td><b><tt>target/</tt></b> </td> - <td>Build output directory. Contains the web book, the PDF file, and supporting directories.</td> - </tr> - <tr class="b"> - <td><b><tt>target/index.pdf</tt></b> </td> - <td>Generated PDF version of the document.</td> - </tr> - <tr class="a"> - <td><b><tt>target/images/</tt></b> </td> - <td>Copy of the <b><tt>images/</tt></b> directory.</td> - </tr> - <tr class="b"> - <td><b><tt>target/resources/</tt></b> </td> - <td>Copy of the <b><tt>resources/</tt></b> directory.</td> - </tr> - <tr class="a"> - <td><b><tt>target/site/</tt></b> </td> - <td>Generated web-book directory.</td> - </tr> - <tr class="b"> - <td><b><tt>target/site/index.html</tt></b> </td> - <td>Generated web book.</td> - </tr> - <tr class="a"> - <td><b><tt>target/site/css/</tt></b> </td> - <td>Stylesheets related to the web book. The common stylesheet is included in the index.html file.</td> - </tr> - <tr class="b"> - <td><b><tt>target/site/images/</tt></b> </td> - <td>Copy of the <b><tt>images/</tt></b> directory.</td> - </tr> - <tr class="a"> - <td><b><tt>target/site/resources/</tt></b> </td> - <td>Copy of the <b><tt>resources/</tt></b> directory.</td> - </tr> - </tbody> - </table> - <h1 id="making_changes">Making Changes</h1> - <p>Please refer to the following web sites for guidance for information about working on asciidoc-based documentation.</p> - <ul> - <li><a class="externalLink" href="https://github.com/apache/incubator-trafodion/blob/master/dcs/src/main/asciidoc/_chapters/appendix_contributing_to_documentation.adoc";>DCS Contributing to Documentation</a></li> - <li><a class="externalLink" href="http://www.methods.co.nz/asciidoc/chunked/index.html";>AsciiDoc User Guide</a></li> - <li><a class="externalLink" href="http://powerman.name/doc/asciidoc";>AsciiDoc cheatsheet</a></li> - <li><a class="externalLink" href="https://github.com/asciidoctor/asciidoctor-pdf/blob/master/docs/theming-guide.adoc";>PDF Theme</a></li> - </ul> - <p>Once you have made the desired changes, then do the following:</p> - </div> -</div> -<div class="section"> - <h2 id="Building_an_Individual_Document">Building an Individual Document</h2> - <ol style="list-style-type: decimal"> - <li>Be sure to source env.sh, so that the TRAFODION_VER environment variable is defined.</li> - <li>Build the document using <b><tt>mvn clean site</tt></b> in the directory containing the document; for example: <b><tt>dcs</tt></b> or <b><tt>docs/odb_user</tt></b>.</li> - </ol> - <ul> - <li>If you have not previously built the JDBC drivers, the DCS and REST documents will give spurious errors about missing that dependency. The documents can be built fine, skipping over that dependency using <b><tt>mvn -P'!jdbc' site</tt></b>.</li> - </ul> - <ol style="list-style-type: decimal"> - <li>Verify the content in the generated <b><tt>target</tt></b> directory.</li> - </ol> - <ul> - <li>The <b><tt>target/index.html</tt></b> file provides the entry point for the web book.</li> - <li>For those that have API documentation, the <b><tt>target/apidocs/index.html</tt></b> file contains the entry point.</li> - <li>For those that have PDF, the <b><tt>target/index.pdf</tt></b> file contains the PDF version of the document.</li> - </ul> -</div> -<div class="section"> - <h2 id="Building_the_Entire_Website_including_Documents">Building the Entire Website, including Documents</h2> - <ol style="list-style-type: decimal"> - <li>Be sure to source env.sh, so that the TRAFODION_VER environment variable is defined.</li> - <li>Build everything using <b><tt>mvn clean post-site</tt></b> in the top-level directory.</li> - </ol> - <ul> - <li>As above, to skip over JDBC dependency, use <b><tt>mvn -P'!jdbc' post-site</tt></b>.</li> - </ul> - <ol style="list-style-type: decimal"> - <li>Verify the contents in the generated <b><tt>docs/target</tt></b> directory.</li> - </ol> - <ul> - <li>All documents are in <b><tt>docs/target/docs</tt></b> directory.</li> - </ul> - <h1 id="build_trafodion_document_tree">Build Trafodion Document Tree</h1> - <p>The external version of the Trafodion Document Tree is published to <a class="externalLink" href="http://trafodion.incubator.apache.org/docs";>http://trafodion.incubator.apache.org/docs</a>. Please refer to <a href="#publish">Publish</a> below.</p> - <p>The build version of the Trafodion Document Tree is located in <b><tt>docs/target/docs</tt></b>, which is created when you build the Trafodion web site in Maven. </p> -</div> -<div class="section"> - <h2 id="Version_Directories">Version Directories</h2> - <p>The Trafodion Document Tree consists of <b>Version Directories</b>:</p> - <table border="0" class="bodyTable table table-striped table-hover"> - <thead> - <tr class="a"> - <th>Version Directory </th> - <th>Content </th> - <th>Web Site Directory</th> - </tr> - </thead> - <tbody> - <tr class="b"> - <td><b><tt>latest</tt></b> </td> - <td>Known place for the latest version of a document. </td> - <td><b><tt>trafodion.incubator.apache.org/docs/<document-name></tt></b></td> - </tr> - <tr class="a"> - <td><b><tt><version></tt></b> </td> - <td>Release-specific version of a document. </td> - <td><b><tt>trafodion.incubator.apache.org/docs/<version>/<document-directory></tt></b></td> - </tr> - </tbody> - </table> - <ul> - <li><b><tt>latest</tt></b>: Provides a well-known place for each document. This practice makes it possible to link to a document in instructional text, web sites, and other documents.</li> - <li><b><tt><version></tt></b>: Provides per-release versions of documents. Previous versions are kept in the web siteâs git repository ensuring that previous versions of the documentation are available.</li> - </ul> -</div> -<div class="section"> - <h2 id="Document_Directories">Document Directories</h2> - <p>Each document is placed in its own <b>Document Directory</b>:</p> - <table border="0" class="bodyTable table table-striped table-hover"> - <thead> - <tr class="a"> - <th>Document </th> - <th>Document Directory Name</th> - </tr> - </thead> - <tbody> - <tr class="b"> - <td>Client Installation Guide </td> - <td><b><tt>client_install</tt></b></td> - </tr> - <tr class="a"> - <td>Command Interface Guide </td> - <td><b><tt>command_interface</tt></b></td> - </tr> - <tr class="b"> - <td>DCS Reference Guide </td> - <td><b><tt>dcs_reference</tt></b></td> - </tr> - <tr class="a"> - <td>odb User Guide </td> - <td><b><tt>odb_user</tt></b></td> - </tr> - <tr class="b"> - <td>REST Reference Guide </td> - <td><b><tt>rest_reference</tt></b></td> - </tr> - <tr class="a"> - <td>SQL Reference Manual </td> - <td><b><tt>sql_reference</tt></b></td> - </tr> - </tbody> - </table> - <p>The Document Directories are organized as follows. Files and sub-directories may or may not be present in the Document Directory depending on document. </p> - <table border="0" class="bodyTable table table-striped table-hover"> - <thead> - <tr class="a"> - <th>File/Directory </th> - <th>Content</th> - </tr> - </thead> - <tbody> - <tr class="b"> - <td><b><tt>*.pdf</tt></b> </td> - <td>The PDF version of the document. For example, <b><tt>Trafodion_SQL_Reference_Guide.pdf</tt></b>.</td> - </tr> - <tr class="a"> - <td><b><tt>index.html</tt></b> </td> - <td>The web book version of the document. Generated by asciidoc.</td> - </tr> - <tr class="b"> - <td><b><tt>apidocs</tt></b> </td> - <td>API documentation provided as a web book. Generated by javadoc.</td> - </tr> - <tr class="a"> - <td><b><tt>apidocs/index.html</tt></b> </td> - <td>Entry point for API documentation. Generated by javadoc.</td> - </tr> - <tr class="b"> - <td><b><tt>css</tt></b> </td> - <td>CSS definitions used by the web-version of the document. Populated by asciidoc.</td> - </tr> - <tr class="a"> - <td><b><tt>images</tt></b> </td> - <td>Images used by the web-version of the document. Populated by asciidoc.</td> - </tr> - <tr class="b"> - <td><b><tt>resouces</tt></b> </td> - <td>Resource files referenced for source download etc. Populated by asciidoc.</td> - </tr> - </tbody> - </table> - <p>The Document Directories are copied under the Version Directories thereby creating the web-accessible Trafodion document tree. </p> - <h1 id="publish">Publish</h1> - <div class="alert alert-dismissible alert-info"> - <button type="button" class="close" data-dismiss="alert"></button> - <p style="color:black">Publication is done when a committer is ready to update the external web site. You do <b>not</b> publish as part of checking in changes.</p> - </div> - <p>Refer to <a href="website.html#publishing">Website Publishing</a> for how the website and documents get published.</p> -</div> - </div> - </div> - </div> - </div> - - </div><!-- /container --> - - <!-- Footer - ================================================== --> - <footer class="well"> - <div class="container"> - <div class="row"> - <div class="span2 bottom-nav"> - <ul class="nav nav-list"> - <li class="nav-header">About</li> - <li > - <a href="index.html" title="Project Overview">Project Overview</a> - </li> - <li > - <a href="new-features.html" title="New Features">New Features</a> - </li> - <li > - <a href="roadmap.html" title="Roadmap">Roadmap</a> - </li> - <li > - <a href="performance.html" title="Performance">Performance</a> - </li> - <li > - <a href="http:divider" title=""></a> - </li> - <li > - <a href="team-list.html" title="Team">Team</a> - </li> - <li > - <a href="presentations.html" title="Presentations">Presentations</a> - </li> - <li > - <a href="mail-lists.html" title="Mailing List">Mailing List</a> - </li> - <li > - <a href="http:divider" title=""></a> - </li> - <li > - <a href="source-repository.html" title="Source Repository">Source Repository</a> - </li> - <li > - <a href="issue-tracking.html" title="Issue Tracking">Issue Tracking</a> - </li> - <li > - <a href="license.html" title="License">License</a> - </li> - </ul> - </div> - <div class="span2 bottom-nav"> - <ul class="nav nav-list"> - <li class="nav-header">Using</li> - <li > - <a href="quickstart.html" title="Quick Start">Quick Start</a> - </li> - <li > - <a href="download.html" title="Download">Download</a> - </li> - <li > - <a href="install.html" title="Install">Install</a> - </li> - <li > - <a href="uninstall.html" title="Uninstall">Uninstall</a> - </li> - <li > - <a href="management.html" title="Managing Trafodion">Managing Trafodion</a> - </li> - <li > - <a href="http:divider" title=""></a> - </li> - <li > - <a href="documentation.html" title="Documentation">Documentation</a> - </li> - <li > - <a href="port-assignment.html" title="Port Assignments">Port Assignments</a> - </li> - <li > - <a href="faq.html" title="FAQ">FAQ</a> - </li> - <li > - <a href="release-notes.html" title="Release Notes">Release Notes</a> - </li> - </ul> - </div> - <div class="span2 bottom-nav"> - <ul class="nav nav-list"> - <li class="nav-header">Features</li> - <li > - <a href="architecture-overview.html" title="Architecture Overview">Architecture Overview</a> - </li> - <li > - <a href="http:divider" title=""></a> - </li> - <li > - <a href="https://blueprints.launchpad.net/trafodion/+spec/security-ansi-schemas"; title="ANSI Schema Support" class="externalLink">ANSI Schema Support</a> - </li> - <li > - <a href="https://blueprints.launchpad.net/trafodion/+spec/ustat-automation"; title="Automated Update Statistics" class="externalLink">Automated Update Statistics</a> - </li> - <li > - <a href="https://blueprints.launchpad.net/trafodion/+spec/bulkunload"; title="Bulk Unload" class="externalLink">Bulk Unload</a> - </li> - <li > - <a href="https://wiki.trafodion.org/wiki/index.php/Trafodion_Manageability#Logging_Events"; title="Event Handling" class="externalLink">Event Handling</a> - </li> - <li > - <a href="https://blueprints.launchpad.net/trafodion/+spec/hybrid-query-cache"; title="Hybrid Query Cache" class="externalLink">Hybrid Query Cache</a> - </li> - <li > - <a href="https://blueprints.launchpad.net/trafodion/+spec/identity-column"; title="Identity Column" class="externalLink">Identity Column</a> - </li> - <li > - <a href="https://wiki.trafodion.org/wiki/index.php/Creating_Statistics_During_Bulk_Load"; title="Immediate Update Statistics" class="externalLink">Immediate Update Statistics</a> - </li> - <li > - <a href="https://blueprints.launchpad.net/trafodion/+spec/lob-support"; title="Large Object (LOB)" class="externalLink">Large Object (LOB)</a> - </li> - <li > - <a href="https://blueprints.launchpad.net/trafodion/+spec/ddl-query-invalidation"; title="Metadata Query Invalidation" class="externalLink">Metadata Query Invalidation</a> - </li> - <li > - <a href="https://cwiki.apache.org/confluence/display/TRAFODION/Cmp-divisioning"; title="Multi-Temperature Data" class="externalLink">Multi-Temperature Data</a> - </li> - <li > - <a href="https://blueprints.launchpad.net/trafodion/+spec/access-external-hbase-tables"; title="Native HBase Tables" class="externalLink">Native HBase Tables</a> - </li> - <li > - <a href="docs/odb_user/index.html" title="ODB">ODB</a> - </li> - <li > - <a href="https://blueprints.launchpad.net/trafodion/+spec/sql-query-cancel"; title="Query Cancel" class="externalLink">Query Cancel</a> - </li> - <li > - <a href="https://blueprints.launchpad.net/trafodion/+spec/security-privilege-updates"; title="Privilege Checking" class="externalLink">Privilege Checking</a> - </li> - <li > - <a href="https://wiki.trafodion.org/wiki/index.php/Trafodion_Manageability"; title="Repository" class="externalLink">Repository</a> - </li> - <li > - <a href="https://blueprints.launchpad.net/trafodion/+spec/enable-get-statistics-thru-rms"; title="Runtime Management System" class="externalLink">Runtime Management System</a> - </li> - <li > - <a href="https://blueprints.launchpad.net/trafodion/+spec/sequence-numbers"; title="Sequence Numbers" class="externalLink">Sequence Numbers</a> - </li> - <li > - <a href="https://blueprints.launchpad.net/trafodion/+spec/skew-buster"; title="Skew Buster" class="externalLink">Skew Buster</a> - </li> - <li > - <a href="https://wiki.trafodion.org/wiki/index.php/Tutorial:_The_object-oriented_UDF_interface"; title="Table-Oriented UDF" class="externalLink">Table-Oriented UDF</a> - </li> - <li > - <a href="https://wiki.trafodion.org/wiki/index.php/Data_Loading#Trickle_Loading_Data_Into_Trafodion_Tables"; title="Trickle Load" class="externalLink">Trickle Load</a> - </li> - <li > - <a href="http:divider" title=""></a> - </li> - <li > - <a href="https://wiki.trafodion.org/wiki/index.php/Backup_and_Restore"; title="Backup/Restore Utility" class="externalLink">Backup/Restore Utility</a> - </li> - <li > - <a href="https://wiki.trafodion.org/wiki/index.php/Metadata_Cleanup"; title="Metadata Cleanup Utility" class="externalLink">Metadata Cleanup Utility</a> - </li> - </ul> - </div> - <div class="span2 bottom-nav"> - <ul class="nav nav-list"> - <li class="nav-header">Contributing</li> - <li > - <a href="contribute.html" title="Contribute">Contribute</a> - </li> - <li > - <a href="advocate.html" title="Advocate">Advocate</a> - </li> - <li > - <a href="develop.html" title="Develop">Develop</a> - </li> - <li > - <a href="testing.html" title="Test">Test</a> - </li> - <li > - <a href="merge.html" title="Merge">Merge</a> - </li> - <li > - <a href="release.html" title="Release">Release</a> - </li> - <li > - <a href="http:divider" title=""></a> - </li> - <li > - <a href="create-dev-environment.html" title="Create Dev Environment">Create Dev Environment</a> - </li> - <li > - <a href="manage-dev-environment.html" title="Manage Dev Environment">Manage Dev Environment</a> - </li> - <li > - <a href="setup-build-environment.html" title="Setup Build Environment">Setup Build Environment</a> - </li> - <li > - <a href="build.html" title="Build Trafodion">Build Trafodion</a> - </li> - <li > - <a href="http:divider" title=""></a> - </li> - <li > - <a href="code.html" title="Modify Code">Modify Code</a> - </li> - <li > - <a href="tests.html" title="Modify Tests">Modify Tests</a> - </li> - <li class="active"> - <a href="#" title="Modify Documentation">Modify Documentation</a> - </li> - <li > - <a href="website.html" title="Modify Web Site">Modify Web Site</a> - </li> - <li > - <a href="wiki.html" title="Modify Wiki Pages">Modify Wiki Pages</a> - </li> - <li > - <a href="http:divider" title=""></a> - </li> - <li > - <a href="cplusplus-coding-guidelines.html" title="C++ Coding Guidelines">C++ Coding Guidelines</a> - </li> - </ul> - </div> - <div class="span4 bottom-description"> - <blockquote><a href="http://trafodion.apache.org/";>Apache Trafodion</a> is a webscale SQL-on-Hadoop solution enabling transactional or operational - workloads on Hadoop. <br /><br />The name "Trafodion" (the Welsh word for transactions, pronounced - "Tra-vod-eee-on") was chosen specifically to emphasize the differentiation that - Trafodion provides in closing a critical gap in the Hadoop ecosystem.<br /><br /> - Trafodion builds on the scalability, elasticity, and flexibility of Hadoop. Trafodion extends - Hadoop to provide guaranteed transactional integrity, enabling new kinds of big data - applications to run on Hadoop.</blockquote> - </div> - </div> - </div> - </footer> - - <div class="container subfooter"> - <div class="row"> - <div class="span12"> - <p class="pull-right"><a href="#">Back to top</a></p> - <p class="copyright">Copyright ©2015-2016 <a href="http://www.apache.org";>Apache Software Foundation</a>. All Rights Reserved.</p> - -<hr/> -<div class="row span16"> - <span>Disclaimer: Apache Trafodion is an effort undergoing incubation at the Apache Software Foundation (ASF), sponsored by the Apache Incubator PMC. - Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making - process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the - completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.</span> - <br/> - <br/> - <span>Apache, Apache Maven, Apache Maven Fluido Skin, the Apache feather logo, the Apache Maven project logo and the Apache Incubator project logo - are trademarks of The Apache Software Foundation.</span> - <br/> - <br/> - <span> - <a target="_blank" href="http://www.apache.org";> - <img id="asf-logo" alt="Apache Software Foundation" src="images/logos/feather-small.gif"/> - </a> - <a target="_blank" href="http://incubator.apache.org/";> - <img id="incubator-logo" alt="Apache Incubator" src="images/logos/egg-logo.gif"/> - </a> - </span> -</div> </div> - </div> - </div> - - <!-- Le javascript - ================================================== --> - <!-- Placed at the end of the document so the pages load faster --> - <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.1/jquery.min.js";></script> - - <script src="http://netdna.bootstrapcdn.com/twitter-bootstrap/2.3.2/js/bootstrap.min.js";></script> - <script src="./js/lightbox.min.js"></script> - <script src="./js/reflow-scroll.js"></script> - <script src="http://yandex.st/highlightjs/7.5/highlight.min.js";></script> - - <script src="./js/reflow-skin.js"></script> - - </body> -</html>
http://git-wip-us.apache.org/repos/asf/incubator-trafodion-site/blob/c166c834/images/logos/egg-logo.gif ---------------------------------------------------------------------- diff --git a/images/logos/egg-logo.gif b/images/logos/egg-logo.gif deleted file mode 100644 index f26d275..0000000 Binary files a/images/logos/egg-logo.gif and /dev/null differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion-site/blob/c166c834/images/logos/pb-Trafodion.png ---------------------------------------------------------------------- diff --git a/images/logos/pb-Trafodion.png b/images/logos/pb-Trafodion.png deleted file mode 100644 index 67643a4..0000000 Binary files a/images/logos/pb-Trafodion.png and /dev/null differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion-site/blob/c166c834/install-preparation.html ---------------------------------------------------------------------- diff --git a/install-preparation.html b/install-preparation.html deleted file mode 100644 index 9335b2a..0000000 --- a/install-preparation.html +++ /dev/null @@ -1,604 +0,0 @@ - -<!DOCTYPE html> -<!-- - Generated by Apache Maven Doxia at 2016-02-12 - Rendered using Reflow Maven Skin 1.1.1 (http://andriusvelykis.github.io/reflow-maven-skin) ---> -<html xml:lang="en" lang="en"> - - <head> - <meta charset="UTF-8" /> - <title>Apache Trafodion Install Preparation</title> - <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <meta name="description" content="" /> - <meta http-equiv="content-language" content="en" /> - - <link href="http://netdna.bootstrapcdn.com/bootswatch/2.3.2/cerulean/bootstrap.min.css"; rel="stylesheet" /> - <link href="http://netdna.bootstrapcdn.com/twitter-bootstrap/2.3.1/css/bootstrap-responsive.min.css"; rel="stylesheet" /> - <link href="./css/bootswatch.css" rel="stylesheet" /> - <link href="./css/reflow-skin.css" rel="stylesheet" /> - - <link href="http://yandex.st/highlightjs/7.5/styles/default.min.css"; rel="stylesheet" /> - - <link href="./css/lightbox.css" rel="stylesheet" /> - - <link href="./css/site.css" rel="stylesheet" /> - <link href="./css/print.css" rel="stylesheet" media="print" /> - - <!-- Le HTML5 shim, for IE6-8 support of HTML5 elements --> - <!--[if lt IE 9]> - <script src="http://html5shim.googlecode.com/svn/trunk/html5.js";></script> - <![endif]--> - - - - <!-- Google Analytics --> - <script type="text/javascript"> - - var _gaq = _gaq || []; - _gaq.push(['_setAccount', 'UA-72491210-1']); - _gaq.push(['_trackPageview']); - - (function() { - var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; - ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); - })(); - - </script> - </head> - - <body class="page-install-preparation project-trafodion" data-spy="scroll" data-offset="60" data-target="#toc-scroll-target"> - - <div class="navbar navbar-fixed-top"> - <div class="navbar-inner"> - <div class="container"> - <a class="btn btn-navbar" data-toggle="collapse" data-target="#top-nav-collapse"> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - </a> - <a class="brand" href="index.html">Apache <span class="color-highlight">Trafodion</span></a> - <div class="nav-collapse collapse" id="top-nav-collapse"> - <ul class="nav pull-right"> - <li ><a href="download.html" title="Download">Download</a></li> - <li ><a href="contributing-redirect.html" title="Contributing">Contributing</a></li> - <li class="dropdown"> - <a href="#" class="dropdown-toggle" data-toggle="dropdown">About <b class="caret"></b></a> - <ul class="dropdown-menu"> - <li ><a href="index.html" title="Project Overview">Project Overview</a></li> - <li ><a href="http:divider" title=""></a></li> - <li ><a href="team-redirect.html" title="Team">Team</a></li> - <li ><a href="presentations.html" title="Presentations">Presentations</a></li> - <li ><a href="mail-lists.html" title="Mailing List">Mailing List</a></li> - <li ><a href="http:divider" title=""></a></li> - <li ><a href="source-repository.html" title="Source Repository">Source Repository</a></li> - <li ><a href="issue-tracking.html" title="Issue Tracking">Issue Tracking</a></li> - <li ><a href="license.html" title="License">License</a></li> - </ul> - </li> - <li class="dropdown"> - <a href="#" class="dropdown-toggle" data-toggle="dropdown">Using <b class="caret"></b></a> - <ul class="dropdown-menu"> - <li ><a href="download.html" title="Download">Download</a></li> - <li ><a href="install.html" title="Install">Install</a></li> - <li ><a href="uninstall.html" title="Uninstall">Uninstall</a></li> - <li ><a href="management.html" title="Managing Trafodion">Managing Trafodion</a></li> - <li ><a href="http:divider" title=""></a></li> - <li ><a href="documentation.html" title="Documentation">Documentation</a></li> - <li ><a href="port-assignment.html" title="Port Assignments">Port Assignments</a></li> - <li ><a href="faq.html" title="FAQ">FAQ</a></li> - <li ><a href="release-notes.html" title="Release Notes">Release Notes</a></li> - </ul> - </li> - <li class="dropdown"> - <a href="#" class="dropdown-toggle" data-toggle="dropdown">Features <b class="caret"></b></a> - <ul class="dropdown-menu"> - <li ><a href="architecture-overview.html" title="Architecture Overview">Architecture Overview</a></li> - <li ><a href="http:divider" title=""></a></li> - <li ><a href="https://blueprints.launchpad.net/trafodion/+spec/security-ansi-schemas"; title="ANSI Schema Support" class="externalLink">ANSI Schema Support</a></li> - <li ><a href="https://blueprints.launchpad.net/trafodion/+spec/ustat-automation"; title="Automated Update Statistics" class="externalLink">Automated Update Statistics</a></li> - <li ><a href="https://blueprints.launchpad.net/trafodion/+spec/bulkunload"; title="Bulk Unload" class="externalLink">Bulk Unload</a></li> - <li ><a href="https://wiki.trafodion.org/wiki/index.php/Trafodion_Manageability#Logging_Events"; title="Event Handling" class="externalLink">Event Handling</a></li> - <li ><a href="https://blueprints.launchpad.net/trafodion/+spec/hybrid-query-cache"; title="Hybrid Query Cache" class="externalLink">Hybrid Query Cache</a></li> - <li ><a href="https://blueprints.launchpad.net/trafodion/+spec/identity-column"; title="Identity Column" class="externalLink">Identity Column</a></li> - <li ><a href="https://wiki.trafodion.org/wiki/index.php/Creating_Statistics_During_Bulk_Load"; title="Immediate Update Statistics" class="externalLink">Immediate Update Statistics</a></li> - <li ><a href="https://blueprints.launchpad.net/trafodion/+spec/lob-support"; title="Large Object (LOB)" class="externalLink">Large Object (LOB)</a></li> - <li ><a href="https://blueprints.launchpad.net/trafodion/+spec/ddl-query-invalidation"; title="Metadata Query Invalidation" class="externalLink">Metadata Query Invalidation</a></li> - <li ><a href="https://cwiki.apache.org/confluence/display/TRAFODION/Cmp-divisioning"; title="Multi-Temperature Data" class="externalLink">Multi-Temperature Data</a></li> - <li ><a href="https://blueprints.launchpad.net/trafodion/+spec/access-external-hbase-tables"; title="Native HBase Tables" class="externalLink">Native HBase Tables</a></li> - <li ><a href="docs/odb_user/index.html" title="ODB">ODB</a></li> - <li ><a href="https://blueprints.launchpad.net/trafodion/+spec/sql-query-cancel"; title="Query Cancel" class="externalLink">Query Cancel</a></li> - <li ><a href="https://blueprints.launchpad.net/trafodion/+spec/security-privilege-updates"; title="Privilege Checking" class="externalLink">Privilege Checking</a></li> - <li ><a href="https://wiki.trafodion.org/wiki/index.php/Trafodion_Manageability"; title="Repository" class="externalLink">Repository</a></li> - <li ><a href="https://blueprints.launchpad.net/trafodion/+spec/enable-get-statistics-thru-rms"; title="Runtime Management System" class="externalLink">Runtime Management System</a></li> - <li ><a href="https://blueprints.launchpad.net/trafodion/+spec/sequence-numbers"; title="Sequence Numbers" class="externalLink">Sequence Numbers</a></li> - <li ><a href="https://blueprints.launchpad.net/trafodion/+spec/skew-buster"; title="Skew Buster" class="externalLink">Skew Buster</a></li> - <li ><a href="https://wiki.trafodion.org/wiki/index.php/Tutorial:_The_object-oriented_UDF_interface"; title="Table-Oriented UDF" class="externalLink">Table-Oriented UDF</a></li> - <li ><a href="https://wiki.trafodion.org/wiki/index.php/Data_Loading#Trickle_Loading_Data_Into_Trafodion_Tables"; title="Trickle Load" class="externalLink">Trickle Load</a></li> - <li ><a href="http:divider" title=""></a></li> - <li ><a href="https://wiki.trafodion.org/wiki/index.php/Backup_and_Restore"; title="Backup/Restore Utility" class="externalLink">Backup/Restore Utility</a></li> - <li ><a href="https://wiki.trafodion.org/wiki/index.php/Metadata_Cleanup"; title="Metadata Cleanup Utility" class="externalLink">Metadata Cleanup Utility</a></li> - </ul> - </li> - <li class="dropdown"> - <a href="#" class="dropdown-toggle" data-toggle="dropdown">Apache <b class="caret"></b></a> - <ul class="dropdown-menu"> - <li ><a href="http://incubator.apache.org/projects/trafodion.html"; title="Project Status" target="_blank" class="externalLink">Project Status</a></li> - <li ><a href="http://www.apache.org/foundation/how-it-works.html"; title="Apache Foundation" target="_blank" class="externalLink">Apache Foundation</a></li> - <li ><a href="http://www.apache.org/licenses/"; title="Apache License" target="_blank" class="externalLink">Apache License</a></li> - <li ><a href="http://www.apache.org/security/"; title="Apache Security" target="_blank" class="externalLink">Apache Security</a></li> - <li ><a href="http:divider" title=""></a></li> - <li ><a href="http://www.apache.org/foundation/sponsorship.html"; title="Sponsorship" target="_blank" class="externalLink">Sponsorship</a></li> - <li ><a href="http://www.apache.org/foundation/thanks.html"; title="Thanks" target="_blank" class="externalLink">Thanks</a></li> - </ul> - </li> - </ul> - </div><!--/.nav-collapse --> - </div> - </div> - </div> - - <div class="container"> - - <!-- Masthead - ================================================== --> - - <header> - <div class="jumbotron subhead"> - <div class="row" id="banner"> - <div class="span12"> - <div class="pull-left"> - <a href="index.html" id="bannerLeft"><h1>Apache <span class="color-highlight">Trafodion</span></h1></a> - <p class="lead">Transactional SQL-on-Hadoop Database</p> - </div> - <div class="pull-right"> - </div> - </div> - </div> - </div> - <div> - <ul class="breadcrumb"> - <li><a href="index.html" title="Trafodion">Trafodion</a></li> - <li class="divider">/</li> - <li>Install Preparation</li> - </ul> - </div> - <hr class="toc-separator" /> - <div id="toc-bar" class="navbar" data-spy="affix" data-offset-top="250"> - <div class="navbar-inner"> - <div id="toc-scroll-target" class="container"> - <a class="btn btn-navbar" data-toggle="collapse" data-target="#toc-nav-collapse"> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - </a> - <div class="nav-collapse collapse" id="toc-nav-collapse"> - <ul id="toc" class="nav"> - <li class="dropdown"> - <a href="#cluster_requirements" title="Cluster Requirements" class="dropdown-toggle" role="button" data-toggle="dropdown" data-target="#">Cluster Requirements <b class="caret"></b></a> - <ul class="dropdown-menu" role="menu"> - <!-- Repeat the item, otherwise it is not clickable as the dropdown root --> - <li><a href="#cluster_requirements" title="Cluster Requirements">Cluster Requirements</a></li> - <li class="divider"></li> - <li class="dropdown-submenu"> - <a href="#Checking_Disk_Space" title="Checking Disk Space">Checking Disk Space</a> - <ul class="dropdown-menu" role="menu"> - <li><a href="#Cloudera_Manager" title="Cloudera Manager">Cloudera Manager</a></li> - - </ul> - </li> - - </ul> - </li> - <li class="divider-vertical"></li> - <li class="dropdown"> - <a href="#security_requirements" title="Security Requirements" class="dropdown-toggle" role="button" data-toggle="dropdown" data-target="#">Security Requirements <b class="caret"></b></a> - <ul class="dropdown-menu" role="menu"> - <!-- Repeat the item, otherwise it is not clickable as the dropdown root --> - <li><a href="#security_requirements" title="Security Requirements">Security Requirements</a></li> - <li class="divider"></li> - <li><a href="#Install_User_ID" title="Install User ID">Install User ID</a></li> - <li><a href="#Configure_LDAP_Identity_Store" title="Configure LDAP Identity Store">Configure LDAP Identity Store</a></li> - - </ul> - </li> - <li class="divider-vertical"></li> - <li class="toplevel"><a href="#pc_tools" title="PC Tools">PC Tools</a></li> - <li class="divider-vertical"></li> - <li class="toplevel"><a href="#install_hadoop_distribution" title="Install Hadoop Distribution">Install Hadoop Distribution</a></li> - <li class="divider-vertical"></li> - <li class="toplevel"><a href="#validation" title="Validation">Validation</a></li> - </ul> - </div> - </div> - </div> - </div> - </header> - - <div class="main-body"> - <div class="row"> - <div class="span12"> - <div class="body-content"> -<!-- Licensed 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. --> -<p>This page describes the steps you need to perform before installing Trafodion.</p> -<div class="page-header"> - <h1 id="cluster_requirements">Cluster Requirements</h1> -</div> -<p>The following configuration settings have been tested and are known to work with the Trafodion installation:</p> -<table border="0" class="bodyTable table table-striped table-hover"> - <thead> - <tr class="a"> - <th>Setting </th> - <th>Value</th> - </tr> - </thead> - <tbody> - <tr class="b"> - <td><b>Hardware Platform</b> </td> - <td>x86-64</td> - </tr> - <tr class="a"> - <td><b>Operating System</b> </td> - <td>RedHat Enterprise Linux, 6.x kernel (64 bit) or CentOS, 6.x kernel (64 bit)</td> - </tr> - <tr class="b"> - <td><b>Install User IDs</b> </td> - <td>A user ID with passwordless and sudo access. Please refer to [Install User ID](#Install User ID) below.</td> - </tr> - <tr class="a"> - <td><b>Cluster Size</b> </td> - <td>A cluster consisting of 1 to N nodes. There is currently no upper limit. Two nodes is the recommended minimum, but a single node cluster should work.</td> - </tr> - <tr class="b"> - <td><b>Disk Space</b> </td> - <td>Minimum of 20 GB. Please refer to <a href="#Checking_Disk_Space">Checking Disk Space</a> below.</td> - </tr> - <tr class="a"> - <td><b>Memory</b> </td> - <td>Minimal 1 GB * number of connectivity servers (MXOSRVR processes) configured per cluster.</td> - </tr> - </tbody> -</table> -<div class="section"> - <h2 id="Checking_Disk_Space">Checking Disk Space</h2> - <div class="section"> - <h3 id="Cloudera_Manager">Cloudera Manager</h3> - <p>This step is required for Cloudera distributions only.</p> - <p>Before installing Cloudera Manager, a minimum of 20 GB is needed to support the Cloudera management database. Default location: <b><tt>/var/lib/cloudera-scm-server-db</tt></b>. </p> - <p>Check the available space for <b><tt>/var</tt></b> as follows:</p> - <ul> - <li>Start a putty or VNC terminal window against the node where Cloudera Manager will be installed.</li> - <li> <p>As a user with <b><tt>root</tt></b> privileges, verify that 20 GB of space is available to <b><tt>/var</tt></b>.</p> <p>cd /var df -hP</p></li> - </ul> - <p>If the <b><tt>/var</tt></b> space is insufficient, then you can provide a soft link to another drive for your Cloudera Manager database.</p> - <ul> - <li>Locate a drive with sufficient disk space.</li> - <li>Create the soft link.</li> - </ul> - <div class="source"> - <div class="source"> - <pre>cd <new drive> # (e.g. cd /DATA) -mkdir cloudera-scm-server-db -chmod 777 cloudera-scm-server-db -cd /var/lib -ln -s <new drive>/cloudera-scm-server-db . -</pre> - </div> - </div> - <p><b>Considerations</b></p> - <ul> - <li>If <b><tt>/var</tt></b> is a sub-directory in your clusterâs root filesystem, then the Cloudera Manager database should have sufficient space available.</li> - <li>If Cloudera Manager has already been installed and it is showing red for log directories, it means that Cloudera Manager was installed using <b><tt>/var/lib</tt></b> and may not have a large enough <b><tt>/var</tt></b> file system. In this case, there is an unsupported script that can be used to move the directories. Please refer to the <b><tt>clouderaMoveDB.sh</tt></b> script in the <b><tt>installer/tools</tt></b> directory, which is created when the installer tar file is unpacked. Run <b><tt>clouderaMoveDB.sh</tt></b> without syntax to display help information.</li> - </ul> - <h1 id="security_requirements">Security Requirements</h1> - </div> -</div> -<div class="section"> - <h2 id="Install_User_ID">Install User ID</h2> - <p>The Trafodion installation requires a user ID (referred to as <b><tt><sudo-user></tt></b>) with these attributes on all nodes where Trafodion is installed:</p> - <ul> - <li>*<i><tt>/etc/sudoers</tt></i> on all nodes: - <ul> - <li><b><tt>sudo</tt></b> access â allows the install scripts to run privileged commands.</li> - <li><b>requiretty</b> disabled â allows Trafodion install scripts to use embedded <b><tt>sudo</tt></b> commands</li> - </ul></li> - <li>passwordless ssh to all nodes â allows Trafodion install scripts to communicate with remote nodes without prompting for password.</li> - </ul> - <p>Please create a the <b><tt><sudo-user></tt></b> per the practices of your environment. For example, you may need to request permission from your cluster-management team to obtain this type of access. [Passwordless SSH(passwordless-ssh.html) describes how to set up passwordless ssh.</p> -</div> -<div class="section"> - <h2 id="Configure_LDAP_Identity_Store">Configure LDAP Identity Store</h2> - <p>If you plan to enable Trafodion authentication, then you need to have an LDAP identity store available to perform authentication. </p> - <p>The Trafodion installer prompts you to set up an authentication configuration file that points to an LDAP server (or servers), which enables security (that is, authentication and authorization) in the Trafodion system.</p> - <p>If you wish to manually set up the authentication configuration file and enable security, then please refer to <a href="enable-secure-trafodion.html">Enabling Security Features in Trafodion</a>.</p> - <h1 id="pc_tools">PC Tools</h1> - <p>If you are using a Windows PC, then additional PC software may be needed throughout the installation process. It is recommended that you pre-install the PC software that you need before continuing with the Trafodion installation.</p> - <p>Install the following software:</p> - <ul> - <li>putty and puttygen (download from the <a class="externalLink" href="http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html";>PuTTY website</a>)</li> - <li>VNC client (download from <a class="externalLink" href="http://www.realvnc.com";>http://www.realvnc.com</a>)</li> - <li>Firefox or Chrome browser</li> - <li>SFTP client to transfer files from your PC to the server: WinSCP or FileZilla</li> - </ul> - <h1 id="install_hadoop_distribution">Install Hadoop Distribution</h1> - <p>Trafodion requires that the following Hadoop services are installed:</p> - <ul> - <li>HDFS</li> - <li>MapReduce</li> - <li>ZooKeeper</li> - <li>HBase</li> - <li>Hive</li> - </ul> - <p>Please ensure that these services are installed for one of the following Hadoop distributions.</p> - <table border="0" class="bodyTable table table-striped table-hover"> - <tbody> - <tr class="a"> - <td><b>IMPORTANT</b><br />Trafodion does not support a Hadoop server running on a node that is not part of the Trafodion cluster. You must specify the Hadoop nodes to be part of the Trafodion list of nodes during the installation of Trafodion (using the <b><tt>--nodes</tt></b> parameter). The Trafodion installer needs to run from the same node where you installed the Hadoop distribution).</td> - </tr> - </tbody> - </table> - <table border="0" class="bodyTable table table-striped table-hover"> - <thead> - <tr class="a"> - <th>Distribution</th> - <th>Version</th> - <th>HBase Version</th> - <th>Installation</th> - <th>Notes</th> - </tr> - </thead> - <tbody> - <tr class="b"> - <td><b>Cloudera</b></td> - <td>CDH 5.2 or 5.3</td> - <td>0.98.6</td> - <td>Refer to <a class="externalLink" href="http://www.cloudera.com/content/cloudera/en/documentation/core/latest/topics/installation.html"; target="_blank">CDH 5.3.x Installation and Upgrade Guide</a> for installation instructions.</td> - <td> - <ul> - <li>Select <b>Cloudera Standard</b> edition.</li> - <li>Install using <b>packages</b>. Do not install using tarballs and parcels. Trafodion does not currently support tarball/parcel installation.</li> - <li>CDH 5.2 is supported but has not been officially tested with Trafodion Release 1.3.</li> - </ul> </td> - </tr> - <tr class="a"> - <td><b>Hortonworks Data Platform (HDP)</b></td> - <td>HDP 2.2</td> - <td>0.98.4</td> - <td> - <ul> - <li><b>Install</b>: <a class="externalLink" href="http://docs.hortonworks.com/HDPDocuments/Ambari-1.7.0.0/Ambari_Install_v170/Ambari_Install_v170.pdf";>Ambari 1.7.0 Install Guide</a></li> - <li><b>Upgrade:</b> <a class="externalLink" href="http://docs.hortonworks.com/HDPDocuments/Ambari-1.7.0.0/Ambari_Upgrade_v170/Ambari_Upgrade_v170.pdf";>Ambari 1.7.0 Upgrade Guide</a></li> - </ul> </td> - <td></td> - </tr> - </tbody> - </table> - <h1 id="validation">Validation</h1> - <p>Once the Hadoop distribution has been installed and started, please ensure that the required services are running. At this point, youâre ready to <a href="install.html">Install Trafodion</a>.</p> -</div> - </div> - </div> - </div> - </div> - - </div><!-- /container --> - - <!-- Footer - ================================================== --> - <footer class="well"> - <div class="container"> - <div class="row"> - <div class="span2 bottom-nav"> - <ul class="nav nav-list"> - <li class="nav-header">About</li> - <li > - <a href="index.html" title="Project Overview">Project Overview</a> - </li> - <li > - <a href="http:divider" title=""></a> - </li> - <li > - <a href="team-redirect.html" title="Team">Team</a> - </li> - <li > - <a href="presentations.html" title="Presentations">Presentations</a> - </li> - <li > - <a href="mail-lists.html" title="Mailing List">Mailing List</a> - </li> - <li > - <a href="http:divider" title=""></a> - </li> - <li > - <a href="source-repository.html" title="Source Repository">Source Repository</a> - </li> - <li > - <a href="issue-tracking.html" title="Issue Tracking">Issue Tracking</a> - </li> - <li > - <a href="license.html" title="License">License</a> - </li> - </ul> - </div> - <div class="span2 bottom-nav"> - <ul class="nav nav-list"> - <li class="nav-header">Using</li> - <li > - <a href="download.html" title="Download">Download</a> - </li> - <li > - <a href="install.html" title="Install">Install</a> - </li> - <li > - <a href="uninstall.html" title="Uninstall">Uninstall</a> - </li> - <li > - <a href="management.html" title="Managing Trafodion">Managing Trafodion</a> - </li> - <li > - <a href="http:divider" title=""></a> - </li> - <li > - <a href="documentation.html" title="Documentation">Documentation</a> - </li> - <li > - <a href="port-assignment.html" title="Port Assignments">Port Assignments</a> - </li> - <li > - <a href="faq.html" title="FAQ">FAQ</a> - </li> - <li > - <a href="release-notes.html" title="Release Notes">Release Notes</a> - </li> - </ul> - </div> - <div class="span2 bottom-nav"> - <ul class="nav nav-list"> - <li class="nav-header">Features</li> - <li > - <a href="architecture-overview.html" title="Architecture Overview">Architecture Overview</a> - </li> - <li > - <a href="http:divider" title=""></a> - </li> - <li > - <a href="https://blueprints.launchpad.net/trafodion/+spec/security-ansi-schemas"; title="ANSI Schema Support" class="externalLink">ANSI Schema Support</a> - </li> - <li > - <a href="https://blueprints.launchpad.net/trafodion/+spec/ustat-automation"; title="Automated Update Statistics" class="externalLink">Automated Update Statistics</a> - </li> - <li > - <a href="https://blueprints.launchpad.net/trafodion/+spec/bulkunload"; title="Bulk Unload" class="externalLink">Bulk Unload</a> - </li> - <li > - <a href="https://wiki.trafodion.org/wiki/index.php/Trafodion_Manageability#Logging_Events"; title="Event Handling" class="externalLink">Event Handling</a> - </li> - <li > - <a href="https://blueprints.launchpad.net/trafodion/+spec/hybrid-query-cache"; title="Hybrid Query Cache" class="externalLink">Hybrid Query Cache</a> - </li> - <li > - <a href="https://blueprints.launchpad.net/trafodion/+spec/identity-column"; title="Identity Column" class="externalLink">Identity Column</a> - </li> - <li > - <a href="https://wiki.trafodion.org/wiki/index.php/Creating_Statistics_During_Bulk_Load"; title="Immediate Update Statistics" class="externalLink">Immediate Update Statistics</a> - </li> - <li > - <a href="https://blueprints.launchpad.net/trafodion/+spec/lob-support"; title="Large Object (LOB)" class="externalLink">Large Object (LOB)</a> - </li> - <li > - <a href="https://blueprints.launchpad.net/trafodion/+spec/ddl-query-invalidation"; title="Metadata Query Invalidation" class="externalLink">Metadata Query Invalidation</a> - </li> - <li > - <a href="https://cwiki.apache.org/confluence/display/TRAFODION/Cmp-divisioning"; title="Multi-Temperature Data" class="externalLink">Multi-Temperature Data</a> - </li> - <li > - <a href="https://blueprints.launchpad.net/trafodion/+spec/access-external-hbase-tables"; title="Native HBase Tables" class="externalLink">Native HBase Tables</a> - </li> - <li > - <a href="docs/odb_user/index.html" title="ODB">ODB</a> - </li> - <li > - <a href="https://blueprints.launchpad.net/trafodion/+spec/sql-query-cancel"; title="Query Cancel" class="externalLink">Query Cancel</a> - </li> - <li > - <a href="https://blueprints.launchpad.net/trafodion/+spec/security-privilege-updates"; title="Privilege Checking" class="externalLink">Privilege Checking</a> - </li> - <li > - <a href="https://wiki.trafodion.org/wiki/index.php/Trafodion_Manageability"; title="Repository" class="externalLink">Repository</a> - </li> - <li > - <a href="https://blueprints.launchpad.net/trafodion/+spec/enable-get-statistics-thru-rms"; title="Runtime Management System" class="externalLink">Runtime Management System</a> - </li> - <li > - <a href="https://blueprints.launchpad.net/trafodion/+spec/sequence-numbers"; title="Sequence Numbers" class="externalLink">Sequence Numbers</a> - </li> - <li > - <a href="https://blueprints.launchpad.net/trafodion/+spec/skew-buster"; title="Skew Buster" class="externalLink">Skew Buster</a> - </li> - <li > - <a href="https://wiki.trafodion.org/wiki/index.php/Tutorial:_The_object-oriented_UDF_interface"; title="Table-Oriented UDF" class="externalLink">Table-Oriented UDF</a> - </li> - <li > - <a href="https://wiki.trafodion.org/wiki/index.php/Data_Loading#Trickle_Loading_Data_Into_Trafodion_Tables"; title="Trickle Load" class="externalLink">Trickle Load</a> - </li> - <li > - <a href="http:divider" title=""></a> - </li> - <li > - <a href="https://wiki.trafodion.org/wiki/index.php/Backup_and_Restore"; title="Backup/Restore Utility" class="externalLink">Backup/Restore Utility</a> - </li> - <li > - <a href="https://wiki.trafodion.org/wiki/index.php/Metadata_Cleanup"; title="Metadata Cleanup Utility" class="externalLink">Metadata Cleanup Utility</a> - </li> - </ul> - </div> - <div class="span2 bottom-nav"> - <ul class="nav nav-list"> - </ul> - </div> - <div class="span4 bottom-description"> - <blockquote><a href="http://trafodion.apache.org/";>Apache Trafodion</a> is a webscale SQL-on-Hadoop solution enabling transactional or operational - workloads on Hadoop. <br /><br />The name "Trafodion" (the Welsh word for transactions, pronounced - "Tra-vod-eee-on") was chosen specifically to emphasize the differentiation that - Trafodion provides in closing a critical gap in the Hadoop ecosystem.<br /><br /> - Trafodion builds on the scalability, elasticity, and flexibility of Hadoop. Trafodion extends - Hadoop to provide guaranteed transactional integrity, enabling new kinds of big data - applications to run on Hadoop.</blockquote> - </div> - </div> - </div> - </footer> - - <div class="container subfooter"> - <div class="row"> - <div class="span12"> - <p class="pull-right"><a href="#">Back to top</a></p> - <p class="copyright">Copyright ©2015-2016 <a href="http://www.apache.org";>Apache Software Foundation</a>. All Rights Reserved.</p> - -<hr/> -<div class="row span16"> - <span>Disclaimer: Apache Trafodion is an effort undergoing incubation at the Apache Software Foundation (ASF), sponsored by the Apache Incubator PMC. - Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making - process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the - completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.</span> - <br/> - <br/> - <span>Apache, Apache Maven, Apache Maven Fluido Skin, the Apache feather logo, the Apache Maven project logo and the Apache Incubator project logo - are trademarks of The Apache Software Foundation.</span> - <br/> - <br/> - <span> - <a target="_blank" href="http://incubator.apache.org/";> - <img id="incubator-logo" alt="Apache Incubator" src="images/logos/egg-logo.png"/> - </a> - </span> -</div> </div> - </div> - </div> - - <!-- Le javascript - ================================================== --> - <!-- Placed at the end of the document so the pages load faster --> - <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.1/jquery.min.js";></script> - - <script src="http://netdna.bootstrapcdn.com/twitter-bootstrap/2.3.2/js/bootstrap.min.js";></script> - <script src="./js/lightbox.min.js"></script> - <script src="./js/reflow-scroll.js"></script> - <script src="http://yandex.st/highlightjs/7.5/highlight.min.js";></script> - - <script src="./js/reflow-skin.js"></script> - - </body> -</html>
