<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/~rareddy">Ramesh Reddy</a>
</h4>
<br/>
<h4>Changes (5)</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-deleted-lines" style="color:#999;background-color:#fdd;text-decoration:line-through;">* Download [Teiid|http://www.jboss.org/teiid/downloads.html]. 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 JBoss AS {space-metadata-from:asVersionNumber} in both _Standalone_ and _Domain_ modes. Teiid provides separate configuration files (standalone-teiid.xml and domain-teiid.xml) for both modes apart from the default configuration files come with JBoss AS {space-metadata-from:asVersionNumber}, so that it does not overwrite any previously modified configuration. Also, this gives facility to remove the unused services from this configuration that are not used by Teiid and not required by user for their applications. <br></td></tr>
<tr><td class="diff-added-lines" style="background-color: #dfd;">* Download [Teiid|http://www.jboss.org/teiid/downloads.html]. 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 JBoss AS {space-metadata-from:asVersionNumber} in both _Standalone_ and _Domain_ modes. Teiid provides separate configuration files for both standalone mode and domain mode. Based on type of mode and installation type you choose there you may have run a CLI script to complete the installation. <br></td></tr>
<tr><td class="diff-unchanged" > <br></td></tr>
<tr><td class="diff-changed-lines" >The "Domain" mode recommended in a clustered environment to take advantage of clustered caching and cluster safe distribution of events. <span class="diff-deleted-words"style="color:#999;background-color:#fdd;text-decoration:line-through;">Only</span> Teiid's default configuration for Domain mode <span class="diff-added-words"style="background-color: #dfd;">through CLI script</span> configured for high availability and clustered caching. <br></td></tr>
<tr><td class="diff-unchanged" > <br>h3. Standalone Mode <br></td></tr>
<tr><td class="diff-snipped" >...<br></td></tr>
<tr><td class="diff-unchanged" >/domain <br> /configuration <br></td></tr>
<tr><td class="diff-deleted-lines" style="color:#999;background-color:#fdd;text-decoration:line-through;"> domain-teiid.xml <br></td></tr>
<tr><td class="diff-unchanged" > teiid-security-users.properties <br> teiid-security-roles.properties <br></td></tr>
<tr><td class="diff-snipped" >...<br></td></tr>
<tr><td class="diff-unchanged" >h3. /domain/configuration/ <br> <br></td></tr>
<tr><td class="diff-deleted-lines" style="color:#999;background-color:#fdd;text-decoration:line-through;">* domain-teiid.xml - Master configuration file for Domain mode. This file contains Teiid subsystem in addition to standard JBoss AS web profile subsystems. <br></td></tr>
<tr><td class="diff-unchanged" >* teiid-security-users.properties, teiid-security-roles.properties - These files define the allowed users and their defined roles in Teiid using the default security domain. Edit these files to add users. If you want to use a different security domain change the security domain details in main configuration file. <br> <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 JBoss AS 7.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-7.2</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://www.jboss.org/teiid/downloads.html" class="external-link" rel="nofollow">Teiid</a>. Unzip the downloaded artifact inside the JBoss AS installation. Teiid 8.3 directory structure matches JBoss AS directly - it is just an overlay. This will add necessary modules and configuration files to install Teiid in JBoss AS 7.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 type of mode and installation type you choose there you may have run a CLI script to complete the 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=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 the JBoss AS 7.2 and Teiid 8.3 on all the servers in are going to be part of the cluster. Select one of the server 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 JBoss AS provided <a href="https://docs.jboss.org/author/display/AS71/AS7+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, to complete the installation for the domain mode, run the following command against "master" node. Note that this only needs to be run for once per whole domain install. This script installs Teiid in <b>HA</b> profile. This also re-configures <em>main-server-group</em> to start the <em>HA</em> profile. Since in domain mode you can not statically deploy resources by dropping them in the <em>domain/deployments</em> folder, this script deploys default resources required (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 the Teiid needs to be installed in other profiles other than <em>HA</em> profile, edit the <em>teiid-domain-mode-install.cli</em> file, and make edits appropriately for profile, socket-bindings, server-groups and then run the above command.</td></tr></table></div>
<p>That 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 the 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 8.3 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
teiid-security-users.properties
teiid-security-roles.properties
/modules
/org/jboss/teiid/*
/standalone
/configuration
standalone-teiid.xml
teiid-security-users.properties
teiid-security-roles.properties
/deployments
teiid-*.rar
</pre>
</div></div>
<h3><a name="InstallationGuide-bin%2Fscripts"></a>bin/scripts</h3>
<p>Has installation and utility CLI scripts.</p>
<h3><a name="InstallationGuide-docs%2Fteiid"></a>docs/teiid</h3>
<p>Has documents, examples, sample data source XML fragments and schema files. Contains artifacts need by the Quick Start Example.</p>
<h3><a name="InstallationGuide-%2Fstandalone%2Fconfiguration"></a>/standalone/configuration</h3>
<ul>
<li>standalone-teiid.xml - Master configuration file for Teiid system. This file contains Teiid subsystem in addition to standard JBoss AS web profile subsystems</li>
<li>teiid-security-users.properties,teiid-security-roles.properties - These files define the allowed users and their defined roles in Teiid using the default security domain. Edit these files to add users. If you want to use a different security domain change the security domain details in main configuration file.</li>
</ul>
<h3><a name="InstallationGuide-%2Fstandalone%2Fdeployments"></a>/standalone/deployments</h3>
<p>This directory contains all the resource-adapter RAR files that are supplied as part of the Teiid installation. Note that resource adaptors are not installed by default for the domain mode.</p>
<h3><a name="InstallationGuide-%2Fmodules%2Forg%2Fjboss%2Fteiid%2F%5C"></a>/modules/org/jboss/teiid/*</h3>
<p>This directory defines the modules for JBoss AS 7.2 system</p>
<h3><a name="InstallationGuide-%2Fdomain%2Fconfiguration%2F"></a>/domain/configuration/</h3>
<ul>
<li>teiid-security-users.properties, teiid-security-roles.properties - These files define the allowed users and their defined roles in Teiid using the default security domain. Edit these files to add users. If you want to use a different security domain change the security domain details in main configuration file.</li>
</ul>
<h3><a name="InstallationGuide-modules%2Forg%2Fjboss%2Fteiid%2Fclient"></a>modules/org/jboss/teiid/client</h3>
<p>This directory contains Teiid client libraries. It has the Teiid JDBC driver jar, "teiid-8.3.0.Final-jdbc.jar", and also contains "teiid-hibernate-dialect-8.3.0.Final.jar" that contains Teiid's Hibernate dialect.</p>
<h3><a name="InstallationGuide-%5Ctmp%2Fteiid"></a>{standlaone or domain}tmp/teiid</h3>
<p>This directory 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.</p>
<h3><a name="InstallationGuide-%5Cdata%2Fteiiddata"></a>{standlaone or domain}data/teiid-data</h3>
<p>This directory contains cached vdb metadata files. Do not edit them manually.</p>
</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=24&originalVersion=23">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>