<html>
<head>
<base href="https://docs.jboss.org/author">
<link rel="stylesheet" href="/author/s/en/2172/19/5/_/styles/combined.css?spaceKey=TEIID&forWysiwyg=true" type="text/css">
</head>
<body style="background: white;" bgcolor="white" class="email-body">
<div id="pageContent">
<div id="notificationFormat">
<div class="wiki-content">
<div class="email">
<h2><a href="https://docs.jboss.org/author/display/TEIID/Installation+Guide">Installation Guide</a></h2>
<h4>Page <b>edited</b> by <a href="https://docs.jboss.org/author/display/~shawkins">Steven Hawkins</a>
</h4>
<br/>
<h4>Changes (1)</h4>
<div id="page-diffs">
<table class="diff" cellpadding="0" cellspacing="0">
<tr><td class="diff-snipped" >...<br></td></tr>
<tr><td class="diff-unchanged" >{note} <br> <br></td></tr>
<tr><td class="diff-changed-lines" >* Download <span class="diff-deleted-words"style="color:#999;background-color:#fdd;text-decoration:line-through;">[Teiid|http://www.jboss.org/teiid/downloads.html].</span> <span class="diff-added-words"style="background-color: #dfd;">[Teiid|http://teiid.jboss.org/downloads/].</span> Unzip the downloaded artifact inside the JBoss AS installation. Teiid {space-metadata-from:versionNumber} directory structure matches JBoss AS directly - it is just an overlay. This will add necessary modules and configuration files to install Teiid in {space-metadata-from:asVersionNumber} in both _Standalone_ and _Domain_ modes. Teiid provides separate configuration files for both standalone mode and domain mode. Based on mode type you selected to run {space-metadata-from:asVersionNumber} , you may have to run a CLI script to complete the Teiid installation. <br></td></tr>
<tr><td class="diff-unchanged" > <br>The "Domain" mode recommended in a clustered environment to take advantage of clustered caching and cluster safe distribution of events. Teiid's default configuration for Domain mode through CLI script configured for high availability and clustered caching. <br></td></tr>
<tr><td class="diff-snipped" >...<br></td></tr>
</table>
</div> <h4>Full Content</h4>
<div class="notificationGreySide">
<p>Teiid needs to be installed into an existing Wildfly 9.0.2 installation.</p>
<div class='panelMacro'><table class='noteMacro'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="/author/images/icons/emoticons/warning.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td>Teiid provides an <a href="/author/display/TEIID/Embedded+Guide" title="Embedded Guide">embedded kit</a>, however it should be considered a tech preview as its APIs will likely evolve and there is sparse documentation.</td></tr></table></div>
<h1><a name="InstallationGuide-StepstoinstallTeiid"></a>Steps to install Teiid</h1>
<ul>
<li>Download the <a href="http://www.jboss.org/jbossas/downloads.html" class="external-link" rel="nofollow">JBoss AS</a> application server. Install the server by unzipping into a known location. Ex: /apps/jboss</li>
</ul>
<div class='panelMacro'><table class='noteMacro'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="/author/images/icons/emoticons/warning.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td>You may also choose to use an existing AS installation. However if a previous version of Teiid was already installed, you must remove the old Teiid distribution artifacts before installing the new version.</td></tr></table></div>
<ul>
<li>Download <a href="http://teiid.jboss.org/downloads/" class="external-link" rel="nofollow">Teiid</a>. Unzip the downloaded artifact inside the JBoss AS installation. Teiid 9.0 directory structure matches JBoss AS directly - it is just an overlay. This will add necessary modules and configuration files to install Teiid in Wildfly 9.0.2 in both <em>Standalone</em> and <em>Domain</em> modes. Teiid provides separate configuration files for both standalone mode and domain mode. Based on mode type you selected to run Wildfly 9.0.2 , you may have to run a CLI script to complete the Teiid installation.</li>
</ul>
<p>The "Domain" mode recommended in a clustered environment to take advantage of clustered caching and cluster safe distribution of events. Teiid's default configuration for Domain mode through CLI script configured for high availability and clustered caching.</p>
<h3><a name="InstallationGuide-StandaloneMode"></a>Standalone Mode</h3>
<p>if you want to start the "standalone" profile, execute the following command</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="theme: Confluence; brush: java; gutter: false" style="font-size:12px; font-family: ConfluenceInstalledFont,monospace;">
<jboss-install>/bin/standalone.sh -c=standalone-teiid.xml
</pre>
</div></div>
<div class='panelMacro'><table class='infoMacro'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="/author/images/icons/emoticons/information.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td><b>Installing Teiid using CLI script</b><br />The above is starting JBoss AS in a separate Teiid specific configuration that is based standalone.xml. However, if you already working with a predefined configuration for example default <em>standalone.xml</em> and would like to install Teiid into that configuration, then you can execute the following JBoss CLI script. First, start the server
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="theme: Confluence; brush: java; gutter: false" style="font-size:12px; font-family: ConfluenceInstalledFont,monospace;">
<jboss-install>/bin/standalone.sh
</pre>
</div></div>
<p>then in a separate console window execute</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="theme: Confluence; brush: java; gutter: false" style="font-size:12px; font-family: ConfluenceInstalledFont,monospace;">
<jboss-install>/bin/jboss-cli.sh --file=bin/scripts/teiid-standalone-mode-install.cli
</pre>
</div></div>
<p>this will install Teiid subsystem into the running configuration of the JBoss AS in standalone mode.</p></td></tr></table></div>
<h3><a name="InstallationGuide-DomainMode"></a>Domain Mode</h3>
<p>To start the server in "Domain" mode, install Wildfly 9.0.2 and Teiid 9.0 on all the servers that are going to be part of the cluster. Select one of the servers as the "master" domain controller, the rest of the servers will be slaves that connect to the "master" domain controller for all the administrative operations. Please refer to Wildfly 9.0.2 provided <a href="https://docs.jboss.org/author/display/WFLY9/WildFly+9+Cluster+Howto" class="external-link" rel="nofollow">documentation</a> for full details.</p>
<p>Once you configured all the servers, start the "master" node with following command</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="theme: Confluence; brush: java; gutter: false" style="font-size:12px; font-family: ConfluenceInstalledFont,monospace;">
<jboss-install>/bin/domain.sh
</pre>
</div></div>
<p>and on "slave" nodes</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="theme: Confluence; brush: java; gutter: false" style="font-size:12px; font-family: ConfluenceInstalledFont,monospace;">
<jboss-install>/bin/domain.sh
</pre>
</div></div>
<p>The slave nodes fetch their domain configuration from the "master" node.</p>
<p>Once all the servers are up, complete the installation to run in domain mode by executing the following command against the "master" node. Note that this only needs to be run once per domain (i.e. cluster) install. This script will install Teiid in the <b>HA</b> profile. It will also re-configure <em>main-server-group</em> to start the <em>HA</em> profile. Once in domain mode, you can not statically deploy resources by dropping them in the <em>domain/deployments</em> folder, so this script will deploy the default resources (file, ldap, salesforce and ws connectors) using the CLI interface.</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="theme: Confluence; brush: java; gutter: false" style="font-size:12px; font-family: ConfluenceInstalledFont,monospace;">
<jboss-install>/bin/jboss-cli.sh --file=scripts/teiid-domain-mode-install.cli
</pre>
</div></div>
<div class='panelMacro'><table class='warningMacro'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="/author/images/icons/emoticons/forbidden.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td><b>Installing "Teiid" in other profiles</b><br />If Teiid needs to be installed in profiles other than <em>HA</em>, before executing edit the <em>teiid-domain-mode-install.cli</em> file, making the appropriate changes to profile, socket-bindings, and server-groups.</td></tr></table></div>
<p>Thats it!. JBoss AS and Teiid are now installed and running. See below instructions to customize various other settings.</p>
<p>Once VDBs have been deployed, users can now connect their JDBC applications to Teiid. If you need help on connecting your application to Teiid using JDBC check out the <a href="/author/display/TEIID/Client+Developer%27s+Guide" title="Client Developer's Guide">Client Developer's Guide</a>.</p>
<h1><a name="InstallationGuide-DirectoryStructureExplained"></a>Directory Structure Explained</h1>
<p>This shows the contents of the Teiid 9.0 deployment. The directory structure is exactly the same under any JBoss profile.</p>
<div class="code panel" style="border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;"><b>Directory Structure</b></div><div class="codeContent panelContent">
<pre class="theme: Confluence; brush: java; gutter: false" style="font-size:12px; font-family: ConfluenceInstalledFont,monospace;">
/bin
/scripts
/docs
/teiid
/datsources
/schema
/examples
/domain
/configuration
/modules
/system
/layers
/base
/org/jboss/teiid/*
/standalone
/configuration
standalone-teiid.xml
</pre>
</div></div>
<div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<th class='confluenceTh'> Name </th>
<th class='confluenceTh'> Description </th>
</tr>
<tr>
<td class='confluenceTd'> bin/scripts <br class="atl-forced-newline" /> </td>
<td class='confluenceTd'> Contains installation and utility CLI scripts for setting up Teiid in different configurations. <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td class='confluenceTd'> docs/teiid <br class="atl-forced-newline" /> </td>
<td class='confluenceTd'> Contains documents, examples, sample data source XML fragments and schema files. <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td class='confluenceTd'> /standalone/configuration <br class="atl-forced-newline" /> </td>
<td class='confluenceTd'> standalone-teiid.xml - Master configuration file for the Teiid system. This file contains the Teiid subsystem, in addition to the standard JBoss AS web profile subsystems <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td class='confluenceTd'> /domain/configuration/ <br class="atl-forced-newline" /> </td>
<td class='confluenceTd'> </td>
</tr>
<tr>
<td class='confluenceTd'> /modules/system/layers/base/org/jboss/teiid/* <br class="atl-forced-newline" /> </td>
<td class='confluenceTd'> This directory contains the Teiid modules for Wildfly 10.0 system <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td class='confluenceTd'> /modules/system/layers/base/org/jboss/teiid/client <br class="atl-forced-newline" /> </td>
<td class='confluenceTd'> This directory contains Teiid client libraries. It has the Teiid JDBC driver jar, "teiid-9.0.0.Final-jdbc.jar", and also contains "teiid-hibernate-dialect-9.0.0.Final.jar" that contains Teiid's Hibernate dialect. <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td class='confluenceTd'> {standalone or domain}/tmp/teiid </td>
<td class='confluenceTd'> This directory under standalone or domain, contains temporary files created by Teiid. These are mostly created by the buffer manager. These files are not needed across a VM restart. Creation of Teiid lob values(for example through SQL/XML) will typically create one file per lob once it exceeds the allowable in memory size of 8KB. In heavy usage scenarios, consider pointing the buffer directory at a partition that is routinely defragmented. <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td class='confluenceTd'> {standalone or domain}/data/teiid-data <br class="atl-forced-newline" /> </td>
<td class='confluenceTd'> This directory under standalone or domain, contains cached vdb metadata files. Do not edit them manually. </td>
</tr>
</tbody></table>
</div>
</div>
<div id="commentsSection" class="wiki-content pageSection">
<div style="float: right;" class="grey">
<a href="https://docs.jboss.org/author/users/removespacenotification.action?spaceKey=TEIID">Stop watching space</a>
<span style="padding: 0px 5px;">|</span>
<a href="https://docs.jboss.org/author/users/editmyemailsettings.action">Change email notification preferences</a>
</div>
<a href="https://docs.jboss.org/author/display/TEIID/Installation+Guide">View Online</a>
|
<a href="https://docs.jboss.org/author/pages/diffpagesbyversion.action?pageId=18646050&revisedVersion=42&originalVersion=41">View Changes</a>
|
<a href="https://docs.jboss.org/author/display/TEIID/Installation+Guide?showComments=true&showCommentArea=true#addcomment">Add Comment</a>
</div>
</div>
</div>
</div>
</div>
</body>
</html>